diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/base/classes.xml | 31022 |
1 files changed, 15546 insertions, 15476 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 5f7e995099..067d73034b 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. </description> <methods> - <method name="sin"> - <return type="float"> + <method name="Color8"> + <return type="Color"> </return> - <argument index="0" name="s" type="float"> + <argument index="0" name="r8" type="int"> </argument> - <description> - Standard sine function. - </description> - </method> - <method name="cos"> - <return type="float"> - </return> - <argument index="0" name="s" type="float"> + <argument index="1" name="g8" type="int"> </argument> - <description> - Standard cosine function. - </description> - </method> - <method name="tan"> - <return type="float"> - </return> - <argument index="0" name="s" type="float"> + <argument index="2" name="b8" type="int"> </argument> - <description> - Standard tangent function. - </description> - </method> - <method name="sinh"> - <return type="float"> - </return> - <argument index="0" name="s" type="float"> + <argument index="3" name="a8" type="int"> </argument> <description> - Hyperbolic sine. + Make a color from red, green, blue and alpha. Arguments can range from 0 to 255. </description> </method> - <method name="cosh"> + <method name="abs"> <return type="float"> </return> <argument index="0" name="s" type="float"> </argument> <description> - Hyperbolic cosine. + Remove sign (works for integer and float). </description> </method> - <method name="tanh"> + <method name="acos"> <return type="float"> </return> <argument index="0" name="s" type="float"> </argument> <description> - Hyperbolic tangent. + Arc-cosine. </description> </method> <method name="asin"> @@ -71,13 +50,13 @@ Arc-sine. </description> </method> - <method name="acos"> - <return type="float"> + <method name="assert"> + <return type="Nil"> </return> - <argument index="0" name="s" type="float"> + <argument index="0" name="condition" type="bool"> </argument> <description> - Arc-cosine. + Assert that the condition is true. If the condition is false, generates an error. </description> </method> <method name="atan"> @@ -100,125 +79,113 @@ Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range. </description> </method> - <method name="sqrt"> - <return type="float"> + <method name="bytes2var"> + <return type="Variant"> </return> - <argument index="0" name="s" type="float"> + <argument index="0" name="bytes" type="RawArray"> </argument> <description> - Square root. + Decode a byte array back to a value. </description> </method> - <method name="fmod"> + <method name="ceil"> <return type="float"> </return> - <argument index="0" name="x" type="float"> - </argument> - <argument index="1" name="y" type="float"> + <argument index="0" name="s" type="float"> </argument> <description> - Module (remainder of x/y). + Ceiling (rounds up to nearest integer). </description> </method> - <method name="fposmod"> + <method name="clamp"> <return type="float"> </return> - <argument index="0" name="x" type="float"> + <argument index="0" name="val" type="float"> </argument> - <argument index="1" name="y" type="float"> + <argument index="1" name="min" type="float"> </argument> - <description> - Module (remainder of x/y) that wraps equally in positive and negative. - </description> - </method> - <method name="floor"> - <return type="float"> - </return> - <argument index="0" name="s" type="float"> + <argument index="2" name="max" type="float"> </argument> <description> - Floor (rounds down to nearest integer). + Clamp both values to a range. </description> </method> - <method name="ceil"> - <return type="float"> + <method name="convert"> + <return type="Object"> </return> - <argument index="0" name="s" type="float"> + <argument index="0" name="what" type="Variant"> </argument> - <description> - Ceiling (rounds up to nearest integer). - </description> - </method> - <method name="round"> - <return type="float"> - </return> - <argument index="0" name="s" type="float"> + <argument index="1" name="type" type="int"> </argument> <description> - Round to nearest integer. + Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in [@Global Scope]. </description> </method> - <method name="abs"> + <method name="cos"> <return type="float"> </return> <argument index="0" name="s" type="float"> </argument> <description> - Remove sign (works for integer and float). + Standard cosine function. </description> </method> - <method name="sign"> + <method name="cosh"> <return type="float"> </return> <argument index="0" name="s" type="float"> </argument> <description> - Return sign (-1 or +1). + Hyperbolic cosine. </description> </method> - <method name="pow"> + <method name="db2linear"> <return type="float"> </return> - <argument index="0" name="x" type="float"> - </argument> - <argument index="1" name="y" type="float"> + <argument index="0" name="db" type="float"> </argument> <description> - Power function, x elevate to y. + Convert from decibels to linear energy (audio). </description> </method> - <method name="log"> + <method name="decimals"> <return type="float"> </return> - <argument index="0" name="s" type="float"> + <argument index="0" name="step" type="float"> </argument> <description> - Natural logarithm. + Return the amount of decimals in the floating point value. </description> </method> - <method name="exp"> + <method name="dectime"> <return type="float"> </return> - <argument index="0" name="s" type="float"> + <argument index="0" name="value" type="float"> + </argument> + <argument index="1" name="amount" type="float"> + </argument> + <argument index="2" name="step" type="float"> </argument> <description> - Exponential logarithm. + Decreases time by a specified amount. </description> </method> - <method name="is_nan"> + <method name="deg2rad"> <return type="float"> </return> - <argument index="0" name="s" type="float"> + <argument index="0" name="deg" type="float"> </argument> <description> + Convert from degrees to radians. </description> </method> - <method name="is_inf"> - <return type="float"> + <method name="dict2inst"> + <return type="Object"> </return> - <argument index="0" name="s" type="float"> + <argument index="0" name="dict" type="Dictionary"> </argument> <description> + Convert a previously converted instances to dictionary back into an instance. Useful for deserializing. </description> </method> <method name="ease"> @@ -232,118 +199,111 @@ 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. </description> </method> - <method name="decimals"> + <method name="exp"> <return type="float"> </return> - <argument index="0" name="step" type="float"> + <argument index="0" name="s" type="float"> </argument> <description> - Return the amount of decimals in the floating point value. + Exponential logarithm. </description> </method> - <method name="stepify"> + <method name="floor"> <return type="float"> </return> <argument index="0" name="s" type="float"> </argument> - <argument index="1" name="step" type="float"> - </argument> <description> - Snap float value to a given step. + Floor (rounds down to nearest integer). </description> </method> - <method name="lerp"> + <method name="fmod"> <return type="float"> </return> - <argument index="0" name="from" type="float"> - </argument> - <argument index="1" name="to" type="float"> + <argument index="0" name="x" type="float"> </argument> - <argument index="2" name="weight" type="float"> + <argument index="1" name="y" type="float"> </argument> <description> - Linear interpolates between two values by a normalized value. + Module (remainder of x/y). </description> </method> - <method name="dectime"> + <method name="fposmod"> <return type="float"> </return> - <argument index="0" name="value" type="float"> - </argument> - <argument index="1" name="amount" type="float"> + <argument index="0" name="x" type="float"> </argument> - <argument index="2" name="step" type="float"> + <argument index="1" name="y" type="float"> </argument> <description> - Decreases time by a specified amount. + Module (remainder of x/y) that wraps equally in positive and negative. </description> </method> - <method name="randomize"> - <return type="Nil"> + <method name="funcref"> + <return type="FuncRef"> </return> + <argument index="0" name="instance" type="Object"> + </argument> + <argument index="1" name="funcname" type="String"> + </argument> <description> - Reset the seed of the random number generator with a new, different one. + Return a reference to the specified function. </description> </method> - <method name="randi"> + <method name="hash"> <return type="int"> </return> + <argument index="0" name="var:Variant" type="Variant"> + </argument> <description> - 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. - </description> - </method> - <method name="randf"> - <return type="float"> - </return> - <description> - Random value (0 to 1 float). + Hash the variable passed and return an integer. </description> </method> - <method name="rand_range"> - <return type="float"> + <method name="inst2dict"> + <return type="Dictionary"> </return> - <argument index="0" name="from" type="float"> - </argument> - <argument index="1" name="to" type="float"> + <argument index="0" name="inst" type="Object"> </argument> <description> - Random range, any floating point value between 'from' and 'to' + Convert a script class instance to a dictionary (useful for serializing). </description> </method> - <method name="seed"> - <return type="Nil"> + <method name="instance_from_id"> + <return type="Object"> </return> - <argument index="0" name="seed" type="int"> + <argument index="0" name="instance_id" type="int"> </argument> <description> - Set seed for the random number generator. + Get an object by its ID. </description> </method> - <method name="rand_seed"> - <return type="Array"> + <method name="is_inf"> + <return type="float"> </return> - <argument index="0" name="seed" type="int"> + <argument index="0" name="s" type="float"> </argument> <description> - Random from seed, pass a seed and an array with both number and new seed is returned. </description> </method> - <method name="deg2rad"> + <method name="is_nan"> <return type="float"> </return> - <argument index="0" name="deg" type="float"> + <argument index="0" name="s" type="float"> </argument> <description> - Convert from degrees to radians. </description> </method> - <method name="rad2deg"> + <method name="lerp"> <return type="float"> </return> - <argument index="0" name="rad" type="float"> + <argument index="0" name="from" type="float"> + </argument> + <argument index="1" name="to" type="float"> + </argument> + <argument index="2" name="weight" type="float"> </argument> <description> - Convert from radians to degrees. + Linear interpolates between two values by a normalized value. </description> </method> <method name="linear2db"> @@ -355,13 +315,22 @@ Convert from linear energy to decibels (audio). </description> </method> - <method name="db2linear"> + <method name="load"> + <return type="Resource"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Load a resource from the filesystem, pass a valid path as argument. + </description> + </method> + <method name="log"> <return type="float"> </return> - <argument index="0" name="db" type="float"> + <argument index="0" name="s" type="float"> </argument> <description> - Convert from decibels to linear energy (audio). + Natural logarithm. </description> </method> <method name="max"> @@ -386,19 +355,6 @@ Return the minimum of two values. </description> </method> - <method name="clamp"> - <return type="float"> - </return> - <argument index="0" name="val" type="float"> - </argument> - <argument index="1" name="min" type="float"> - </argument> - <argument index="2" name="max" type="float"> - </argument> - <description> - Clamp both values to a range. - </description> - </method> <method name="nearest_po2"> <return type="int"> </return> @@ -408,58 +364,56 @@ Return the nearest larger power of 2 for an integer. </description> </method> - <method name="weakref"> - <return type="WeakRef"> + <method name="pow"> + <return type="float"> </return> - <argument index="0" name="obj" type="Object"> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> </argument> <description> - Return a weak reference to an object. + Power function, x elevate to y. </description> </method> - <method name="funcref"> - <return type="FuncRef"> + <method name="preload"> + <return type="Resource"> </return> - <argument index="0" name="instance" type="Object"> - </argument> - <argument index="1" name="funcname" type="String"> + <argument index="0" name="path" type="String"> </argument> <description> - Return a reference to the specified function. + Preload a resource from the filesystem. The resource is loaded during script parsing. </description> </method> - <method name="convert"> - <return type="Object"> + <method name="print"> + <return type="Nil"> </return> <argument index="0" name="what" type="Variant"> </argument> - <argument index="1" name="type" type="int"> + <argument index="1" name="..." type="Variant"> </argument> <description> - Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in [@Global Scope]. + Print one or more arguments to strings in the best way possible to a console line. </description> </method> - <method name="typeof"> - <return type="int"> + <method name="print_stack"> + <return type="Nil"> </return> - <argument index="0" name="what" type="Variant"> - </argument> <description> - Return the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope]. + Print a stack track at code location, only works when running with debugger turned on. </description> </method> - <method name="str"> - <return type="String"> + <method name="printerr"> + <return type="Nil"> </return> <argument index="0" name="what" type="Variant"> </argument> <argument index="1" name="..." type="Variant"> </argument> <description> - Convert one or more arguments to strings in the best way possible. + Print one or more arguments to strings in the best way possible to standard error line. </description> </method> - <method name="print"> + <method name="printraw"> <return type="Nil"> </return> <argument index="0" name="what" type="Variant"> @@ -467,10 +421,10 @@ <argument index="1" name="..." type="Variant"> </argument> <description> - Print one or more arguments to strings in the best way possible to a console line. + Print one or more arguments to strings in the best way possible to console. No newline is added at the end. </description> </method> - <method name="printt"> + <method name="prints"> <return type="Nil"> </return> <argument index="0" name="what" type="Variant"> @@ -478,10 +432,10 @@ <argument index="1" name="..." type="Variant"> </argument> <description> - 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. </description> </method> - <method name="prints"> + <method name="printt"> <return type="Nil"> </return> <argument index="0" name="what" type="Variant"> @@ -489,65 +443,57 @@ <argument index="1" name="..." type="Variant"> </argument> <description> - Print one or more arguments to the console with a space between each argument. + Print one or more arguments to the console with a tab between each argument. </description> </method> - <method name="printerr"> - <return type="Nil"> + <method name="rad2deg"> + <return type="float"> </return> - <argument index="0" name="what" type="Variant"> - </argument> - <argument index="1" name="..." type="Variant"> + <argument index="0" name="rad" type="float"> </argument> <description> - Print one or more arguments to strings in the best way possible to standard error line. + Convert from radians to degrees. </description> </method> - <method name="printraw"> - <return type="Nil"> + <method name="rand_range"> + <return type="float"> </return> - <argument index="0" name="what" type="Variant"> + <argument index="0" name="from" type="float"> </argument> - <argument index="1" name="..." type="Variant"> + <argument index="1" name="to" type="float"> </argument> <description> - Print one or more arguments to strings in the best way possible to console. No newline is added at the end. + Random range, any floating point value between 'from' and 'to' </description> </method> - <method name="var2str"> - <return type="String"> + <method name="rand_seed"> + <return type="Array"> </return> - <argument index="0" name="var" type="Variant"> + <argument index="0" name="seed" type="int"> </argument> <description> - Convert a value to a formatted string that can later be parsed using [method str2var]. + Random from seed, pass a seed and an array with both number and new seed is returned. </description> </method> - <method name="str2var"> - <return type="Variant"> + <method name="randf"> + <return type="float"> </return> - <argument index="0" name="string" type="String"> - </argument> <description> - Convert a formatted string that was returned by [method var2str] to the original value. + Random value (0 to 1 float). </description> </method> - <method name="var2bytes"> - <return type="RawArray"> + <method name="randi"> + <return type="int"> </return> - <argument index="0" name="var" type="Variant"> - </argument> <description> - Encode a variable value to a byte array. + 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. </description> </method> - <method name="bytes2var"> - <return type="Variant"> + <method name="randomize"> + <return type="Nil"> </return> - <argument index="0" name="bytes" type="RawArray"> - </argument> <description> - Decode a byte array back to a value. + Reset the seed of the random number generator with a new, different one. </description> </method> <method name="range"> @@ -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). </description> </method> - <method name="load"> - <return type="Resource"> + <method name="round"> + <return type="float"> </return> - <argument index="0" name="path" type="String"> + <argument index="0" name="s" type="float"> </argument> <description> - Load a resource from the filesystem, pass a valid path as argument. + Round to nearest integer. </description> </method> - <method name="inst2dict"> - <return type="Dictionary"> + <method name="seed"> + <return type="Nil"> </return> - <argument index="0" name="inst" type="Object"> + <argument index="0" name="seed" type="int"> </argument> <description> - Convert a script class instance to a dictionary (useful for serializing). + Set seed for the random number generator. </description> </method> - <method name="dict2inst"> - <return type="Object"> + <method name="sign"> + <return type="float"> </return> - <argument index="0" name="dict" type="Dictionary"> + <argument index="0" name="s" type="float"> </argument> <description> - Convert a previously converted instances to dictionary back into an instance. Useful for deserializing. + Return sign (-1 or +1). </description> </method> - <method name="hash"> - <return type="int"> + <method name="sin"> + <return type="float"> </return> - <argument index="0" name="var:Variant" type="Variant"> + <argument index="0" name="s" type="float"> </argument> <description> - Hash the variable passed and return an integer. + Standard sine function. </description> </method> - <method name="Color8"> - <return type="Color"> + <method name="sinh"> + <return type="float"> </return> - <argument index="0" name="r8" type="int"> + <argument index="0" name="s" type="float"> </argument> - <argument index="1" name="g8" type="int"> + <description> + Hyperbolic sine. + </description> + </method> + <method name="sqrt"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> </argument> - <argument index="2" name="b8" type="int"> + <description> + Square root. + </description> + </method> + <method name="stepify"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> </argument> - <argument index="3" name="a8" type="int"> + <argument index="1" name="step" type="float"> </argument> <description> - Make a color from red, green, blue and alpha. Arguments can range from 0 to 255. + Snap float value to a given step. </description> </method> - <method name="print_stack"> - <return type="Nil"> + <method name="str"> + <return type="String"> </return> + <argument index="0" name="what" type="Variant"> + </argument> + <argument index="1" name="..." type="Variant"> + </argument> <description> - Print a stack track at code location, only works when running with debugger turned on. + Convert one or more arguments to strings in the best way possible. </description> </method> - <method name="instance_from_id"> - <return type="Object"> + <method name="str2var"> + <return type="Variant"> </return> - <argument index="0" name="instance_id" type="int"> + <argument index="0" name="string" type="String"> </argument> <description> - Get an object by its ID. + Convert a formatted string that was returned by [method var2str] to the original value. </description> </method> - <method name="preload"> - <return type="Resource"> + <method name="tan"> + <return type="float"> </return> - <argument index="0" name="path" type="String"> + <argument index="0" name="s" type="float"> </argument> <description> - Preload a resource from the filesystem. The resource is loaded during script parsing. + Standard tangent function. + </description> + </method> + <method name="tanh"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Hyperbolic tangent. + </description> + </method> + <method name="type_exists"> + <return type="bool"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="typeof"> + <return type="int"> + </return> + <argument index="0" name="what" type="Variant"> + </argument> + <description> + Return the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope]. + </description> + </method> + <method name="var2bytes"> + <return type="RawArray"> + </return> + <argument index="0" name="var" type="Variant"> + </argument> + <description> + Encode a variable value to a byte array. + </description> + </method> + <method name="var2str"> + <return type="String"> + </return> + <argument index="0" name="var" type="Variant"> + </argument> + <description> + Convert a value to a formatted string that can later be parsed using [method str2var]. + </description> + </method> + <method name="weakref"> + <return type="WeakRef"> + </return> + <argument index="0" name="obj" type="Object"> + </argument> + <description> + Return a weak reference to an object. </description> </method> <method name="yield"> @@ -648,15 +665,6 @@ If passed an object and a signal, the execution is resumed when the object's signal is emmited. </description> </method> - <method name="assert"> - <return type="Nil"> - </return> - <argument index="0" name="condition" type="bool"> - </argument> - <description> - Assert that the condition is true. If the condition is false, generates an error. - </description> - </method> </methods> <constants> <constant name="PI" value="3.141593"> @@ -675,38 +683,20 @@ <methods> </methods> <members> - <member name="Performance" type="Performance"> - [Performance] singleton - </member> - <member name="Globals" type="Globals"> - [Globals] singleton + <member name="AS" type="AudioServer"> + [AudioServer] singleton </member> - <member name="IP" type="IP"> - [IP] singleton + <member name="AudioServer" type="AudioServer"> + [AudioServer] singleton </member> <member name="Geometry" type="Geometry"> [Geometry] singleton </member> - <member name="ResourceLoader" type="ResourceLoader"> - [ResourceLoader] singleton - </member> - <member name="ResourceSaver" type="ResourceSaver"> - [ResourceSaver] singleton - </member> - <member name="PathRemap" type="PathRemap"> - [PathRemap] singleton - </member> - <member name="OS" type="OS"> - [OS] singleton - </member> - <member name="Marshalls" type="Reference"> - [Marshalls] singleton - </member> - <member name="TranslationServer" type="TranslationServer"> - [TranslationServer] singleton + <member name="Globals" type="Globals"> + [Globals] singleton </member> - <member name="TS" type="TranslationServer"> - [TranslationServer] singleton + <member name="IP" type="IP"> + [IP] singleton </member> <member name="Input" type="Input"> [Input] singleton @@ -714,61 +704,171 @@ <member name="InputMap" type="InputMap"> [InputMap] singleton </member> - <member name="VisualServer" type="VisualServer"> - [VisualServer] singleton + <member name="Marshalls" type="Reference"> + [Marshalls] singleton </member> - <member name="VS" type="VisualServer"> - [VisualServer] singleton + <member name="OS" type="OS"> + [OS] singleton </member> - <member name="AudioServer" type="AudioServer"> - [AudioServer] singleton + <member name="PS" type="PhysicsServer"> + [PhysicsServer] singleton </member> - <member name="AS" type="AudioServer"> - [AudioServer] singleton + <member name="PS2D" type="Physics2DServer"> + [Physics2DServer] singleton </member> - <member name="PhysicsServer" type="PhysicsServer"> - [PhysicsServer] singleton + <member name="PathRemap" type="PathRemap"> + [PathRemap] singleton </member> - <member name="PS" type="PhysicsServer"> - [PhysicsServer] singleton + <member name="Performance" type="Performance"> + [Performance] singleton </member> <member name="Physics2DServer" type="Physics2DServer"> [Physics2DServer] singleton </member> - <member name="PS2D" type="Physics2DServer"> - [Physics2DServer] singleton + <member name="PhysicsServer" type="PhysicsServer"> + [PhysicsServer] singleton </member> - <member name="SpatialSoundServer" type="SpatialSoundServer"> - [SpatialSoundServer] singleton + <member name="ResourceLoader" type="ResourceLoader"> + [ResourceLoader] singleton + </member> + <member name="ResourceSaver" type="ResourceSaver"> + [ResourceSaver] singleton </member> <member name="SS" type="SpatialSoundServer"> [SpatialSoundServer] singleton </member> - <member name="SpatialSound2DServer" type="SpatialSound2DServer"> + <member name="SS2D" type="SpatialSound2DServer"> [SpatialSound2DServer] singleton </member> - <member name="SS2D" type="SpatialSound2DServer"> + <member name="SpatialSound2DServer" type="SpatialSound2DServer"> [SpatialSound2DServer] singleton </member> + <member name="SpatialSoundServer" type="SpatialSoundServer"> + [SpatialSoundServer] singleton + </member> + <member name="TS" type="TranslationServer"> + [TranslationServer] singleton + </member> + <member name="TranslationServer" type="TranslationServer"> + [TranslationServer] singleton + </member> + <member name="VS" type="VisualServer"> + [VisualServer] singleton + </member> + <member name="VisualServer" type="VisualServer"> + [VisualServer] singleton + </member> </members> <constants> - <constant name="MARGIN_LEFT" value="0"> - Left margin, used usually for [Control] or [StyleBox] derived classes. + <constant name="BUTTON_LEFT" value="1"> + Left Mouse Button </constant> - <constant name="MARGIN_TOP" value="1"> - Top margin, used usually for [Control] or [StyleBox] derived classes. + <constant name="BUTTON_MASK_LEFT" value="1"> </constant> - <constant name="MARGIN_RIGHT" value="2"> - Right margin, used usually for [Control] or [StyleBox] derived classes. + <constant name="BUTTON_MASK_RIGHT" value="2"> </constant> - <constant name="MARGIN_BOTTOM" value="3"> - Bottom margin, used usually for [Control] or [StyleBox] derived classes. + <constant name="BUTTON_RIGHT" value="2"> + Right Mouse Button </constant> - <constant name="VERTICAL" value="1"> - General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc. + <constant name="BUTTON_MIDDLE" value="3"> + Middle Mouse Button </constant> - <constant name="HORIZONTAL" value="0"> - General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc. + <constant name="BUTTON_MASK_MIDDLE" value="4"> + </constant> + <constant name="BUTTON_WHEEL_UP" value="4"> + Mouse wheel up + </constant> + <constant name="BUTTON_WHEEL_DOWN" value="5"> + Mouse wheel down + </constant> + <constant name="BUTTON_WHEEL_LEFT" value="6"> + Mouse wheel left button + </constant> + <constant name="BUTTON_WHEEL_RIGHT" value="7"> + Mouse wheel right button + </constant> + <constant name="ERR_FILE_NO_PERMISSION" value="10"> + </constant> + <constant name="ERR_FILE_ALREADY_IN_USE" value="11"> + </constant> + <constant name="ERR_FILE_CANT_OPEN" value="12"> + </constant> + <constant name="ERR_FILE_CANT_WRITE" value="13"> + </constant> + <constant name="ERR_FILE_CANT_READ" value="14"> + </constant> + <constant name="ERR_FILE_UNRECOGNIZED" value="15"> + </constant> + <constant name="ERR_FILE_CORRUPT" value="16"> + </constant> + <constant name="ERR_FILE_MISSING_DEPENDENCIES" value="17"> + </constant> + <constant name="ERR_FILE_EOF" value="18"> + </constant> + <constant name="ERR_CANT_OPEN" value="19"> + </constant> + <constant name="ERR_UNAVAILABLE" value="2"> + </constant> + <constant name="ERR_CANT_CREATE" value="20"> + </constant> + <constant name="ERR_ALREADY_IN_USE" value="22"> + </constant> + <constant name="ERR_LOCKED" value="23"> + </constant> + <constant name="ERR_TIMEOUT" value="24"> + </constant> + <constant name="ERR_CANT_AQUIRE_RESOURCE" value="28"> + </constant> + <constant name="ERR_UNCONFIGURED" value="3"> + </constant> + <constant name="ERR_INVALID_DATA" value="30"> + </constant> + <constant name="ERR_INVALID_PARAMETER" value="31"> + </constant> + <constant name="ERR_ALREADY_EXISTS" value="32"> + </constant> + <constant name="ERR_DOES_NOT_EXIST" value="33"> + </constant> + <constant name="ERR_DATABASE_CANT_READ" value="34"> + </constant> + <constant name="ERR_DATABASE_CANT_WRITE" value="35"> + </constant> + <constant name="ERR_COMPILATION_FAILED" value="36"> + </constant> + <constant name="ERR_METHOD_NOT_FOUND" value="37"> + </constant> + <constant name="ERR_LINK_FAILED" value="38"> + </constant> + <constant name="ERR_SCRIPT_FAILED" value="39"> + </constant> + <constant name="ERR_UNAUTHORIZED" value="4"> + </constant> + <constant name="ERR_CYCLIC_LINK" value="40"> + </constant> + <constant name="ERR_PARSE_ERROR" value="43"> + </constant> + <constant name="ERR_BUSY" value="44"> + </constant> + <constant name="ERR_HELP" value="46"> + </constant> + <constant name="ERR_BUG" value="47"> + </constant> + <constant name="ERR_WTF" value="49"> + </constant> + <constant name="ERR_PARAMETER_RANGE_ERROR" value="5"> + </constant> + <constant name="ERR_OUT_OF_MEMORY" value="6"> + </constant> + <constant name="ERR_FILE_NOT_FOUND" value="7"> + </constant> + <constant name="ERR_FILE_BAD_DRIVE" value="8"> + </constant> + <constant name="ERR_FILE_BAD_PATH" value="9"> + </constant> + <constant name="ERROR_QUERY_FAILED" value="21"> + </constant> + <constant name="FAILED" value="1"> + Generic fail return error. </constant> <constant name="HALIGN_LEFT" value="0"> Horizontal left alignment, usually for text-derived classes. @@ -779,17 +879,232 @@ <constant name="HALIGN_RIGHT" value="2"> Horizontal right alignment, usually for text-derived classes. </constant> - <constant name="VALIGN_TOP" value="0"> - Vertical top alignment, usually for text-derived classes. + <constant name="HORIZONTAL" value="0"> + General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc. </constant> - <constant name="VALIGN_CENTER" value="1"> - Vertical center alignment, usually for text-derived classes. + <constant name="JOY_ANALOG_0_X" value="0"> + Joystick Left Stick Horizontal Axis </constant> - <constant name="VALIGN_BOTTOM" value="2"> - Vertical bottom alignment, usually for text-derived classes. + <constant name="JOY_AXIS_0" value="0"> + Joystick Left Stick Horizontal Axis </constant> - <constant name="SPKEY" value="16777216"> - Scancodes with this bit applied are non printable. + <constant name="JOY_BUTTON_0" value="0"> + Joystick Button 0 + </constant> + <constant name="JOY_DS_B" value="0"> + </constant> + <constant name="JOY_SEGA_A" value="0"> + SEGA controller A button + </constant> + <constant name="JOY_SNES_B" value="0"> + Super Nintendo Entertaiment System controller B button + </constant> + <constant name="JOY_SONY_X" value="0"> + DUALSHOCK X button + </constant> + <constant name="JOY_XBOX_A" value="0"> + XBOX controller A button + </constant> + <constant name="JOY_ANALOG_0_Y" value="1"> + Joystick Left Stick Vertical Axis + </constant> + <constant name="JOY_AXIS_1" value="1"> + Joystick Left Stick Vertical Axis + </constant> + <constant name="JOY_BUTTON_1" value="1"> + Joystick Button 1 + </constant> + <constant name="JOY_DS_A" value="1"> + </constant> + <constant name="JOY_SEGA_B" value="1"> + SEGA controller B button + </constant> + <constant name="JOY_SNES_A" value="1"> + Super Nintendo Entertaiment System controller A button + </constant> + <constant name="JOY_SONY_CIRCLE" value="1"> + DUALSHOCK circle button + </constant> + <constant name="JOY_XBOX_B" value="1"> + XBOX controller B button + </constant> + <constant name="JOY_BUTTON_10" value="10"> + Joystick Button 10 + </constant> + <constant name="JOY_SELECT" value="10"> + Joystick Button Select + </constant> + <constant name="JOY_BUTTON_11" value="11"> + Joystick Button 11 + </constant> + <constant name="JOY_START" value="11"> + Joystick Button Start + </constant> + <constant name="JOY_BUTTON_12" value="12"> + Joystick Button 12 + </constant> + <constant name="JOY_DPAD_UP" value="12"> + Joystick DPad Up + </constant> + <constant name="JOY_BUTTON_13" value="13"> + Joystick Button 13 + </constant> + <constant name="JOY_DPAD_DOWN" value="13"> + Joystick DPad Down + </constant> + <constant name="JOY_BUTTON_14" value="14"> + Joystick Button 14 + </constant> + <constant name="JOY_DPAD_LEFT" value="14"> + Joystick DPad Left + </constant> + <constant name="JOY_BUTTON_15" value="15"> + Joystick Button 15 + </constant> + <constant name="JOY_DPAD_RIGHT" value="15"> + Joystick DPad Right + </constant> + <constant name="JOY_BUTTON_MAX" value="16"> + Joystick Button 16 + </constant> + <constant name="JOY_ANALOG_1_X" value="2"> + Joystick Right Stick Horizontal Axis + </constant> + <constant name="JOY_AXIS_2" value="2"> + Joystick Right Stick Horizontal Axis + </constant> + <constant name="JOY_BUTTON_2" value="2"> + Joystick Button 2 + </constant> + <constant name="JOY_DS_Y" value="2"> + </constant> + <constant name="JOY_SEGA_X" value="2"> + SEGA controller X button + </constant> + <constant name="JOY_SNES_Y" value="2"> + Super Nintendo Entertaiment System controller Y button + </constant> + <constant name="JOY_SONY_SQUARE" value="2"> + DUALSHOCK square button + </constant> + <constant name="JOY_XBOX_X" value="2"> + XBOX controller X button + </constant> + <constant name="JOY_ANALOG_1_Y" value="3"> + Joystick Right Stick Vertical Axis + </constant> + <constant name="JOY_AXIS_3" value="3"> + Joystick Right Stick Vertical Axis + </constant> + <constant name="JOY_BUTTON_3" value="3"> + Joystick Button 3 + </constant> + <constant name="JOY_DS_X" value="3"> + </constant> + <constant name="JOY_SEGA_Y" value="3"> + SEGA controller Y button + </constant> + <constant name="JOY_SNES_X" value="3"> + Super Nintendo Entertaiment System controller X button + </constant> + <constant name="JOY_SONY_TRIANGLE" value="3"> + DUALSHOCK triangle button + </constant> + <constant name="JOY_XBOX_Y" value="3"> + XBOX controller Y button + </constant> + <constant name="JOY_ANALOG_2_X" value="4"> + </constant> + <constant name="JOY_AXIS_4" value="4"> + </constant> + <constant name="JOY_BUTTON_4" value="4"> + Joystick Button 4 + </constant> + <constant name="JOY_L" value="4"> + Joystick Left Shoulder Button + </constant> + <constant name="JOY_ANALOG_2_Y" value="5"> + </constant> + <constant name="JOY_AXIS_5" value="5"> + </constant> + <constant name="JOY_BUTTON_5" value="5"> + Joystick Button 5 + </constant> + <constant name="JOY_R" value="5"> + Joystick Right Shoulder Button + </constant> + <constant name="JOY_ANALOG_L2" value="6"> + </constant> + <constant name="JOY_AXIS_6" value="6"> + Joystick Left Trigger Analog Axis + </constant> + <constant name="JOY_BUTTON_6" value="6"> + Joystick Button 6 + </constant> + <constant name="JOY_L2" value="6"> + Joystick Left Trigger + </constant> + <constant name="JOY_ANALOG_R2" value="7"> + </constant> + <constant name="JOY_AXIS_7" value="7"> + Joystick Right Trigger Analog Axis + </constant> + <constant name="JOY_BUTTON_7" value="7"> + Joystick Button 7 + </constant> + <constant name="JOY_R2" value="7"> + Joystick Right Trigger + </constant> + <constant name="JOY_AXIS_MAX" value="8"> + </constant> + <constant name="JOY_BUTTON_8" value="8"> + Joystick Button 8 + </constant> + <constant name="JOY_L3" value="8"> + Joystick Left Stick Click + </constant> + <constant name="JOY_BUTTON_9" value="9"> + Joystick Button 9 + </constant> + <constant name="JOY_R3" value="9"> + Joystick Right Stick Click + </constant> + <constant name="KEY_MODIFIER_MASK" value="-16777216"> + </constant> + <constant name="KEY_MASK_GROUP_SWITCH" value="1073741824"> + </constant> + <constant name="KEY_BRACELEFT" value="123"> + { key + </constant> + <constant name="KEY_BAR" value="124"> + | key + </constant> + <constant name="KEY_BRACERIGHT" value="125"> + } key + </constant> + <constant name="KEY_ASCIITILDE" value="126"> + ~ key + </constant> + <constant name="KEY_MASK_META" value="134217728"> + </constant> + <constant name="KEY_NOBREAKSPACE" value="160"> + </constant> + <constant name="KEY_EXCLAMDOWN" value="161"> + </constant> + <constant name="KEY_CENT" value="162"> + ¢ key + </constant> + <constant name="KEY_STERLING" value="163"> + </constant> + <constant name="KEY_CURRENCY" value="164"> + </constant> + <constant name="KEY_YEN" value="165"> + </constant> + <constant name="KEY_BROKENBAR" value="166"> + ¦ key + </constant> + <constant name="KEY_SECTION" value="167"> + § key </constant> <constant name="KEY_ESCAPE" value="16777217"> Escape Key @@ -917,54 +1232,6 @@ <constant name="KEY_F16" value="16777259"> F16 Key </constant> - <constant name="KEY_KP_ENTER" value="16777344"> - Enter Key on Numpad - </constant> - <constant name="KEY_KP_MULTIPLY" value="16777345"> - Multiply Key on Numpad - </constant> - <constant name="KEY_KP_DIVIDE" value="16777346"> - Divide Key on Numpad - </constant> - <constant name="KEY_KP_SUBTRACT" value="16777347"> - Subtract Key on Numpad - </constant> - <constant name="KEY_KP_PERIOD" value="16777348"> - Period Key on Numpad - </constant> - <constant name="KEY_KP_ADD" value="16777349"> - Add Key on Numpad - </constant> - <constant name="KEY_KP_0" value="16777350"> - Number 0 on Numpad - </constant> - <constant name="KEY_KP_1" value="16777351"> - Number 1 on Numpad - </constant> - <constant name="KEY_KP_2" value="16777352"> - Number 2 on Numpad - </constant> - <constant name="KEY_KP_3" value="16777353"> - Number 3 on Numpad - </constant> - <constant name="KEY_KP_4" value="16777354"> - Number 4 on Numpad - </constant> - <constant name="KEY_KP_5" value="16777355"> - Number 5 on Numpad - </constant> - <constant name="KEY_KP_6" value="16777356"> - Number 6 on Numpad - </constant> - <constant name="KEY_KP_7" value="16777357"> - Number 7 on Numpad - </constant> - <constant name="KEY_KP_8" value="16777358"> - Number 8 on Numpad - </constant> - <constant name="KEY_KP_9" value="16777359"> - Number 9 on Numpad - </constant> <constant name="KEY_SUPER_L" value="16777260"> Super Left key (windows key) </constant> @@ -1080,232 +1347,53 @@ </constant> <constant name="KEY_LAUNCHF" value="16777319"> </constant> - <constant name="KEY_UNKNOWN" value="33554431"> - </constant> - <constant name="KEY_SPACE" value="32"> - Space Key - </constant> - <constant name="KEY_EXCLAM" value="33"> - ! key - </constant> - <constant name="KEY_QUOTEDBL" value="34"> - " key - </constant> - <constant name="KEY_NUMBERSIGN" value="35"> - # key - </constant> - <constant name="KEY_DOLLAR" value="36"> - $ key - </constant> - <constant name="KEY_PERCENT" value="37"> - % key - </constant> - <constant name="KEY_AMPERSAND" value="38"> - & key - </constant> - <constant name="KEY_APOSTROPHE" value="39"> - ' key - </constant> - <constant name="KEY_PARENLEFT" value="40"> - ( key - </constant> - <constant name="KEY_PARENRIGHT" value="41"> - ) key - </constant> - <constant name="KEY_ASTERISK" value="42"> - * key - </constant> - <constant name="KEY_PLUS" value="43"> - + key - </constant> - <constant name="KEY_COMMA" value="44"> - , key - </constant> - <constant name="KEY_MINUS" value="45"> - - key - </constant> - <constant name="KEY_PERIOD" value="46"> - . key - </constant> - <constant name="KEY_SLASH" value="47"> - / key - </constant> - <constant name="KEY_0" value="48"> - Number 0 - </constant> - <constant name="KEY_1" value="49"> - Number 1 - </constant> - <constant name="KEY_2" value="50"> - Number 2 - </constant> - <constant name="KEY_3" value="51"> - Number 3 - </constant> - <constant name="KEY_4" value="52"> - Number 4 - </constant> - <constant name="KEY_5" value="53"> - Number 5 - </constant> - <constant name="KEY_6" value="54"> - Number 6 - </constant> - <constant name="KEY_7" value="55"> - Number 7 - </constant> - <constant name="KEY_8" value="56"> - Number 8 - </constant> - <constant name="KEY_9" value="57"> - Number 9 - </constant> - <constant name="KEY_COLON" value="58"> - : key - </constant> - <constant name="KEY_SEMICOLON" value="59"> - ; key - </constant> - <constant name="KEY_LESS" value="60"> - Lower than key - </constant> - <constant name="KEY_EQUAL" value="61"> - = key - </constant> - <constant name="KEY_GREATER" value="62"> - Greater than key - </constant> - <constant name="KEY_QUESTION" value="63"> - ? key - </constant> - <constant name="KEY_AT" value="64"> - @ key - </constant> - <constant name="KEY_A" value="65"> - A Key - </constant> - <constant name="KEY_B" value="66"> - B Key - </constant> - <constant name="KEY_C" value="67"> - C Key - </constant> - <constant name="KEY_D" value="68"> - D Key - </constant> - <constant name="KEY_E" value="69"> - E Key - </constant> - <constant name="KEY_F" value="70"> - F Key - </constant> - <constant name="KEY_G" value="71"> - G Key - </constant> - <constant name="KEY_H" value="72"> - H Key - </constant> - <constant name="KEY_I" value="73"> - I Key - </constant> - <constant name="KEY_J" value="74"> - J Key - </constant> - <constant name="KEY_K" value="75"> - K Key - </constant> - <constant name="KEY_L" value="76"> - L Key - </constant> - <constant name="KEY_M" value="77"> - M Key - </constant> - <constant name="KEY_N" value="78"> - N Key - </constant> - <constant name="KEY_O" value="79"> - O Key - </constant> - <constant name="KEY_P" value="80"> - P Key - </constant> - <constant name="KEY_Q" value="81"> - Q Key - </constant> - <constant name="KEY_R" value="82"> - R Key - </constant> - <constant name="KEY_S" value="83"> - S Key - </constant> - <constant name="KEY_T" value="84"> - T Key - </constant> - <constant name="KEY_U" value="85"> - U Key - </constant> - <constant name="KEY_V" value="86"> - V Key - </constant> - <constant name="KEY_W" value="87"> - W Key - </constant> - <constant name="KEY_X" value="88"> - X Key - </constant> - <constant name="KEY_Y" value="89"> - Y Key - </constant> - <constant name="KEY_Z" value="90"> - Z Key - </constant> - <constant name="KEY_BRACKETLEFT" value="91"> - [ key - </constant> - <constant name="KEY_BACKSLASH" value="92"> - \ key - </constant> - <constant name="KEY_BRACKETRIGHT" value="93"> - ] key + <constant name="KEY_KP_ENTER" value="16777344"> + Enter Key on Numpad </constant> - <constant name="KEY_ASCIICIRCUM" value="94"> - ^ key + <constant name="KEY_KP_MULTIPLY" value="16777345"> + Multiply Key on Numpad </constant> - <constant name="KEY_UNDERSCORE" value="95"> - _ key + <constant name="KEY_KP_DIVIDE" value="16777346"> + Divide Key on Numpad </constant> - <constant name="KEY_QUOTELEFT" value="96"> + <constant name="KEY_KP_SUBTRACT" value="16777347"> + Subtract Key on Numpad </constant> - <constant name="KEY_BRACELEFT" value="123"> - { key + <constant name="KEY_KP_PERIOD" value="16777348"> + Period Key on Numpad </constant> - <constant name="KEY_BAR" value="124"> - | key + <constant name="KEY_KP_ADD" value="16777349"> + Add Key on Numpad </constant> - <constant name="KEY_BRACERIGHT" value="125"> - } key + <constant name="KEY_KP_0" value="16777350"> + Number 0 on Numpad </constant> - <constant name="KEY_ASCIITILDE" value="126"> - ~ key + <constant name="KEY_KP_1" value="16777351"> + Number 1 on Numpad </constant> - <constant name="KEY_NOBREAKSPACE" value="160"> + <constant name="KEY_KP_2" value="16777352"> + Number 2 on Numpad </constant> - <constant name="KEY_EXCLAMDOWN" value="161"> + <constant name="KEY_KP_3" value="16777353"> + Number 3 on Numpad </constant> - <constant name="KEY_CENT" value="162"> - ¢ key + <constant name="KEY_KP_4" value="16777354"> + Number 4 on Numpad </constant> - <constant name="KEY_STERLING" value="163"> + <constant name="KEY_KP_5" value="16777355"> + Number 5 on Numpad </constant> - <constant name="KEY_CURRENCY" value="164"> + <constant name="KEY_KP_6" value="16777356"> + Number 6 on Numpad </constant> - <constant name="KEY_YEN" value="165"> + <constant name="KEY_KP_7" value="16777357"> + Number 7 on Numpad </constant> - <constant name="KEY_BROKENBAR" value="166"> - ¦ key + <constant name="KEY_KP_8" value="16777358"> + Number 8 on Numpad </constant> - <constant name="KEY_SECTION" value="167"> - § key + <constant name="KEY_KP_9" value="16777359"> + Number 9 on Numpad </constant> <constant name="KEY_DIAERESIS" value="168"> ¨ key @@ -1438,356 +1526,266 @@ </constant> <constant name="KEY_YDIAERESIS" value="255"> </constant> - <constant name="KEY_CODE_MASK" value="33554431"> - </constant> - <constant name="KEY_MODIFIER_MASK" value="-16777216"> + <constant name="KEY_MASK_CMD" value="268435456"> </constant> - <constant name="KEY_MASK_SHIFT" value="33554432"> + <constant name="KEY_MASK_CTRL" value="268435456"> </constant> - <constant name="KEY_MASK_ALT" value="67108864"> + <constant name="KEY_SPACE" value="32"> + Space Key </constant> - <constant name="KEY_MASK_META" value="134217728"> + <constant name="KEY_EXCLAM" value="33"> + ! key </constant> - <constant name="KEY_MASK_CTRL" value="268435456"> + <constant name="KEY_CODE_MASK" value="33554431"> </constant> - <constant name="KEY_MASK_CMD" value="268435456"> + <constant name="KEY_UNKNOWN" value="33554431"> </constant> - <constant name="KEY_MASK_KPAD" value="536870912"> + <constant name="KEY_MASK_SHIFT" value="33554432"> </constant> - <constant name="KEY_MASK_GROUP_SWITCH" value="1073741824"> + <constant name="KEY_QUOTEDBL" value="34"> + " key </constant> - <constant name="BUTTON_LEFT" value="1"> - Left Mouse Button + <constant name="KEY_NUMBERSIGN" value="35"> + # key </constant> - <constant name="BUTTON_RIGHT" value="2"> - Right Mouse Button + <constant name="KEY_DOLLAR" value="36"> + $ key </constant> - <constant name="BUTTON_MIDDLE" value="3"> - Middle Mouse Button + <constant name="KEY_PERCENT" value="37"> + % key </constant> - <constant name="BUTTON_WHEEL_UP" value="4"> - Mouse wheel up + <constant name="KEY_AMPERSAND" value="38"> + & key </constant> - <constant name="BUTTON_WHEEL_DOWN" value="5"> - Mouse wheel down + <constant name="KEY_APOSTROPHE" value="39"> + ' key </constant> - <constant name="BUTTON_WHEEL_LEFT" value="6"> - Mouse wheel left button + <constant name="KEY_PARENLEFT" value="40"> + ( key </constant> - <constant name="BUTTON_WHEEL_RIGHT" value="7"> - Mouse wheel right button + <constant name="KEY_PARENRIGHT" value="41"> + ) key </constant> - <constant name="BUTTON_MASK_LEFT" value="1"> + <constant name="KEY_ASTERISK" value="42"> + * key </constant> - <constant name="BUTTON_MASK_RIGHT" value="2"> + <constant name="KEY_PLUS" value="43"> + + key </constant> - <constant name="BUTTON_MASK_MIDDLE" value="4"> + <constant name="KEY_COMMA" value="44"> + , key </constant> - <constant name="JOY_BUTTON_0" value="0"> - Joystick Button 0 + <constant name="KEY_MINUS" value="45"> + - key </constant> - <constant name="JOY_BUTTON_1" value="1"> - Joystick Button 1 + <constant name="KEY_PERIOD" value="46"> + . key </constant> - <constant name="JOY_BUTTON_2" value="2"> - Joystick Button 2 + <constant name="KEY_SLASH" value="47"> + / key </constant> - <constant name="JOY_BUTTON_3" value="3"> - Joystick Button 3 + <constant name="KEY_0" value="48"> + Number 0 </constant> - <constant name="JOY_BUTTON_4" value="4"> - Joystick Button 4 + <constant name="KEY_1" value="49"> + Number 1 </constant> - <constant name="JOY_BUTTON_5" value="5"> - Joystick Button 5 + <constant name="KEY_2" value="50"> + Number 2 </constant> - <constant name="JOY_BUTTON_6" value="6"> - Joystick Button 6 + <constant name="KEY_3" value="51"> + Number 3 </constant> - <constant name="JOY_BUTTON_7" value="7"> - Joystick Button 7 + <constant name="KEY_4" value="52"> + Number 4 </constant> - <constant name="JOY_BUTTON_8" value="8"> - Joystick Button 8 + <constant name="KEY_5" value="53"> + Number 5 </constant> - <constant name="JOY_BUTTON_9" value="9"> - Joystick Button 9 + <constant name="KEY_MASK_KPAD" value="536870912"> </constant> - <constant name="JOY_BUTTON_10" value="10"> - Joystick Button 10 + <constant name="KEY_6" value="54"> + Number 6 </constant> - <constant name="JOY_BUTTON_11" value="11"> - Joystick Button 11 + <constant name="KEY_7" value="55"> + Number 7 </constant> - <constant name="JOY_BUTTON_12" value="12"> - Joystick Button 12 + <constant name="KEY_8" value="56"> + Number 8 </constant> - <constant name="JOY_BUTTON_13" value="13"> - Joystick Button 13 + <constant name="KEY_9" value="57"> + Number 9 </constant> - <constant name="JOY_BUTTON_14" value="14"> - Joystick Button 14 + <constant name="KEY_COLON" value="58"> + : key </constant> - <constant name="JOY_BUTTON_15" value="15"> - Joystick Button 15 + <constant name="KEY_SEMICOLON" value="59"> + ; key </constant> - <constant name="JOY_BUTTON_MAX" value="16"> - Joystick Button 16 + <constant name="KEY_LESS" value="60"> + Lower than key </constant> - <constant name="JOY_SNES_A" value="1"> - Super Nintendo Entertaiment System controller A button + <constant name="KEY_EQUAL" value="61"> + = key </constant> - <constant name="JOY_SNES_B" value="0"> - Super Nintendo Entertaiment System controller B button + <constant name="KEY_GREATER" value="62"> + Greater than key </constant> - <constant name="JOY_SNES_X" value="3"> - Super Nintendo Entertaiment System controller X button + <constant name="KEY_QUESTION" value="63"> + ? key </constant> - <constant name="JOY_SNES_Y" value="2"> - Super Nintendo Entertaiment System controller Y button + <constant name="KEY_AT" value="64"> + @ key </constant> - <constant name="JOY_SONY_CIRCLE" value="1"> - DUALSHOCK circle button + <constant name="KEY_A" value="65"> + A Key </constant> - <constant name="JOY_SONY_X" value="0"> - DUALSHOCK X button + <constant name="KEY_B" value="66"> + B Key </constant> - <constant name="JOY_SONY_SQUARE" value="2"> - DUALSHOCK square button + <constant name="KEY_C" value="67"> + C Key </constant> - <constant name="JOY_SONY_TRIANGLE" value="3"> - DUALSHOCK triangle button + <constant name="KEY_MASK_ALT" value="67108864"> </constant> - <constant name="JOY_SEGA_B" value="1"> - SEGA controller B button + <constant name="KEY_D" value="68"> + D Key </constant> - <constant name="JOY_SEGA_A" value="0"> - SEGA controller A button + <constant name="KEY_E" value="69"> + E Key </constant> - <constant name="JOY_SEGA_X" value="2"> - SEGA controller X button + <constant name="KEY_F" value="70"> + F Key </constant> - <constant name="JOY_SEGA_Y" value="3"> - SEGA controller Y button + <constant name="KEY_G" value="71"> + G Key </constant> - <constant name="JOY_XBOX_B" value="1"> - XBOX controller B button + <constant name="KEY_H" value="72"> + H Key </constant> - <constant name="JOY_XBOX_A" value="0"> - XBOX controller A button + <constant name="KEY_I" value="73"> + I Key </constant> - <constant name="JOY_XBOX_X" value="2"> - XBOX controller X button + <constant name="KEY_J" value="74"> + J Key </constant> - <constant name="JOY_XBOX_Y" value="3"> - XBOX controller Y button + <constant name="KEY_K" value="75"> + K Key </constant> - <constant name="JOY_DS_A" value="1"> + <constant name="KEY_L" value="76"> + L Key </constant> - <constant name="JOY_DS_B" value="0"> + <constant name="KEY_M" value="77"> + M Key </constant> - <constant name="JOY_DS_X" value="3"> + <constant name="KEY_N" value="78"> + N Key </constant> - <constant name="JOY_DS_Y" value="2"> + <constant name="KEY_O" value="79"> + O Key </constant> - <constant name="JOY_SELECT" value="10"> - Joystick Button Select + <constant name="KEY_P" value="80"> + P Key </constant> - <constant name="JOY_START" value="11"> - Joystick Button Start + <constant name="KEY_Q" value="81"> + Q Key </constant> - <constant name="JOY_DPAD_UP" value="12"> - Joystick DPad Up + <constant name="KEY_R" value="82"> + R Key </constant> - <constant name="JOY_DPAD_DOWN" value="13"> - Joystick DPad Down + <constant name="KEY_S" value="83"> + S Key </constant> - <constant name="JOY_DPAD_LEFT" value="14"> - Joystick DPad Left + <constant name="KEY_T" value="84"> + T Key </constant> - <constant name="JOY_DPAD_RIGHT" value="15"> - Joystick DPad Right + <constant name="KEY_U" value="85"> + U Key </constant> - <constant name="JOY_L" value="4"> - Joystick Left Shoulder Button + <constant name="KEY_V" value="86"> + V Key </constant> - <constant name="JOY_L2" value="6"> - Joystick Left Trigger + <constant name="KEY_W" value="87"> + W Key </constant> - <constant name="JOY_L3" value="8"> - Joystick Left Stick Click + <constant name="KEY_X" value="88"> + X Key </constant> - <constant name="JOY_R" value="5"> - Joystick Right Shoulder Button + <constant name="KEY_Y" value="89"> + Y Key </constant> - <constant name="JOY_R2" value="7"> - Joystick Right Trigger + <constant name="KEY_Z" value="90"> + Z Key </constant> - <constant name="JOY_R3" value="9"> - Joystick Right Stick Click + <constant name="KEY_BRACKETLEFT" value="91"> + [ key </constant> - <constant name="JOY_AXIS_0" value="0"> - Joystick Left Stick Horizontal Axis + <constant name="KEY_BACKSLASH" value="92"> + \ key </constant> - <constant name="JOY_AXIS_1" value="1"> - Joystick Left Stick Vertical Axis + <constant name="KEY_BRACKETRIGHT" value="93"> + ] key </constant> - <constant name="JOY_AXIS_2" value="2"> - Joystick Right Stick Horizontal Axis + <constant name="KEY_ASCIICIRCUM" value="94"> + ^ key </constant> - <constant name="JOY_AXIS_3" value="3"> - Joystick Right Stick Vertical Axis + <constant name="KEY_UNDERSCORE" value="95"> + _ key </constant> - <constant name="JOY_AXIS_4" value="4"> + <constant name="KEY_QUOTELEFT" value="96"> </constant> - <constant name="JOY_AXIS_5" value="5"> + <constant name="MARGIN_LEFT" value="0"> + Left margin, used usually for [Control] or [StyleBox] derived classes. </constant> - <constant name="JOY_AXIS_6" value="6"> - Joystick Left Trigger Analog Axis + <constant name="MARGIN_TOP" value="1"> + Top margin, used usually for [Control] or [StyleBox] derived classes. </constant> - <constant name="JOY_AXIS_7" value="7"> - Joystick Right Trigger Analog Axis + <constant name="MARGIN_RIGHT" value="2"> + Right margin, used usually for [Control] or [StyleBox] derived classes. </constant> - <constant name="JOY_AXIS_MAX" value="8"> + <constant name="MARGIN_BOTTOM" value="3"> + Bottom margin, used usually for [Control] or [StyleBox] derived classes. </constant> - <constant name="JOY_ANALOG_0_X" value="0"> - Joystick Left Stick Horizontal Axis + <constant name="METHOD_FLAGS_DEFAULT" value="1"> </constant> - <constant name="JOY_ANALOG_0_Y" value="1"> - Joystick Left Stick Vertical Axis + <constant name="METHOD_FLAG_NORMAL" value="1"> </constant> - <constant name="JOY_ANALOG_1_X" value="2"> - Joystick Right Stick Horizontal Axis + <constant name="METHOD_FLAG_REVERSE" value="16"> </constant> - <constant name="JOY_ANALOG_1_Y" value="3"> - Joystick Right Stick Vertical Axis + <constant name="METHOD_FLAG_EDITOR" value="2"> </constant> - <constant name="JOY_ANALOG_2_X" value="4"> + <constant name="METHOD_FLAG_VIRTUAL" value="32"> </constant> - <constant name="JOY_ANALOG_2_Y" value="5"> + <constant name="METHOD_FLAG_NOSCRIPT" value="4"> </constant> - <constant name="JOY_ANALOG_L2" value="6"> + <constant name="METHOD_FLAG_FROM_SCRIPT" value="64"> </constant> - <constant name="JOY_ANALOG_R2" value="7"> + <constant name="METHOD_FLAG_CONST" value="8"> </constant> <constant name="OK" value="0"> Functions that return Error return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout. </constant> - <constant name="FAILED" value="1"> - Generic fail return error. - </constant> - <constant name="ERR_UNAVAILABLE" value="2"> - </constant> - <constant name="ERR_UNCONFIGURED" value="3"> - </constant> - <constant name="ERR_UNAUTHORIZED" value="4"> - </constant> - <constant name="ERR_PARAMETER_RANGE_ERROR" value="5"> - </constant> - <constant name="ERR_OUT_OF_MEMORY" value="6"> - </constant> - <constant name="ERR_FILE_NOT_FOUND" value="7"> - </constant> - <constant name="ERR_FILE_BAD_DRIVE" value="8"> - </constant> - <constant name="ERR_FILE_BAD_PATH" value="9"> - </constant> - <constant name="ERR_FILE_NO_PERMISSION" value="10"> - </constant> - <constant name="ERR_FILE_ALREADY_IN_USE" value="11"> - </constant> - <constant name="ERR_FILE_CANT_OPEN" value="12"> - </constant> - <constant name="ERR_FILE_CANT_WRITE" value="13"> - </constant> - <constant name="ERR_FILE_CANT_READ" value="14"> - </constant> - <constant name="ERR_FILE_UNRECOGNIZED" value="15"> - </constant> - <constant name="ERR_FILE_CORRUPT" value="16"> - </constant> - <constant name="ERR_FILE_MISSING_DEPENDENCIES" value="17"> - </constant> - <constant name="ERR_FILE_EOF" value="18"> - </constant> - <constant name="ERR_CANT_OPEN" value="19"> - </constant> - <constant name="ERR_CANT_CREATE" value="20"> - </constant> - <constant name="ERR_PARSE_ERROR" value="43"> - </constant> - <constant name="ERROR_QUERY_FAILED" value="21"> - </constant> - <constant name="ERR_ALREADY_IN_USE" value="22"> - </constant> - <constant name="ERR_LOCKED" value="23"> - </constant> - <constant name="ERR_TIMEOUT" value="24"> - </constant> - <constant name="ERR_CANT_AQUIRE_RESOURCE" value="28"> - </constant> - <constant name="ERR_INVALID_DATA" value="30"> - </constant> - <constant name="ERR_INVALID_PARAMETER" value="31"> - </constant> - <constant name="ERR_ALREADY_EXISTS" value="32"> - </constant> - <constant name="ERR_DOES_NOT_EXIST" value="33"> - </constant> - <constant name="ERR_DATABASE_CANT_READ" value="34"> - </constant> - <constant name="ERR_DATABASE_CANT_WRITE" value="35"> - </constant> - <constant name="ERR_COMPILATION_FAILED" value="36"> - </constant> - <constant name="ERR_METHOD_NOT_FOUND" value="37"> - </constant> - <constant name="ERR_LINK_FAILED" value="38"> - </constant> - <constant name="ERR_SCRIPT_FAILED" value="39"> - </constant> - <constant name="ERR_CYCLIC_LINK" value="40"> - </constant> - <constant name="ERR_BUSY" value="44"> - </constant> - <constant name="ERR_HELP" value="46"> - </constant> - <constant name="ERR_BUG" value="47"> - </constant> - <constant name="ERR_WTF" value="49"> - </constant> <constant name="PROPERTY_HINT_NONE" value="0"> No hint for edited property. </constant> <constant name="PROPERTY_HINT_RANGE" value="1"> Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats. </constant> - <constant name="PROPERTY_HINT_EXP_RANGE" value="2"> - Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. - </constant> - <constant name="PROPERTY_HINT_ENUM" value="3"> - Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties. - </constant> - <constant name="PROPERTY_HINT_EXP_EASING" value="4"> - </constant> - <constant name="PROPERTY_HINT_LENGTH" value="5"> - </constant> - <constant name="PROPERTY_HINT_KEY_ACCEL" value="7"> - </constant> - <constant name="PROPERTY_HINT_FLAGS" value="8"> - Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. - </constant> - <constant name="PROPERTY_HINT_ALL_FLAGS" value="9"> - Property hint for a bitmask description that covers all 32 bits. Valid only for integers. + <constant name="PROPERTY_USAGE_STORAGE" value="1"> + Property will be used as storage (default). </constant> <constant name="PROPERTY_HINT_FILE" value="10"> String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc". </constant> + <constant name="PROPERTY_USAGE_STORE_IF_NONONE" value="1024"> + </constant> <constant name="PROPERTY_HINT_DIR" value="11"> String property is a directory (so pop up a file dialog when edited). </constant> <constant name="PROPERTY_HINT_GLOBAL_FILE" value="12"> </constant> + <constant name="PROPERTY_USAGE_BUNDLE" value="128"> + </constant> <constant name="PROPERTY_HINT_GLOBAL_DIR" value="13"> </constant> <constant name="PROPERTY_HINT_RESOURCE_TYPE" value="14"> @@ -1797,62 +1795,60 @@ </constant> <constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="16"> </constant> + <constant name="PROPERTY_USAGE_CHECKABLE" value="16"> + </constant> <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="17"> </constant> <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="18"> </constant> - <constant name="PROPERTY_USAGE_STORAGE" value="1"> - Property will be used as storage (default). + <constant name="PROPERTY_HINT_EXP_RANGE" value="2"> + Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. </constant> <constant name="PROPERTY_USAGE_EDITOR" value="2"> Property will be visible in editor (default). </constant> - <constant name="PROPERTY_USAGE_NETWORK" value="4"> + <constant name="PROPERTY_USAGE_NO_INSTANCE_STATE" value="2048"> </constant> - <constant name="PROPERTY_USAGE_EDITOR_HELPER" value="8"> + <constant name="PROPERTY_USAGE_CATEGORY" value="256"> </constant> - <constant name="PROPERTY_USAGE_CHECKABLE" value="16"> + <constant name="PROPERTY_HINT_ENUM" value="3"> + Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties. </constant> <constant name="PROPERTY_USAGE_CHECKED" value="32"> </constant> - <constant name="PROPERTY_USAGE_INTERNATIONALIZED" value="64"> + <constant name="PROPERTY_HINT_EXP_EASING" value="4"> </constant> - <constant name="PROPERTY_USAGE_BUNDLE" value="128"> + <constant name="PROPERTY_USAGE_NETWORK" value="4"> </constant> - <constant name="PROPERTY_USAGE_CATEGORY" value="256"> + <constant name="PROPERTY_USAGE_RESTART_IF_CHANGED" value="4096"> </constant> - <constant name="PROPERTY_USAGE_STORE_IF_NONZERO" value="512"> + <constant name="PROPERTY_HINT_LENGTH" value="5"> </constant> - <constant name="PROPERTY_USAGE_STORE_IF_NONONE" value="1024"> + <constant name="PROPERTY_USAGE_NOEDITOR" value="5"> </constant> - <constant name="PROPERTY_USAGE_NO_INSTANCE_STATE" value="2048"> + <constant name="PROPERTY_USAGE_STORE_IF_NONZERO" value="512"> </constant> - <constant name="PROPERTY_USAGE_RESTART_IF_CHANGED" value="4096"> + <constant name="PROPERTY_USAGE_INTERNATIONALIZED" value="64"> </constant> - <constant name="PROPERTY_USAGE_SCRIPT_VARIABLE" value="8192"> + <constant name="PROPERTY_HINT_KEY_ACCEL" value="7"> </constant> <constant name="PROPERTY_USAGE_DEFAULT" value="7"> Default usage (storage and editor). </constant> <constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71"> </constant> - <constant name="PROPERTY_USAGE_NOEDITOR" value="5"> - </constant> - <constant name="METHOD_FLAG_NORMAL" value="1"> - </constant> - <constant name="METHOD_FLAG_EDITOR" value="2"> - </constant> - <constant name="METHOD_FLAG_NOSCRIPT" value="4"> - </constant> - <constant name="METHOD_FLAG_CONST" value="8"> + <constant name="PROPERTY_HINT_FLAGS" value="8"> + Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. </constant> - <constant name="METHOD_FLAG_REVERSE" value="16"> + <constant name="PROPERTY_USAGE_EDITOR_HELPER" value="8"> </constant> - <constant name="METHOD_FLAG_VIRTUAL" value="32"> + <constant name="PROPERTY_USAGE_SCRIPT_VARIABLE" value="8192"> </constant> - <constant name="METHOD_FLAG_FROM_SCRIPT" value="64"> + <constant name="PROPERTY_HINT_ALL_FLAGS" value="9"> + Property hint for a bitmask description that covers all 32 bits. Valid only for integers. </constant> - <constant name="METHOD_FLAGS_DEFAULT" value="1"> + <constant name="SPKEY" value="16777216"> + Scancodes with this bit applied are non printable. </constant> <constant name="TYPE_NIL" value="0"> Variable is of type nil (only applied for null). @@ -1860,30 +1856,6 @@ <constant name="TYPE_BOOL" value="1"> Variable is of type [bool]. </constant> - <constant name="TYPE_INT" value="2"> - Variable is of type [int]. - </constant> - <constant name="TYPE_REAL" value="3"> - Variable is of type [float]/real. - </constant> - <constant name="TYPE_STRING" value="4"> - Variable is of type [String]. - </constant> - <constant name="TYPE_VECTOR2" value="5"> - Variable is of type [Vector2]. - </constant> - <constant name="TYPE_RECT2" value="6"> - Variable is of type [Rect2]. - </constant> - <constant name="TYPE_VECTOR3" value="7"> - Variable is of type [Vector3]. - </constant> - <constant name="TYPE_MATRIX32" value="8"> - Variable is of type [Matrix32]. - </constant> - <constant name="TYPE_PLANE" value="9"> - Variable is of type [Plane]. - </constant> <constant name="TYPE_QUAT" value="10"> Variable is of type [Quat]. </constant> @@ -1914,6 +1886,9 @@ <constant name="TYPE_INPUT_EVENT" value="19"> Variable is of type [InputEvent]. </constant> + <constant name="TYPE_INT" value="2"> + Variable is of type [int]. + </constant> <constant name="TYPE_DICTIONARY" value="20"> Variable is of type [Dictionary]. </constant> @@ -1936,6 +1911,39 @@ </constant> <constant name="TYPE_MAX" value="29"> </constant> + <constant name="TYPE_REAL" value="3"> + Variable is of type [float]/real. + </constant> + <constant name="TYPE_STRING" value="4"> + Variable is of type [String]. + </constant> + <constant name="TYPE_VECTOR2" value="5"> + Variable is of type [Vector2]. + </constant> + <constant name="TYPE_RECT2" value="6"> + Variable is of type [Rect2]. + </constant> + <constant name="TYPE_VECTOR3" value="7"> + Variable is of type [Vector3]. + </constant> + <constant name="TYPE_MATRIX32" value="8"> + Variable is of type [Matrix32]. + </constant> + <constant name="TYPE_PLANE" value="9"> + Variable is of type [Plane]. + </constant> + <constant name="VALIGN_TOP" value="0"> + Vertical top alignment, usually for text-derived classes. + </constant> + <constant name="VALIGN_CENTER" value="1"> + Vertical center alignment, usually for text-derived classes. + </constant> + <constant name="VALIGN_BOTTOM" value="2"> + Vertical bottom alignment, usually for text-derived classes. + </constant> + <constant name="VERTICAL" value="1"> + General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc. + </constant> </constants> </class> <class name="AABB" category="Built-In Types"> @@ -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. </description> <methods> + <method name="AABB"> + <return type="AABB"> + </return> + <argument index="0" name="pos" type="Vector3"> + </argument> + <argument index="1" name="size" type="Vector3"> + </argument> + <description> + Optional constructor, accepts position and size. + </description> + </method> <method name="encloses"> <return type="bool"> </return> @@ -2110,28 +2129,17 @@ Combine this [AABB] with another, a larger one is returned that contains both. </description> </method> - <method name="AABB"> - <return type="AABB"> - </return> - <argument index="0" name="pos" type="Vector3"> - </argument> - <argument index="1" name="size" type="Vector3"> - </argument> - <description> - Optional constructor, accepts position and size. - </description> - </method> </methods> <members> + <member name="end" type="Vector3"> + Ending corner. + </member> <member name="pos" type="Vector3"> Position (starting corner). </member> <member name="size" type="Vector3"> Size from position to end. </member> - <member name="end" type="Vector3"> - Ending corner. - </member> </members> <constants> </constants> @@ -2144,25 +2152,27 @@ This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result. </description> <methods> - <method name="get_ok"> - <return type="Object"> + <method name="add_button"> + <return type="Button"> </return> + <argument index="0" name="text" type="String"> + </argument> + <argument index="1" name="right" type="bool" default="false"> + </argument> + <argument index="2" name="action" type="String" default=""""> + </argument> <description> - Return the OK Button. + Add custom button to the dialog and return the created button. + The button titled with [i]text[/i] and the [i]action[/i] will be passed to [custom_action] signal when it is pressed. </description> </method> - <method name="get_label"> - <return type="Object"> + <method name="add_cancel"> + <return type="Button"> </return> - <description> - Return the label used for built-in text. - </description> - </method> - <method name="set_hide_on_ok"> - <argument index="0" name="enabled" type="bool"> + <argument index="0" name="name" type="String"> </argument> <description> - Set whether the dialog is hidden when accepted (default true). + Add custom cancel button to the dialog and return the created button. </description> </method> <method name="get_hide_on_ok" qualifiers="const"> @@ -2172,27 +2182,25 @@ Return true if the dialog will be hidden when accepted (default true). </description> </method> - <method name="add_button"> - <return type="Button"> + <method name="get_label"> + <return type="Object"> </return> - <argument index="0" name="text" type="String"> - </argument> - <argument index="1" name="right" type="bool" default="false"> - </argument> - <argument index="2" name="action" type="String" default=""""> - </argument> <description> - Add custom button to the dialog and return the created button. - The button titled with [i]text[/i] and the [i]action[/i] will be passed to [custom_action] signal when it is pressed. + Return the label used for built-in text. </description> </method> - <method name="add_cancel"> - <return type="Button"> + <method name="get_ok"> + <return type="Object"> </return> - <argument index="0" name="name" type="String"> - </argument> <description> - Add custom cancel button to the dialog and return the created button. + Return the OK Button. + </description> + </method> + <method name="get_text" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the built-in label text. </description> </method> <method name="register_text_enter"> @@ -2204,18 +2212,18 @@ Register a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. </description> </method> - <method name="set_text"> - <argument index="0" name="text" type="String"> + <method name="set_hide_on_ok"> + <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the built-in label text. + Set whether the dialog is hidden when accepted (default true). </description> </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> + <method name="set_text"> + <argument index="0" name="text" type="String"> + </argument> <description> - Return the built-in label text. + Set the built-in label text. </description> </method> </methods> @@ -2244,88 +2252,91 @@ Sprite node that can use multiple textures for animation. </description> <methods> - <method name="set_sprite_frames"> - <argument index="0" name="sprite_frames" type="SpriteFrames"> - </argument> + <method name="get_animation" qualifiers="const"> + <return type="String"> + </return> <description> - Set the [SpriteFrames] resource, which contains all frames. </description> </method> - <method name="get_sprite_frames" qualifiers="const"> - <return type="SpriteFrames"> + <method name="get_frame" qualifiers="const"> + <return type="int"> </return> <description> - Get the [SpriteFrames] resource, which contains all frames. + Return the visible frame index. </description> </method> - <method name="set_animation"> - <argument index="0" name="animation" type="String"> - </argument> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> + </return> <description> + Return the color modulation for this sprite. </description> </method> - <method name="get_animation" qualifiers="const"> - <return type="String"> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> </return> <description> + Return the offset of the sprite in the node origin. </description> </method> - <method name="play"> - <argument index="0" name="anim" type="String" default=""""> - </argument> + <method name="get_sprite_frames" qualifiers="const"> + <return type="SpriteFrames"> + </return> <description> + Get the [SpriteFrames] resource, which contains all frames. </description> </method> - <method name="stop"> + <method name="is_centered" qualifiers="const"> + <return type="bool"> + </return> <description> + Return true when centered. See [method set_centered]. </description> </method> - <method name="is_playing" qualifiers="const"> + <method name="is_flipped_h" qualifiers="const"> <return type="bool"> </return> <description> + Return true if sprite is flipped horizontally. </description> </method> - <method name="set_centered"> - <argument index="0" name="centered" type="bool"> - </argument> + <method name="is_flipped_v" qualifiers="const"> + <return type="bool"> + </return> <description> - When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is. + Return true if sprite is flipped vertically. </description> </method> - <method name="is_centered" qualifiers="const"> + <method name="is_playing" qualifiers="const"> <return type="bool"> </return> <description> - Return true when centered. See [method set_centered]. </description> </method> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> + <method name="play"> + <argument index="0" name="anim" type="String" default=""""> </argument> <description> - Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not. </description> </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_animation"> + <argument index="0" name="animation" type="String"> + </argument> <description> - Return the offset of the sprite in the node origin. </description> </method> - <method name="set_flip_h"> - <argument index="0" name="flip_h" type="bool"> + <method name="set_centered"> + <argument index="0" name="centered" type="bool"> </argument> <description> - If true, sprite is flipped horizontally. + When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is. </description> </method> - <method name="is_flipped_h" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_flip_h"> + <argument index="0" name="flip_h" type="bool"> + </argument> <description> - Return true if sprite is flipped horizontally. + If true, sprite is flipped horizontally. </description> </method> <method name="set_flip_v"> @@ -2335,13 +2346,6 @@ If true, sprite is flipped vertically. </description> </method> - <method name="is_flipped_v" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if sprite is flipped vertically. - </description> - </method> <method name="set_frame"> <argument index="0" name="frame" type="int"> </argument> @@ -2349,13 +2353,6 @@ Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource). </description> </method> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the visible frame index. - </description> - </method> <method name="set_modulate"> <argument index="0" name="modulate" type="Color"> </argument> @@ -2363,11 +2360,22 @@ Change the color modulation (multiplication) for this sprite. </description> </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> - </return> + <method name="set_offset"> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not. + </description> + </method> + <method name="set_sprite_frames"> + <argument index="0" name="sprite_frames" type="SpriteFrames"> + </argument> + <description> + Set the [SpriteFrames] resource, which contains all frames. + </description> + </method> + <method name="stop"> <description> - Return the color modulation for this sprite. </description> </method> </methods> @@ -2387,26 +2395,26 @@ <description> </description> <methods> - <method name="set_sprite_frames"> - <argument index="0" name="sprite_frames" type="SpriteFrames"> - </argument> + <method name="get_animation" qualifiers="const"> + <return type="String"> + </return> <description> </description> </method> - <method name="get_sprite_frames" qualifiers="const"> - <return type="SpriteFrames"> + <method name="get_frame" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="set_animation"> - <argument index="0" name="animation" type="String"> - </argument> + <method name="get_sprite_frames" qualifiers="const"> + <return type="SpriteFrames"> + </return> <description> </description> </method> - <method name="get_animation" qualifiers="const"> - <return type="String"> + <method name="is_playing" qualifiers="const"> + <return type="bool"> </return> <description> </description> @@ -2417,25 +2425,25 @@ <description> </description> </method> - <method name="stop"> + <method name="set_animation"> + <argument index="0" name="animation" type="String"> + </argument> <description> </description> </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_frame"> + <argument index="0" name="frame" type="int"> + </argument> <description> </description> </method> - <method name="set_frame"> - <argument index="0" name="frame" type="int"> + <method name="set_sprite_frames"> + <argument index="0" name="sprite_frames" type="SpriteFrames"> </argument> <description> </description> </method> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> + <method name="stop"> <description> </description> </method> @@ -2469,148 +2477,140 @@ Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. </description> </method> - <method name="remove_track"> - <argument index="0" name="idx" type="int"> - </argument> - <description> - Remove a track by specifying the track index. - </description> - </method> - <method name="get_track_count" qualifiers="const"> - <return type="int"> - </return> + <method name="clear"> <description> - Return the amount of tracks in the animation. + Clear the animation (clear all tracks and reset all). </description> </method> - <method name="track_get_type" qualifiers="const"> + <method name="find_track" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="idx" type="int"> + <argument index="0" name="path" type="NodePath"> </argument> <description> - Get the type of a track. </description> </method> - <method name="track_get_path" qualifiers="const"> - <return type="NodePath"> + <method name="get_length" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - Get the path of a track. for more information on the path format, see [method track_set_path] + Return the total length of the animation (in seconds). </description> </method> - <method name="track_set_path"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="path" type="NodePath"> - </argument> + <method name="get_step" qualifiers="const"> + <return type="float"> + </return> <description> - 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" </description> </method> - <method name="find_track" qualifiers="const"> + <method name="get_track_count" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="path" type="NodePath"> - </argument> <description> + Return the amount of tracks in the animation. </description> </method> - <method name="track_move_up"> - <argument index="0" name="idx" type="int"> - </argument> + <method name="has_loop" qualifiers="const"> + <return type="bool"> + </return> <description> - Move a track up. + Return whether the animation has the loop flag set. </description> </method> - <method name="track_move_down"> - <argument index="0" name="idx" type="int"> - </argument> + <method name="has_loop_interpolation" qualifiers="const"> + <return type="bool"> + </return> <description> - Move a track down. </description> </method> - <method name="transform_track_insert_key"> - <return type="int"> + <method name="method_track_get_key_indices" qualifiers="const"> + <return type="IntArray"> </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="time" type="float"> - </argument> - <argument index="2" name="loc" type="Vector3"> - </argument> - <argument index="3" name="rot" type="Quat"> + <argument index="1" name="time_sec" type="float"> </argument> - <argument index="4" name="scale" type="Vector3"> + <argument index="2" name="delta" type="float"> </argument> <description> - Insert a transform key for a transform track. + Return all the key indices of a method track, given a position and delta time. </description> </method> - <method name="track_insert_key"> + <method name="method_track_get_name" qualifiers="const"> + <return type="String"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="time" type="float"> - </argument> - <argument index="2" name="key" type="Variant"> - </argument> - <argument index="3" name="transition" type="float" default="1"> + <argument index="1" name="key_idx" type="int"> </argument> <description> - Insert a generic key in a given track. + Return the method name of a method track. </description> </method> - <method name="track_remove_key"> + <method name="method_track_get_params" qualifiers="const"> + <return type="Array"> + </return> <argument index="0" name="idx" type="int"> </argument> <argument index="1" name="key_idx" type="int"> </argument> <description> - Remove a key by index in a given track. + Return the arguments values to be called on a method track for a given key in a given track. </description> </method> - <method name="track_remove_key_at_pos"> + <method name="remove_track"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="pos" type="float"> + <description> + Remove a track by specifying the track index. + </description> + </method> + <method name="set_length"> + <argument index="0" name="time_sec" type="float"> </argument> <description> - Remove a key by position (seconds) in a given track. + 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. </description> </method> - <method name="track_set_key_value"> - <argument index="0" name="idx" type="int"> + <method name="set_loop"> + <argument index="0" name="enabled" type="bool"> </argument> - <argument index="1" name="key" type="int"> + <description> + 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. + </description> + </method> + <method name="set_loop_interpolation"> + <argument index="0" name="enabled" type="bool"> </argument> - <argument index="2" name="value" type="Variant"> + <description> + </description> + </method> + <method name="set_step"> + <argument index="0" name="size_sec" type="float"> </argument> <description> - Set the value of an existing key. </description> </method> - <method name="track_set_key_transition"> + <method name="track_find_key" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="key_idx" type="int"> + <argument index="1" name="time" type="float"> </argument> - <argument index="2" name="transition" type="float"> + <argument index="2" name="exact" type="bool" default="false"> </argument> <description> - Set the transition curve (easing) for a specific key (see built-in math function "ease"). + Find the key index by time in a given track. Optionally, only find it if the exact time is given. </description> </method> - <method name="track_get_key_transition" qualifiers="const"> - <return type="float"> + <method name="track_get_interpolation_type" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="key_idx" type="int"> - </argument> <description> - Return the transition curve (easing) for a specific key (see built-in math function "ease"). + Return the interpolation type of a given track, from the INTERPOLATION_* enum. </description> </method> <method name="track_get_key_count" qualifiers="const"> @@ -2622,16 +2622,18 @@ Return the amount of keys in a given track. </description> </method> - <method name="track_get_key_value" qualifiers="const"> + <method name="track_get_key_time" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="idx" type="int"> </argument> <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the value of a given key in a given track. + Return the time at which the key is located. </description> </method> - <method name="track_get_key_time" qualifiers="const"> + <method name="track_get_key_transition" qualifiers="const"> <return type="float"> </return> <argument index="0" name="idx" type="int"> @@ -2639,164 +2641,205 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the time at which the key is located. + Return the transition curve (easing) for a specific key (see built-in math function "ease"). </description> </method> - <method name="track_find_key" qualifiers="const"> - <return type="int"> - </return> + <method name="track_get_key_value" qualifiers="const"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="time" type="float"> - </argument> - <argument index="2" name="exact" type="bool" default="false"> + <argument index="1" name="key_idx" type="int"> </argument> <description> - Find the key index by time in a given track. Optionally, only find it if the exact time is given. + Return the value of a given key in a given track. </description> </method> - <method name="track_set_interpolation_type"> + <method name="track_get_path" qualifiers="const"> + <return type="NodePath"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="interpolation" type="int"> - </argument> <description> - Set the interpolation type of a given track, from the INTERPOLATION_* enum. + Get the path of a track. for more information on the path format, see [method track_set_path] </description> </method> - <method name="track_get_interpolation_type" qualifiers="const"> + <method name="track_get_type" qualifiers="const"> <return type="int"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return the interpolation type of a given track, from the INTERPOLATION_* enum. + Get the type of a track. </description> </method> - <method name="transform_track_interpolate" qualifiers="const"> - <return type="Array"> - </return> + <method name="track_insert_key"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="time_sec" type="float"> + <argument index="1" name="time" type="float"> + </argument> + <argument index="2" name="key" type="Variant"> + </argument> + <argument index="3" name="transition" type="float" default="1"> </argument> <description> - 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]). + Insert a generic key in a given track. </description> </method> - <method name="value_track_set_continuous"> + <method name="track_is_imported" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="continuous" type="bool"> - </argument> <description> - Enable or disable interpolation for a whole track. By default tracks are interpolated. </description> </method> - <method name="value_track_is_continuous" qualifiers="const"> - <return type="bool"> - </return> + <method name="track_move_down"> <argument index="0" name="idx" type="int"> </argument> <description> - Return whether interpolation is enabled or disabled for a whole track. By default tracks are interpolated. + Move a track down. </description> </method> - <method name="value_track_get_key_indices" qualifiers="const"> - <return type="IntArray"> - </return> + <method name="track_move_up"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="time_sec" type="float"> + <description> + Move a track up. + </description> + </method> + <method name="track_remove_key"> + <argument index="0" name="idx" type="int"> </argument> - <argument index="2" name="delta" type="float"> + <argument index="1" name="key_idx" type="int"> </argument> <description> - Return all the key indices of a value track, given a position and delta time. + Remove a key by index in a given track. </description> </method> - <method name="method_track_get_key_indices" qualifiers="const"> - <return type="IntArray"> - </return> + <method name="track_remove_key_at_pos"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="time_sec" type="float"> + <argument index="1" name="pos" type="float"> </argument> - <argument index="2" name="delta" type="float"> + <description> + Remove a key by position (seconds) in a given track. + </description> + </method> + <method name="track_set_imported"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="imported" type="bool"> </argument> <description> - Return all the key indices of a method track, given a position and delta time. </description> </method> - <method name="method_track_get_name" qualifiers="const"> - <return type="String"> - </return> + <method name="track_set_interpolation_type"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="key_idx" type="int"> + <argument index="1" name="interpolation" type="int"> </argument> <description> - Return the method name of a method track. + Set the interpolation type of a given track, from the INTERPOLATION_* enum. </description> </method> - <method name="method_track_get_params" qualifiers="const"> - <return type="Array"> - </return> + <method name="track_set_key_transition"> <argument index="0" name="idx" type="int"> </argument> <argument index="1" name="key_idx" type="int"> </argument> + <argument index="2" name="transition" type="float"> + </argument> <description> - Return the arguments values to be called on a method track for a given key in a given track. + Set the transition curve (easing) for a specific key (see built-in math function "ease"). </description> </method> - <method name="set_length"> - <argument index="0" name="time_sec" type="float"> + <method name="track_set_key_value"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key" type="int"> + </argument> + <argument index="2" name="value" type="Variant"> </argument> <description> - 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. + Set the value of an existing key. </description> </method> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> + <method name="track_set_path"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="path" type="NodePath"> + </argument> <description> - Return the total length of the animation (in seconds). + 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" </description> </method> - <method name="set_loop"> - <argument index="0" name="enabled" type="bool"> + <method name="transform_track_insert_key"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="time" type="float"> + </argument> + <argument index="2" name="loc" type="Vector3"> + </argument> + <argument index="3" name="rot" type="Quat"> + </argument> + <argument index="4" name="scale" type="Vector3"> </argument> <description> - 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. + Insert a transform key for a transform track. </description> </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> + <method name="transform_track_interpolate" qualifiers="const"> + <return type="Array"> </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="time_sec" type="float"> + </argument> <description> - Return whether the animation has the loop flag set. + 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]). </description> </method> - <method name="set_step"> - <argument index="0" name="size_sec" type="float"> + <method name="value_track_get_key_indices" qualifiers="const"> + <return type="IntArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="time_sec" type="float"> + </argument> + <argument index="2" name="delta" type="float"> </argument> <description> + Return all the key indices of a value track, given a position and delta time. </description> </method> - <method name="get_step" qualifiers="const"> - <return type="float"> + <method name="value_track_get_update_mode" qualifiers="const"> + <return type="int"> </return> + <argument index="0" name="idx" type="int"> + </argument> <description> </description> </method> - <method name="clear"> + <method name="value_track_set_update_mode"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="mode" type="int"> + </argument> <description> - Clear the animation (clear all tracks and reset all). </description> </method> </methods> <constants> + <constant name="INTERPOLATION_NEAREST" value="0"> + No interpolation (nearest value). + </constant> + <constant name="INTERPOLATION_LINEAR" value="1"> + Linear interpolation. + </constant> + <constant name="INTERPOLATION_CUBIC" value="2"> + Cubic interpolation. + </constant> <constant name="TYPE_VALUE" value="0"> Value tracks set values in node properties, but only those which can be Interpolated. </constant> @@ -2806,14 +2849,11 @@ <constant name="TYPE_METHOD" value="2"> Method tracks call functions with given arguments per key. </constant> - <constant name="INTERPOLATION_NEAREST" value="0"> - No interpolation (nearest value). + <constant name="UPDATE_CONTINUOUS" value="0"> </constant> - <constant name="INTERPOLATION_LINEAR" value="1"> - Linear interpolation. + <constant name="UPDATE_DISCRETE" value="1"> </constant> - <constant name="INTERPOLATION_CUBIC" value="2"> - Cubic interpolation. + <constant name="UPDATE_TRIGGER" value="2"> </constant> </constants> </class> @@ -2836,29 +2876,46 @@ Add an animation resource to the player, which will be later referenced by the "name" argument. </description> </method> - <method name="remove_animation"> - <argument index="0" name="name" type="String"> + <method name="advance"> + <argument index="0" name="delta" type="float"> </argument> <description> - 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. </description> </method> - <method name="rename_animation"> - <argument index="0" name="name" type="String"> + <method name="animation_get_next" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="anim_from" type="String"> </argument> - <argument index="1" name="newname" type="String"> + <description> + </description> + </method> + <method name="animation_set_next"> + <argument index="0" name="anim_from" type="String"> + </argument> + <argument index="1" name="anim_to" type="String"> </argument> <description> - Rename an existing animation. </description> </method> - <method name="has_animation" qualifiers="const"> - <return type="bool"> + <method name="clear_caches"> + <description> + 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. + </description> + </method> + <method name="clear_queue"> + <description> + If animations are queued to play, clear them. + </description> + </method> + <method name="find_animation" qualifiers="const"> + <return type="String"> </return> - <argument index="0" name="name" type="String"> + <argument index="0" name="animation" type="Animation"> </argument> <description> - Request whether an [Animation] name exist within the player. + Find an animation name by resource. </description> </method> <method name="get_animation" qualifiers="const"> @@ -2877,49 +2934,50 @@ Get the list of names of the animations stored in the player. </description> </method> - <method name="animation_set_next"> - <argument index="0" name="anim_from" type="String"> - </argument> - <argument index="1" name="anim_to" type="String"> - </argument> + <method name="get_animation_process_mode" qualifiers="const"> + <return type="int"> + </return> <description> + Return the mode in which the animation player processes. See [method set_animation_process_mode]. </description> </method> - <method name="animation_get_next" qualifiers="const"> + <method name="get_autoplay" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="anim_from" type="String"> - </argument> <description> + Return the name of the animation that will be automatically played when the scene is loaded. </description> </method> - <method name="set_blend_time"> + <method name="get_blend_time" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="anim_from" type="String"> </argument> <argument index="1" name="anim_to" type="String"> </argument> - <argument index="2" name="sec" type="float"> - </argument> <description> - Specify a blend time (in seconds) between two animations, referenced by their names. + Get the blend time between two animations, referenced by their names. </description> </method> - <method name="get_blend_time" qualifiers="const"> + <method name="get_current_animation" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the name of the animation being played. + </description> + </method> + <method name="get_current_animation_length" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="anim_from" type="String"> - </argument> - <argument index="1" name="anim_to" type="String"> - </argument> <description> - Get the blend time between two animations, referenced by their names. + Get the length (in seconds) of the currently being played animation. </description> </method> - <method name="set_default_blend_time"> - <argument index="0" name="sec" type="float"> - </argument> + <method name="get_current_animation_pos" qualifiers="const"> + <return type="float"> + </return> <description> - Set the default blend time between animations. + Get the position (in seconds) of the currently being played animation. </description> </method> <method name="get_default_blend_time" qualifiers="const"> @@ -2929,38 +2987,41 @@ Return the default blend time between animations. </description> </method> - <method name="play"> - <argument index="0" name="name" type="String" default=""""> - </argument> - <argument index="1" name="custom_blend" type="float" default="-1"> - </argument> - <argument index="2" name="custom_speed" type="float" default="1"> - </argument> - <argument index="3" name="from_end" type="bool" default="false"> - </argument> + <method name="get_pos" qualifiers="const"> + <return type="float"> + </return> <description> - Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. + Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). </description> </method> - <method name="play_backwards"> - <argument index="0" name="name" type="String" default=""""> - </argument> - <argument index="1" name="custom_blend" type="float" default="-1"> - </argument> + <method name="get_root" qualifiers="const"> + <return type="NodePath"> + </return> <description> - Play a given animation by the animation name in reverse. + Return path to root node (see [method set_root]). </description> </method> - <method name="stop"> - <argument index="0" name="reset" type="bool" default="true"> + <method name="get_speed" qualifiers="const"> + <return type="float"> + </return> + <description> + 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). + </description> + </method> + <method name="has_animation" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> </argument> <description> - Stop the currently playing animation. + Request whether an [Animation] name exist within the player. </description> </method> - <method name="stop_all"> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> <description> - Stop playback of animations (deprecated). + Return true if the player is active. </description> </method> <method name="is_playing" qualifiers="const"> @@ -2970,18 +3031,26 @@ Return whether an animation is playing. </description> </method> - <method name="set_current_animation"> - <argument index="0" name="anim" type="String"> + <method name="play"> + <argument index="0" name="name" type="String" default=""""> + </argument> + <argument index="1" name="custom_blend" type="float" default="-1"> + </argument> + <argument index="2" name="custom_speed" type="float" default="1"> + </argument> + <argument index="3" name="from_end" type="bool" default="false"> </argument> <description> - Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). + Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. </description> </method> - <method name="get_current_animation" qualifiers="const"> - <return type="String"> - </return> + <method name="play_backwards"> + <argument index="0" name="name" type="String" default=""""> + </argument> + <argument index="1" name="custom_blend" type="float" default="-1"> + </argument> <description> - Return the name of the animation being played. + Play a given animation by the animation name in reverse. </description> </method> <method name="queue"> @@ -2991,38 +3060,44 @@ Queue an animation for playback once the current one is done. </description> </method> - <method name="clear_queue"> + <method name="remove_animation"> + <argument index="0" name="name" type="String"> + </argument> <description> - If animations are queued to play, clear them. + Remove an animation from the player (by supplying the same name used to add it). </description> </method> - <method name="set_active"> - <argument index="0" name="active" type="bool"> + <method name="rename_animation"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="newname" type="String"> </argument> <description> - Set the player as active (playing). If false, it - will do nothing. + Rename an existing animation. </description> </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> + <method name="seek"> + <argument index="0" name="pos_sec" type="float"> + </argument> + <argument index="1" name="update" type="bool" default="false"> + </argument> <description> - Return true if the player is active. + 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. </description> </method> - <method name="set_speed"> - <argument index="0" name="speed" type="float"> + <method name="set_active"> + <argument index="0" name="active" type="bool"> </argument> <description> - 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). + Set the player as active (playing). If false, it + will do nothing. </description> </method> - <method name="get_speed" qualifiers="const"> - <return type="float"> - </return> + <method name="set_animation_process_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> - 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 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_*. </description> </method> <method name="set_autoplay"> @@ -3032,101 +3107,59 @@ Set the name of the animation that will be automatically played when the scene is loaded. </description> </method> - <method name="get_autoplay" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the name of the animation that will be automatically played when the scene is loaded. - </description> - </method> - <method name="set_root"> - <argument index="0" name="path" type="NodePath"> + <method name="set_blend_time"> + <argument index="0" name="anim_from" type="String"> </argument> - <description> - AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed. - </description> - </method> - <method name="get_root" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - Return path to root node (see [method set_root]). - </description> - </method> - <method name="seek"> - <argument index="0" name="pos_sec" type="float"> + <argument index="1" name="anim_to" type="String"> </argument> - <argument index="1" name="update" type="bool" default="false"> + <argument index="2" name="sec" type="float"> </argument> <description> - 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. - </description> - </method> - <method name="get_pos" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). + Specify a blend time (in seconds) between two animations, referenced by their names. </description> </method> - <method name="find_animation" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="animation" type="Animation"> + <method name="set_current_animation"> + <argument index="0" name="anim" type="String"> </argument> <description> - Find an animation name by resource. - </description> - </method> - <method name="clear_caches"> - <description> - 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 current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). </description> </method> - <method name="set_animation_process_mode"> - <argument index="0" name="mode" type="int"> + <method name="set_default_blend_time"> + <argument index="0" name="sec" type="float"> </argument> <description> - 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 default blend time between animations. </description> </method> - <method name="get_animation_process_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_root"> + <argument index="0" name="path" type="NodePath"> + </argument> <description> - Return the mode in which the animation player processes. See [method set_animation_process_mode]. + AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed. </description> </method> - <method name="get_current_animation_pos" qualifiers="const"> - <return type="float"> - </return> + <method name="set_speed"> + <argument index="0" name="speed" type="float"> + </argument> <description> - Get the position (in seconds) of the currently being played animation. + 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). </description> </method> - <method name="get_current_animation_length" qualifiers="const"> - <return type="float"> - </return> + <method name="stop"> + <argument index="0" name="reset" type="bool" default="true"> + </argument> <description> - Get the length (in seconds) of the currently being played animation. + Stop the currently playing animation. </description> </method> - <method name="advance"> - <argument index="0" name="delta" type="float"> - </argument> + <method name="stop_all"> <description> - Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip. + Stop playback of animations (deprecated). </description> </method> </methods> <signals> - <signal name="animation_started"> - <argument index="0" name="name" type="String"> - </argument> - <description> - Notifies when an animation starts playing. - </description> - </signal> <signal name="animation_changed"> <argument index="0" name="old_name" type="String"> </argument> @@ -3136,6 +3169,13 @@ If the currently being played animation changes, this signal will notify of such change. </description> </signal> + <signal name="animation_started"> + <argument index="0" name="name" type="String"> + </argument> + <description> + Notifies when an animation starts playing. + </description> + </signal> <signal name="finished"> <description> Notifies when an animation finished playing. @@ -3168,53 +3208,26 @@ Add a node of a given type in the graph with given id. </description> </method> - <method name="node_exists" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="node" type="String"> - </argument> - <description> - Check if a node exists (by name). - </description> - </method> - <method name="node_rename"> - <return type="int"> - </return> - <argument index="0" name="node" type="String"> - </argument> - <argument index="1" name="new_name" type="String"> - </argument> - <description> - Rename a node in the graph. - </description> - </method> - <method name="node_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="id" type="String"> + <method name="advance"> + <argument index="0" name="delta" type="float"> </argument> <description> - Get the node type, will return from NODE_* enum. </description> </method> - <method name="node_get_input_count" qualifiers="const"> - <return type="int"> + <method name="animation_node_get_animation" qualifiers="const"> + <return type="Animation"> </return> <argument index="0" name="id" type="String"> </argument> <description> - Return the input count for a given node. Different types of nodes have different amount of inputs. </description> </method> - <method name="node_get_input_source" qualifiers="const"> + <method name="animation_node_get_master_animation" qualifiers="const"> <return type="String"> </return> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="idx" type="int"> - </argument> <description> - Return the input source for a given node input. </description> </method> <method name="animation_node_set_animation"> @@ -3226,11 +3239,13 @@ Set the animation for an animation node. </description> </method> - <method name="animation_node_get_animation" qualifiers="const"> - <return type="Animation"> - </return> + <method name="animation_node_set_filter_path"> <argument index="0" name="id" type="String"> </argument> + <argument index="1" name="path" type="NodePath"> + </argument> + <argument index="2" name="enable" type="bool"> + </argument> <description> </description> </method> @@ -3242,33 +3257,33 @@ <description> </description> </method> - <method name="animation_node_get_master_animation" qualifiers="const"> - <return type="String"> + <method name="blend2_node_get_amount" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="id" type="String"> </argument> <description> </description> </method> - <method name="animation_node_set_filter_path"> + <method name="blend2_node_set_amount"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="path" type="NodePath"> - </argument> - <argument index="2" name="enable" type="bool"> + <argument index="1" name="blend" type="float"> </argument> <description> </description> </method> - <method name="oneshot_node_set_fadein_time"> + <method name="blend2_node_set_filter_path"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="time_sec" type="float"> + <argument index="1" name="path" type="NodePath"> + </argument> + <argument index="2" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="oneshot_node_get_fadein_time" qualifiers="const"> + <method name="blend3_node_get_amount" qualifiers="const"> <return type="float"> </return> <argument index="0" name="id" type="String"> @@ -3276,97 +3291,97 @@ <description> </description> </method> - <method name="oneshot_node_set_fadeout_time"> + <method name="blend3_node_set_amount"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="time_sec" type="float"> + <argument index="1" name="blend" type="float"> </argument> <description> </description> </method> - <method name="oneshot_node_get_fadeout_time" qualifiers="const"> - <return type="float"> + <method name="blend4_node_get_amount" qualifiers="const"> + <return type="Vector2"> </return> <argument index="0" name="id" type="String"> </argument> <description> </description> </method> - <method name="oneshot_node_set_autorestart"> + <method name="blend4_node_set_amount"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="enable" type="bool"> + <argument index="1" name="blend" type="Vector2"> </argument> <description> </description> </method> - <method name="oneshot_node_set_autorestart_delay"> + <method name="connect"> + <return type="int"> + </return> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="delay_sec" type="float"> + <argument index="1" name="dst_id" type="String"> + </argument> + <argument index="2" name="dst_input_idx" type="int"> </argument> <description> </description> </method> - <method name="oneshot_node_set_autorestart_random_delay"> + <method name="disconnect"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="rand_sec" type="float"> + <argument index="1" name="dst_input_idx" type="int"> </argument> <description> </description> </method> - <method name="oneshot_node_has_autorestart" qualifiers="const"> - <return type="bool"> + <method name="get_animation_process_mode" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="id" type="String"> - </argument> <description> </description> </method> - <method name="oneshot_node_get_autorestart_delay" qualifiers="const"> - <return type="float"> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> </return> - <argument index="0" name="id" type="String"> - </argument> <description> </description> </method> - <method name="oneshot_node_get_autorestart_random_delay" qualifiers="const"> - <return type="float"> + <method name="get_master_player" qualifiers="const"> + <return type="NodePath"> </return> - <argument index="0" name="id" type="String"> - </argument> <description> </description> </method> - <method name="oneshot_node_start"> - <argument index="0" name="id" type="String"> - </argument> + <method name="get_node_list"> + <return type="StringArray"> + </return> <description> </description> </method> - <method name="oneshot_node_stop"> - <argument index="0" name="id" type="String"> - </argument> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="oneshot_node_is_active" qualifiers="const"> + <method name="is_connected" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="id" type="String"> </argument> + <argument index="1" name="dst_id" type="String"> + </argument> + <argument index="2" name="dst_input_idx" type="int"> + </argument> <description> </description> </method> - <method name="oneshot_node_set_filter_path"> + <method name="mix_node_get_amount" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="path" type="NodePath"> - </argument> - <argument index="2" name="enable" type="bool"> - </argument> <description> </description> </method> @@ -3378,81 +3393,88 @@ <description> </description> </method> - <method name="mix_node_get_amount" qualifiers="const"> - <return type="float"> + <method name="node_exists" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="id" type="String"> + <argument index="0" name="node" type="String"> </argument> <description> + Check if a node exists (by name). </description> </method> - <method name="blend2_node_set_amount"> + <method name="node_get_input_count" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="blend" type="float"> - </argument> <description> + Return the input count for a given node. Different types of nodes have different amount of inputs. </description> </method> - <method name="blend2_node_get_amount" qualifiers="const"> - <return type="float"> + <method name="node_get_input_source" qualifiers="const"> + <return type="String"> </return> <argument index="0" name="id" type="String"> </argument> + <argument index="1" name="idx" type="int"> + </argument> <description> + Return the input source for a given node input. </description> </method> - <method name="blend2_node_set_filter_path"> + <method name="node_get_pos" qualifiers="const"> + <return type="Vector2"> + </return> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="path" type="NodePath"> - </argument> - <argument index="2" name="enable" type="bool"> - </argument> <description> </description> </method> - <method name="blend3_node_set_amount"> + <method name="node_get_type" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="blend" type="float"> - </argument> <description> + Get the node type, will return from NODE_* enum. </description> </method> - <method name="blend3_node_get_amount" qualifiers="const"> - <return type="float"> + <method name="node_rename"> + <return type="int"> </return> - <argument index="0" name="id" type="String"> + <argument index="0" name="node" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> </argument> <description> + Rename a node in the graph. </description> </method> - <method name="blend4_node_set_amount"> + <method name="node_set_pos"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="blend" type="Vector2"> + <argument index="1" name="screen_pos" type="Vector2"> </argument> <description> </description> </method> - <method name="blend4_node_get_amount" qualifiers="const"> - <return type="Vector2"> + <method name="oneshot_node_get_autorestart_delay" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="id" type="String"> </argument> <description> </description> </method> - <method name="timescale_node_set_scale"> + <method name="oneshot_node_get_autorestart_random_delay" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="scale" type="float"> - </argument> <description> </description> </method> - <method name="timescale_node_get_scale" qualifiers="const"> + <method name="oneshot_node_get_fadein_time" qualifiers="const"> <return type="float"> </return> <argument index="0" name="id" type="String"> @@ -3460,59 +3482,55 @@ <description> </description> </method> - <method name="timeseek_node_seek"> + <method name="oneshot_node_get_fadeout_time" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="pos_sec" type="float"> - </argument> <description> </description> </method> - <method name="transition_node_set_input_count"> + <method name="oneshot_node_has_autorestart" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="count" type="int"> - </argument> <description> </description> </method> - <method name="transition_node_get_input_count" qualifiers="const"> - <return type="int"> + <method name="oneshot_node_is_active" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="id" type="String"> </argument> <description> </description> </method> - <method name="transition_node_delete_input"> + <method name="oneshot_node_set_autorestart"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="input_idx" type="int"> + <argument index="1" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="transition_node_set_input_auto_advance"> + <method name="oneshot_node_set_autorestart_delay"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="input_idx" type="int"> - </argument> - <argument index="2" name="enable" type="bool"> + <argument index="1" name="delay_sec" type="float"> </argument> <description> </description> </method> - <method name="transition_node_has_input_auto_advance" qualifiers="const"> - <return type="bool"> - </return> + <method name="oneshot_node_set_autorestart_random_delay"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="input_idx" type="int"> + <argument index="1" name="rand_sec" type="float"> </argument> <description> </description> </method> - <method name="transition_node_set_xfade_time"> + <method name="oneshot_node_set_fadein_time"> <argument index="0" name="id" type="String"> </argument> <argument index="1" name="time_sec" type="float"> @@ -3520,43 +3538,37 @@ <description> </description> </method> - <method name="transition_node_get_xfade_time" qualifiers="const"> - <return type="float"> - </return> + <method name="oneshot_node_set_fadeout_time"> <argument index="0" name="id" type="String"> </argument> + <argument index="1" name="time_sec" type="float"> + </argument> <description> </description> </method> - <method name="transition_node_set_current"> + <method name="oneshot_node_set_filter_path"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="input_idx" type="int"> + <argument index="1" name="path" type="NodePath"> + </argument> + <argument index="2" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="transition_node_get_current" qualifiers="const"> - <return type="int"> - </return> + <method name="oneshot_node_start"> <argument index="0" name="id" type="String"> </argument> <description> </description> </method> - <method name="node_set_pos"> + <method name="oneshot_node_stop"> <argument index="0" name="id" type="String"> </argument> - <argument index="1" name="screen_pos" type="Vector2"> - </argument> <description> </description> </method> - <method name="node_get_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="id" type="String"> - </argument> + <method name="recompute_caches"> <description> </description> </method> @@ -3566,103 +3578,131 @@ <description> </description> </method> - <method name="connect"> - <return type="int"> - </return> - <argument index="0" name="id" type="String"> - </argument> - <argument index="1" name="dst_id" type="String"> - </argument> - <argument index="2" name="dst_input_idx" type="int"> - </argument> + <method name="reset"> <description> </description> </method> - <method name="is_connected" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="id" type="String"> - </argument> - <argument index="1" name="dst_id" type="String"> - </argument> - <argument index="2" name="dst_input_idx" type="int"> + <method name="set_active"> + <argument index="0" name="enabled" type="bool"> </argument> <description> </description> </method> - <method name="disconnect"> - <argument index="0" name="id" type="String"> + <method name="set_animation_process_mode"> + <argument index="0" name="mode" type="int"> </argument> - <argument index="1" name="dst_input_idx" type="int"> + <description> + </description> + </method> + <method name="set_base_path"> + <argument index="0" name="path" type="NodePath"> </argument> <description> </description> </method> - <method name="set_active"> - <argument index="0" name="enabled" type="bool"> + <method name="set_master_player"> + <argument index="0" name="nodepath" type="NodePath"> </argument> <description> </description> </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> + <method name="timescale_node_get_scale" qualifiers="const"> + <return type="float"> </return> + <argument index="0" name="id" type="String"> + </argument> <description> </description> </method> - <method name="set_base_path"> - <argument index="0" name="path" type="NodePath"> + <method name="timescale_node_set_scale"> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="scale" type="float"> </argument> <description> </description> </method> - <method name="get_base_path" qualifiers="const"> - <return type="NodePath"> - </return> + <method name="timeseek_node_seek"> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="pos_sec" type="float"> + </argument> <description> </description> </method> - <method name="set_master_player"> - <argument index="0" name="nodepath" type="NodePath"> + <method name="transition_node_delete_input"> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="input_idx" type="int"> </argument> <description> </description> </method> - <method name="get_master_player" qualifiers="const"> - <return type="NodePath"> + <method name="transition_node_get_current" qualifiers="const"> + <return type="int"> </return> + <argument index="0" name="id" type="String"> + </argument> <description> </description> </method> - <method name="get_node_list"> - <return type="StringArray"> + <method name="transition_node_get_input_count" qualifiers="const"> + <return type="int"> </return> + <argument index="0" name="id" type="String"> + </argument> <description> </description> </method> - <method name="set_animation_process_mode"> - <argument index="0" name="mode" type="int"> + <method name="transition_node_get_xfade_time" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> </argument> <description> </description> </method> - <method name="get_animation_process_mode" qualifiers="const"> - <return type="int"> + <method name="transition_node_has_input_auto_advance" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="input_idx" type="int"> + </argument> <description> </description> </method> - <method name="advance"> - <argument index="0" name="delta" type="float"> + <method name="transition_node_set_current"> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="input_idx" type="int"> </argument> <description> </description> </method> - <method name="reset"> + <method name="transition_node_set_input_auto_advance"> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="input_idx" type="int"> + </argument> + <argument index="2" name="enable" type="bool"> + </argument> <description> </description> </method> - <method name="recompute_caches"> + <method name="transition_node_set_input_count"> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="count" type="int"> + </argument> + <description> + </description> + </method> + <method name="transition_node_set_xfade_time"> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="time_sec" type="float"> + </argument> <description> </description> </method> @@ -3698,44 +3738,34 @@ 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. </description> <methods> - <method name="set_space_override_mode"> - <argument index="0" name="enable" type="int"> - </argument> + <method name="get_angular_damp" qualifiers="const"> + <return type="float"> + </return> <description> - Set the space override mode. This mode controls how an area affects gravity and damp. - AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. - AREA_SPACE_OVERRIDE_COMBINE: 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. - AREA_SPACE_OVERRIDE_COMBINE_REPLACE: 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. - AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. - 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 angular damp rate. </description> </method> - <method name="get_space_override_mode" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the space override mode. - </description> - </method> - <method name="set_gravity_is_point"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - 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 the physics layers this area can scan for collisions. </description> </method> - <method name="is_gravity_a_point" qualifiers="const"> + <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> + <argument index="0" name="bit" type="int"> + </argument> <description> - 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 an individual bit on the collision mask. </description> </method> - <method name="set_gravity_distance_scale"> - <argument index="0" name="distance_scale" type="float"> - </argument> + <method name="get_gravity" qualifiers="const"> + <return type="float"> + </return> <description> - 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 gravity intensity. </description> </method> <method name="get_gravity_distance_scale" qualifiers="const"> @@ -3745,14 +3775,6 @@ Return the falloff factor for point gravity. </description> </method> - <method name="set_gravity_vector"> - <argument index="0" name="vector" type="Vector3"> - </argument> - <description> - 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. - </description> - </method> <method name="get_gravity_vector" qualifiers="const"> <return type="Vector3"> </return> @@ -3760,94 +3782,109 @@ Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> - <method name="set_gravity"> - <argument index="0" name="gravity" type="float"> + <method name="get_layer_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layer this area is in. + </description> + </method> + <method name="get_layer_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> </argument> <description> - 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 an individual bit on the layer mask. </description> </method> - <method name="get_gravity" qualifiers="const"> + <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the gravity intensity. + Return the linear damp rate. </description> </method> - <method name="set_angular_damp"> - <argument index="0" name="angular_damp" type="float"> - </argument> + <method name="get_overlapping_areas" qualifiers="const"> + <return type="Array"> + </return> <description> - 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 a list of the areas that are totally or partially inside this area. </description> </method> - <method name="get_angular_damp" qualifiers="const"> + <method name="get_overlapping_bodies" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return a list of the bodies ([PhysicsBody]) that are totally or partially inside this area. + </description> + </method> + <method name="get_priority" qualifiers="const"> <return type="float"> </return> <description> - Return the angular damp rate. + Return the processing order of this area. </description> </method> - <method name="set_linear_damp"> - <argument index="0" name="linear_damp" type="float"> - </argument> + <method name="get_space_override_mode" qualifiers="const"> + <return type="int"> + </return> <description> - 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 space override mode. </description> </method> - <method name="get_linear_damp" qualifiers="const"> - <return type="float"> + <method name="is_gravity_a_point" qualifiers="const"> + <return type="bool"> </return> <description> - Return the linear damp rate. + 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. </description> </method> - <method name="set_priority"> - <argument index="0" name="priority" type="float"> - </argument> + <method name="is_monitorable" qualifiers="const"> + <return type="bool"> + </return> <description> - 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 whether this area can be detected by other, monitoring, areas. </description> </method> - <method name="get_priority" qualifiers="const"> - <return type="float"> + <method name="is_monitoring_enabled" qualifiers="const"> + <return type="bool"> </return> <description> - Return the processing order of this area. + Return whether this area detects bodies/areas entering/exiting it. </description> </method> - <method name="set_collision_mask"> - <argument index="0" name="collision_mask" type="int"> + <method name="overlaps_area" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="area" type="Object"> </argument> <description> - Set the physics layers this area can scan for collisions. + Return whether the area passed is totally or partially inside this area. </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> + <method name="overlaps_body" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="body" type="Object"> + </argument> <description> - Return the physics layers this area can scan for collisions. + Return whether the body passed is totally or partially inside this area. </description> </method> - <method name="set_layer_mask"> - <argument index="0" name="layer_mask" type="int"> + <method name="set_angular_damp"> + <argument index="0" name="angular_damp" type="float"> </argument> <description> - 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 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. </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_collision_mask"> + <argument index="0" name="collision_mask" type="int"> + </argument> <description> - Return the physics layer this area is in. + Set the physics layers this area can scan for collisions. </description> </method> <method name="set_collision_mask_bit"> @@ -3859,123 +3896,126 @@ Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> - <method name="get_collision_mask_bit" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="bit" type="int"> + <method name="set_enable_monitoring"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Return an individual bit on the collision mask. + Set whether this area can detect bodies/areas entering/exiting it. </description> </method> - <method name="set_layer_mask_bit"> - <argument index="0" name="bit" type="int"> - </argument> - <argument index="1" name="value" type="bool"> + <method name="set_gravity"> + <argument index="0" name="gravity" type="float"> </argument> <description> - Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. + 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). </description> </method> - <method name="get_layer_mask_bit" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="bit" type="int"> + <method name="set_gravity_distance_scale"> + <argument index="0" name="distance_scale" type="float"> </argument> <description> - Return an individual bit on the layer mask. + Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. </description> </method> - <method name="set_monitorable"> + <method name="set_gravity_is_point"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. + 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]. </description> </method> - <method name="is_monitorable" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_gravity_vector"> + <argument index="0" name="vector" type="Vector3"> + </argument> <description> - Return whether this area can be detected by other, monitoring, areas. + 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. </description> </method> - <method name="set_enable_monitoring"> - <argument index="0" name="enable" type="bool"> + <method name="set_layer_mask"> + <argument index="0" name="layer_mask" type="int"> </argument> <description> - Set whether this area can detect bodies/areas entering/exiting 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. </description> </method> - <method name="is_monitoring_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_layer_mask_bit"> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> <description> - Return whether this area detects bodies/areas entering/exiting it. + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. </description> </method> - <method name="get_overlapping_bodies" qualifiers="const"> - <return type="Array"> - </return> + <method name="set_linear_damp"> + <argument index="0" name="linear_damp" type="float"> + </argument> <description> - Return a list of the bodies ([PhysicsBody]) that are totally or partially inside this area. + 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. </description> </method> - <method name="get_overlapping_areas" qualifiers="const"> - <return type="Array"> - </return> + <method name="set_monitorable"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return a list of the areas that are totally or partially inside this area. + Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. </description> </method> - <method name="overlaps_body" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="body" type="Object"> + <method name="set_priority"> + <argument index="0" name="priority" type="float"> </argument> <description> - Return whether the body passed is totally or partially inside this area. + 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. </description> </method> - <method name="overlaps_area" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="area" type="Object"> + <method name="set_space_override_mode"> + <argument index="0" name="enable" type="int"> </argument> <description> - Return whether the area passed is totally or partially inside this area. + Set the space override mode. This mode controls how an area affects gravity and damp. + AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + AREA_SPACE_OVERRIDE_COMBINE: 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. + AREA_SPACE_OVERRIDE_COMBINE_REPLACE: 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. + AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + 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. </description> </method> </methods> <signals> - <signal name="body_enter"> - <argument index="0" name="body" type="Object"> + <signal name="area_enter"> + <argument index="0" name="area" type="Object"> </argument> <description> - 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 is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. </description> </signal> - <signal name="body_enter_shape"> - <argument index="0" name="body_id" type="int"> + <signal name="area_enter_shape"> + <argument index="0" name="area_id" type="int"> </argument> - <argument index="1" name="body" type="Object"> + <argument index="1" name="area" type="Object"> </argument> - <argument index="2" name="body_shape" type="int"> + <argument index="2" name="area_shape" type="int"> </argument> <argument index="3" name="area_shape" type="int"> </argument> <description> - 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 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. </description> </signal> - <signal name="area_enter"> + <signal name="area_exit"> <argument index="0" name="area" type="Object"> </argument> <description> - This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. </description> </signal> - <signal name="area_enter_shape"> + <signal name="area_exit_shape"> <argument index="0" name="area_id" type="int"> </argument> <argument index="1" name="area" type="Object"> @@ -3985,17 +4025,17 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - 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 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. </description> </signal> - <signal name="body_exit"> + <signal name="body_enter"> <argument index="0" name="body" type="Object"> </argument> <description> - 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 is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. </description> </signal> - <signal name="body_exit_shape"> + <signal name="body_enter_shape"> <argument index="0" name="body_id" type="int"> </argument> <argument index="1" name="body" type="Object"> @@ -4005,27 +4045,27 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - 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. + 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. </description> </signal> - <signal name="area_exit"> - <argument index="0" name="area" type="Object"> + <signal name="body_exit"> + <argument index="0" name="body" type="Object"> </argument> <description> - This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. </description> </signal> - <signal name="area_exit_shape"> - <argument index="0" name="area_id" type="int"> + <signal name="body_exit_shape"> + <argument index="0" name="body_id" type="int"> </argument> - <argument index="1" name="area" type="Object"> + <argument index="1" name="body" type="Object"> </argument> - <argument index="2" name="area_shape" type="int"> + <argument index="2" name="body_shape" type="int"> </argument> <argument index="3" name="area_shape" type="int"> </argument> <description> - 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 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. </description> </signal> </signals> @@ -4040,44 +4080,34 @@ 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. </description> <methods> - <method name="set_space_override_mode"> - <argument index="0" name="enable" type="int"> - </argument> + <method name="get_angular_damp" qualifiers="const"> + <return type="float"> + </return> <description> - Set the space override mode. This mode controls how an area affects gravity and damp. - AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. - AREA_SPACE_OVERRIDE_COMBINE: 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. - AREA_SPACE_OVERRIDE_COMBINE_REPLACE: 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. - AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. - 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 angular damp rate. </description> </method> - <method name="get_space_override_mode" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the space override mode. - </description> - </method> - <method name="set_gravity_is_point"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - 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 the physics layers this area can scan for collisions. </description> </method> - <method name="is_gravity_a_point" qualifiers="const"> + <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> + <argument index="0" name="bit" type="int"> + </argument> <description> - 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 an individual bit on the collision mask. </description> </method> - <method name="set_gravity_distance_scale"> - <argument index="0" name="distance_scale" type="float"> - </argument> + <method name="get_gravity" qualifiers="const"> + <return type="float"> + </return> <description> - 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 gravity intensity. </description> </method> <method name="get_gravity_distance_scale" qualifiers="const"> @@ -4087,14 +4117,6 @@ Return the falloff factor for point gravity. </description> </method> - <method name="set_gravity_vector"> - <argument index="0" name="vector" type="Vector2"> - </argument> - <description> - 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. - </description> - </method> <method name="get_gravity_vector" qualifiers="const"> <return type="Vector2"> </return> @@ -4102,94 +4124,109 @@ Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> - <method name="set_gravity"> - <argument index="0" name="gravity" type="float"> + <method name="get_layer_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layer this area is in. + </description> + </method> + <method name="get_layer_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> </argument> <description> - 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 an individual bit on the layer mask. </description> </method> - <method name="get_gravity" qualifiers="const"> + <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the gravity intensity. + Return the linear damp rate. </description> </method> - <method name="set_linear_damp"> - <argument index="0" name="linear_damp" type="float"> - </argument> + <method name="get_overlapping_areas" qualifiers="const"> + <return type="Array"> + </return> <description> - 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 a list of the areas that are totally or partially inside this area. </description> </method> - <method name="get_linear_damp" qualifiers="const"> + <method name="get_overlapping_bodies" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return a list of the bodies ([PhysicsBody2D]) that are totally or partially inside this area. + </description> + </method> + <method name="get_priority" qualifiers="const"> <return type="float"> </return> <description> - Return the linear damp rate. + Return the processing order of this area. </description> </method> - <method name="set_angular_damp"> - <argument index="0" name="angular_damp" type="float"> - </argument> + <method name="get_space_override_mode" qualifiers="const"> + <return type="int"> + </return> <description> - 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 space override mode. </description> </method> - <method name="get_angular_damp" qualifiers="const"> - <return type="float"> + <method name="is_gravity_a_point" qualifiers="const"> + <return type="bool"> </return> <description> - Return the angular damp rate. + 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. </description> </method> - <method name="set_priority"> - <argument index="0" name="priority" type="float"> - </argument> + <method name="is_monitorable" qualifiers="const"> + <return type="bool"> + </return> <description> - 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 whether this area can be detected by other, monitoring, areas. </description> </method> - <method name="get_priority" qualifiers="const"> - <return type="float"> + <method name="is_monitoring_enabled" qualifiers="const"> + <return type="bool"> </return> <description> - Return the processing order of this area. + Return whether this area detects bodies/areas entering/exiting it. </description> </method> - <method name="set_collision_mask"> - <argument index="0" name="collision_mask" type="int"> + <method name="overlaps_area" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="area" type="Object"> </argument> <description> - Set the physics layers this area can scan for collisions. + Return whether the area passed is totally or partially inside this area. </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> + <method name="overlaps_body" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="body" type="Object"> + </argument> <description> - Return the physics layers this area can scan for collisions. + Return whether the body passed is totally or partially inside this area. </description> </method> - <method name="set_layer_mask"> - <argument index="0" name="layer_mask" type="int"> + <method name="set_angular_damp"> + <argument index="0" name="angular_damp" type="float"> </argument> <description> - 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 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. </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_collision_mask"> + <argument index="0" name="collision_mask" type="int"> + </argument> <description> - Return the physics layer this area is in. + Set the physics layers this area can scan for collisions. </description> </method> <method name="set_collision_mask_bit"> @@ -4201,123 +4238,126 @@ Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> - <method name="get_collision_mask_bit" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="bit" type="int"> + <method name="set_enable_monitoring"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Return an individual bit on the collision mask. + Set whether this area can detect bodies/areas entering/exiting it. </description> </method> - <method name="set_layer_mask_bit"> - <argument index="0" name="bit" type="int"> - </argument> - <argument index="1" name="value" type="bool"> + <method name="set_gravity"> + <argument index="0" name="gravity" type="float"> </argument> <description> - Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. + 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). </description> </method> - <method name="get_layer_mask_bit" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="bit" type="int"> + <method name="set_gravity_distance_scale"> + <argument index="0" name="distance_scale" type="float"> </argument> <description> - Return an individual bit on the layer mask. + Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. </description> </method> - <method name="set_enable_monitoring"> + <method name="set_gravity_is_point"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether this area can detect bodies/areas entering/exiting it. + 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]. </description> </method> - <method name="is_monitoring_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_gravity_vector"> + <argument index="0" name="vector" type="Vector2"> + </argument> <description> - Return whether this area detects bodies/areas entering/exiting it. + 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. </description> </method> - <method name="set_monitorable"> - <argument index="0" name="enable" type="bool"> + <method name="set_layer_mask"> + <argument index="0" name="layer_mask" type="int"> </argument> <description> - 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 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. </description> </method> - <method name="is_monitorable" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_layer_mask_bit"> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> <description> - Return whether this area can be detected by other, monitoring, areas. + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. </description> </method> - <method name="get_overlapping_bodies" qualifiers="const"> - <return type="Array"> - </return> + <method name="set_linear_damp"> + <argument index="0" name="linear_damp" type="float"> + </argument> <description> - Return a list of the bodies ([PhysicsBody2D]) that are totally or partially inside this area. + 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. </description> </method> - <method name="get_overlapping_areas" qualifiers="const"> - <return type="Array"> - </return> + <method name="set_monitorable"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return a list of the areas that are totally or partially inside this area. + Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. </description> </method> - <method name="overlaps_body" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="body" type="Object"> + <method name="set_priority"> + <argument index="0" name="priority" type="float"> </argument> <description> - Return whether the body passed is totally or partially inside this area. + 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. </description> </method> - <method name="overlaps_area" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="area" type="Object"> + <method name="set_space_override_mode"> + <argument index="0" name="enable" type="int"> </argument> <description> - Return whether the area passed is totally or partially inside this area. + Set the space override mode. This mode controls how an area affects gravity and damp. + AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + AREA_SPACE_OVERRIDE_COMBINE: 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. + AREA_SPACE_OVERRIDE_COMBINE_REPLACE: 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. + AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + 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. </description> </method> </methods> <signals> - <signal name="body_enter"> - <argument index="0" name="body" type="Object"> + <signal name="area_enter"> + <argument index="0" name="area" type="Object"> </argument> <description> - 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 is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. </description> </signal> - <signal name="body_enter_shape"> - <argument index="0" name="body_id" type="int"> + <signal name="area_enter_shape"> + <argument index="0" name="area_id" type="int"> </argument> - <argument index="1" name="body" type="Object"> + <argument index="1" name="area" type="Object"> </argument> - <argument index="2" name="body_shape" type="int"> + <argument index="2" name="area_shape" type="int"> </argument> <argument index="3" name="area_shape" type="int"> </argument> <description> - 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 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. </description> </signal> - <signal name="area_enter"> + <signal name="area_exit"> <argument index="0" name="area" type="Object"> </argument> <description> - This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. </description> </signal> - <signal name="area_enter_shape"> + <signal name="area_exit_shape"> <argument index="0" name="area_id" type="int"> </argument> <argument index="1" name="area" type="Object"> @@ -4327,17 +4367,17 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - 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 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. </description> </signal> - <signal name="body_exit"> + <signal name="body_enter"> <argument index="0" name="body" type="Object"> </argument> <description> - 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 is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. </description> </signal> - <signal name="body_exit_shape"> + <signal name="body_enter_shape"> <argument index="0" name="body_id" type="int"> </argument> <argument index="1" name="body" type="Object"> @@ -4347,27 +4387,27 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - 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. + 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. </description> </signal> - <signal name="area_exit"> - <argument index="0" name="area" type="Object"> + <signal name="body_exit"> + <argument index="0" name="body" type="Object"> </argument> <description> - This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. </description> </signal> - <signal name="area_exit_shape"> - <argument index="0" name="area_id" type="int"> + <signal name="body_exit_shape"> + <argument index="0" name="body_id" type="int"> </argument> - <argument index="1" name="area" type="Object"> + <argument index="1" name="body" type="Object"> </argument> - <argument index="2" name="area_shape" type="int"> + <argument index="2" name="body_shape" type="int"> </argument> <argument index="3" name="area_shape" type="int"> </argument> <description> - 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 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. </description> </signal> </signals> @@ -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. </description> <methods> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="ColorArray"> + </argument> + <description> + Construct an array from a [RawArray]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="Vector3Array"> + </argument> + <description> + Construct an array from a [RawArray]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="Vector2Array"> + </argument> + <description> + Construct an array from a [RawArray]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="StringArray"> + </argument> + <description> + Construct an array from a [RawArray]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="RealArray"> + </argument> + <description> + Construct an array from a [RawArray]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="IntArray"> + </argument> + <description> + Construct an array from a [RawArray]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="RawArray"> + </argument> + <description> + Construct an array from a [RawArray]. + </description> + </method> <method name="append"> <argument index="0" name="value" type="var"> </argument> @@ -4535,127 +4638,92 @@ 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. </description> </method> - <method name="Array"> - <return type="Array"> - </return> - <argument index="0" name="from" type="RawArray"> - </argument> - <description> - Construct an array from a [RawArray]. - </description> - </method> - <method name="Array"> - <return type="Array"> + </methods> + <constants> + </constants> +</class> +<class name="AtlasTexture" inherits="Texture" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_atlas" qualifiers="const"> + <return type="Texture"> </return> - <argument index="0" name="from" type="IntArray"> - </argument> <description> - Construct an array from a [RawArray]. </description> </method> - <method name="Array"> - <return type="Array"> + <method name="get_margin" qualifiers="const"> + <return type="Rect2"> </return> - <argument index="0" name="from" type="RealArray"> - </argument> <description> - Construct an array from a [RawArray]. </description> </method> - <method name="Array"> - <return type="Array"> + <method name="get_region" qualifiers="const"> + <return type="Rect2"> </return> - <argument index="0" name="from" type="StringArray"> - </argument> <description> - Construct an array from a [RawArray]. </description> </method> - <method name="Array"> - <return type="Array"> - </return> - <argument index="0" name="from" type="Vector2Array"> + <method name="set_atlas"> + <argument index="0" name="atlas" type="Texture"> </argument> <description> - Construct an array from a [RawArray]. </description> </method> - <method name="Array"> - <return type="Array"> - </return> - <argument index="0" name="from" type="Vector3Array"> + <method name="set_margin"> + <argument index="0" name="margin" type="Rect2"> </argument> <description> - Construct an array from a [RawArray]. </description> </method> - <method name="Array"> - <return type="Array"> - </return> - <argument index="0" name="from" type="ColorArray"> + <method name="set_region"> + <argument index="0" name="region" type="Rect2"> </argument> <description> - Construct an array from a [RawArray]. </description> </method> </methods> <constants> </constants> </class> -<class name="AtlasTexture" inherits="Texture" category="Core"> +<class name="AudioServer" inherits="Object" category="Core"> <brief_description> + Server interface for low level audio access. </brief_description> <description> + 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. </description> <methods> - <method name="set_atlas"> - <argument index="0" name="atlas" type="Texture"> + <method name="free_rid"> + <argument index="0" name="rid" type="RID"> </argument> <description> + Free a [RID] resource. </description> </method> - <method name="get_atlas" qualifiers="const"> - <return type="Texture"> + <method name="get_event_voice_global_volume_scale" qualifiers="const"> + <return type="float"> </return> <description> + Return the global scale for event-based stream playback. </description> </method> - <method name="set_region"> - <argument index="0" name="region" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="get_region" qualifiers="const"> - <return type="Rect2"> + <method name="get_fx_global_volume_scale" qualifiers="const"> + <return type="float"> </return> <description> + Return the global scale for all voices. </description> </method> - <method name="set_margin"> - <argument index="0" name="margin" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="get_margin" qualifiers="const"> - <return type="Rect2"> + <method name="get_stream_global_volume_scale" qualifiers="const"> + <return type="float"> </return> <description> + Return the global scale for stream playback. </description> </method> - </methods> - <constants> - </constants> -</class> -<class name="AudioServer" inherits="Object" category="Core"> - <brief_description> - Server interface for low level audio access. - </brief_description> - <description> - 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. - </description> - <methods> <method name="sample_create"> <return type="RID"> </return> @@ -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. </description> </method> - <method name="sample_set_description"> + <method name="sample_get_data" qualifiers="const"> + <return type="RawArray"> + </return> <argument index="0" name="sample" type="RID"> </argument> - <argument index="1" name="description" type="String"> - </argument> <description> - 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. </description> </method> <method name="sample_get_description" qualifiers="const"> @@ -4697,15 +4765,6 @@ Return the format of the audio sample, in the form of the SAMPLE_FORMAT_* enum. </description> </method> - <method name="sample_is_stereo" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <description> - Return whether the sample is stereo (2 channels). - </description> - </method> <method name="sample_get_length" qualifiers="const"> <return type="int"> </return> @@ -4715,73 +4774,71 @@ 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. </description> </method> - <method name="sample_set_signed_data"> + <method name="sample_get_loop_begin" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="sample" type="RID"> </argument> - <argument index="1" name="data" type="RealArray"> - </argument> <description> - 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 initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. </description> </method> - <method name="sample_set_data"> + <method name="sample_get_loop_end" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="sample" type="RID"> </argument> - <argument index="1" name="data" type="RawArray"> - </argument> <description> - Set the sample data for a given sample as an array of bytes. The length must be equal to the sample length expected in bytes or an error will be produced. The byte length can be calculated as follows: - Get the sample length ([method sample_get_length]). - If the sample format is SAMPLE_FORMAT_PCM16, multiply it by 2. - If the sample format is SAMPLE_FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. - If the sample is stereo ([method sample_is_stereo]), multiply it by 2. + Return the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. </description> </method> - <method name="sample_get_data" qualifiers="const"> - <return type="RawArray"> + <method name="sample_get_loop_format" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="sample" type="RID"> </argument> <description> - Return the sample data as an array of bytes. The length will be the expected length in bytes. + Return the loop format for a sample, as a value from the SAMPLE_LOOP_* enum. </description> </method> - <method name="sample_set_mix_rate"> + <method name="sample_get_mix_rate" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="sample" type="RID"> </argument> - <argument index="1" name="mix_rate" type="int"> - </argument> <description> - Change the default mix rate of a given sample. + Return the mix rate of the given sample. </description> </method> - <method name="sample_get_mix_rate" qualifiers="const"> - <return type="int"> + <method name="sample_is_stereo" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="sample" type="RID"> </argument> <description> - Return the mix rate of the given sample. + Return whether the sample is stereo (2 channels). </description> </method> - <method name="sample_set_loop_format"> + <method name="sample_set_data"> <argument index="0" name="sample" type="RID"> </argument> - <argument index="1" name="loop_format" type="int"> + <argument index="1" name="data" type="RawArray"> </argument> <description> - 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. + Set the sample data for a given sample as an array of bytes. The length must be equal to the sample length expected in bytes or an error will be produced. The byte length can be calculated as follows: + Get the sample length ([method sample_get_length]). + If the sample format is SAMPLE_FORMAT_PCM16, multiply it by 2. + If the sample format is SAMPLE_FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. + If the sample is stereo ([method sample_is_stereo]), multiply it by 2. </description> </method> - <method name="sample_get_loop_format" qualifiers="const"> - <return type="int"> - </return> + <method name="sample_set_description"> <argument index="0" name="sample" type="RID"> </argument> + <argument index="1" name="description" type="String"> + </argument> <description> - 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. </description> </method> <method name="sample_set_loop_begin"> @@ -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]. </description> </method> - <method name="sample_get_loop_begin" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <description> - Return the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. - </description> - </method> <method name="sample_set_loop_end"> <argument index="0" name="sample" type="RID"> </argument> @@ -4811,176 +4859,142 @@ Set the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. </description> </method> - <method name="sample_get_loop_end" qualifiers="const"> - <return type="int"> - </return> + <method name="sample_set_loop_format"> <argument index="0" name="sample" type="RID"> </argument> - <description> - Return the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. - </description> - </method> - <method name="voice_create"> - <return type="RID"> - </return> - <description> - Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See [method sample_create]. - </description> - </method> - <method name="voice_play"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="sample" type="RID"> + <argument index="1" name="loop_format" type="int"> </argument> <description> - Start playback of a given voice using a given sample. If the voice was already playing it will be restarted. + 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. </description> </method> - <method name="voice_set_volume"> - <argument index="0" name="voice" type="RID"> + <method name="sample_set_mix_rate"> + <argument index="0" name="sample" type="RID"> </argument> - <argument index="1" name="volume" type="float"> + <argument index="1" name="mix_rate" type="int"> </argument> <description> - 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 default mix rate of a given sample. </description> </method> - <method name="voice_set_pan"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="pan" type="float"> - </argument> - <argument index="2" name="depth" type="float" default="0"> + <method name="sample_set_signed_data"> + <argument index="0" name="sample" type="RID"> </argument> - <argument index="3" name="height" type="float" default="0"> + <argument index="1" name="data" type="RealArray"> </argument> <description> - 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 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. </description> </method> - <method name="voice_set_filter"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="type" type="int"> - </argument> - <argument index="2" name="cutoff" type="float"> - </argument> - <argument index="3" name="resonance" type="float"> - </argument> - <argument index="4" name="gain" type="float" default="0"> + <method name="set_event_voice_global_volume_scale"> + <argument index="0" name="scale" type="float"> </argument> <description> - Set a resonant filter post processing for the voice. Filter type is a value from the FILTER_* enum. + Set global scale for event-based stream ([EventStream]) playback. Default is 1.0. </description> </method> - <method name="voice_set_chorus"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="chorus" type="float"> + <method name="set_fx_global_volume_scale"> + <argument index="0" name="scale" type="float"> </argument> <description> - Set chorus send post processing for the voice (from 0 to 1). + Set global scale for all voices (not including streams). Default is 1.0. </description> </method> - <method name="voice_set_reverb"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="room" type="int"> - </argument> - <argument index="2" name="reverb" type="float"> + <method name="set_stream_global_volume_scale"> + <argument index="0" name="scale" type="float"> </argument> <description> - Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB_* enum. + Set global scale for stream playback. Default is 1.0. </description> </method> - <method name="voice_set_mix_rate"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="rate" type="int"> - </argument> + <method name="voice_create"> + <return type="RID"> + </return> <description> - Set a different playback mix rate for the given voice. + Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See [method sample_create]. </description> </method> - <method name="voice_set_positional"> + <method name="voice_get_chorus" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="voice" type="RID"> </argument> - <argument index="1" name="enabled" type="bool"> - </argument> <description> - 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 chorus send for a given voice (0 to 1). </description> </method> - <method name="voice_get_volume" qualifiers="const"> + <method name="voice_get_filter_cutoff" qualifiers="const"> <return type="float"> </return> <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current volume for a given voice. + Return the current filter cutoff (in hz) for a given voice. </description> </method> - <method name="voice_get_pan" qualifiers="const"> + <method name="voice_get_filter_resonance" qualifiers="const"> <return type="float"> </return> <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current pan for a given voice (-1 to +1 range). + Return the current filter resonance for a given voice. </description> </method> - <method name="voice_get_pan_height" qualifiers="const"> - <return type="float"> + <method name="voice_get_filter_type" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current pan height for a given voice (-1 to +1 range). + Return the current selected filter type for a given voice, from the FILTER_* enum. </description> </method> - <method name="voice_get_pan_depth" qualifiers="const"> - <return type="float"> + <method name="voice_get_mix_rate" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current pan depth for a given voice (-1 to +1 range). + Return the current mix rate for a given voice. </description> </method> - <method name="voice_get_filter_type" qualifiers="const"> - <return type="int"> + <method name="voice_get_pan" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current selected filter type for a given voice, from the FILTER_* enum. + Return the current pan for a given voice (-1 to +1 range). </description> </method> - <method name="voice_get_filter_cutoff" qualifiers="const"> + <method name="voice_get_pan_depth" qualifiers="const"> <return type="float"> </return> <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current filter cutoff (in hz) for a given voice. + Return the current pan depth for a given voice (-1 to +1 range). </description> </method> - <method name="voice_get_filter_resonance" qualifiers="const"> + <method name="voice_get_pan_height" qualifiers="const"> <return type="float"> </return> <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current filter resonance for a given voice. + Return the current pan height for a given voice (-1 to +1 range). </description> </method> - <method name="voice_get_chorus" qualifiers="const"> + <method name="voice_get_reverb" qualifiers="const"> <return type="float"> </return> <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current chorus send for a given voice (0 to 1). + Return the current reverb send for a given voice (0 to 1). </description> </method> <method name="voice_get_reverb_type" qualifiers="const"> @@ -4992,109 +5006,117 @@ Return the current reverb type for a given voice from the REVERB_* enum. </description> </method> - <method name="voice_get_reverb" qualifiers="const"> + <method name="voice_get_volume" qualifiers="const"> <return type="float"> </return> <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current reverb send for a given voice (0 to 1). + Return the current volume for a given voice. </description> </method> - <method name="voice_get_mix_rate" qualifiers="const"> - <return type="int"> + <method name="voice_is_positional" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current mix rate for a given voice. + Return whether the current voice is positional. See [method voice_set_positional]. </description> </method> - <method name="voice_is_positional" qualifiers="const"> - <return type="bool"> - </return> + <method name="voice_play"> <argument index="0" name="voice" type="RID"> </argument> + <argument index="1" name="sample" type="RID"> + </argument> <description> - 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. </description> </method> - <method name="voice_stop"> + <method name="voice_set_chorus"> <argument index="0" name="voice" type="RID"> </argument> + <argument index="1" name="chorus" type="float"> + </argument> <description> - Stop a given voice. + Set chorus send post processing for the voice (from 0 to 1). </description> </method> - <method name="free_rid"> - <argument index="0" name="rid" type="RID"> + <method name="voice_set_filter"> + <argument index="0" name="voice" type="RID"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="cutoff" type="float"> + </argument> + <argument index="3" name="resonance" type="float"> + </argument> + <argument index="4" name="gain" type="float" default="0"> </argument> <description> - Free a [RID] resource. + Set a resonant filter post processing for the voice. Filter type is a value from the FILTER_* enum. </description> </method> - <method name="set_stream_global_volume_scale"> - <argument index="0" name="scale" type="float"> + <method name="voice_set_mix_rate"> + <argument index="0" name="voice" type="RID"> + </argument> + <argument index="1" name="rate" type="int"> </argument> <description> - Set global scale for stream playback. Default is 1.0. + Set a different playback mix rate for the given voice. </description> </method> - <method name="get_stream_global_volume_scale" qualifiers="const"> - <return type="float"> - </return> + <method name="voice_set_pan"> + <argument index="0" name="voice" type="RID"> + </argument> + <argument index="1" name="pan" type="float"> + </argument> + <argument index="2" name="depth" type="float" default="0"> + </argument> + <argument index="3" name="height" type="float" default="0"> + </argument> <description> - Return the global scale for stream playback. + 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. </description> </method> - <method name="set_fx_global_volume_scale"> - <argument index="0" name="scale" type="float"> + <method name="voice_set_positional"> + <argument index="0" name="voice" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> </argument> <description> - Set global scale for all voices (not including streams). Default is 1.0. + Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding. </description> </method> - <method name="get_fx_global_volume_scale" qualifiers="const"> - <return type="float"> - </return> + <method name="voice_set_reverb"> + <argument index="0" name="voice" type="RID"> + </argument> + <argument index="1" name="room" type="int"> + </argument> + <argument index="2" name="reverb" type="float"> + </argument> <description> - Return the global scale for all voices. + Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB_* enum. </description> </method> - <method name="set_event_voice_global_volume_scale"> - <argument index="0" name="scale" type="float"> + <method name="voice_set_volume"> + <argument index="0" name="voice" type="RID"> + </argument> + <argument index="1" name="volume" type="float"> </argument> <description> - Set global scale for event-based stream ([EventStream]) playback. Default is 1.0. + Change the volume of a currently playing voice. Volume is expressed as linear gain where 0.0 is mute and 1.0 is default. </description> </method> - <method name="get_event_voice_global_volume_scale" qualifiers="const"> - <return type="float"> - </return> + <method name="voice_stop"> + <argument index="0" name="voice" type="RID"> + </argument> <description> - Return the global scale for event-based stream playback. + Stop a given voice. </description> </method> </methods> <constants> - <constant name="SAMPLE_FORMAT_PCM8" value="0"> - Sample format is 8 bits, signed. - </constant> - <constant name="SAMPLE_FORMAT_PCM16" value="1"> - Sample format is 16 bits, little-endian, signed. - </constant> - <constant name="SAMPLE_FORMAT_IMA_ADPCM" value="2"> - Sample format is IMA-ADPCM compressed. - </constant> - <constant name="SAMPLE_LOOP_NONE" value="0"> - Sample does not loop. - </constant> - <constant name="SAMPLE_LOOP_FORWARD" value="1"> - Sample loops in forward mode. - </constant> - <constant name="SAMPLE_LOOP_PING_PONG" value="2"> - Sample loops in a bidirectional way. - </constant> <constant name="FILTER_NONE" value="0"> Filter is disabled. </constant> @@ -5125,6 +5147,24 @@ <constant name="REVERB_HALL" value="3"> Large reverb room with long decay. </constant> + <constant name="SAMPLE_FORMAT_PCM8" value="0"> + Sample format is 8 bits, signed. + </constant> + <constant name="SAMPLE_LOOP_NONE" value="0"> + Sample does not loop. + </constant> + <constant name="SAMPLE_FORMAT_PCM16" value="1"> + Sample format is 16 bits, little-endian, signed. + </constant> + <constant name="SAMPLE_LOOP_FORWARD" value="1"> + Sample loops in forward mode. + </constant> + <constant name="SAMPLE_FORMAT_IMA_ADPCM" value="2"> + Sample format is IMA-ADPCM compressed. + </constant> + <constant name="SAMPLE_LOOP_PING_PONG" value="2"> + Sample loops in a bidirectional way. + </constant> </constants> </class> <class name="AudioServerSW" inherits="AudioServer" category="Core"> @@ -5194,73 +5234,73 @@ <description> </description> <methods> - <method name="play"> - <argument index="0" name="from_pos_sec" type="float" default="0"> - </argument> + <method name="get_channels" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="stop"> + <method name="get_length" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> + <method name="get_loop_count" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="set_loop"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_minimum_buffer_size" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> + <method name="get_mix_rate" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="get_loop_count" qualifiers="const"> - <return type="int"> + <method name="get_pos" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="seek_pos"> - <argument index="0" name="pos" type="float"> - </argument> + <method name="has_loop" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_pos" qualifiers="const"> - <return type="float"> + <method name="is_playing" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> + <method name="play"> + <argument index="0" name="from_pos_sec" type="float" default="0"> + </argument> <description> </description> </method> - <method name="get_channels" qualifiers="const"> - <return type="int"> - </return> + <method name="seek_pos"> + <argument index="0" name="pos" type="float"> + </argument> <description> </description> </method> - <method name="get_mix_rate" qualifiers="const"> - <return type="int"> - </return> + <method name="set_loop"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> </description> </method> - <method name="get_minimum_buffer_size" qualifiers="const"> - <return type="int"> - </return> + <method name="stop"> <description> </description> </method> @@ -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. </description> <methods> - <method name="set_rect"> - <argument index="0" name="rect" type="Rect2"> - </argument> + <method name="get_copy_mode" qualifiers="const"> + <return type="int"> + </return> <description> - Defines the area covered by the BackBufferCopy. + Return the copy mode currently applied to the BackBufferCopy (refer to constants section). </description> </method> <method name="get_rect" qualifiers="const"> @@ -5309,11 +5349,11 @@ Set the copy mode of the BackBufferCopy (refer to constants section). </description> </method> - <method name="get_copy_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_rect"> + <argument index="0" name="rect" type="Rect2"> + </argument> <description> - Return the copy mode currently applied to the BackBufferCopy (refer to constants section). + Defines the area covered by the BackBufferCopy. </description> </method> </methods> @@ -5335,87 +5375,83 @@ <description> </description> <methods> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> + <method name="add_lightmap"> + <argument index="0" name="texture" type="Texture"> + </argument> + <argument index="1" name="gen_size" type="Vector2"> </argument> <description> </description> </method> - <method name="get_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="clear_lightmaps"> <description> </description> </method> - <method name="set_octree"> - <argument index="0" name="octree" type="RawArray"> + <method name="erase_lightmap"> + <argument index="0" name="id" type="int"> </argument> <description> </description> </method> - <method name="get_octree" qualifiers="const"> - <return type="RawArray"> + <method name="get_ao_radius" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="set_light"> - <argument index="0" name="light" type="RawArray"> - </argument> - <description> - </description> - </method> - <method name="get_light" qualifiers="const"> - <return type="RawArray"> + <method name="get_ao_strength" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="set_sampler_octree"> - <argument index="0" name="sampler_octree" type="IntArray"> + <method name="get_bake_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int"> </argument> <description> </description> </method> - <method name="get_sampler_octree" qualifiers="const"> - <return type="IntArray"> + <method name="get_bounces" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="add_lightmap"> - <argument index="0" name="texture" type="Texture"> - </argument> - <argument index="1" name="gen_size" type="Vector2"> - </argument> + <method name="get_cell_extra_margin" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="erase_lightmap"> - <argument index="0" name="id" type="int"> - </argument> + <method name="get_cell_subdivision" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="clear_lightmaps"> + <method name="get_edge_damp" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="set_cell_subdivision"> - <argument index="0" name="cell_subdivision" type="int"> - </argument> + <method name="get_energy_multiplier" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_cell_subdivision" qualifiers="const"> + <method name="get_format" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="set_initial_lattice_subdiv"> - <argument index="0" name="cell_subdivision" type="int"> - </argument> + <method name="get_gamma_adjust" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> @@ -5425,220 +5461,220 @@ <description> </description> </method> - <method name="set_plot_size"> - <argument index="0" name="plot_size" type="float"> - </argument> + <method name="get_light" qualifiers="const"> + <return type="RawArray"> + </return> <description> </description> </method> - <method name="get_plot_size" qualifiers="const"> - <return type="float"> + <method name="get_mode" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="set_bounces"> - <argument index="0" name="bounces" type="int"> - </argument> + <method name="get_normal_damp" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_bounces" qualifiers="const"> - <return type="int"> + <method name="get_octree" qualifiers="const"> + <return type="RawArray"> </return> <description> </description> </method> - <method name="set_cell_extra_margin"> - <argument index="0" name="cell_extra_margin" type="float"> - </argument> + <method name="get_plot_size" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_cell_extra_margin" qualifiers="const"> - <return type="float"> + <method name="get_realtime_color" qualifiers="const"> + <return type="Color"> </return> <description> </description> </method> - <method name="set_edge_damp"> - <argument index="0" name="edge_damp" type="float"> - </argument> + <method name="get_realtime_color_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_edge_damp" qualifiers="const"> + <method name="get_realtime_energy" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="set_normal_damp"> - <argument index="0" name="normal_damp" type="float"> - </argument> + <method name="get_sampler_octree" qualifiers="const"> + <return type="IntArray"> + </return> <description> </description> </method> - <method name="get_normal_damp" qualifiers="const"> + <method name="get_saturation" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="set_tint"> - <argument index="0" name="tint" type="float"> - </argument> + <method name="get_tint" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_tint" qualifiers="const"> - <return type="float"> + <method name="get_transfer_lightmaps_only_to_uv2" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_saturation"> - <argument index="0" name="saturation" type="float"> + <method name="set_ao_radius"> + <argument index="0" name="ao_radius" type="float"> </argument> <description> </description> </method> - <method name="get_saturation" qualifiers="const"> - <return type="float"> - </return> + <method name="set_ao_strength"> + <argument index="0" name="ao_strength" type="float"> + </argument> <description> </description> </method> - <method name="set_ao_radius"> - <argument index="0" name="ao_radius" type="float"> + <method name="set_bake_flag"> + <argument index="0" name="flag" type="int"> + </argument> + <argument index="1" name="enabled" type="bool"> </argument> <description> </description> </method> - <method name="get_ao_radius" qualifiers="const"> - <return type="float"> - </return> + <method name="set_bounces"> + <argument index="0" name="bounces" type="int"> + </argument> <description> </description> </method> - <method name="set_ao_strength"> - <argument index="0" name="ao_strength" type="float"> + <method name="set_cell_extra_margin"> + <argument index="0" name="cell_extra_margin" type="float"> </argument> <description> </description> </method> - <method name="get_ao_strength" qualifiers="const"> - <return type="float"> - </return> + <method name="set_cell_subdivision"> + <argument index="0" name="cell_subdivision" type="int"> + </argument> <description> </description> </method> - <method name="set_realtime_color_enabled"> - <argument index="0" name="enabled" type="bool"> + <method name="set_edge_damp"> + <argument index="0" name="edge_damp" type="float"> </argument> <description> </description> </method> - <method name="get_realtime_color_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_energy_multiplier"> + <argument index="0" name="energy_multiplier" type="float"> + </argument> <description> </description> </method> - <method name="set_realtime_color"> - <argument index="0" name="tint" type="Color"> + <method name="set_format"> + <argument index="0" name="format" type="int"> </argument> <description> </description> </method> - <method name="get_realtime_color" qualifiers="const"> - <return type="Color"> - </return> + <method name="set_gamma_adjust"> + <argument index="0" name="gamma_adjust" type="float"> + </argument> <description> </description> </method> - <method name="set_realtime_energy"> - <argument index="0" name="energy" type="float"> + <method name="set_initial_lattice_subdiv"> + <argument index="0" name="cell_subdivision" type="int"> </argument> <description> </description> </method> - <method name="get_realtime_energy" qualifiers="const"> - <return type="float"> - </return> + <method name="set_light"> + <argument index="0" name="light" type="RawArray"> + </argument> <description> </description> </method> - <method name="set_format"> - <argument index="0" name="format" type="int"> + <method name="set_mode"> + <argument index="0" name="mode" type="int"> </argument> <description> </description> </method> - <method name="get_format" qualifiers="const"> - <return type="int"> - </return> + <method name="set_normal_damp"> + <argument index="0" name="normal_damp" type="float"> + </argument> <description> </description> </method> - <method name="set_transfer_lightmaps_only_to_uv2"> - <argument index="0" name="enable" type="bool"> + <method name="set_octree"> + <argument index="0" name="octree" type="RawArray"> </argument> <description> </description> </method> - <method name="get_transfer_lightmaps_only_to_uv2" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_plot_size"> + <argument index="0" name="plot_size" type="float"> + </argument> <description> </description> </method> - <method name="set_energy_multiplier"> - <argument index="0" name="energy_multiplier" type="float"> + <method name="set_realtime_color"> + <argument index="0" name="tint" type="Color"> </argument> <description> </description> </method> - <method name="get_energy_multiplier" qualifiers="const"> - <return type="float"> - </return> + <method name="set_realtime_color_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> </description> </method> - <method name="set_gamma_adjust"> - <argument index="0" name="gamma_adjust" type="float"> + <method name="set_realtime_energy"> + <argument index="0" name="energy" type="float"> </argument> <description> </description> </method> - <method name="get_gamma_adjust" qualifiers="const"> - <return type="float"> - </return> + <method name="set_sampler_octree"> + <argument index="0" name="sampler_octree" type="IntArray"> + </argument> <description> </description> </method> - <method name="set_bake_flag"> - <argument index="0" name="flag" type="int"> + <method name="set_saturation"> + <argument index="0" name="saturation" type="float"> </argument> - <argument index="1" name="enabled" type="bool"> + <description> + </description> + </method> + <method name="set_tint"> + <argument index="0" name="tint" type="float"> </argument> <description> </description> </method> - <method name="get_bake_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int"> + <method name="set_transfer_lightmaps_only_to_uv2"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> </methods> <constants> - <constant name="MODE_OCTREE" value="0"> - </constant> - <constant name="MODE_LIGHTMAPS" value="1"> - </constant> <constant name="BAKE_DIFFUSE" value="0"> </constant> <constant name="BAKE_SPECULAR" value="1"> @@ -5649,6 +5685,10 @@ </constant> <constant name="BAKE_MAX" value="5"> </constant> + <constant name="MODE_OCTREE" value="0"> + </constant> + <constant name="MODE_LIGHTMAPS" value="1"> + </constant> </constants> </class> <class name="BakedLightInstance" inherits="VisualInstance" category="Core"> @@ -5657,12 +5697,6 @@ <description> </description> <methods> - <method name="set_baked_light"> - <argument index="0" name="baked_light" type="Object"> - </argument> - <description> - </description> - </method> <method name="get_baked_light" qualifiers="const"> <return type="Object"> </return> @@ -5675,6 +5709,12 @@ <description> </description> </method> + <method name="set_baked_light"> + <argument index="0" name="baked_light" type="Object"> + </argument> + <description> + </description> + </method> </methods> <signals> <signal name="baked_light_changed"> @@ -5691,19 +5731,25 @@ <description> </description> <methods> - <method name="set_param"> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="param" type="int"> </argument> - <argument index="1" name="value" type="float"> - </argument> <description> </description> </method> - <method name="get_param" qualifiers="const"> - <return type="float"> + <method name="get_resolution" qualifiers="const"> + <return type="int"> </return> + <description> + </description> + </method> + <method name="set_param"> <argument index="0" name="param" type="int"> </argument> + <argument index="1" name="value" type="float"> + </argument> <description> </description> </method> @@ -5713,12 +5759,6 @@ <description> </description> </method> - <method name="get_resolution" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> </methods> <constants> <constant name="PARAM_RADIUS" value="0"> @@ -5753,53 +5793,59 @@ Called when button is toggled (only if toggle_mode is active). </description> </method> - <method name="set_pressed"> - <argument index="0" name="pressed" type="bool"> - </argument> + <method name="get_click_on_press" qualifiers="const"> + <return type="bool"> + </return> <description> - Set the button to pressed state (only if toggle_mode is active). + Return the state of the click_on_press property (see [method set_click_on_press]). </description> </method> - <method name="is_pressed" qualifiers="const"> - <return type="bool"> + <method name="get_draw_mode" qualifiers="const"> + <return type="int"> </return> <description> - 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 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. </description> </method> - <method name="is_hovered" qualifiers="const"> - <return type="bool"> + <method name="get_enabled_focus_mode" qualifiers="const"> + <return type="int"> </return> <description> - Return true if mouse entered the button before it exit. + Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). </description> </method> - <method name="set_toggle_mode"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_shortcut" qualifiers="const"> + <return type="Object"> + </return> <description> - Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. </description> </method> - <method name="is_toggle_mode" qualifiers="const"> + <method name="is_disabled" qualifiers="const"> <return type="bool"> </return> <description> - Return the toggle_mode property (see [method set_toggle_mode]). + Return whether the button is in disabled state (see [method set_disabled]). </description> </method> - <method name="set_disabled"> - <argument index="0" name="disabled" type="bool"> - </argument> + <method name="is_hovered" qualifiers="const"> + <return type="bool"> + </return> <description> - Set the button into disabled state. When a button is disabled, it can't be clicked or toggled. + Return true if mouse entered the button before it exit. </description> </method> - <method name="is_disabled" qualifiers="const"> + <method name="is_pressed" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the button is in disabled state (see [method set_disabled]). + If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down. + </description> + </method> + <method name="is_toggle_mode" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return the toggle_mode property (see [method set_toggle_mode]). </description> </method> <method name="set_click_on_press"> @@ -5809,18 +5855,11 @@ 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). </description> </method> - <method name="get_click_on_press" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return the state of the click_on_press property (see [method set_click_on_press]). - </description> - </method> - <method name="get_draw_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_disabled"> + <argument index="0" name="disabled" type="bool"> + </argument> <description> - 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. + Set the button into disabled state. When a button is disabled, it can't be clicked or toggled. </description> </method> <method name="set_enabled_focus_mode"> @@ -5830,11 +5869,11 @@ Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). </description> </method> - <method name="get_enabled_focus_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_pressed"> + <argument index="0" name="pressed" type="bool"> + </argument> <description> - Returns focus access mode used 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). </description> </method> <method name="set_shortcut"> @@ -5843,14 +5882,20 @@ <description> </description> </method> - <method name="get_shortcut" qualifiers="const"> - <return type="Object"> - </return> + <method name="set_toggle_mode"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> + Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. </description> </method> </methods> <signals> + <signal name="pressed"> + <description> + This signal is emitted every time the button is pressed or toggled. + </description> + </signal> <signal name="released"> <description> 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. </description> </signal> - <signal name="pressed"> - <description> - This signal is emitted every time the button is pressed or toggled. - </description> - </signal> </signals> <constants> <constant name="DRAW_NORMAL" value="0"> @@ -5902,14 +5942,6 @@ <description> </description> </method> - <method name="set_bit"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <argument index="1" name="bit" type="bool"> - </argument> - <description> - </description> - </method> <method name="get_bit" qualifiers="const"> <return type="bool"> </return> @@ -5918,11 +5950,9 @@ <description> </description> </method> - <method name="set_bit_rect"> - <argument index="0" name="p_rect" type="Rect2"> - </argument> - <argument index="1" name="bit" type="bool"> - </argument> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> <description> </description> </method> @@ -5932,9 +5962,19 @@ <description> </description> </method> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_bit"> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="bit" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bit_rect"> + <argument index="0" name="p_rect" type="Rect2"> + </argument> + <argument index="1" name="bit" type="bool"> + </argument> <description> </description> </method> @@ -5948,26 +5988,19 @@ <description> </description> <methods> - <method name="create_from_fnt"> - <return type="int"> - </return> - <argument index="0" name="path" type="String"> + <method name="add_char"> + <argument index="0" name="character" type="int"> </argument> - <description> - </description> - </method> - <method name="set_height"> - <argument index="0" name="px" type="float"> + <argument index="1" name="texture" type="int"> </argument> - <description> - Set the total font height (ascent plus descent) in pixels. - </description> - </method> - <method name="set_ascent"> - <argument index="0" name="px" type="float"> + <argument index="2" name="rect" type="Rect2"> + </argument> + <argument index="3" name="align" type="Vector2" default="Vector2(0,0)"> + </argument> + <argument index="4" name="advance" type="float" default="-1"> </argument> <description> - Set the font ascent (number of pixels above the baseline). + 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. </description> </method> <method name="add_kerning_pair"> @@ -5981,17 +6014,6 @@ 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. </description> </method> - <method name="get_kerning_pair" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="char_a" type="int"> - </argument> - <argument index="1" name="char_b" type="int"> - </argument> - <description> - Return a kerning pair as a difference. - </description> - </method> <method name="add_texture"> <argument index="0" name="texture" type="Texture"> </argument> @@ -5999,25 +6021,45 @@ Add a texture to the [BitmapFont]. </description> </method> - <method name="add_char"> - <argument index="0" name="character" type="int"> - </argument> - <argument index="1" name="texture" type="int"> - </argument> - <argument index="2" name="rect" type="Rect2"> + <method name="clear"> + <description> + Clear all the font data. + </description> + </method> + <method name="create_from_fnt"> + <return type="int"> + </return> + <argument index="0" name="path" type="String"> </argument> - <argument index="3" name="align" type="Vector2" default="Vector2(0,0)"> + <description> + </description> + </method> + <method name="get_char_size" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="char" type="int"> </argument> - <argument index="4" name="advance" type="float" default="-1"> + <argument index="1" name="next" type="int" default="0"> </argument> <description> - 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. + Return the size of a character, optionally taking kerning into account if the next character is provided. </description> </method> - <method name="get_texture_count" qualifiers="const"> + <method name="get_fallback" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_kerning_pair" qualifiers="const"> <return type="int"> </return> + <argument index="0" name="char_a" type="int"> + </argument> + <argument index="1" name="char_b" type="int"> + </argument> <description> + Return a kerning pair as a difference. </description> </method> <method name="get_texture" qualifiers="const"> @@ -6028,26 +6070,23 @@ <description> </description> </method> - <method name="get_char_size" qualifiers="const"> - <return type="Vector2"> + <method name="get_texture_count" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="char" type="int"> - </argument> - <argument index="1" name="next" type="int" default="0"> - </argument> <description> - Return the size of a character, optionally taking kerning into account if the next character is provided. </description> </method> - <method name="set_distance_field_hint"> - <argument index="0" name="enable" type="bool"> + <method name="set_ascent"> + <argument index="0" name="px" type="float"> </argument> <description> + Set the font ascent (number of pixels above the baseline). </description> </method> - <method name="clear"> + <method name="set_distance_field_hint"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Clear all the font data. </description> </method> <method name="set_fallback"> @@ -6056,10 +6095,11 @@ <description> </description> </method> - <method name="get_fallback" qualifiers="const"> - <return type="Object"> - </return> + <method name="set_height"> + <argument index="0" name="px" type="float"> + </argument> <description> + Set the total font height (ascent plus descent) in pixels. </description> </method> </methods> @@ -6129,13 +6169,6 @@ Box shape resource, which can be set into a [PhysicsBody] or area. </description> <methods> - <method name="set_extents"> - <argument index="0" name="extents" type="Vector3"> - </argument> - <description> - Set the half extents for the shape. - </description> - </method> <method name="get_extents" qualifiers="const"> <return type="Vector3"> </return> @@ -6143,6 +6176,13 @@ Return the half extents of the shape. </description> </method> + <method name="set_extents"> + <argument index="0" name="extents" type="Vector3"> + </argument> + <description> + Set the half extents for the shape. + </description> + </method> </methods> <constants> </constants> @@ -6155,11 +6195,18 @@ Button is the standard themed button. It can contain text and an icon, and will display them according to the current [Theme]. </description> <methods> - <method name="set_text"> - <argument index="0" name="text" type="String"> - </argument> + <method name="get_button_icon" qualifiers="const"> + <return type="Texture"> + </return> <description> - Set the button text, which will be displayed inside the button area. + Return the button icon. + </description> + </method> + <method name="get_clip_text" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return the state of the [i]clip_text[/i] property (see [method set_clip_text]) </description> </method> <method name="get_text" qualifiers="const"> @@ -6169,25 +6216,25 @@ Return the button text. </description> </method> - <method name="set_button_icon"> - <argument index="0" name="texture" type="Texture"> - </argument> + <method name="get_text_align" qualifiers="const"> + <return type="int"> + </return> <description> - Set the icon that will be displayed next to the text inside the button area. + Return the text alignment policy. </description> </method> - <method name="get_button_icon" qualifiers="const"> - <return type="Texture"> + <method name="is_flat" qualifiers="const"> + <return type="bool"> </return> <description> - Return the button icon. + Return the state of the [i]flat[/i] property (see [method set_flat]). </description> </method> - <method name="set_flat"> - <argument index="0" name="enabled" type="bool"> + <method name="set_button_icon"> + <argument index="0" name="texture" type="Texture"> </argument> <description> - Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed. + Set the icon that will be displayed next to the text inside the button area. </description> </method> <method name="set_clip_text"> @@ -6197,32 +6244,25 @@ 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. </description> </method> - <method name="get_clip_text" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return the state of the [i]clip_text[/i] property (see [method set_clip_text]) - </description> - </method> - <method name="set_text_align"> - <argument index="0" name="align" type="int"> + <method name="set_flat"> + <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the text alignment policy, using one of the ALIGN_* constants. + Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed. </description> </method> - <method name="get_text_align" qualifiers="const"> - <return type="int"> - </return> + <method name="set_text"> + <argument index="0" name="text" type="String"> + </argument> <description> - Return the text alignment policy. + Set the button text, which will be displayed inside the button area. </description> </method> - <method name="is_flat" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_text_align"> + <argument index="0" name="align" type="int"> + </argument> <description> - Return the state of the [i]flat[/i] property (see [method set_flat]). + Set the text alignment policy, using one of the ALIGN_* constants. </description> </method> </methods> @@ -6238,28 +6278,28 @@ </constant> </constants> <theme_items> - <theme_item name="hseparation" type="int"> + <theme_item name="disabled" type="StyleBox"> </theme_item> - <theme_item name="font_color_disabled" type="Color"> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> <theme_item name="font_color_hover" type="Color"> </theme_item> <theme_item name="font_color_pressed" type="Color"> </theme_item> - <theme_item name="font" type="Font"> - </theme_item> <theme_item name="hover" type="StyleBox"> </theme_item> - <theme_item name="pressed" type="StyleBox"> - </theme_item> - <theme_item name="focus" type="StyleBox"> - </theme_item> - <theme_item name="disabled" type="StyleBox"> + <theme_item name="hseparation" type="int"> </theme_item> <theme_item name="normal" type="StyleBox"> </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> </theme_items> </class> <class name="ButtonArray" inherits="Control" category="Core"> @@ -6287,31 +6327,23 @@ Append a new button to the array, with the specified icon and text. </description> </method> - <method name="set_button_text"> - <argument index="0" name="button_idx" type="int"> - </argument> - <argument index="1" name="text" type="String"> - </argument> + <method name="clear"> <description> - Define the text of the specified button. + Remove all buttons from the array. </description> </method> - <method name="set_button_icon"> + <method name="erase_button"> <argument index="0" name="button_idx" type="int"> </argument> - <argument index="1" name="icon" type="Texture"> - </argument> <description> - Set the icon of the specified button. + Remove the specified button in the array. </description> </method> - <method name="get_button_text" qualifiers="const"> - <return type="String"> + <method name="get_button_count" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="button_idx" type="int"> - </argument> <description> - Return the text of the specified button. + Return the amount of buttons in the array. </description> </method> <method name="get_button_icon" qualifiers="const"> @@ -6323,44 +6355,52 @@ Return the icon of the specified button. </description> </method> - <method name="get_button_count" qualifiers="const"> - <return type="int"> + <method name="get_button_text" qualifiers="const"> + <return type="String"> </return> + <argument index="0" name="button_idx" type="int"> + </argument> <description> - Return the amount of buttons in the array. + Return the text of the specified button. </description> </method> - <method name="get_selected" qualifiers="const"> + <method name="get_hovered" qualifiers="const"> <return type="int"> </return> <description> - Return the index of the currently selected button in the array. + Return the index of the currently hovered button in the array. </description> </method> - <method name="get_hovered" qualifiers="const"> + <method name="get_selected" qualifiers="const"> <return type="int"> </return> <description> - Return the index of the currently hovered button in the array. + Return the index of the currently selected button in the array. </description> </method> - <method name="set_selected"> + <method name="set_button_icon"> <argument index="0" name="button_idx" type="int"> </argument> + <argument index="1" name="icon" type="Texture"> + </argument> <description> - Select a button in the array based on the given index. + Set the icon of the specified button. </description> </method> - <method name="erase_button"> + <method name="set_button_text"> <argument index="0" name="button_idx" type="int"> </argument> + <argument index="1" name="text" type="String"> + </argument> <description> - Remove the specified button in the array. + Define the text of the specified button. </description> </method> - <method name="clear"> + <method name="set_selected"> + <argument index="0" name="button_idx" type="int"> + </argument> <description> - Remove all buttons from the array. + Select a button in the array based on the given index. </description> </method> </methods> @@ -6399,32 +6439,32 @@ Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed. </description> <methods> - <method name="get_pressed_button" qualifiers="const"> - <return type="BaseButton"> + <method name="get_button_list" qualifiers="const"> + <return type="Array"> </return> <description> - Return the pressed button. + Return the list of all the buttons in the group. </description> </method> - <method name="get_pressed_button_index" qualifiers="const"> - <return type="int"> + <method name="get_focused_button" qualifiers="const"> + <return type="BaseButton"> </return> <description> - Return the index of the pressed button (by tree order). + Return the focused button. </description> </method> - <method name="get_focused_button" qualifiers="const"> + <method name="get_pressed_button" qualifiers="const"> <return type="BaseButton"> </return> <description> - Return the focused button. + Return the pressed button. </description> </method> - <method name="get_button_list" qualifiers="const"> - <return type="Array"> + <method name="get_pressed_button_index" qualifiers="const"> + <return type="int"> </return> <description> - Return the list of all the buttons in the group. + Return the index of the pressed button (by tree order). </description> </method> <method name="set_pressed_button"> @@ -6450,85 +6490,62 @@ 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. </description> <methods> - <method name="project_ray_normal" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="screen_point" type="Vector2"> - </argument> + <method name="clear_current"> <description> - 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. </description> </method> - <method name="project_local_ray_normal" qualifiers="const"> - <return type="Vector3"> + <method name="get_camera_transform" qualifiers="const"> + <return type="Transform"> </return> - <argument index="0" name="screen_point" type="Vector2"> - </argument> <description> + Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. </description> </method> - <method name="project_ray_origin" qualifiers="const"> - <return type="Vector3"> + <method name="get_environment" qualifiers="const"> + <return type="Environment"> </return> - <argument index="0" name="screen_point" type="Vector2"> - </argument> <description> - 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. </description> </method> - <method name="unproject_position" qualifiers="const"> - <return type="Vector2"> + <method name="get_fov" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="world_point" type="Vector3"> - </argument> <description> - Return how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle. </description> </method> - <method name="is_position_behind" qualifiers="const"> - <return type="bool"> + <method name="get_keep_aspect_mode" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="world_point" type="Vector3"> - </argument> <description> </description> </method> - <method name="project_position" qualifiers="const"> - <return type="Vector3"> + <method name="get_projection" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="screen_point" type="Vector2"> - </argument> <description> </description> </method> - <method name="set_perspective"> - <argument index="0" name="fov" type="float"> - </argument> - <argument index="1" name="z_near" type="float"> - </argument> - <argument index="2" name="z_far" type="float"> - </argument> + <method name="get_size" qualifiers="const"> + <return type="float"> + </return> <description> - 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. </description> </method> - <method name="set_orthogonal"> - <argument index="0" name="size" type="float"> - </argument> - <argument index="1" name="z_near" type="float"> - </argument> - <argument index="2" name="z_far" type="float"> - </argument> + <method name="get_visible_layers" qualifiers="const"> + <return type="int"> + </return> <description> - 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) </description> </method> - <method name="make_current"> + <method name="get_zfar" qualifiers="const"> + <return type="float"> + </return> <description> - 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. </description> </method> - <method name="clear_current"> + <method name="get_znear" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> @@ -6539,91 +6556,114 @@ Return whether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree). </description> </method> - <method name="get_camera_transform" qualifiers="const"> - <return type="Transform"> + <method name="is_position_behind" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="world_point" type="Vector3"> + </argument> <description> - Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. </description> </method> - <method name="get_fov" qualifiers="const"> - <return type="float"> - </return> + <method name="make_current"> <description> + 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. </description> </method> - <method name="get_size" qualifiers="const"> - <return type="float"> + <method name="project_local_ray_normal" qualifiers="const"> + <return type="Vector3"> </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> <description> </description> </method> - <method name="get_zfar" qualifiers="const"> - <return type="float"> + <method name="project_position" qualifiers="const"> + <return type="Vector3"> </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> <description> </description> </method> - <method name="get_znear" qualifiers="const"> - <return type="float"> + <method name="project_ray_normal" qualifiers="const"> + <return type="Vector3"> </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> <description> + 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. </description> </method> - <method name="get_projection" qualifiers="const"> - <return type="int"> + <method name="project_ray_origin" qualifiers="const"> + <return type="Vector3"> </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> <description> + 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. </description> </method> - <method name="set_visible_layers"> - <argument index="0" name="mask" type="int"> + <method name="set_environment"> + <argument index="0" name="env" type="Environment"> </argument> <description> </description> </method> - <method name="get_visible_layers" qualifiers="const"> - <return type="int"> - </return> + <method name="set_keep_aspect_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> </description> </method> - <method name="set_environment"> - <argument index="0" name="env" type="Environment"> + <method name="set_orthogonal"> + <argument index="0" name="size" type="float"> + </argument> + <argument index="1" name="z_near" type="float"> + </argument> + <argument index="2" name="z_far" type="float"> </argument> <description> + 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) </description> </method> - <method name="get_environment" qualifiers="const"> - <return type="Environment"> - </return> + <method name="set_perspective"> + <argument index="0" name="fov" type="float"> + </argument> + <argument index="1" name="z_near" type="float"> + </argument> + <argument index="2" name="z_far" type="float"> + </argument> <description> + 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. </description> </method> - <method name="set_keep_aspect_mode"> - <argument index="0" name="mode" type="int"> + <method name="set_visible_layers"> + <argument index="0" name="mask" type="int"> </argument> <description> </description> </method> - <method name="get_keep_aspect_mode" qualifiers="const"> - <return type="int"> + <method name="unproject_position" qualifiers="const"> + <return type="Vector2"> </return> + <argument index="0" name="world_point" type="Vector3"> + </argument> <description> + Return how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle. </description> </method> </methods> <constants> + <constant name="KEEP_WIDTH" value="0"> + </constant> + <constant name="KEEP_HEIGHT" value="1"> + </constant> <constant name="PROJECTION_PERSPECTIVE" value="0"> Perspective Projection (object's size on the screen becomes smaller when far away). </constant> <constant name="PROJECTION_ORTHOGONAL" value="1"> Orthogonal Projection (objects remain the same size on the screen no matter how far away they are). </constant> - <constant name="KEEP_WIDTH" value="0"> - </constant> - <constant name="KEEP_HEIGHT" value="1"> - </constant> </constants> </class> <class name="Camera2D" inherits="Node2D" category="Core"> @@ -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]. </description> <methods> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - Set the scroll offset. Useful for looking around or camera shake animations. - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="clear_current"> <description> - Return the scroll offset. </description> </method> - <method name="set_anchor_mode"> - <argument index="0" name="anchor_mode" type="int"> - </argument> + <method name="force_update_scroll"> <description> + Force the camera to update scroll immediately. </description> </method> <method name="get_anchor_mode" qualifiers="const"> @@ -6661,41 +6690,38 @@ <description> </description> </method> - <method name="set_rotating"> - <argument index="0" name="rotating" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_rotating" qualifiers="const"> - <return type="bool"> + <method name="get_camera_pos" qualifiers="const"> + <return type="Vector2"> </return> <description> + Return the camera position. </description> </method> - <method name="make_current"> + <method name="get_camera_screen_center" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. </description> </method> - <method name="clear_current"> + <method name="get_drag_margin" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int"> + </argument> <description> + Return the margins needed to drag the camera (see [method set_drag_margin]). </description> </method> - <method name="is_current" qualifiers="const"> - <return type="bool"> + <method name="get_follow_smoothing" qualifiers="const"> + <return type="float"> </return> <description> - Return true of this is the current camera (see [method make_current]). </description> </method> - <method name="set_limit"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="limit" type="int"> - </argument> + <method name="get_h_offset" qualifiers="const"> + <return type="float"> + </return> <description> - Set the scrolling limit in pixels. </description> </method> <method name="get_limit" qualifiers="const"> @@ -6707,21 +6733,35 @@ Return the scrolling limit in pixels. </description> </method> - <method name="set_v_drag_enabled"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> <description> + Return the scroll offset. </description> </method> - <method name="is_v_drag_enabled" qualifiers="const"> + <method name="get_v_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_zoom" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="is_current" qualifiers="const"> <return type="bool"> </return> <description> + Return true of this is the current camera (see [method make_current]). </description> </method> - <method name="set_h_drag_enabled"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="is_follow_smoothing_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> @@ -6731,27 +6771,26 @@ <description> </description> </method> - <method name="set_v_offset"> - <argument index="0" name="ofs" type="float"> - </argument> + <method name="is_rotating" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_v_offset" qualifiers="const"> - <return type="float"> + <method name="is_v_drag_enabled" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_h_offset"> - <argument index="0" name="ofs" type="float"> - </argument> + <method name="make_current"> <description> + Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. </description> </method> - <method name="get_h_offset" qualifiers="const"> - <return type="float"> - </return> + <method name="set_anchor_mode"> + <argument index="0" name="anchor_mode" type="int"> + </argument> <description> </description> </method> @@ -6764,75 +6803,76 @@ 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. </description> </method> - <method name="get_drag_margin" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int"> + <method name="set_enable_follow_smoothing"> + <argument index="0" name="follow_smoothing" type="bool"> </argument> <description> - Return the margins needed to drag the camera (see [method set_drag_margin]). </description> </method> - <method name="get_camera_pos" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_follow_smoothing"> + <argument index="0" name="follow_smoothing" type="float"> + </argument> <description> - Return the camera position. </description> </method> - <method name="get_camera_screen_center" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_h_drag_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> </description> </method> - <method name="set_zoom"> - <argument index="0" name="zoom" type="Vector2"> + <method name="set_h_offset"> + <argument index="0" name="ofs" type="float"> </argument> <description> </description> </method> - <method name="get_zoom" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_limit"> + <argument index="0" name="margin" type="int"> + </argument> + <argument index="1" name="limit" type="int"> + </argument> <description> + Set the scrolling limit in pixels. </description> </method> - <method name="set_follow_smoothing"> - <argument index="0" name="follow_smoothing" type="float"> + <method name="set_offset"> + <argument index="0" name="offset" type="Vector2"> </argument> <description> + Set the scroll offset. Useful for looking around or camera shake animations. </description> </method> - <method name="get_follow_smoothing" qualifiers="const"> - <return type="float"> - </return> + <method name="set_rotating"> + <argument index="0" name="rotating" type="bool"> + </argument> <description> </description> </method> - <method name="set_enable_follow_smoothing"> - <argument index="0" name="follow_smoothing" type="bool"> + <method name="set_v_drag_enabled"> + <argument index="0" name="enabled" type="bool"> </argument> <description> </description> </method> - <method name="is_follow_smoothing_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_v_offset"> + <argument index="0" name="ofs" type="float"> + </argument> <description> </description> </method> - <method name="force_update_scroll"> + <method name="set_zoom"> + <argument index="0" name="zoom" type="Vector2"> + </argument> <description> - Force the camera to update scroll immediately. </description> </method> </methods> <constants> - <constant name="ANCHOR_MODE_DRAG_CENTER" value="1"> - </constant> <constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0"> </constant> + <constant name="ANCHOR_MODE_DRAG_CENTER" value="1"> + </constant> </constants> </class> <class name="CanvasItem" inherits="Node" category="Core"> @@ -6852,165 +6892,45 @@ Called (if exists) to draw the canvas item. </description> </method> - <method name="edit_set_state"> - <argument index="0" name="state" type="Variant"> + <method name="draw_char"> + <return type="float"> + </return> + <argument index="0" name="font" type="Font"> </argument> - <description> - Used for editing, returns an opaque value representing the transform state. - </description> - </method> - <method name="edit_get" qualifiers="const"> - <description> - </description> - </method> - <method name="edit_set_rect"> - <argument index="0" name="rect" type="Rect2"> + <argument index="1" name="pos" type="Vector2"> </argument> - <description> - </description> - </method> - <method name="edit_rotate"> - <argument index="0" name="degrees" type="float"> + <argument index="2" name="char" type="String"> </argument> - <description> - Used for editing, handle rotation. - </description> - </method> - <method name="get_item_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - Return a rect containing the editable contents of the item. - </description> - </method> - <method name="get_item_and_children_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="get_canvas_item" qualifiers="const"> - <return type="RID"> - </return> - <description> - Return the canvas item RID used by [VisualServer] for this item. - </description> - </method> - <method name="is_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. - </description> - </method> - <method name="is_hidden" qualifiers="const"> - <return type="bool"> - </return> - <description> - 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. - </description> - </method> - <method name="show"> - <description> - Show the CanvasItem currently hidden. - </description> - </method> - <method name="hide"> - <description> - Hide the CanvasItem currently visible. - </description> - </method> - <method name="set_hidden"> - <argument index="0" name="hidden" type="bool"> + <argument index="3" name="next" type="String"> </argument> - <description> - </description> - </method> - <method name="update"> - <description> - Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw. - </description> - </method> - <method name="set_as_toplevel"> - <argument index="0" name="enable" type="bool"> + <argument index="4" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> <description> - Set as toplevel. This means that it will not inherit transform from parent canvas items. - </description> - </method> - <method name="is_set_as_toplevel" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return if set as toplevel. See [method set_as_toplevel]. + Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. </description> </method> - <method name="set_blend_mode"> - <argument index="0" name="blend_mode" type="int"> + <method name="draw_circle"> + <argument index="0" name="pos" type="Vector2"> </argument> - <description> - Set the blending mode from enum BLEND_MODE_*. - </description> - </method> - <method name="get_blend_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the current blending mode from enum BLEND_MODE_*. - </description> - </method> - <method name="set_light_mask"> - <argument index="0" name="light_mask" type="int"> + <argument index="1" name="radius" type="float"> </argument> - <description> - </description> - </method> - <method name="get_light_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_opacity"> - <argument index="0" name="opacity" type="float"> + <argument index="2" name="color" type="Color"> </argument> <description> - Set canvas item opacity. This will affect the canvas item and all the children. - </description> - </method> - <method name="get_opacity" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the canvas item opacity. This affects the canvas item and all the children. + Draw a colored circle. </description> </method> - <method name="set_self_opacity"> - <argument index="0" name="self_opacity" type="float"> + <method name="draw_colored_polygon"> + <argument index="0" name="points" type="Vector2Array"> </argument> - <description> - Set canvas item self-opacity. This does not affect the opacity of children items. - </description> - </method> - <method name="get_self_opacity" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the canvas item self-opacity. - </description> - </method> - <method name="set_draw_behind_parent"> - <argument index="0" name="enable" type="bool"> + <argument index="1" name="color" type="Color"> + </argument> + <argument index="2" name="uvs" type="Vector2Array" default="Vector2Array()"> + </argument> + <argument index="3" name="texture" type="Texture" default="NULL"> </argument> <description> - Sets whether the canvas item is drawn behind its parent. - </description> - </method> - <method name="is_draw_behind_parent_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the item is drawn behind its parent. + Draw a colored polygon of any amount of points, convex or concave. </description> </method> <method name="draw_line"> @@ -7026,6 +6946,34 @@ Draw a line from a 2D point to another, with a given color and width. </description> </method> + <method name="draw_polygon"> + <argument index="0" name="points" type="Vector2Array"> + </argument> + <argument index="1" name="colors" type="ColorArray"> + </argument> + <argument index="2" name="uvs" type="Vector2Array" default="Vector2Array()"> + </argument> + <argument index="3" name="texture" type="Texture" default="NULL"> + </argument> + <description> + Draw a polygon of any amount of points, convex or concave. + </description> + </method> + <method name="draw_primitive"> + <argument index="0" name="points" type="Vector2Array"> + </argument> + <argument index="1" name="colors" type="ColorArray"> + </argument> + <argument index="2" name="uvs" type="Vector2Array"> + </argument> + <argument index="3" name="texture" type="Texture" default="NULL"> + </argument> + <argument index="4" name="width" type="float" default="1"> + </argument> + <description> + 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. + </description> + </method> <method name="draw_rect"> <argument index="0" name="rect" type="Rect2"> </argument> @@ -7035,15 +6983,39 @@ Draw a colored rectangle. </description> </method> - <method name="draw_circle"> + <method name="draw_set_transform"> <argument index="0" name="pos" type="Vector2"> </argument> - <argument index="1" name="radius" type="float"> + <argument index="1" name="rot" type="float"> </argument> - <argument index="2" name="color" type="Color"> + <argument index="2" name="scale" type="Vector2"> </argument> <description> - Draw a colored circle. + Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. + </description> + </method> + <method name="draw_string"> + <argument index="0" name="font" type="Font"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="text" type="String"> + </argument> + <argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)"> + </argument> + <argument index="4" name="clip_w" type="int" default="-1"> + </argument> + <description> + Draw a string using a custom font. + </description> + </method> + <method name="draw_style_box"> + <argument index="0" name="style_box" type="StyleBox"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <description> + Draw a styled rectangle. </description> </method> <method name="draw_texture"> @@ -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. </description> </method> - <method name="draw_style_box"> - <argument index="0" name="style_box" type="StyleBox"> - </argument> - <argument index="1" name="rect" type="Rect2"> - </argument> + <method name="edit_get" qualifiers="const"> <description> - Draw a styled rectangle. </description> </method> - <method name="draw_primitive"> - <argument index="0" name="points" type="Vector2Array"> - </argument> - <argument index="1" name="colors" type="ColorArray"> - </argument> - <argument index="2" name="uvs" type="Vector2Array"> - </argument> - <argument index="3" name="texture" type="Texture" default="NULL"> - </argument> - <argument index="4" name="width" type="float" default="1"> + <method name="edit_rotate"> + <argument index="0" name="degrees" type="float"> </argument> <description> - 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. </description> </method> - <method name="draw_polygon"> - <argument index="0" name="points" type="Vector2Array"> - </argument> - <argument index="1" name="colors" type="ColorArray"> - </argument> - <argument index="2" name="uvs" type="Vector2Array" default="Vector2Array()"> - </argument> - <argument index="3" name="texture" type="Texture" default="NULL"> + <method name="edit_set_rect"> + <argument index="0" name="rect" type="Rect2"> </argument> <description> - Draw a polygon of any amount of points, convex or concave. </description> </method> - <method name="draw_colored_polygon"> - <argument index="0" name="points" type="Vector2Array"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <argument index="2" name="uvs" type="Vector2Array" default="Vector2Array()"> - </argument> - <argument index="3" name="texture" type="Texture" default="NULL"> + <method name="edit_set_state"> + <argument index="0" name="state" type="Variant"> </argument> <description> - Draw a colored polygon of any amount of points, convex or concave. + Used for editing, returns an opaque value representing the transform state. </description> </method> - <method name="draw_string"> - <argument index="0" name="font" type="Font"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <argument index="2" name="text" type="String"> - </argument> - <argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)"> - </argument> - <argument index="4" name="clip_w" type="int" default="-1"> - </argument> + <method name="get_blend_mode" qualifiers="const"> + <return type="int"> + </return> <description> - Draw a string using a custom font. + Return the current blending mode from enum BLEND_MODE_*. </description> </method> - <method name="draw_char"> - <return type="float"> + <method name="get_canvas" qualifiers="const"> + <return type="RID"> </return> - <argument index="0" name="font" type="Font"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <argument index="2" name="char" type="String"> - </argument> - <argument index="3" name="next" type="String"> - </argument> - <argument index="4" name="modulate" type="Color" default="Color(1,1,1,1)"> - </argument> <description> - Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. </description> </method> - <method name="draw_set_transform"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <argument index="1" name="rot" type="float"> - </argument> - <argument index="2" name="scale" type="Vector2"> - </argument> + <method name="get_canvas_item" qualifiers="const"> + <return type="RID"> + </return> <description> - 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. </description> </method> - <method name="get_transform" qualifiers="const"> + <method name="get_canvas_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> </description> </method> + <method name="get_global_mouse_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> <method name="get_global_transform" qualifiers="const"> <return type="Matrix32"> </return> @@ -7198,20 +7127,21 @@ <description> </description> </method> - <method name="get_viewport_transform" qualifiers="const"> - <return type="Matrix32"> + <method name="get_item_and_children_rect" qualifiers="const"> + <return type="Rect2"> </return> <description> </description> </method> - <method name="get_viewport_rect" qualifiers="const"> + <method name="get_item_rect" qualifiers="const"> <return type="Rect2"> </return> <description> + Return a rect containing the editable contents of the item. </description> </method> - <method name="get_canvas_transform" qualifiers="const"> - <return type="Matrix32"> + <method name="get_light_mask" qualifiers="const"> + <return type="int"> </return> <description> </description> @@ -7222,14 +7152,46 @@ <description> </description> </method> - <method name="get_global_mouse_pos" qualifiers="const"> - <return type="Vector2"> + <method name="get_material" qualifiers="const"> + <return type="CanvasItemMaterial"> </return> <description> </description> </method> - <method name="get_canvas" qualifiers="const"> - <return type="RID"> + <method name="get_opacity" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the canvas item opacity. This affects the canvas item and all the children. + </description> + </method> + <method name="get_self_opacity" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the canvas item self-opacity. + </description> + </method> + <method name="get_transform" qualifiers="const"> + <return type="Matrix32"> + </return> + <description> + </description> + </method> + <method name="get_use_parent_material" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_viewport_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="get_viewport_transform" qualifiers="const"> + <return type="Matrix32"> </return> <description> </description> @@ -7240,28 +7202,37 @@ <description> </description> </method> - <method name="set_material"> - <argument index="0" name="material" type="CanvasItemMaterial"> - </argument> + <method name="hide"> <description> + Hide the CanvasItem currently visible. </description> </method> - <method name="get_material" qualifiers="const"> - <return type="CanvasItemMaterial"> + <method name="is_draw_behind_parent_enabled" qualifiers="const"> + <return type="bool"> </return> <description> + Return whether the item is drawn behind its parent. </description> </method> - <method name="set_use_parent_material"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="is_hidden" qualifiers="const"> + <return type="bool"> + </return> <description> + 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. </description> </method> - <method name="get_use_parent_material" qualifiers="const"> + <method name="is_set_as_toplevel" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return if set as toplevel. See [method set_as_toplevel]. + </description> + </method> + <method name="is_visible" qualifiers="const"> <return type="bool"> </return> <description> + Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. </description> </method> <method name="make_input_local" qualifiers="const"> @@ -7272,26 +7243,95 @@ <description> </description> </method> + <method name="set_as_toplevel"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set as toplevel. This means that it will not inherit transform from parent canvas items. + </description> + </method> + <method name="set_blend_mode"> + <argument index="0" name="blend_mode" type="int"> + </argument> + <description> + Set the blending mode from enum BLEND_MODE_*. + </description> + </method> + <method name="set_draw_behind_parent"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Sets whether the canvas item is drawn behind its parent. + </description> + </method> + <method name="set_hidden"> + <argument index="0" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_light_mask"> + <argument index="0" name="light_mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_material"> + <argument index="0" name="material" type="CanvasItemMaterial"> + </argument> + <description> + </description> + </method> + <method name="set_opacity"> + <argument index="0" name="opacity" type="float"> + </argument> + <description> + Set canvas item opacity. This will affect the canvas item and all the children. + </description> + </method> + <method name="set_self_opacity"> + <argument index="0" name="self_opacity" type="float"> + </argument> + <description> + Set canvas item self-opacity. This does not affect the opacity of children items. + </description> + </method> + <method name="set_use_parent_material"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="show"> + <description> + Show the CanvasItem currently hidden. + </description> + </method> + <method name="update"> + <description> + Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw. + </description> + </method> </methods> <signals> - <signal name="item_rect_changed"> + <signal name="draw"> <description> - 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. </description> </signal> - <signal name="draw"> + <signal name="hide"> <description> - Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. + Emitted when becoming hidden. </description> </signal> - <signal name="visibility_changed"> + <signal name="item_rect_changed"> <description> - Emitted when the visibility (hidden/visible) changes. + Emitted when the item rect has changed. </description> </signal> - <signal name="hide"> + <signal name="visibility_changed"> <description> - Emitted when becoming hidden. + Emitted when the visibility (hidden/visible) changes. </description> </signal> </signals> @@ -7311,6 +7351,9 @@ <constant name="BLEND_MODE_PREMULT_ALPHA" value="4"> Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. </constant> + <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29"> + Canvas item transform has changed. Only received if requested. + </constant> <constant name="NOTIFICATION_DRAW" value="30"> CanvasItem is requested to draw. </constant> @@ -7323,9 +7366,6 @@ <constant name="NOTIFICATION_EXIT_CANVAS" value="33"> Canvas item has exited the canvas. </constant> - <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29"> - Canvas item transform has changed. Only received if requested. - </constant> </constants> </class> <class name="CanvasItemMaterial" inherits="Resource" category="Core"> @@ -7334,29 +7374,35 @@ <description> </description> <methods> - <method name="set_shader"> - <argument index="0" name="shader" type="Shader"> - </argument> - <description> - </description> - </method> <method name="get_shader" qualifiers="const"> <return type="Shader"> </return> <description> </description> </method> - <method name="set_shader_param"> + <method name="get_shader_param" qualifiers="const"> <argument index="0" name="param" type="String"> </argument> - <argument index="1" name="value" type="Variant"> + <description> + </description> + </method> + <method name="get_shading_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_shader"> + <argument index="0" name="shader" type="Shader"> </argument> <description> </description> </method> - <method name="get_shader_param" qualifiers="const"> + <method name="set_shader_param"> <argument index="0" name="param" type="String"> </argument> + <argument index="1" name="value" type="Variant"> + </argument> <description> </description> </method> @@ -7366,12 +7412,6 @@ <description> </description> </method> - <method name="get_shading_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> </methods> <constants> <constant name="SHADING_NORMAL" value="0"> @@ -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). </description> <methods> - <method name="set_layer"> - <argument index="0" name="layer" type="int"> - </argument> - <description> - Set the layer index, determines the draw order, a lower value will be below a higher one. - </description> - </method> <method name="get_layer" qualifiers="const"> <return type="int"> </return> @@ -7424,88 +7457,95 @@ Return the layer index, determines the draw order, a lower value will be below a higher one. </description> </method> - <method name="set_transform"> - <argument index="0" name="transform" type="Matrix32"> - </argument> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Set the base transform for this layer. + Return the base offset for this layer (helper). </description> </method> - <method name="get_transform" qualifiers="const"> - <return type="Matrix32"> + <method name="get_rotation" qualifiers="const"> + <return type="float"> </return> <description> - Return the base transform for this layer. + Return the base rotation for this layer (helper). </description> </method> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> - </argument> + <method name="get_rotationd" qualifiers="const"> + <return type="float"> + </return> <description> - Set the base offset for this layer (helper). + Get rotation of the layer in degree. </description> </method> - <method name="get_offset" qualifiers="const"> + <method name="get_scale" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the base offset for this layer (helper). + Return the base scale for this layer (helper). </description> </method> - <method name="set_rotation"> - <argument index="0" name="radians" type="float"> - </argument> + <method name="get_transform" qualifiers="const"> + <return type="Matrix32"> + </return> <description> - Set the base rotation for this layer (helper). + Return the base transform for this layer. </description> </method> - <method name="get_rotation" qualifiers="const"> - <return type="float"> + <method name="get_viewport" qualifiers="const"> + <return type="RID"> </return> <description> - Return the base rotation for this layer (helper). + Return the viewport RID for this layer. </description> </method> - <method name="set_rotationd"> - <argument index="0" name="degrees" type="float"> + <method name="get_world_2d" qualifiers="const"> + <return type="World2D"> + </return> + <description> + Return the [World2D] used by this layer. + </description> + </method> + <method name="set_layer"> + <argument index="0" name="layer" type="int"> </argument> <description> - Set rotation of the layer in degree. + Set the layer index, determines the draw order, a lower value will be below a higher one. </description> </method> - <method name="get_rotationd" qualifiers="const"> - <return type="float"> - </return> + <method name="set_offset"> + <argument index="0" name="offset" type="Vector2"> + </argument> <description> - Get rotation of the layer in degree. + Set the base offset for this layer (helper). </description> </method> - <method name="set_scale"> - <argument index="0" name="scale" type="Vector2"> + <method name="set_rotation"> + <argument index="0" name="radians" type="float"> </argument> <description> - Set the base scale for this layer (helper). + Set the base rotation for this layer (helper). </description> </method> - <method name="get_scale" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_rotationd"> + <argument index="0" name="degrees" type="float"> + </argument> <description> - Return the base scale for this layer (helper). + Set rotation of the layer in degree. </description> </method> - <method name="get_world_2d" qualifiers="const"> - <return type="World2D"> - </return> + <method name="set_scale"> + <argument index="0" name="scale" type="Vector2"> + </argument> <description> - Return the [World2D] used by this layer. + Set the base scale for this layer (helper). </description> </method> - <method name="get_viewport" qualifiers="const"> - <return type="RID"> - </return> + <method name="set_transform"> + <argument index="0" name="transform" type="Matrix32"> + </argument> <description> - Return the viewport RID for this layer. + Set the base transform for this layer. </description> </method> </methods> @@ -7520,13 +7560,6 @@ CanvasModulate tints the canvas elements using its asigned color </description> <methods> - <method name="set_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - Sets the canvas tint color - </description> - </method> <method name="get_color" qualifiers="const"> <return type="Color"> </return> @@ -7534,6 +7567,13 @@ Gets the canvas tint color </description> </method> + <method name="set_color"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Sets the canvas tint color + </description> + </method> </methods> <constants> </constants> @@ -7546,11 +7586,11 @@ Capsule shape resource, which can be set into a [PhysicsBody] or area. </description> <methods> - <method name="set_radius"> - <argument index="0" name="radius" type="float"> - </argument> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> <description> - Set the capsule radius. + Return the capsule height. </description> </method> <method name="get_radius" qualifiers="const"> @@ -7567,11 +7607,11 @@ Set the capsule height. </description> </method> - <method name="get_height" qualifiers="const"> - <return type="float"> - </return> + <method name="set_radius"> + <argument index="0" name="radius" type="float"> + </argument> <description> - Return the capsule height. + Set the capsule radius. </description> </method> </methods> @@ -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. </description> <methods> - <method name="set_radius"> - <argument index="0" name="radius" type="float"> - </argument> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> <description> - Set the radius of the [CapsuleShape2D]. + Return the height of the [CapsuleShape2D]. </description> </method> <method name="get_radius" qualifiers="const"> @@ -7607,11 +7647,11 @@ Set the height of the [CapsuleShape2D]. </description> </method> - <method name="get_height" qualifiers="const"> - <return type="float"> - </return> + <method name="set_radius"> + <argument index="0" name="radius" type="float"> + </argument> <description> - Return the height of the [CapsuleShape2D]. + Set the radius of the [CapsuleShape2D]. </description> </method> </methods> @@ -7626,13 +7666,6 @@ CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center. </description> <methods> - <method name="set_use_top_left"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - 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). - </description> - </method> <method name="is_using_top_left" qualifiers="const"> <return type="bool"> </return> @@ -7640,6 +7673,13 @@ Should put children to the top left corner instead of center of the container. </description> </method> + <method name="set_use_top_left"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + 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). + </description> + </method> </methods> <constants> </constants> @@ -7658,35 +7698,35 @@ <theme_items> <theme_item name="check_vadjust" type="int"> </theme_item> - <theme_item name="hseparation" type="int"> + <theme_item name="checked" type="Texture"> </theme_item> - <theme_item name="font_color_disabled" type="Color"> + <theme_item name="disabled" type="StyleBox"> </theme_item> - <theme_item name="font_color" type="Color"> + <theme_item name="focus" type="StyleBox"> </theme_item> - <theme_item name="font_color_hover" type="Color"> + <theme_item name="font" type="Font"> </theme_item> - <theme_item name="font_color_pressed" type="Color"> + <theme_item name="font_color" type="Color"> </theme_item> - <theme_item name="radio_checked" type="Texture"> + <theme_item name="font_color_disabled" type="Color"> </theme_item> - <theme_item name="checked" type="Texture"> + <theme_item name="font_color_hover" type="Color"> </theme_item> - <theme_item name="radio_unchecked" type="Texture"> + <theme_item name="font_color_pressed" type="Color"> </theme_item> - <theme_item name="unchecked" type="Texture"> + <theme_item name="hover" type="StyleBox"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="hseparation" type="int"> </theme_item> - <theme_item name="hover" type="StyleBox"> + <theme_item name="normal" type="StyleBox"> </theme_item> <theme_item name="pressed" type="StyleBox"> </theme_item> - <theme_item name="focus" type="StyleBox"> + <theme_item name="radio_checked" type="Texture"> </theme_item> - <theme_item name="disabled" type="StyleBox"> + <theme_item name="radio_unchecked" type="Texture"> </theme_item> - <theme_item name="normal" type="StyleBox"> + <theme_item name="unchecked" type="Texture"> </theme_item> </theme_items> </class> @@ -7704,31 +7744,31 @@ <theme_items> <theme_item name="check_vadjust" type="int"> </theme_item> - <theme_item name="hseparation" type="int"> + <theme_item name="disabled" type="StyleBox"> </theme_item> - <theme_item name="font_color_disabled" type="Color"> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> <theme_item name="font_color_hover" type="Color"> </theme_item> <theme_item name="font_color_pressed" type="Color"> </theme_item> - <theme_item name="off" type="Texture"> - </theme_item> - <theme_item name="on" type="Texture"> - </theme_item> - <theme_item name="font" type="Font"> - </theme_item> <theme_item name="hover" type="StyleBox"> </theme_item> - <theme_item name="pressed" type="StyleBox"> + <theme_item name="hseparation" type="int"> </theme_item> - <theme_item name="focus" type="StyleBox"> + <theme_item name="normal" type="StyleBox"> </theme_item> - <theme_item name="disabled" type="StyleBox"> + <theme_item name="off" type="Texture"> </theme_item> - <theme_item name="normal" type="StyleBox"> + <theme_item name="on" type="Texture"> + </theme_item> + <theme_item name="pressed" type="StyleBox"> </theme_item> </theme_items> </class> @@ -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. </description> <methods> - <method name="set_radius"> - <argument index="0" name="radius" type="float"> - </argument> - <description> - Set the radius of the circle shape. - </description> - </method> <method name="get_radius" qualifiers="const"> <return type="float"> </return> @@ -7754,6 +7787,13 @@ Return the radius of the circle shape. </description> </method> + <method name="set_radius"> + <argument index="0" name="radius" type="float"> + </argument> + <description> + Set the radius of the circle shape. + </description> + </method> </methods> <constants> </constants> @@ -7786,54 +7826,52 @@ <description> </description> </method> - <method name="get_shape_count" qualifiers="const"> - <return type="int"> + <method name="clear_shapes"> + <description> + </description> + </method> + <method name="get_capture_input_on_drag" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_shape"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <argument index="1" name="shape" type="Shape"> - </argument> + <method name="get_rid" qualifiers="const"> + <return type="RID"> + </return> <description> </description> </method> - <method name="set_shape_transform"> + <method name="get_shape" qualifiers="const"> + <return type="Shape"> + </return> <argument index="0" name="shape_idx" type="int"> </argument> - <argument index="1" name="transform" type="Transform"> - </argument> <description> </description> </method> - <method name="set_shape_as_trigger"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> + <method name="get_shape_count" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="is_shape_set_as_trigger" qualifiers="const"> - <return type="bool"> + <method name="get_shape_transform" qualifiers="const"> + <return type="Transform"> </return> <argument index="0" name="shape_idx" type="int"> </argument> <description> </description> </method> - <method name="get_shape" qualifiers="const"> - <return type="Shape"> + <method name="is_ray_pickable" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="shape_idx" type="int"> - </argument> <description> </description> </method> - <method name="get_shape_transform" qualifiers="const"> - <return type="Transform"> + <method name="is_shape_set_as_trigger" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="shape_idx" type="int"> </argument> @@ -7846,7 +7884,9 @@ <description> </description> </method> - <method name="clear_shapes"> + <method name="set_capture_input_on_drag"> + <argument index="0" name="enable" type="bool"> + </argument> <description> </description> </method> @@ -7856,36 +7896,32 @@ <description> </description> </method> - <method name="is_ray_pickable" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_capture_input_on_drag"> - <argument index="0" name="enable" type="bool"> + <method name="set_shape"> + <argument index="0" name="shape_idx" type="int"> + </argument> + <argument index="1" name="shape" type="Shape"> </argument> <description> </description> </method> - <method name="get_capture_input_on_drag" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_shape_as_trigger"> + <argument index="0" name="shape_idx" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> <description> </description> </method> - <method name="get_rid" qualifiers="const"> - <return type="RID"> - </return> + <method name="set_shape_transform"> + <argument index="0" name="shape_idx" type="int"> + </argument> + <argument index="1" name="transform" type="Transform"> + </argument> <description> </description> </method> </methods> <signals> - <signal name="mouse_enter"> - <description> - </description> - </signal> <signal name="input_event"> <argument index="0" name="camera" type="Object"> </argument> @@ -7900,6 +7936,10 @@ <description> </description> </signal> + <signal name="mouse_enter"> + <description> + </description> + </signal> <signal name="mouse_exit"> <description> </description> @@ -7936,38 +7976,16 @@ Add a [Shape2D] to the collision body, with a given custom transform. </description> </method> - <method name="get_shape_count" qualifiers="const"> - <return type="int"> - </return> - <description> - 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]. - </description> - </method> - <method name="set_shape"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <argument index="1" name="shape" type="Shape"> - </argument> - <description> - Change a shape in the collision body. - </description> - </method> - <method name="set_shape_transform"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <argument index="1" name="transform" type="Matrix32"> - </argument> + <method name="clear_shapes"> <description> - Change the shape transform in the collision body. + Remove all shapes. </description> </method> - <method name="set_shape_as_trigger"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> + <method name="get_rid" qualifiers="const"> + <return type="RID"> + </return> <description> - 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. </description> </method> <method name="get_shape" qualifiers="const"> @@ -7979,6 +7997,13 @@ Return the shape in the given index. </description> </method> + <method name="get_shape_count" qualifiers="const"> + <return type="int"> + </return> + <description> + 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]. + </description> + </method> <method name="get_shape_transform" qualifiers="const"> <return type="Matrix32"> </return> @@ -7988,6 +8013,13 @@ Return the shape transform in the given index. </description> </method> + <method name="is_pickable" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this object is pickable. + </description> + </method> <method name="is_shape_set_as_trigger" qualifiers="const"> <return type="bool"> </return> @@ -8004,39 +8036,42 @@ Remove the shape in the given index. </description> </method> - <method name="clear_shapes"> + <method name="set_pickable"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> - Remove all shapes. + 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. </description> </method> - <method name="get_rid" qualifiers="const"> - <return type="RID"> - </return> + <method name="set_shape"> + <argument index="0" name="shape_idx" type="int"> + </argument> + <argument index="1" name="shape" type="Shape"> + </argument> <description> - Return the RID of this object. + Change a shape in the collision body. </description> </method> - <method name="set_pickable"> - <argument index="0" name="enabled" type="bool"> + <method name="set_shape_as_trigger"> + <argument index="0" name="shape_idx" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> </argument> <description> - 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. + 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). </description> </method> - <method name="is_pickable" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_shape_transform"> + <argument index="0" name="shape_idx" type="int"> + </argument> + <argument index="1" name="transform" type="Matrix32"> + </argument> <description> - Return whether this object is pickable. + Change the shape transform in the collision body. </description> </method> </methods> <signals> - <signal name="mouse_enter"> - <description> - This event fires only once when the mouse pointer enters any shape of this object. - </description> - </signal> <signal name="input_event"> <argument index="0" name="viewport" type="Object"> </argument> @@ -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. </description> </signal> + <signal name="mouse_enter"> + <description> + This event fires only once when the mouse pointer enters any shape of this object. + </description> + </signal> <signal name="mouse_exit"> <description> This event fires only once when the mouse pointer exits all shapes of this object. @@ -8063,21 +8103,21 @@ <description> </description> <methods> - <method name="set_build_mode"> - <argument index="0" name="build_mode" type="int"> - </argument> + <method name="get_build_mode" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_build_mode" qualifiers="const"> + <method name="get_collision_object_first_shape" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="set_depth"> - <argument index="0" name="depth" type="float"> - </argument> + <method name="get_collision_object_last_shape" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> @@ -8087,27 +8127,27 @@ <description> </description> </method> - <method name="set_polygon"> - <argument index="0" name="polygon" type="Vector2Array"> - </argument> - <description> - </description> - </method> <method name="get_polygon" qualifiers="const"> <return type="Vector2Array"> </return> <description> </description> </method> - <method name="get_collision_object_first_shape" qualifiers="const"> - <return type="int"> - </return> + <method name="set_build_mode"> + <argument index="0" name="build_mode" type="int"> + </argument> <description> </description> </method> - <method name="get_collision_object_last_shape" qualifiers="const"> - <return type="int"> - </return> + <method name="set_depth"> + <argument index="0" name="depth" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_polygon"> + <argument index="0" name="polygon" type="Vector2Array"> + </argument> <description> </description> </method> @@ -8123,40 +8163,34 @@ 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. </description> <methods> - <method name="set_polygon"> - <argument index="0" name="polygon" type="Vector2Array"> - </argument> - <description> - 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. - </description> - </method> - <method name="get_polygon" qualifiers="const"> - <return type="Vector2Array"> + <method name="get_build_mode" qualifiers="const"> + <return type="int"> </return> <description> - Return the list of points that define the polygon. + Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). </description> </method> - <method name="set_build_mode"> - <argument index="0" name="build_mode" type="int"> - </argument> + <method name="get_collision_object_first_shape" qualifiers="const"> + <return type="int"> + </return> <description> - Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). + Return the index of the first shape generated by the editor. + When [code]build_mode[/code] is set to generate convex polygons, the shape shown in the editor may be decomposed into many convex polygons. In that case, a range of indexes is needed to directly access the [Shape2D]. + When [code]build_mode[/code] is set to generate concave polygons, there is only one [Shape2D] generated, so the start index and the end index are the same. </description> </method> - <method name="get_build_mode" qualifiers="const"> + <method name="get_collision_object_last_shape" qualifiers="const"> <return type="int"> </return> <description> - Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). + Return the index of the last shape generated by the editor. </description> </method> - <method name="set_trigger"> - <argument index="0" name="trigger" type="bool"> - </argument> + <method name="get_polygon" qualifiers="const"> + <return type="Vector2Array"> + </return> <description> - 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 the list of points that define the polygon. </description> </method> <method name="is_trigger" qualifiers="const"> @@ -8166,20 +8200,26 @@ Return whether this polygon is a trigger. </description> </method> - <method name="get_collision_object_first_shape" qualifiers="const"> - <return type="int"> - </return> + <method name="set_build_mode"> + <argument index="0" name="build_mode" type="int"> + </argument> <description> - Return the index of the first shape generated by the editor. - When [code]build_mode[/code] is set to generate convex polygons, the shape shown in the editor may be decomposed into many convex polygons. In that case, a range of indexes is needed to directly access the [Shape2D]. - When [code]build_mode[/code] is set to generate concave polygons, there is only one [Shape2D] generated, so the start index and the end index are the same. + Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). </description> </method> - <method name="get_collision_object_last_shape" qualifiers="const"> - <return type="int"> - </return> + <method name="set_polygon"> + <argument index="0" name="polygon" type="Vector2Array"> + </argument> <description> - Return the index of the last shape generated by the editor. + 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. + </description> + </method> + <method name="set_trigger"> + <argument index="0" name="trigger" type="bool"> + </argument> + <description> + 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). </description> </method> </methods> @@ -8192,15 +8232,9 @@ <description> </description> <methods> - <method name="resource_changed"> - <argument index="0" name="resource" type="Object"> - </argument> - <description> - </description> - </method> - <method name="set_shape"> - <argument index="0" name="shape" type="Object"> - </argument> + <method name="get_collision_object_shape_index" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> @@ -8210,12 +8244,6 @@ <description> </description> </method> - <method name="set_trigger"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> <method name="is_trigger" qualifiers="const"> <return type="bool"> </return> @@ -8226,9 +8254,21 @@ <description> </description> </method> - <method name="get_collision_object_shape_index" qualifiers="const"> - <return type="int"> - </return> + <method name="resource_changed"> + <argument index="0" name="resource" type="Object"> + </argument> + <description> + </description> + </method> + <method name="set_shape"> + <argument index="0" name="shape" type="Object"> + </argument> + <description> + </description> + </method> + <method name="set_trigger"> + <argument index="0" name="enable" type="bool"> + </argument> <description> </description> </method> @@ -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. </description> <methods> - <method name="set_shape"> - <argument index="0" name="shape" type="Object"> - </argument> + <method name="get_collision_object_shape_index" qualifiers="const"> + <return type="int"> + </return> <description> - 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]. </description> </method> <method name="get_shape" qualifiers="const"> @@ -8258,13 +8298,6 @@ Return this shape's [Shape2D]. </description> </method> - <method name="set_trigger"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - 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). - </description> - </method> <method name="is_trigger" qualifiers="const"> <return type="bool"> </return> @@ -8272,11 +8305,18 @@ Return whether this shape is a trigger. </description> </method> - <method name="get_collision_object_shape_index" qualifiers="const"> - <return type="int"> - </return> + <method name="set_shape"> + <argument index="0" name="shape" type="Object"> + </argument> <description> - 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. + </description> + </method> + <method name="set_trigger"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + 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). </description> </method> </methods> @@ -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. </description> <methods> + <method name="Color"> + <return type="Color"> + </return> + <argument index="0" name="r" type="float"> + </argument> + <argument index="1" name="g" type="float"> + </argument> + <argument index="2" name="b" type="float"> + </argument> + <argument index="3" name="a" type="float"> + </argument> + <description> + Construct the color from an RGBA profile. + </description> + </method> + <method name="Color"> + <return type="Color"> + </return> + <argument index="0" name="r" type="float"> + </argument> + <argument index="1" name="g" type="float"> + </argument> + <argument index="2" name="b" type="float"> + </argument> + <description> + Construct the color from an RGBA profile. + </description> + </method> + <method name="Color"> + <return type="Color"> + </return> + <argument index="0" name="from" type="int"> + </argument> + <description> + Construct the color from an RGBA profile. + </description> + </method> + <method name="Color"> + <return type="Color"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <description> + Construct the color from an RGBA profile. + </description> + </method> <method name="blend"> <return type="Color"> </return> @@ -8355,86 +8441,40 @@ Return the HTML hexadecimal color string. </description> </method> - <method name="Color"> - <return type="Color"> - </return> - <argument index="0" name="r" type="float"> - </argument> - <argument index="1" name="g" type="float"> - </argument> - <argument index="2" name="b" type="float"> - </argument> - <argument index="3" name="a" type="float"> - </argument> - <description> - Construct the color from an RGBA profile. - </description> - </method> - <method name="Color"> - <return type="Color"> - </return> - <argument index="0" name="r" type="float"> - </argument> - <argument index="1" name="g" type="float"> - </argument> - <argument index="2" name="b" type="float"> - </argument> - <description> - Construct the color from an RGBA profile. - </description> - </method> - <method name="Color"> - <return type="Color"> - </return> - <argument index="0" name="from" type="int"> - </argument> - <description> - Construct the color from an RGBA profile. - </description> - </method> - <method name="Color"> - <return type="Color"> - </return> - <argument index="0" name="from" type="String"> - </argument> - <description> - Construct the color from an RGBA profile. - </description> - </method> </methods> <members> - <member name="r" type="float"> - Red (0 to 1) + <member name="a" type="float"> + Alpha (0 to 1) </member> - <member name="g" type="float"> - Green (0 to 1) + <member name="a8" type="int"> + Alpha (0 to 255) </member> <member name="b" type="float"> Blue (0 to 1) </member> - <member name="a" type="float"> - Alpha (0 to 1) + <member name="b8" type="int"> + Blue (0 to 255) + </member> + <member name="g" type="float"> + Green (0 to 1) + </member> + <member name="g8" type="int"> + Green (0 to 255) </member> <member name="h" type="float"> Hue (0 to 1) </member> - <member name="s" type="float"> - Saturation (0 to 1) - </member> - <member name="v" type="float"> - Value (0 to 1) + <member name="r" type="float"> + Red (0 to 1) </member> <member name="r8" type="int"> Red (0 to 255) </member> - <member name="g8" type="int"> - Green (0 to 255) - </member> - <member name="b8" type="int"> - Blue (0 to 255) + <member name="s" type="float"> + Saturation (0 to 1) </member> - <member name="a8" type="int"> - Alpha (0 to 255) + <member name="v" type="float"> + Value (0 to 1) </member> </members> <constants> @@ -8448,6 +8488,15 @@ Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory. </description> <methods> + <method name="ColorArray"> + <return type="ColorArray"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Create from a generic array. + </description> + </method> <method name="push_back"> <argument index="0" name="color" type="Color"> </argument> @@ -8478,15 +8527,6 @@ Return the array size. </description> </method> - <method name="ColorArray"> - <return type="ColorArray"> - </return> - <argument index="0" name="from" type="Array"> - </argument> - <description> - Create from a generic array. - </description> - </method> </methods> <constants> </constants> @@ -8499,11 +8539,11 @@ This is a simple color picker [Control]. It's useful for selecting a color from an RGB/RGBA colorspace. </description> <methods> - <method name="set_color"> - <argument index="0" name="color" type="Color"> + <method name="add_preset"> + <argument index="0" name="arg0" type="Color"> </argument> <description> - 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. </description> </method> <method name="get_color" qualifiers="const"> @@ -8513,11 +8553,11 @@ Return the current (edited) color. </description> </method> - <method name="set_raw_mode"> - <argument index="0" name="mode" type="bool"> - </argument> + <method name="is_editing_alpha" qualifiers="const"> + <return type="bool"> + </return> <description> - 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. </description> </method> <method name="is_raw_mode" qualifiers="const"> @@ -8527,25 +8567,25 @@ Returns whether this color picker is in raw mode or not </description> </method> - <method name="set_edit_alpha"> - <argument index="0" name="show" type="bool"> + <method name="set_color"> + <argument index="0" name="color" type="Color"> </argument> <description> - Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. + Select the current color. </description> </method> - <method name="is_editing_alpha" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_edit_alpha"> + <argument index="0" name="show" type="bool"> + </argument> <description> - Returns whether the color has transparency or not. + Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. </description> </method> - <method name="add_preset"> - <argument index="0" name="arg0" type="Color"> + <method name="set_raw_mode"> + <argument index="0" name="mode" type="bool"> </argument> <description> - Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. + When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255. </description> </method> </methods> @@ -8561,20 +8601,20 @@ <constants> </constants> <theme_items> - <theme_item name="value_width" type="int"> - </theme_item> - <theme_item name="value_height" type="int"> + <theme_item name="add_preset" type="Texture"> </theme_item> <theme_item name="color_width" type="int"> </theme_item> - <theme_item name="label_width" type="int"> - </theme_item> <theme_item name="hseparator" type="int"> </theme_item> - <theme_item name="add_preset" type="Texture"> + <theme_item name="label_width" type="int"> </theme_item> <theme_item name="screen_picker" type="Texture"> </theme_item> + <theme_item name="value_height" type="int"> + </theme_item> + <theme_item name="value_width" type="int"> + </theme_item> </theme_items> </class> <class name="ColorPickerButton" inherits="Button" category="Core"> @@ -8585,13 +8625,6 @@ Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility </description> <methods> - <method name="set_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - Sets the current color - </description> - </method> <method name="get_color" qualifiers="const"> <return type="Color"> </return> @@ -8599,11 +8632,10 @@ Gets the current color </description> </method> - <method name="set_edit_alpha"> - <argument index="0" name="show" type="bool"> - </argument> + <method name="get_picker"> + <return type="ColorPicker"> + </return> <description> - See [method ColorPicker.set_edit_alpha] </description> </method> <method name="is_editing_alpha" qualifiers="const"> @@ -8613,6 +8645,20 @@ See [method ColorPicker.is_edit_alpha] </description> </method> + <method name="set_color"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Sets the current color + </description> + </method> + <method name="set_edit_alpha"> + <argument index="0" name="show" type="bool"> + </argument> + <description> + See [method ColorPicker.set_edit_alpha] + </description> + </method> </methods> <signals> <signal name="color_changed"> @@ -8626,28 +8672,28 @@ <constants> </constants> <theme_items> - <theme_item name="hseparation" type="int"> + <theme_item name="disabled" type="StyleBox"> </theme_item> - <theme_item name="font_color_disabled" type="Color"> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> <theme_item name="font_color_hover" type="Color"> </theme_item> <theme_item name="font_color_pressed" type="Color"> </theme_item> - <theme_item name="font" type="Font"> - </theme_item> <theme_item name="hover" type="StyleBox"> </theme_item> - <theme_item name="pressed" type="StyleBox"> - </theme_item> - <theme_item name="focus" type="StyleBox"> - </theme_item> - <theme_item name="disabled" type="StyleBox"> + <theme_item name="hseparation" type="int"> </theme_item> <theme_item name="normal" type="StyleBox"> </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> </theme_items> </class> <class name="ColorRamp" inherits="Resource" category="Core"> @@ -8667,20 +8713,20 @@ Adds the specified color to the end of the ramp, with the specified offset </description> </method> - <method name="remove_point"> - <argument index="0" name="offset" type="int"> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="point" type="int"> </argument> <description> - Removes the color at the index [i]offset[/i] + Returns the color of the ramp color at index [i]point[/i] </description> </method> - <method name="set_offset"> - <argument index="0" name="point" type="int"> - </argument> - <argument index="1" name="offset" type="float"> - </argument> + <method name="get_colors" qualifiers="const"> + <return type="ColorArray"> + </return> <description> - Sets the offset for the ramp color at index [i]point[/i] + Returns the colors in the ramp </description> </method> <method name="get_offset" qualifiers="const"> @@ -8692,22 +8738,18 @@ Returns the offset of the ramp color at index [i]point[/i] </description> </method> - <method name="set_color"> - <argument index="0" name="point" type="int"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> + <method name="get_offsets" qualifiers="const"> + <return type="RealArray"> + </return> <description> - Sets the color of the ramp color at index [i]point[/i] + Returns the offsets for the colors in this ramp </description> </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> + <method name="get_point_count" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="point" type="int"> - </argument> <description> - Returns the color of the ramp color at index [i]point[/i] + Returns the number of colors in the ramp </description> </method> <method name="interpolate"> @@ -8719,25 +8761,20 @@ Returns the interpolated color specified by [i]offset[/i] </description> </method> - <method name="get_point_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the number of colors in the ramp - </description> - </method> - <method name="set_offsets"> - <argument index="0" name="offsets" type="RealArray"> + <method name="remove_point"> + <argument index="0" name="offset" type="int"> </argument> <description> - 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] </description> </method> - <method name="get_offsets" qualifiers="const"> - <return type="RealArray"> - </return> + <method name="set_color"> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> <description> - Returns the offsets for the colors in this ramp + Sets the color of the ramp color at index [i]point[/i] </description> </method> <method name="set_colors"> @@ -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. </description> </method> - <method name="get_colors" qualifiers="const"> - <return type="ColorArray"> - </return> + <method name="set_offset"> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="offset" type="float"> + </argument> <description> - Returns the colors in the ramp + Sets the offset for the ramp color at index [i]point[/i] + </description> + </method> + <method name="set_offsets"> + <argument index="0" name="offsets" type="RealArray"> + </argument> + <description> + 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. </description> </method> </methods> @@ -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. </description> <methods> - <method name="set_faces"> - <argument index="0" name="faces" type="Vector3Array"> - </argument> - <description> - Set the faces (an array of triangles). - </description> - </method> <method name="get_faces" qualifiers="const"> <return type="Vector3Array"> </return> @@ -8780,6 +8819,13 @@ Return the faces (an array of triangles). </description> </method> + <method name="set_faces"> + <argument index="0" name="faces" type="Vector3Array"> + </argument> + <description> + Set the faces (an array of triangles). + </description> + </method> </methods> <constants> </constants> @@ -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. </description> <methods> - <method name="set_segments"> - <argument index="0" name="segments" type="Vector2Array"> - </argument> - <description> - Set the array of segments. - </description> - </method> <method name="get_segments" qualifiers="const"> <return type="Vector2Array"> </return> @@ -8807,6 +8846,13 @@ Return the array of segments. </description> </method> + <method name="set_segments"> + <argument index="0" name="segments" type="Vector2Array"> + </argument> + <description> + Set the array of segments. + </description> + </method> </methods> <constants> </constants> @@ -8817,19 +8863,19 @@ <description> </description> <methods> - <method name="set_param"> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="param" type="int"> </argument> - <argument index="1" name="value" type="float"> - </argument> <description> </description> </method> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> + <method name="set_param"> <argument index="0" name="param" type="int"> </argument> + <argument index="1" name="value" type="float"> + </argument> <description> </description> </method> @@ -8870,15 +8916,20 @@ [/codeblock] </description> <methods> - <method name="set_value"> + <method name="get_section_keys" qualifiers="const"> + <return type="StringArray"> + </return> <argument index="0" name="section" type="String"> </argument> - <argument index="1" name="key" type="String"> - </argument> - <argument index="2" name="value" type="Variant"> - </argument> <description> - 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. + </description> + </method> + <method name="get_sections" qualifiers="const"> + <return type="StringArray"> + </return> + <description> + Return an array of all defined section identifiers. </description> </method> <method name="get_value" qualifiers="const"> @@ -8914,22 +8965,6 @@ Check if the specified section-key pair exists. </description> </method> - <method name="get_sections" qualifiers="const"> - <return type="StringArray"> - </return> - <description> - Return an array of all defined section identifiers. - </description> - </method> - <method name="get_section_keys" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="section" type="String"> - </argument> - <description> - Return an array of all defined key identifiers in the specified section. - </description> - </method> <method name="load"> <return type="Error"> </return> @@ -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). </description> </method> + <method name="set_value"> + <argument index="0" name="section" type="String"> + </argument> + <argument index="1" name="key" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + 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). + </description> + </method> </methods> <constants> </constants> @@ -8981,11 +9027,6 @@ A Control can inherit this to create custom container classes. </description> <methods> - <method name="queue_sort"> - <description> - Queue resort of the contained children. This is called automatically anyway, but can be called upon request. - </description> - </method> <method name="fit_child_in_rect"> <argument index="0" name="child" type="Control"> </argument> @@ -8995,6 +9036,11 @@ Fit a child control in a given rect. This is mainly a helper for creating custom container classes. </description> </method> + <method name="queue_sort"> + <description> + Queue resort of the contained children. This is called automatically anyway, but can be called upon request. + </description> + </method> </methods> <signals> <signal name="sort_children"> @@ -9030,221 +9076,197 @@ Called when an input event reaches the control. </description> </method> - <method name="can_drop_data" qualifiers="virtual"> - <return type="bool"> - </return> - <argument index="0" name="pos" type="Vector2"> - </argument> - <argument index="1" name="data" type="Variant"> - </argument> + <method name="accept_event"> <description> + 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]. </description> </method> - <method name="drop_data" qualifiers="virtual"> - <argument index="0" name="pos" type="Vector2"> + <method name="add_color_override"> + <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="data" type="Variant"> + <argument index="1" name="color" type="Color"> </argument> <description> </description> </method> - <method name="get_drag_data" qualifiers="virtual"> - <return type="Object"> - </return> - <argument index="0" name="pos" type="Vector2"> + <method name="add_constant_override"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="constant" type="int"> </argument> <description> + Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared. </description> </method> - <method name="get_minimum_size" qualifiers="virtual"> - <return type="Vector2"> - </return> - <description> - Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. - </description> - </method> - <method name="accept_event"> - <description> - 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]. - </description> - </method> - <method name="get_minimum_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. - </description> - </method> - <method name="get_combined_minimum_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_anchor"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="anchor_mode" type="int"> + <method name="add_font_override"> + <argument index="0" name="name" type="String"> </argument> - <argument index="2" name="keep_margin" type="bool" default="false"> + <argument index="1" name="font" type="Font"> </argument> <description> - 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. + Override a single font (font) in the theme of this Control. If font is empty, override is cleared. </description> </method> - <method name="get_anchor" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="margin" type="int"> + <method name="add_icon_override"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="texture" type="Texture"> </argument> <description> - Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). + Override a single icon ([Texture]) in the theme of this Control. If texture is empty, override is cleared. </description> </method> - <method name="set_margin"> - <argument index="0" name="margin" type="int"> + <method name="add_shader_override"> + <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="offset" type="float"> + <argument index="1" name="shader" type="Shader"> </argument> <description> - 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. </description> </method> - <method name="set_anchor_and_margin"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="anchor_mode" type="int"> + <method name="add_style_override"> + <argument index="0" name="name" type="String"> </argument> - <argument index="2" name="offset" type="float"> + <argument index="1" name="stylebox" type="StyleBox"> </argument> <description> - 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]). + Override a single stylebox ([Stylebox]) in the theme of this Control. If stylebox is empty, override is cleared. </description> </method> - <method name="set_begin"> + <method name="can_drop_data" qualifiers="virtual"> + <return type="bool"> + </return> <argument index="0" name="pos" type="Vector2"> </argument> - <description> - Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). - </description> - </method> - <method name="set_end"> - <argument index="0" name="pos" type="Vector2"> + <argument index="1" name="data" type="Variant"> </argument> <description> - Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]). </description> </method> - <method name="set_pos"> + <method name="drop_data" qualifiers="virtual"> <argument index="0" name="pos" type="Vector2"> </argument> - <description> - 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]). - </description> - </method> - <method name="set_size"> - <argument index="0" name="size" type="Vector2"> + <argument index="1" name="data" type="Variant"> </argument> <description> - Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]). </description> </method> - <method name="set_custom_minimum_size"> - <argument index="0" name="size" type="Vector2"> + <method name="force_drag"> + <argument index="0" name="data" type="Variant"> + </argument> + <argument index="1" name="preview" type="Object"> </argument> <description> </description> </method> - <method name="set_global_pos"> - <argument index="0" name="pos" type="Vector2"> + <method name="get_anchor" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="margin" type="int"> </argument> <description> - 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]). + Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). </description> </method> - <method name="set_rotation"> - <argument index="0" name="radians" type="float"> - </argument> + <method name="get_begin" qualifiers="const"> + <return type="Vector2"> + </return> <description> </description> </method> - <method name="set_rotation_deg"> - <argument index="0" name="degrees" type="float"> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> </method> - <method name="set_scale"> - <argument index="0" name="scale" type="Vector2"> - </argument> + <method name="get_combined_minimum_size" qualifiers="const"> + <return type="Vector2"> + </return> <description> </description> </method> - <method name="get_margin" qualifiers="const"> - <return type="float"> + <method name="get_constant" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="margin" type="int"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> </argument> <description> - 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. </description> </method> - <method name="get_begin" qualifiers="const"> - <return type="Vector2"> + <method name="get_cursor_shape" qualifiers="const"> + <return type="int"> </return> + <argument index="0" name="pos" type="Vector2" default="Vector2(0,0)"> + </argument> <description> + Return the cursor shape at a certain position in the control. </description> </method> - <method name="get_end" qualifiers="const"> + <method name="get_custom_minimum_size" qualifiers="const"> <return type="Vector2"> </return> <description> - Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). </description> </method> - <method name="get_pos" qualifiers="const"> - <return type="Vector2"> + <method name="get_default_cursor_shape" qualifiers="const"> + <return type="int"> </return> <description> - Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. + Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes. </description> </method> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> + <method name="get_drag_data" qualifiers="virtual"> + <return type="Object"> </return> + <argument index="0" name="pos" type="Vector2"> + </argument> <description> - 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]). </description> </method> - <method name="get_rotation" qualifiers="const"> - <return type="float"> + <method name="get_end" qualifiers="const"> + <return type="Vector2"> </return> <description> + Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). </description> </method> - <method name="get_rotation_deg" qualifiers="const"> - <return type="float"> + <method name="get_focus_mode" qualifiers="const"> + <return type="int"> </return> <description> + Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]). </description> </method> - <method name="get_scale" qualifiers="const"> - <return type="Vector2"> + <method name="get_focus_neighbour" qualifiers="const"> + <return type="NodePath"> </return> + <argument index="0" name="margin" type="int"> + </argument> <description> + 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. </description> </method> - <method name="get_custom_minimum_size" qualifiers="const"> - <return type="Vector2"> + <method name="get_focus_owner" qualifiers="const"> + <return type="Control"> </return> <description> + Return which control is owning the keyboard focus, or null if no one. </description> </method> - <method name="get_parent_area_size" qualifiers="const"> - <return type="Vector2"> + <method name="get_font" qualifiers="const"> + <return type="Font"> </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> <description> </description> </method> @@ -9255,13 +9277,6 @@ Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. </description> </method> - <method name="get_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - 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]). - </description> - </method> <method name="get_global_rect" qualifiers="const"> <return type="Rect2"> </return> @@ -9269,105 +9284,112 @@ 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]). </description> </method> - <method name="set_area_as_parent_rect"> - <argument index="0" name="margin" type="int" default="0"> - </argument> + <method name="get_h_size_flags" qualifiers="const"> + <return type="int"> + </return> <description> - 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]). + Hint for containers, return horizontal positioning flags. </description> </method> - <method name="show_modal"> - <argument index="0" name="exclusive" type="bool" default="false"> + <method name="get_icon" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> </argument> <description> - 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. </description> </method> - <method name="set_focus_mode"> - <argument index="0" name="mode" type="int"> + <method name="get_margin" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int"> </argument> <description> - 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. + 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. </description> </method> - <method name="get_focus_mode" qualifiers="const"> - <return type="int"> + <method name="get_minimum_size" qualifiers="const"> + <return type="Vector2"> </return> <description> - Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]). + Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. </description> </method> - <method name="has_focus" qualifiers="const"> - <return type="bool"> + <method name="get_minimum_size" qualifiers="virtual"> + <return type="Vector2"> </return> <description> - Return whether the Control is the current focused control (see [method set_focus_mode]). + Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. </description> </method> - <method name="grab_focus"> + <method name="get_parent_area_size" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Steal the focus from another control and become the focused control (see [method set_focus_mode]). </description> </method> - <method name="release_focus"> + <method name="get_parent_control" qualifiers="const"> + <return type="Control"> + </return> <description> - Give up the focus, no other control will be able to receive keyboard input. </description> </method> - <method name="get_focus_owner" qualifiers="const"> - <return type="Control"> + <method name="get_pos" qualifiers="const"> + <return type="Vector2"> </return> <description> - 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. </description> </method> - <method name="set_h_size_flags"> - <argument index="0" name="flags" type="int"> - </argument> + <method name="get_rect" qualifiers="const"> + <return type="Rect2"> + </return> <description> - Hint for containers, set horizontal positioning flags. + 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]). </description> </method> - <method name="get_h_size_flags" qualifiers="const"> - <return type="int"> + <method name="get_rotation" qualifiers="const"> + <return type="float"> </return> <description> - Hint for containers, return horizontal positioning flags. </description> </method> - <method name="set_stretch_ratio"> - <argument index="0" name="ratio" type="float"> - </argument> + <method name="get_rotation_deg" qualifiers="const"> + <return type="float"> + </return> <description> - 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. </description> </method> - <method name="get_stretch_ratio" qualifiers="const"> - <return type="float"> + <method name="get_scale" qualifiers="const"> + <return type="Vector2"> </return> <description> - 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. </description> </method> - <method name="set_v_size_flags"> - <argument index="0" name="flags" type="int"> - </argument> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Hint for containers, set vertical positioning flags. + 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]). </description> </method> - <method name="get_v_size_flags" qualifiers="const"> - <return type="int"> + <method name="get_stretch_ratio" qualifiers="const"> + <return type="float"> </return> <description> - Hint for containers, return vertical positioning flags. + 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. </description> </method> - <method name="set_theme"> - <argument index="0" name="theme" type="Theme"> + <method name="get_stylebox" qualifiers="const"> + <return type="StyleBox"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> </argument> <description> - Override whole the [Theme] for this Control and all its children controls. </description> </method> <method name="get_theme" qualifiers="const"> @@ -9377,60 +9399,51 @@ Return a [Theme] override, if one exists (see [method set_theme]). </description> </method> - <method name="add_icon_override"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="texture" type="Texture"> + <method name="get_tooltip" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="atpos" type="Vector2" default="Vector2(0,0)"> </argument> <description> - Override a single icon ([Texture]) in the theme of this Control. If texture is empty, override is cleared. + Return the tooltip, which will appear when the cursor is resting over this control. </description> </method> - <method name="add_shader_override"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="shader" type="Shader"> - </argument> + <method name="get_v_size_flags" qualifiers="const"> + <return type="int"> + </return> <description> + Hint for containers, return vertical positioning flags. </description> </method> - <method name="add_style_override"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="stylebox" type="StyleBox"> - </argument> + <method name="grab_click_focus"> <description> - Override a single stylebox ([Stylebox]) in the theme of this Control. If stylebox is empty, override is cleared. </description> </method> - <method name="add_font_override"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="font" type="Font"> - </argument> + <method name="grab_focus"> <description> - Override a single font (font) in the theme of this Control. If font is empty, override is cleared. + Steal the focus from another control and become the focused control (see [method set_focus_mode]). </description> </method> - <method name="add_color_override"> + <method name="has_color" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="color" type="Color"> + <argument index="1" name="type" type="String" default=""""> </argument> <description> </description> </method> - <method name="add_constant_override"> + <method name="has_color_override" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="constant" type="int"> - </argument> <description> - Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared. </description> </method> - <method name="get_icon" qualifiers="const"> - <return type="Texture"> + <method name="has_constant" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="name" type="String"> </argument> @@ -9439,28 +9452,23 @@ <description> </description> </method> - <method name="get_stylebox" qualifiers="const"> - <return type="StyleBox"> + <method name="has_constant_override" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> <description> </description> </method> - <method name="get_font" qualifiers="const"> - <return type="Font"> + <method name="has_focus" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> <description> + Return whether the Control is the current focused control (see [method set_focus_mode]). </description> </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> + <method name="has_font" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="name" type="String"> </argument> @@ -9469,25 +9477,25 @@ <description> </description> </method> - <method name="get_constant" qualifiers="const"> - <return type="int"> + <method name="has_font_override" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> <description> </description> </method> - <method name="has_icon_override" qualifiers="const"> + <method name="has_icon" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="name" type="String"> </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> <description> </description> </method> - <method name="has_stylebox_override" qualifiers="const"> + <method name="has_icon_override" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="name" type="String"> @@ -9495,15 +9503,17 @@ <description> </description> </method> - <method name="has_font_override" qualifiers="const"> + <method name="has_stylebox" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="name" type="String"> </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> <description> </description> </method> - <method name="has_color_override" qualifiers="const"> + <method name="has_stylebox_override" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="name" type="String"> @@ -9511,84 +9521,70 @@ <description> </description> </method> - <method name="has_constant_override" qualifiers="const"> + <method name="is_ignoring_mouse" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="name" type="String"> - </argument> <description> + Return if the control is ignoring mouse events (even touchpad events send mouse events). </description> </method> - <method name="has_icon" qualifiers="const"> + <method name="is_stopping_mouse" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> <description> </description> </method> - <method name="has_stylebox" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> + <method name="minimum_size_changed"> <description> </description> </method> - <method name="has_font" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> + <method name="release_focus"> <description> + Give up the focus, no other control will be able to receive keyboard input. </description> </method> - <method name="has_color" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> + <method name="set_anchor"> + <argument index="0" name="margin" type="int"> </argument> - <argument index="1" name="type" type="String" default=""""> + <argument index="1" name="anchor_mode" type="int"> + </argument> + <argument index="2" name="keep_margin" type="bool" default="false"> </argument> <description> + 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. </description> </method> - <method name="has_constant" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> + <method name="set_anchor_and_margin"> + <argument index="0" name="margin" type="int"> </argument> - <argument index="1" name="type" type="String" default=""""> + <argument index="1" name="anchor_mode" type="int"> + </argument> + <argument index="2" name="offset" type="float"> </argument> <description> + 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]). </description> </method> - <method name="get_parent_control" qualifiers="const"> - <return type="Control"> - </return> + <method name="set_area_as_parent_rect"> + <argument index="0" name="margin" type="int" default="0"> + </argument> <description> + 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]). </description> </method> - <method name="set_tooltip"> - <argument index="0" name="tooltip" type="String"> + <method name="set_begin"> + <argument index="0" name="pos" type="Vector2"> </argument> <description> - Set a tooltip, which will appear when the cursor is resting over this control. + Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). </description> </method> - <method name="get_tooltip" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="atpos" type="Vector2" default="Vector2(0,0)"> + <method name="set_custom_minimum_size"> + <argument index="0" name="size" type="Vector2"> </argument> <description> - Return the tooltip, which will appear when the cursor is resting over this control. </description> </method> <method name="set_default_cursor_shape"> @@ -9598,20 +9594,30 @@ Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes. </description> </method> - <method name="get_default_cursor_shape" qualifiers="const"> - <return type="int"> - </return> + <method name="set_drag_forwarding"> + <argument index="0" name="target" type="Control"> + </argument> <description> - Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes. </description> </method> - <method name="get_cursor_shape" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="pos" type="Vector2" default="Vector2(0,0)"> + <method name="set_drag_preview"> + <argument index="0" name="control" type="Control"> </argument> <description> - Return the cursor shape at a certain position in the control. + </description> + </method> + <method name="set_end"> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]). + </description> + </method> + <method name="set_focus_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + 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. </description> </method> <method name="set_focus_neighbour"> @@ -9623,13 +9629,18 @@ 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. </description> </method> - <method name="get_focus_neighbour" qualifiers="const"> - <return type="NodePath"> - </return> - <argument index="0" name="margin" type="int"> + <method name="set_global_pos"> + <argument index="0" name="pos" type="Vector2"> </argument> <description> - 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. + 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]). + </description> + </method> + <method name="set_h_size_flags"> + <argument index="0" name="flags" type="int"> + </argument> + <description> + Hint for containers, set horizontal positioning flags. </description> </method> <method name="set_ignore_mouse"> @@ -9639,56 +9650,91 @@ Ignore mouse events on this control (even touchpad events send mouse events). </description> </method> - <method name="is_ignoring_mouse" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_margin"> + <argument index="0" name="margin" type="int"> + </argument> + <argument index="1" name="offset" type="float"> + </argument> <description> - Return if the control is ignoring mouse events (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. </description> </method> - <method name="force_drag"> - <argument index="0" name="data" type="Variant"> + <method name="set_pos"> + <argument index="0" name="pos" type="Vector2"> </argument> - <argument index="1" name="preview" type="Object"> + <description> + 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]). + </description> + </method> + <method name="set_rotation"> + <argument index="0" name="radians" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_rotation_deg"> + <argument index="0" name="degrees" type="float"> </argument> <description> </description> </method> + <method name="set_scale"> + <argument index="0" name="scale" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_size"> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]). + </description> + </method> <method name="set_stop_mouse"> <argument index="0" name="stop" type="bool"> </argument> <description> </description> </method> - <method name="is_stopping_mouse" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_stretch_ratio"> + <argument index="0" name="ratio" type="float"> + </argument> <description> + 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. </description> </method> - <method name="grab_click_focus"> + <method name="set_theme"> + <argument index="0" name="theme" type="Theme"> + </argument> <description> + Override whole the [Theme] for this Control and all its children controls. </description> </method> - <method name="set_drag_forwarding"> - <argument index="0" name="target" type="Control"> + <method name="set_tooltip"> + <argument index="0" name="tooltip" type="String"> </argument> <description> + Set a tooltip, which will appear when the cursor is resting over this control. </description> </method> - <method name="set_drag_preview"> - <argument index="0" name="control" type="Control"> + <method name="set_v_size_flags"> + <argument index="0" name="flags" type="int"> </argument> <description> + Hint for containers, set vertical positioning flags. </description> </method> - <method name="warp_mouse"> - <argument index="0" name="to_pos" type="Vector2"> + <method name="show_modal"> + <argument index="0" name="exclusive" type="bool" default="false"> </argument> <description> + 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. </description> </method> - <method name="minimum_size_changed"> + <method name="warp_mouse"> + <argument index="0" name="to_pos" type="Vector2"> + </argument> <description> </description> </method> @@ -9699,14 +9745,16 @@ Emitted when keyboard focus is gained. </description> </signal> - <signal name="mouse_enter"> + <signal name="focus_exit"> <description> - Emitted when the mouse enters the control area. + Emitted when the keyboard focus is lost. </description> </signal> - <signal name="resized"> + <signal name="input_event"> + <argument index="0" name="ev" type="InputEvent"> + </argument> <description> - Emitted when the control changed size. + Emitted when an input event is received. Connecting in realtime is recommended for accepting the events. </description> </signal> <signal name="minimum_size_changed"> @@ -9714,30 +9762,28 @@ Emitted when the minimum size of the control changed. </description> </signal> - <signal name="size_flags_changed"> + <signal name="modal_close"> <description> - Emitted when the size flags changed. </description> </signal> - <signal name="focus_exit"> + <signal name="mouse_enter"> <description> - Emitted when the keyboard focus is lost. + Emitted when the mouse enters the control area. </description> </signal> - <signal name="input_event"> - <argument index="0" name="ev" type="InputEvent"> - </argument> + <signal name="mouse_exit"> <description> - Emitted when an input event is received. Connecting in realtime is recommended for accepting the events. + Emitted when the mouse left the control area. </description> </signal> - <signal name="modal_close"> + <signal name="resized"> <description> + Emitted when the control changed size. </description> </signal> - <signal name="mouse_exit"> + <signal name="size_flags_changed"> <description> - Emitted when the mouse left the control area. + Emitted when the size flags changed. </description> </signal> </signals> @@ -9753,39 +9799,23 @@ </constant> <constant name="ANCHOR_CENTER" value="3"> </constant> - <constant name="FOCUS_NONE" value="0"> - Control can't acquire focus. - </constant> - <constant name="FOCUS_CLICK" value="1"> - Control can acquire focus only if clicked. - </constant> - <constant name="FOCUS_ALL" value="2"> - Control can acquire focus if clicked, or by pressing TAB/Directionals in the keyboard from another Control. - </constant> - <constant name="NOTIFICATION_RESIZED" value="40"> - Control changed size (get_size() reports the new size). + <constant name="CURSOR_ARROW" value="0"> </constant> - <constant name="NOTIFICATION_MOUSE_ENTER" value="41"> - Mouse pointer entered the area of the Control. + <constant name="CURSOR_IBEAM" value="1"> </constant> - <constant name="NOTIFICATION_MOUSE_EXIT" value="42"> - Mouse pointer exited the area of the Control. + <constant name="CURSOR_HSIZE" value="10"> </constant> - <constant name="NOTIFICATION_FOCUS_ENTER" value="43"> - Control gained focus. + <constant name="CURSOR_BDIAGSIZE" value="11"> </constant> - <constant name="NOTIFICATION_FOCUS_EXIT" value="44"> - Control lost focus. + <constant name="CURSOR_FDIAGSIZE" value="12"> </constant> - <constant name="NOTIFICATION_THEME_CHANGED" value="45"> - Theme changed. Redrawing is desired. + <constant name="CURSOR_MOVE" value="13"> </constant> - <constant name="NOTIFICATION_MODAL_CLOSE" value="46"> - Modal control was closed. + <constant name="CURSOR_VSPLIT" value="14"> </constant> - <constant name="CURSOR_ARROW" value="0"> + <constant name="CURSOR_HSPLIT" value="15"> </constant> - <constant name="CURSOR_IBEAM" value="1"> + <constant name="CURSOR_HELP" value="16"> </constant> <constant name="CURSOR_POINTING_HAND" value="2"> </constant> @@ -9803,19 +9833,35 @@ </constant> <constant name="CURSOR_VSIZE" value="9"> </constant> - <constant name="CURSOR_HSIZE" value="10"> + <constant name="FOCUS_NONE" value="0"> + Control can't acquire focus. </constant> - <constant name="CURSOR_BDIAGSIZE" value="11"> + <constant name="FOCUS_CLICK" value="1"> + Control can acquire focus only if clicked. </constant> - <constant name="CURSOR_FDIAGSIZE" value="12"> + <constant name="FOCUS_ALL" value="2"> + Control can acquire focus if clicked, or by pressing TAB/Directionals in the keyboard from another Control. </constant> - <constant name="CURSOR_MOVE" value="13"> + <constant name="NOTIFICATION_RESIZED" value="40"> + Control changed size (get_size() reports the new size). </constant> - <constant name="CURSOR_VSPLIT" value="14"> + <constant name="NOTIFICATION_MOUSE_ENTER" value="41"> + Mouse pointer entered the area of the Control. </constant> - <constant name="CURSOR_HSPLIT" value="15"> + <constant name="NOTIFICATION_MOUSE_EXIT" value="42"> + Mouse pointer exited the area of the Control. </constant> - <constant name="CURSOR_HELP" value="16"> + <constant name="NOTIFICATION_FOCUS_ENTER" value="43"> + Control gained focus. + </constant> + <constant name="NOTIFICATION_FOCUS_EXIT" value="44"> + Control lost focus. + </constant> + <constant name="NOTIFICATION_THEME_CHANGED" value="45"> + Theme changed. Redrawing is desired. + </constant> + <constant name="NOTIFICATION_MODAL_CLOSE" value="46"> + Modal control was closed. </constant> <constant name="SIZE_EXPAND" value="1"> </constant> @@ -9833,18 +9879,18 @@ Convex polygon shape resource, which can be set into a [PhysicsBody] or area. </description> <methods> - <method name="set_points"> - <argument index="0" name="points" type="Vector3Array"> - </argument> - <description> - </description> - </method> <method name="get_points" qualifiers="const"> <return type="Vector3Array"> </return> <description> </description> </method> + <method name="set_points"> + <argument index="0" name="points" type="Vector3Array"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -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. </description> <methods> + <method name="get_points" qualifiers="const"> + <return type="Vector2Array"> + </return> + <description> + Return a list of points in either clockwise or counter clockwise order, forming a convex polygon. + </description> + </method> <method name="set_point_cloud"> <argument index="0" name="point_cloud" type="Vector2Array"> </argument> @@ -9872,13 +9925,6 @@ Set a list of points in either clockwise or counter clockwise order, forming a convex polygon. </description> </method> - <method name="get_points" qualifiers="const"> - <return type="Vector2Array"> - </return> - <description> - Return a list of points in either clockwise or counter clockwise order, forming a convex polygon. - </description> - </method> </methods> <constants> </constants> @@ -9889,7 +9935,7 @@ <description> </description> <methods> - <method name="get_width" qualifiers="const"> + <method name="get_flags" qualifiers="const"> <return type="int"> </return> <description> @@ -9901,32 +9947,18 @@ <description> </description> </method> - <method name="get_rid" qualifiers="const"> - <return type="RID"> + <method name="get_lossy_storage_quality" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="set_flags"> - <argument index="0" name="flags" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_flags" qualifiers="const"> - <return type="int"> + <method name="get_rid" qualifiers="const"> + <return type="RID"> </return> <description> </description> </method> - <method name="set_side"> - <argument index="0" name="side" type="int"> - </argument> - <argument index="1" name="image" type="Image"> - </argument> - <description> - </description> - </method> <method name="get_side" qualifiers="const"> <return type="Image"> </return> @@ -9935,37 +9967,53 @@ <description> </description> </method> - <method name="set_storage"> - <argument index="0" name="mode" type="int"> - </argument> + <method name="get_storage" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_storage" qualifiers="const"> + <method name="get_width" qualifiers="const"> <return type="int"> </return> <description> </description> </method> + <method name="set_flags"> + <argument index="0" name="flags" type="int"> + </argument> + <description> + </description> + </method> <method name="set_lossy_storage_quality"> <argument index="0" name="quality" type="float"> </argument> <description> </description> </method> - <method name="get_lossy_storage_quality" qualifiers="const"> - <return type="float"> - </return> + <method name="set_side"> + <argument index="0" name="side" type="int"> + </argument> + <argument index="1" name="image" type="Image"> + </argument> + <description> + </description> + </method> + <method name="set_storage"> + <argument index="0" name="mode" type="int"> + </argument> <description> </description> </method> </methods> <constants> - <constant name="STORAGE_RAW" value="0"> + <constant name="FLAG_MIPMAPS" value="1"> </constant> - <constant name="STORAGE_COMPRESS_LOSSY" value="1"> + <constant name="FLAG_REPEAT" value="2"> </constant> - <constant name="STORAGE_COMPRESS_LOSSLESS" value="2"> + <constant name="FLAG_FILTER" value="4"> + </constant> + <constant name="FLAGS_DEFAULT" value="7"> </constant> <constant name="SIDE_LEFT" value="0"> </constant> @@ -9979,13 +10027,11 @@ </constant> <constant name="SIDE_BACK" value="5"> </constant> - <constant name="FLAG_MIPMAPS" value="1"> - </constant> - <constant name="FLAG_REPEAT" value="2"> + <constant name="STORAGE_RAW" value="0"> </constant> - <constant name="FLAG_FILTER" value="4"> + <constant name="STORAGE_COMPRESS_LOSSY" value="1"> </constant> - <constant name="FLAGS_DEFAULT" value="7"> + <constant name="STORAGE_COMPRESS_LOSSLESS" value="2"> </constant> </constants> </class> @@ -9998,13 +10044,6 @@ It keeps a cache of precalculated points along the curve, to speed further calculations up. </description> <methods> - <method name="get_point_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the number of points describing the curve. - </description> - </method> <method name="add_point"> <argument index="0" name="pos" type="Vector2"> </argument> @@ -10019,49 +10058,41 @@ 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. </description> </method> - <method name="set_point_pos"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> + <method name="get_bake_interval" qualifiers="const"> + <return type="float"> + </return> <description> - Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. + Returns the distance between two adjacent cached points. </description> </method> - <method name="get_point_pos" qualifiers="const"> - <return type="Vector2"> + <method name="get_baked_length" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - 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 total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough. </description> </method> - <method name="set_point_in"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> + <method name="get_baked_points" qualifiers="const"> + <return type="Vector2Array"> + </return> <description> - 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 cache of points as a [Vector2Array]. </description> </method> - <method name="get_point_in" qualifiers="const"> - <return type="Vector2"> + <method name="get_point_count" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - 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 number of points describing the curve. </description> </method> - <method name="set_point_out"> + <method name="get_point_in" qualifiers="const"> + <return type="Vector2"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> <description> - 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 to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). </description> </method> <method name="get_point_out" qualifiers="const"> @@ -10073,11 +10104,13 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi 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). </description> </method> - <method name="remove_point"> + <method name="get_point_pos" qualifiers="const"> + <return type="Vector2"> + </return> <argument index="0" name="idx" type="int"> </argument> <description> - Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. + 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). </description> </method> <method name="interpolate" qualifiers="const"> @@ -10092,6 +10125,19 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi 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). </description> </method> + <method name="interpolate_baked" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <argument index="1" name="cubic" type="bool" default="false"> + </argument> + <description> + Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. +To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. +Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). + </description> + </method> <method name="interpolatef" qualifiers="const"> <return type="Vector2"> </return> @@ -10101,45 +10147,45 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i 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". </description> </method> - <method name="set_bake_interval"> - <argument index="0" name="distance" type="float"> + <method name="remove_point"> + <argument index="0" name="idx" type="int"> </argument> <description> - 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. + Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. </description> </method> - <method name="get_bake_interval" qualifiers="const"> - <return type="float"> - </return> + <method name="set_bake_interval"> + <argument index="0" name="distance" type="float"> + </argument> <description> - Returns the distance between two adjacent cached points. + 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. </description> </method> - <method name="get_baked_length" qualifiers="const"> - <return type="float"> - </return> + <method name="set_point_in"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> <description> - 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. + 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. </description> </method> - <method name="interpolate_baked" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="offset" type="float"> + <method name="set_point_out"> + <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="cubic" type="bool" default="false"> + <argument index="1" name="pos" type="Vector2"> </argument> <description> - Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. -To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. -Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). + 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. </description> </method> - <method name="get_baked_points" qualifiers="const"> - <return type="Vector2Array"> - </return> + <method name="set_point_pos"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> <description> - Returns the cache of points as a [Vector2Array]. + Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="tesselate" qualifiers="const"> @@ -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. </description> <methods> - <method name="get_point_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the number of points describing the curve. - </description> - </method> <method name="add_point"> <argument index="0" name="pos" type="Vector3"> </argument> @@ -10190,50 +10229,39 @@ 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. </description> </method> - <method name="set_point_pos"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="pos" type="Vector3"> - </argument> + <method name="get_bake_interval" qualifiers="const"> + <return type="float"> + </return> <description> - Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. + Returns the distance between two adjacent cached points. </description> </method> - <method name="get_point_pos" qualifiers="const"> - <return type="Vector3"> + <method name="get_baked_length" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - 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 total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough. </description> </method> - <method name="set_point_tilt"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="tilt" type="float"> - </argument> + <method name="get_baked_points" qualifiers="const"> + <return type="Vector3Array"> + </return> <description> - 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 cache of points as a [Vector3Array]. </description> </method> - <method name="get_point_tilt" qualifiers="const"> - <return type="float"> + <method name="get_baked_tilts" qualifiers="const"> + <return type="RealArray"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - 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 cache of tilts as a [RealArray]. </description> </method> - <method name="set_point_in"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="pos" type="Vector3"> - </argument> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> <description> - 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 number of points describing the curve. </description> </method> <method name="get_point_in" qualifiers="const"> @@ -10245,29 +10273,31 @@ The tilt controls the rotation along the look-at axis an object traveling the pa 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). </description> </method> - <method name="set_point_out"> + <method name="get_point_out" qualifiers="const"> + <return type="Vector3"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="pos" type="Vector3"> - </argument> <description> - 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). </description> </method> - <method name="get_point_out" qualifiers="const"> + <method name="get_point_pos" qualifiers="const"> <return type="Vector3"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - 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). </description> </method> - <method name="remove_point"> + <method name="get_point_tilt" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="idx" type="int"> </argument> <description> - Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. + 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. </description> </method> <method name="interpolate" qualifiers="const"> @@ -10282,6 +10312,19 @@ The tilt controls the rotation along the look-at axis an object traveling the pa 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). </description> </method> + <method name="interpolate_baked" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <argument index="1" name="cubic" type="bool" default="false"> + </argument> + <description> + Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. +To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. +Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). + </description> + </method> <method name="interpolatef" qualifiers="const"> <return type="Vector3"> </return> @@ -10291,52 +10334,55 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i 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". </description> </method> - <method name="set_bake_interval"> - <argument index="0" name="distance" type="float"> + <method name="remove_point"> + <argument index="0" name="idx" type="int"> </argument> <description> - 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. + Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. </description> </method> - <method name="get_bake_interval" qualifiers="const"> - <return type="float"> - </return> + <method name="set_bake_interval"> + <argument index="0" name="distance" type="float"> + </argument> <description> - Returns the distance between two adjacent cached points. + 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. </description> </method> - <method name="get_baked_length" qualifiers="const"> - <return type="float"> - </return> + <method name="set_point_in"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="Vector3"> + </argument> <description> - 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. + 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. </description> </method> - <method name="interpolate_baked" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="offset" type="float"> + <method name="set_point_out"> + <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="cubic" type="bool" default="false"> + <argument index="1" name="pos" type="Vector3"> </argument> <description> - Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. -To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. -Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). + 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. </description> </method> - <method name="get_baked_points" qualifiers="const"> - <return type="Vector3Array"> - </return> + <method name="set_point_pos"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="Vector3"> + </argument> <description> - Returns the cache of points as a [Vector3Array]. + Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> - <method name="get_baked_tilts" qualifiers="const"> - <return type="RealArray"> - </return> + <method name="set_point_tilt"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="tilt" type="float"> + </argument> <description> - Returns the cache of tilts as a [RealArray]. + 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. </description> </method> <method name="tesselate" qualifiers="const"> @@ -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. </description> <methods> - <method name="set_length"> - <argument index="0" name="length" type="float"> - </argument> + <method name="get_damping" qualifiers="const"> + <return type="float"> + </return> <description> - 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). </description> </method> <method name="get_length" qualifiers="const"> @@ -10379,13 +10425,6 @@ This approximation makes straight segments between each point, then subdivides t Return the maximum length of the spring joint. </description> </method> - <method name="set_rest_length"> - <argument index="0" name="rest_length" type="float"> - </argument> - <description> - Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. - </description> - </method> <method name="get_rest_length" qualifiers="const"> <return type="float"> </return> @@ -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. </description> </method> - <method name="set_stiffness"> - <argument index="0" name="stiffness" type="float"> - </argument> - <description> - Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. - </description> - </method> <method name="get_stiffness" qualifiers="const"> <return type="float"> </return> @@ -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). </description> </method> - <method name="get_damping" qualifiers="const"> - <return type="float"> - </return> + <method name="set_length"> + <argument index="0" name="length" type="float"> + </argument> <description> - 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. + </description> + </method> + <method name="set_rest_length"> + <argument index="0" name="rest_length" type="float"> + </argument> + <description> + Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. + </description> + </method> + <method name="set_stiffness"> + <argument index="0" name="stiffness" type="float"> + </argument> + <description> + Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. </description> </method> </methods> @@ -10526,31 +10572,31 @@ 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. </description> <methods> - <method name="set_shadow_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> <method name="get_shadow_mode" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="set_shadow_param"> + <method name="get_shadow_param" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="param" type="int"> </argument> - <argument index="1" name="value" type="float"> + <description> + </description> + </method> + <method name="set_shadow_mode"> + <argument index="0" name="mode" type="int"> </argument> <description> </description> </method> - <method name="get_shadow_param" qualifiers="const"> - <return type="float"> - </return> + <method name="set_shadow_param"> <argument index="0" name="param" type="int"> </argument> + <argument index="1" name="value" type="float"> + </argument> <description> </description> </method> @@ -10558,18 +10604,18 @@ This approximation makes straight segments between each point, then subdivides t <constants> <constant name="SHADOW_ORTHOGONAL" value="0"> </constant> - <constant name="SHADOW_PERSPECTIVE" value="1"> - </constant> - <constant name="SHADOW_PARALLEL_2_SPLITS" value="2"> - </constant> - <constant name="SHADOW_PARALLEL_4_SPLITS" value="3"> - </constant> <constant name="SHADOW_PARAM_MAX_DISTANCE" value="0"> </constant> <constant name="SHADOW_PARAM_PSSM_SPLIT_WEIGHT" value="1"> </constant> + <constant name="SHADOW_PERSPECTIVE" value="1"> + </constant> + <constant name="SHADOW_PARALLEL_2_SPLITS" value="2"> + </constant> <constant name="SHADOW_PARAM_PSSM_ZOFFSET_SCALE" value="2"> </constant> + <constant name="SHADOW_PARALLEL_4_SPLITS" value="3"> + </constant> </constants> </class> <class name="Directory" inherits="Reference" category="Core"> @@ -10596,48 +10642,58 @@ This approximation makes straight segments between each point, then subdivides t [/codeblock] </description> <methods> - <method name="open"> + <method name="change_dir"> <return type="Error"> </return> - <argument index="0" name="path" type="String"> + <argument index="0" name="todir" type="String"> </argument> <description> - 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_*). </description> </method> - <method name="list_dir_begin"> - <return type="bool"> + <method name="copy"> + <return type="Error"> </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="to" type="String"> + </argument> <description> - 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. + 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_*). </description> </method> - <method name="get_next"> - <return type="String"> + <method name="current_is_dir" qualifiers="const"> + <return type="bool"> </return> <description> - 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). + Return whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). </description> </method> - <method name="current_is_dir" qualifiers="const"> + <method name="dir_exists"> <return type="bool"> </return> + <argument index="0" name="path" type="String"> + </argument> <description> - Return whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). + Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. </description> </method> - <method name="list_dir_end"> + <method name="file_exists"> + <return type="bool"> + </return> + <argument index="0" name="path" type="String"> + </argument> <description> - 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 file exists. The argument can be relative to the current directory, or an absolute path. </description> </method> - <method name="get_drive_count"> - <return type="int"> + <method name="get_current_dir"> + <return type="String"> </return> <description> - 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]). </description> </method> <method name="get_drive"> @@ -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. </description> </method> - <method name="change_dir"> - <return type="Error"> + <method name="get_drive_count"> + <return type="int"> </return> - <argument index="0" name="todir" type="String"> - </argument> <description> - 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. </description> </method> - <method name="get_current_dir"> + <method name="get_next"> <return type="String"> </return> <description> - 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). + </description> + </method> + <method name="get_space_left"> + <return type="int"> + </return> + <description> + 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. + </description> + </method> + <method name="list_dir_begin"> + <return type="bool"> + </return> + <description> + 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. + </description> + </method> + <method name="list_dir_end"> + <description> + 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). </description> </method> <method name="make_dir"> @@ -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_*). </description> </method> - <method name="file_exists"> - <return type="bool"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - Return whether the target file exists. The argument can be relative to the current directory, or an absolute path. - </description> - </method> - <method name="dir_exists"> - <return type="bool"> + <method name="open"> + <return type="Error"> </return> <argument index="0" name="path" type="String"> </argument> <description> - Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. - </description> - </method> - <method name="get_space_left"> - <return type="int"> - </return> - <description> - 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. + 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_*). </description> </method> - <method name="copy"> + <method name="remove"> <return type="Error"> </return> - <argument index="0" name="from" type="String"> - </argument> - <argument index="1" name="to" type="String"> + <argument index="0" name="path" type="String"> </argument> <description> - 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_*). + 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). </description> </method> <method name="rename"> @@ -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). </description> </method> - <method name="remove"> - <return type="Error"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - 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). - </description> - </method> </methods> <constants> </constants> @@ -10755,21 +10801,29 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> <methods> - <method name="set_font_data"> + <method name="add_fallback"> <argument index="0" name="data" type="DynamicFontData"> </argument> <description> </description> </method> - <method name="get_font_data" qualifiers="const"> + <method name="get_fallback" qualifiers="const"> <return type="DynamicFontData"> </return> + <argument index="0" name="idx" type="int"> + </argument> <description> </description> </method> - <method name="set_size"> - <argument index="0" name="data" type="int"> - </argument> + <method name="get_fallback_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_font_data" qualifiers="const"> + <return type="DynamicFontData"> + </return> <description> </description> </method> @@ -10779,8 +10833,8 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="add_fallback"> - <argument index="0" name="data" type="DynamicFontData"> + <method name="remove_fallback"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -10793,26 +10847,18 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="get_fallback" qualifiers="const"> - <return type="DynamicFontData"> - </return> - <argument index="0" name="idx" type="int"> + <method name="set_font_data"> + <argument index="0" name="data" type="DynamicFontData"> </argument> <description> </description> </method> - <method name="remove_fallback"> - <argument index="0" name="idx" type="int"> + <method name="set_size"> + <argument index="0" name="data" type="int"> </argument> <description> </description> </method> - <method name="get_fallback_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> </methods> <constants> </constants> @@ -10823,6 +10869,18 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> <methods> + <method name="get_font_path" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_font_path"> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -10874,13 +10932,19 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> <methods> + <method name="add_filter"> + <argument index="0" name="filter" type="String"> + </argument> + <description> + </description> + </method> <method name="clear_filters"> <description> </description> </method> - <method name="add_filter"> - <argument index="0" name="filter" type="String"> - </argument> + <method name="get_access" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> @@ -10902,38 +10966,36 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="set_current_dir"> - <argument index="0" name="dir" type="String"> - </argument> + <method name="get_display_mode" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="set_current_file"> - <argument index="0" name="file" type="String"> - </argument> + <method name="get_mode" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="set_current_path"> - <argument index="0" name="path" type="String"> - </argument> + <method name="get_vbox"> + <return type="VBoxContainer"> + </return> <description> </description> </method> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> - </argument> + <method name="invalidate"> <description> </description> </method> - <method name="get_mode" qualifiers="const"> - <return type="int"> + <method name="is_overwrite_warning_disabled" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="get_vbox"> - <return type="VBoxContainer"> + <method name="is_showing_hidden_files" qualifiers="const"> + <return type="bool"> </return> <description> </description> @@ -10944,21 +11006,27 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="get_access" qualifiers="const"> - <return type="int"> - </return> + <method name="set_current_dir"> + <argument index="0" name="dir" type="String"> + </argument> <description> </description> </method> - <method name="set_show_hidden_files"> - <argument index="0" name="show" type="bool"> + <method name="set_current_file"> + <argument index="0" name="file" type="String"> </argument> <description> </description> </method> - <method name="is_showing_hidden_files" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_current_path"> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_disable_overwrite_warning"> + <argument index="0" name="disable" type="bool"> + </argument> <description> </description> </method> @@ -10968,24 +11036,20 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="get_display_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> </description> </method> - <method name="invalidate"> + <method name="set_show_hidden_files"> + <argument index="0" name="show" type="bool"> + </argument> <description> </description> </method> </methods> <signals> - <signal name="files_selected"> - <argument index="0" name="paths" type="StringArray"> - </argument> - <description> - </description> - </signal> <signal name="dir_selected"> <argument index="0" name="dir" type="String"> </argument> @@ -10998,8 +11062,20 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </signal> + <signal name="files_selected"> + <argument index="0" name="paths" type="StringArray"> + </argument> + <description> + </description> + </signal> </signals> <constants> + <constant name="ACCESS_RESOURCES" value="0"> + </constant> + <constant name="ACCESS_USERDATA" value="1"> + </constant> + <constant name="ACCESS_FILESYSTEM" value="2"> + </constant> <constant name="MODE_OPEN_FILE" value="0"> </constant> <constant name="MODE_OPEN_FILES" value="1"> @@ -11010,12 +11086,6 @@ This approximation makes straight segments between each point, then subdivides t </constant> <constant name="MODE_SAVE_FILE" value="4"> </constant> - <constant name="ACCESS_RESOURCES" value="0"> - </constant> - <constant name="ACCESS_USERDATA" value="1"> - </constant> - <constant name="ACCESS_FILESYSTEM" value="2"> - </constant> </constants> </class> <class name="EditorImportPlugin" inherits="Reference" category="Core"> @@ -11054,6 +11124,14 @@ This approximation makes straight segments between each point, then subdivides t instead. </description> </method> + <method name="expand_source_path"> + <return type="String"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> <method name="get_name" qualifiers="virtual"> <return type="String"> </return> @@ -11149,14 +11227,6 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="expand_source_path"> - <return type="String"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> </methods> <constants> </constants> @@ -11171,6 +11241,105 @@ This approximation makes straight segments between each point, then subdivides t resource type, import plugins and export plugins. </description> <methods> + <method name="add_control_to_bottom_panel"> + <argument index="0" name="control" type="Control"> + </argument> + <argument index="1" name="title" type="String"> + </argument> + <description> + 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]. + </description> + </method> + <method name="add_control_to_container"> + <argument index="0" name="container" type="int"> + </argument> + <argument index="1" name="control" type="Control"> + </argument> + <description> + 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. + </description> + </method> + <method name="add_control_to_dock"> + <argument index="0" name="slot" type="int"> + </argument> + <argument index="1" name="control" type="Control"> + </argument> + <description> + 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]. + </description> + </method> + <method name="add_custom_type"> + <argument index="0" name="type" type="String"> + </argument> + <argument index="1" name="base" type="String"> + </argument> + <argument index="2" name="script" type="Script"> + </argument> + <argument index="3" name="icon" type="Texture"> + </argument> + <description> + 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. + </description> + </method> + <method name="add_export_plugin"> + <argument index="0" name="plugin" type="EditorExportPlugin"> + </argument> + <description> + Add an export plugin. Plugins of this kind can + change files being exported. On exit don't forget to + call [method remove_export_plugin]. + </description> + </method> + <method name="add_import_plugin"> + <argument index="0" name="plugin" type="EditorImportPlugin"> + </argument> + <description> + 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] + </description> + </method> <method name="apply_changes" qualifiers="virtual"> <description> 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. </description> </method> + <method name="get_base_control"> + <return type="Control"> + </return> + <description> + 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. + </description> + </method> <method name="get_breakpoints" qualifiers="virtual"> <return type="StringArray"> </return> @@ -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 </description> </method> + <method name="get_editor_settings"> + <return type="EditorSettings"> + </return> + <description> + Get the general settings for the editor (the same + window that appears in the Settings menu). + </description> + </method> <method name="get_name" qualifiers="virtual"> <return type="String"> </return> @@ -11265,6 +11452,14 @@ This approximation makes straight segments between each point, then subdivides t (which by default is 2D, 3D, Script). </description> </method> + <method name="get_selection"> + <return type="EditorSelection"> + </return> + <description> + Get the object that handles the selection of nodes + in the Scene Tree editor. + </description> + </method> <method name="get_state" qualifiers="virtual"> <return type="Dictionary"> </return> @@ -11275,6 +11470,15 @@ This approximation makes straight segments between each point, then subdivides t restored when the tab returns). </description> </method> + <method name="get_undo_redo"> + <return type="UndoRedo"> + </return> + <description> + 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. + </description> + </method> <method name="handles" qualifiers="virtual"> <return type="bool"> </return> @@ -11309,61 +11513,13 @@ This approximation makes straight segments between each point, then subdivides t all your editor controls manually. </description> </method> - <method name="set_state" qualifiers="virtual"> - <argument index="0" name="state" type="Dictionary"> - </argument> - <description> - Restore the state saved by [EditorPlugin.get_state]. - </description> - </method> - <method name="add_control_to_container"> - <argument index="0" name="container" type="int"> - </argument> - <argument index="1" name="control" type="Control"> - </argument> - <description> - 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. - </description> - </method> - <method name="add_control_to_bottom_panel"> + <method name="remove_control_from_bottom_panel"> <argument index="0" name="control" type="Control"> </argument> - <argument index="1" name="title" type="String"> - </argument> - <description> - 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]. - </description> - </method> - <method name="add_control_to_dock"> - <argument index="0" name="slot" type="int"> - </argument> - <argument index="1" name="control" type="Control"> - </argument> <description> - 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. </description> </method> <method name="remove_control_from_docks"> @@ -11375,43 +11531,6 @@ This approximation makes straight segments between each point, then subdivides t the layout and remove it cleanly. </description> </method> - <method name="remove_control_from_bottom_panel"> - <argument index="0" name="control" type="Control"> - </argument> - <description> - Remove the control from the bottom panel. Don't forget - to call this if you added one, so the editor can - remove it cleanly. - </description> - </method> - <method name="add_custom_type"> - <argument index="0" name="type" type="String"> - </argument> - <argument index="1" name="base" type="String"> - </argument> - <argument index="2" name="script" type="Script"> - </argument> - <argument index="3" name="icon" type="Texture"> - </argument> - <description> - 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. - </description> - </method> <method name="remove_custom_type"> <argument index="0" name="type" type="String"> </argument> @@ -11420,16 +11539,12 @@ This approximation makes straight segments between each point, then subdivides t [EditorPlugin.add_custom_type] </description> </method> - <method name="add_import_plugin"> - <argument index="0" name="plugin" type="EditorImportPlugin"> + <method name="remove_export_plugin"> + <argument index="0" name="plugin" type="EditorExportPlugin"> </argument> <description> - 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 export plugin, don't forget to call this + on exit. </description> </method> <method name="remove_import_plugin"> @@ -11440,56 +11555,11 @@ This approximation makes straight segments between each point, then subdivides t on exit. </description> </method> - <method name="add_export_plugin"> - <argument index="0" name="plugin" type="EditorExportPlugin"> - </argument> - <description> - Add an export plugin. Plugins of this kind can - change files being exported. On exit don't forget to - call [method remove_export_plugin]. - </description> - </method> - <method name="remove_export_plugin"> - <argument index="0" name="plugin" type="EditorExportPlugin"> + <method name="set_state" qualifiers="virtual"> + <argument index="0" name="state" type="Dictionary"> </argument> <description> - Remove the export plugin, don't forget to call this - on exit. - </description> - </method> - <method name="get_base_control"> - <return type="Control"> - </return> - <description> - 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. - </description> - </method> - <method name="get_undo_redo"> - <return type="UndoRedo"> - </return> - <description> - 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. - </description> - </method> - <method name="get_selection"> - <return type="EditorSelection"> - </return> - <description> - Get the object that handles the selection of nodes - in the Scene Tree editor. - </description> - </method> - <method name="get_editor_settings"> - <return type="EditorSettings"> - </return> - <description> - Get the general settings for the editor (the same - window that appears in the Settings menu). + Restore the state saved by [EditorPlugin.get_state]. </description> </method> </methods> @@ -11589,11 +11659,6 @@ This approximation makes straight segments between each point, then subdivides t This object manages the SceneTree selection in the editor. </description> <methods> - <method name="clear"> - <description> - Clear the selection. - </description> - </method> <method name="add_node"> <argument index="0" name="node" type="Node"> </argument> @@ -11601,11 +11666,9 @@ This approximation makes straight segments between each point, then subdivides t Add a node to the selection. </description> </method> - <method name="remove_node"> - <argument index="0" name="node" type="Node"> - </argument> + <method name="clear"> <description> - Remove a node from the selection. + Clear the selection. </description> </method> <method name="get_selected_nodes"> @@ -11615,6 +11678,13 @@ This approximation makes straight segments between each point, then subdivides t Get the list of selectes nodes. </description> </method> + <method name="remove_node"> + <argument index="0" name="node" type="Node"> + </argument> + <description> + Remove a node from the selection. + </description> + </method> </methods> <signals> <signal name="selection_changed"> @@ -11651,17 +11721,12 @@ This approximation makes straight segments between each point, then subdivides t Erase a given setting (pass full property path). </description> </method> - <method name="get_settings_path" qualifiers="const"> - <return type="String"> + <method name="get_favorite_dirs" qualifiers="const"> + <return type="StringArray"> </return> <description> - Get the global settings path for the engine. Inside - this path you can find some standard paths such as: - - settings/tmp - used for temporary storage of files - - settings/templates - where export templates are - located + Get the list of favorite directories for this + project. </description> </method> <method name="get_project_settings_path" qualifiers="const"> @@ -11673,35 +11738,40 @@ This approximation makes straight segments between each point, then subdivides t path where project specific settings are saved. </description> </method> - <method name="set_favorite_dirs"> - <argument index="0" name="dirs" type="StringArray"> - </argument> + <method name="get_recent_dirs" qualifiers="const"> + <return type="StringArray"> + </return> <description> - Set the list of favorite directories for this - project. + Get the list of recently visited folders in the file + dialog for this project. </description> </method> - <method name="get_favorite_dirs" qualifiers="const"> - <return type="StringArray"> + <method name="get_settings_path" qualifiers="const"> + <return type="String"> </return> <description> - Get the list of favorite directories for this - project. + Get the global settings path for the engine. Inside + this path you can find some standard paths such as: + + settings/tmp - used for temporary storage of files + + settings/templates - where export templates are + located </description> </method> - <method name="set_recent_dirs"> + <method name="set_favorite_dirs"> <argument index="0" name="dirs" type="StringArray"> </argument> <description> - Set the list of recently visited folders in the file - dialog for this project. + Set the list of favorite directories for this + project. </description> </method> - <method name="get_recent_dirs" qualifiers="const"> - <return type="StringArray"> - </return> + <method name="set_recent_dirs"> + <argument index="0" name="dirs" type="StringArray"> + </argument> <description> - Get the list of recently visited folders in the file + Set the list of recently visited folders in the file dialog for this project. </description> </method> @@ -11725,66 +11795,38 @@ This approximation makes straight segments between each point, then subdivides t [method EditorPlugin.create_spatial_gizmo]. </description> <methods> - <method name="commit_handle" qualifiers="virtual"> - <argument index="0" name="index" type="int"> - </argument> - <argument index="1" name="restore" type="Variant"> - </argument> - <argument index="2" name="cancel" type="bool"> + <method name="add_collision_segments"> + <argument index="0" name="segments" type="Vector3Array"> </argument> <description> - Commit a handle being edited (handles must have been - prevously added by [method add_handles]). - - If the cancel parameter is true, an option to - restore the edited value to the original is - provided. </description> </method> - <method name="get_handle_name" qualifiers="virtual"> - <return type="String"> - </return> - <argument index="0" name="index" type="int"> + <method name="add_collision_triangles"> + <argument index="0" name="triangles" type="TriangleMesh"> </argument> <description> - Get the name of an edited handle (handles must have - been previously added by [method add_handles]). + Add collision triangles to the gizmo for picking. A + [TriangleMesh] can be generated from a regular + [Mesh] too. - Handles can be named for reference to the user when editing. - </description> - </method> - <method name="get_handle_value" qualifiers="virtual"> - <return type="Variant"> - </return> - <argument index="0" name="index" type="int"> - </argument> - <description> - Get actual value of a handle. This value can be - anything and used for eventually undoing the motion - when calling [method commit_handle] - </description> - </method> - <method name="redraw" qualifiers="virtual"> - <description> - This function is called when the Spatial this gizmo - refers to changes (the [method Spatial.update_gizmo] - is called). + Call this function during [method redraw]. </description> </method> - <method name="set_handle" qualifiers="virtual"> - <argument index="0" name="index" type="int"> + <method name="add_handles"> + <argument index="0" name="handles" type="Vector3Array"> </argument> - <argument index="1" name="camera" type="Camera"> + <argument index="1" name="billboard" type="bool" default="false"> </argument> - <argument index="2" name="point" type="Vector2"> + <argument index="2" name="secondary" type="bool" default="false"> </argument> <description> - This function is used when the user drags a gizmo - handle (previously added with [method add_handles]) - in screen coordinates. + Add a list of handles (points) which can be used to + deform the object being edited. - The [Camera] is also provided - so screen coordinates can be converted to raycasts. + There are virtual functions which will be called + upon editing of these handles. + + Call this function during [method redraw]. </description> </method> <method name="add_lines"> @@ -11816,49 +11858,77 @@ This approximation makes straight segments between each point, then subdivides t Call this function during [method redraw]. </description> </method> - <method name="add_collision_segments"> - <argument index="0" name="segments" type="Vector3Array"> + <method name="add_unscaled_billboard"> + <argument index="0" name="material" type="Material"> + </argument> + <argument index="1" name="default_scale" type="float" default="1"> </argument> <description> + Add an unscaled billboard for visualization. + + Call this function during [method redraw]. </description> </method> - <method name="add_collision_triangles"> - <argument index="0" name="triangles" type="TriangleMesh"> + <method name="commit_handle" qualifiers="virtual"> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="restore" type="Variant"> + </argument> + <argument index="2" name="cancel" type="bool"> </argument> <description> - Add collision triangles to the gizmo for picking. A - [TriangleMesh] can be generated from a regular - [Mesh] too. + Commit a handle being edited (handles must have been + prevously added by [method add_handles]). - Call this function during [method redraw]. + If the cancel parameter is true, an option to + restore the edited value to the original is + provided. </description> </method> - <method name="add_unscaled_billboard"> - <argument index="0" name="material" type="Material"> - </argument> - <argument index="1" name="default_scale" type="float" default="1"> + <method name="get_handle_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="index" type="int"> </argument> <description> - Add an unscaled billboard for visualization. + Get the name of an edited handle (handles must have + been previously added by [method add_handles]). - Call this function during [method redraw]. + Handles can be named for reference to the user when editing. </description> </method> - <method name="add_handles"> - <argument index="0" name="handles" type="Vector3Array"> + <method name="get_handle_value" qualifiers="virtual"> + <return type="Variant"> + </return> + <argument index="0" name="index" type="int"> </argument> - <argument index="1" name="billboard" type="bool" default="false"> + <description> + Get actual value of a handle. This value can be + anything and used for eventually undoing the motion + when calling [method commit_handle] + </description> + </method> + <method name="redraw" qualifiers="virtual"> + <description> + This function is called when the Spatial this gizmo + refers to changes (the [method Spatial.update_gizmo] + is called). + </description> + </method> + <method name="set_handle" qualifiers="virtual"> + <argument index="0" name="index" type="int"> </argument> - <argument index="2" name="secondary" type="bool" default="false"> + <argument index="1" name="camera" type="Camera"> + </argument> + <argument index="2" name="point" type="Vector2"> </argument> <description> - 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. + This function is used when the user drags a gizmo + handle (previously added with [method add_handles]) + in screen coordinates. - Call this function during [method redraw]. + The [Camera] is also provided + so screen coordinates can be converted to raycasts. </description> </method> <method name="set_spatial_node"> @@ -11881,19 +11951,13 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> <methods> - <method name="set_background"> - <argument index="0" name="bgmode" type="int"> + <method name="fx_get_param" qualifiers="const"> + <argument index="0" name="param" type="int"> </argument> <description> </description> </method> - <method name="get_background" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_background_param"> + <method name="fx_set_param"> <argument index="0" name="param" type="int"> </argument> <argument index="1" name="value" type="Variant"> @@ -11901,16 +11965,14 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="get_background_param" qualifiers="const"> - <argument index="0" name="param" type="int"> - </argument> + <method name="get_background" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="set_enable_fx"> - <argument index="0" name="effect" type="int"> - </argument> - <argument index="1" name="enabled" type="bool"> + <method name="get_background_param" qualifiers="const"> + <argument index="0" name="param" type="int"> </argument> <description> </description> @@ -11923,7 +11985,13 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="fx_set_param"> + <method name="set_background"> + <argument index="0" name="bgmode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_background_param"> <argument index="0" name="param" type="int"> </argument> <argument index="1" name="value" type="Variant"> @@ -11931,8 +11999,10 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="fx_get_param" qualifiers="const"> - <argument index="0" name="param" type="int"> + <method name="set_enable_fx"> + <argument index="0" name="effect" type="int"> + </argument> + <argument index="1" name="enabled" type="bool"> </argument> <description> </description> @@ -11941,83 +12011,47 @@ This approximation makes straight segments between each point, then subdivides t <constants> <constant name="BG_KEEP" value="0"> </constant> + <constant name="BG_PARAM_CANVAS_MAX_LAYER" value="0"> + </constant> <constant name="BG_DEFAULT_COLOR" value="1"> </constant> + <constant name="BG_PARAM_COLOR" value="1"> + </constant> <constant name="BG_COLOR" value="2"> </constant> + <constant name="BG_PARAM_TEXTURE" value="2"> + </constant> + <constant name="BG_PARAM_CUBEMAP" value="3"> + </constant> <constant name="BG_TEXTURE" value="3"> </constant> <constant name="BG_CUBEMAP" value="4"> </constant> + <constant name="BG_PARAM_ENERGY" value="4"> + </constant> <constant name="BG_CANVAS" value="5"> </constant> <constant name="BG_MAX" value="6"> </constant> - <constant name="BG_PARAM_CANVAS_MAX_LAYER" value="0"> - </constant> - <constant name="BG_PARAM_COLOR" value="1"> - </constant> - <constant name="BG_PARAM_TEXTURE" value="2"> - </constant> - <constant name="BG_PARAM_CUBEMAP" value="3"> - </constant> - <constant name="BG_PARAM_ENERGY" value="4"> - </constant> <constant name="BG_PARAM_GLOW" value="6"> </constant> <constant name="BG_PARAM_MAX" value="7"> </constant> <constant name="FX_AMBIENT_LIGHT" value="0"> </constant> - <constant name="FX_FXAA" value="1"> - </constant> - <constant name="FX_GLOW" value="2"> - </constant> - <constant name="FX_DOF_BLUR" value="3"> - </constant> - <constant name="FX_HDR" value="4"> - </constant> - <constant name="FX_FOG" value="5"> - </constant> - <constant name="FX_BCS" value="6"> - </constant> - <constant name="FX_SRGB" value="7"> - </constant> - <constant name="FX_MAX" value="8"> - </constant> <constant name="FX_BLUR_BLEND_MODE_ADDITIVE" value="0"> </constant> - <constant name="FX_BLUR_BLEND_MODE_SCREEN" value="1"> - </constant> - <constant name="FX_BLUR_BLEND_MODE_SOFTLIGHT" value="2"> - </constant> <constant name="FX_HDR_TONE_MAPPER_LINEAR" value="0"> </constant> - <constant name="FX_HDR_TONE_MAPPER_LOG" value="1"> - </constant> - <constant name="FX_HDR_TONE_MAPPER_REINHARDT" value="2"> - </constant> - <constant name="FX_HDR_TONE_MAPPER_REINHARDT_AUTOWHITE" value="3"> - </constant> <constant name="FX_PARAM_AMBIENT_LIGHT_COLOR" value="0"> </constant> - <constant name="FX_PARAM_AMBIENT_LIGHT_ENERGY" value="1"> - </constant> - <constant name="FX_PARAM_GLOW_BLUR_PASSES" value="2"> - </constant> - <constant name="FX_PARAM_GLOW_BLUR_SCALE" value="3"> - </constant> - <constant name="FX_PARAM_GLOW_BLUR_STRENGTH" value="4"> - </constant> - <constant name="FX_PARAM_GLOW_BLUR_BLEND_MODE" value="5"> - </constant> - <constant name="FX_PARAM_GLOW_BLOOM" value="6"> + <constant name="FX_BLUR_BLEND_MODE_SCREEN" value="1"> </constant> - <constant name="FX_PARAM_GLOW_BLOOM_TRESHOLD" value="7"> + <constant name="FX_FXAA" value="1"> </constant> - <constant name="FX_PARAM_DOF_BLUR_PASSES" value="8"> + <constant name="FX_HDR_TONE_MAPPER_LOG" value="1"> </constant> - <constant name="FX_PARAM_DOF_BLUR_BEGIN" value="9"> + <constant name="FX_PARAM_AMBIENT_LIGHT_ENERGY" value="1"> </constant> <constant name="FX_PARAM_DOF_BLUR_RANGE" value="10"> </constant> @@ -12039,12 +12073,20 @@ This approximation makes straight segments between each point, then subdivides t </constant> <constant name="FX_PARAM_FOG_BEGIN" value="19"> </constant> - <constant name="FX_PARAM_FOG_ATTENUATION" value="22"> + <constant name="FX_BLUR_BLEND_MODE_SOFTLIGHT" value="2"> + </constant> + <constant name="FX_GLOW" value="2"> + </constant> + <constant name="FX_HDR_TONE_MAPPER_REINHARDT" value="2"> + </constant> + <constant name="FX_PARAM_GLOW_BLUR_PASSES" value="2"> </constant> <constant name="FX_PARAM_FOG_BEGIN_COLOR" value="20"> </constant> <constant name="FX_PARAM_FOG_END_COLOR" value="21"> </constant> + <constant name="FX_PARAM_FOG_ATTENUATION" value="22"> + </constant> <constant name="FX_PARAM_FOG_BG" value="23"> </constant> <constant name="FX_PARAM_BCS_BRIGHTNESS" value="24"> @@ -12055,6 +12097,34 @@ This approximation makes straight segments between each point, then subdivides t </constant> <constant name="FX_PARAM_MAX" value="27"> </constant> + <constant name="FX_DOF_BLUR" value="3"> + </constant> + <constant name="FX_HDR_TONE_MAPPER_REINHARDT_AUTOWHITE" value="3"> + </constant> + <constant name="FX_PARAM_GLOW_BLUR_SCALE" value="3"> + </constant> + <constant name="FX_HDR" value="4"> + </constant> + <constant name="FX_PARAM_GLOW_BLUR_STRENGTH" value="4"> + </constant> + <constant name="FX_FOG" value="5"> + </constant> + <constant name="FX_PARAM_GLOW_BLUR_BLEND_MODE" value="5"> + </constant> + <constant name="FX_BCS" value="6"> + </constant> + <constant name="FX_PARAM_GLOW_BLOOM" value="6"> + </constant> + <constant name="FX_PARAM_GLOW_BLOOM_TRESHOLD" value="7"> + </constant> + <constant name="FX_SRGB" value="7"> + </constant> + <constant name="FX_MAX" value="8"> + </constant> + <constant name="FX_PARAM_DOF_BLUR_PASSES" value="8"> + </constant> + <constant name="FX_PARAM_DOF_BLUR_BEGIN" value="9"> + </constant> </constants> </class> <class name="EventPlayer" inherits="Node" category="Core"> @@ -12066,71 +12136,71 @@ This approximation makes straight segments between each point, then subdivides t Currently, only MOD, S3M, IT, and XM music is supported. </description> <methods> - <method name="set_stream"> - <argument index="0" name="stream" type="EventStream"> + <method name="get_channel_last_note_time" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="channel" type="int"> </argument> <description> - Set the [EventStream] this player will play. + Return the time at which the last note of a given channel in the stream plays. </description> </method> - <method name="get_stream" qualifiers="const"> - <return type="EventStream"> + <method name="get_channel_volume" qualifiers="const"> + <return type="float"> </return> + <argument index="0" name="channel" type="int"> + </argument> <description> - Return the currently assigned stream. - </description> - </method> - <method name="play"> - <description> - Play the currently assigned stream. + Return the volume scale for an individual channel of the stream. </description> </method> - <method name="stop"> + <method name="get_length" qualifiers="const"> + <return type="float"> + </return> <description> - Stop playing. + Return the song length. May be in seconds, but depends on the stream type. </description> </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> + <method name="get_loop_count" qualifiers="const"> + <return type="int"> </return> <description> - Return whether this player is playing. + Return the number of times the playback has looped. </description> </method> - <method name="set_paused"> - <argument index="0" name="paused" type="bool"> - </argument> + <method name="get_pitch_scale" qualifiers="const"> + <return type="float"> + </return> <description> - Pause stream playback. + Return the pitch scale factor for this player. </description> </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> + <method name="get_pos" qualifiers="const"> + <return type="float"> </return> <description> - Return whether the playback is currently paused. + Return the playback position. May be in seconds, but depends on the stream type. </description> </method> - <method name="set_loop"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_stream" qualifiers="const"> + <return type="EventStream"> + </return> <description> - Set whether the stream will be restarted at the end. + Return the currently assigned stream. </description> </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> + <method name="get_stream_name" qualifiers="const"> + <return type="String"> </return> <description> - Return whether this player will be restart the playback at the end. + 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>". </description> </method> - <method name="set_volume"> - <argument index="0" name="volume" type="float"> - </argument> + <method name="get_tempo_scale" qualifiers="const"> + <return type="float"> + </return> <description> - 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 tempo multiplier. </description> </method> <method name="get_volume" qualifiers="const"> @@ -12140,67 +12210,44 @@ This approximation makes straight segments between each point, then subdivides t Return the playback volume for this player. </description> </method> - <method name="set_pitch_scale"> - <argument index="0" name="pitch_scale" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="get_pitch_scale" qualifiers="const"> + <method name="get_volume_db" qualifiers="const"> <return type="float"> </return> <description> - Return the pitch scale factor for this player. - </description> - </method> - <method name="set_tempo_scale"> - <argument index="0" name="tempo_scale" type="float"> - </argument> - <description> - Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch. + Return the playback volume for this player, in decibels. </description> </method> - <method name="get_tempo_scale" qualifiers="const"> - <return type="float"> + <method name="has_autoplay" qualifiers="const"> + <return type="bool"> </return> <description> - Return the tempo multiplier. - </description> - </method> - <method name="set_volume_db"> - <argument index="0" name="db" type="float"> - </argument> - <description> - 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 whether this player will start playing as soon as it enters the scene tree. </description> </method> - <method name="get_volume_db" qualifiers="const"> - <return type="float"> + <method name="has_loop" qualifiers="const"> + <return type="bool"> </return> <description> - Return the playback volume for this player, in decibels. + Return whether this player will be restart the playback at the end. </description> </method> - <method name="get_stream_name" qualifiers="const"> - <return type="String"> + <method name="is_paused" qualifiers="const"> + <return type="bool"> </return> <description> - 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 whether the playback is currently paused. </description> </method> - <method name="get_loop_count" qualifiers="const"> - <return type="int"> + <method name="is_playing" qualifiers="const"> + <return type="bool"> </return> <description> - Return the number of times the playback has looped. + Return whether this player is playing. </description> </method> - <method name="get_pos" qualifiers="const"> - <return type="float"> - </return> + <method name="play"> <description> - Return the playback position. May be in seconds, but depends on the stream type. + Play the currently assigned stream. </description> </method> <method name="seek_pos"> @@ -12210,13 +12257,6 @@ This approximation makes straight segments between each point, then subdivides t Set the playback position. May be in seconds, but depends on the stream type. </description> </method> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the song length. May be in seconds, but depends on the stream type. - </description> - </method> <method name="set_autoplay"> <argument index="0" name="enabled" type="bool"> </argument> @@ -12224,13 +12264,6 @@ This approximation makes straight segments between each point, then subdivides t Set whether this player will start playing as soon as it enters the scene tree. </description> </method> - <method name="has_autoplay" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether this player will start playing as soon as it enters the scene tree. - </description> - </method> <method name="set_channel_volume"> <argument index="0" name="channel" type="int"> </argument> @@ -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. </description> </method> - <method name="get_channel_volume" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="channel" type="int"> + <method name="set_loop"> + <argument index="0" name="enabled" type="bool"> </argument> <description> - Return the volume scale for an individual channel of the stream. + Set whether the stream will be restarted at the end. </description> </method> - <method name="get_channel_last_note_time" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="channel" type="int"> + <method name="set_paused"> + <argument index="0" name="paused" type="bool"> </argument> <description> - Return the time at which the last note of a given channel in the stream plays. + Pause stream playback. + </description> + </method> + <method name="set_pitch_scale"> + <argument index="0" name="pitch_scale" type="float"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_stream"> + <argument index="0" name="stream" type="EventStream"> + </argument> + <description> + Set the [EventStream] this player will play. + </description> + </method> + <method name="set_tempo_scale"> + <argument index="0" name="tempo_scale" type="float"> + </argument> + <description> + Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch. + </description> + </method> + <method name="set_volume"> + <argument index="0" name="volume" type="float"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_volume_db"> + <argument index="0" name="db" type="float"> + </argument> + <description> + 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. + </description> + </method> + <method name="stop"> + <description> + Stop playing. </description> </method> </methods> @@ -12318,116 +12388,99 @@ This approximation makes straight segments between each point, then subdivides t [/codeblock] </description> <methods> - <method name="open_encrypted"> - <return type="int"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="mode_flags" type="int"> - </argument> - <argument index="2" name="key" type="RawArray"> - </argument> + <method name="close"> <description> - Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. + Close the currently opened file. </description> </method> - <method name="open_encrypted_with_pass"> - <return type="int"> + <method name="eof_reached" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="mode_flags" type="int"> - </argument> - <argument index="2" name="pass" type="String"> - </argument> <description> - Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. + Return whether the file cursor reached the end of the file. </description> </method> - <method name="open"> - <return type="int"> + <method name="file_exists" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="path" type="String"> </argument> - <argument index="1" name="flags" type="int"> - </argument> <description> - Open the file for writing or reading, depending on the flags. - </description> - </method> - <method name="close"> - <description> - Close the currently opened file. + Get whether or not the file in the specified path exists. </description> </method> - <method name="is_open" qualifiers="const"> - <return type="bool"> + <method name="get_16" qualifiers="const"> + <return type="int"> </return> <description> - Return whether the file is currently opened. + Get the next 16 bits from the file as an integer. </description> </method> - <method name="seek"> - <argument index="0" name="pos" type="int"> - </argument> + <method name="get_32" qualifiers="const"> + <return type="int"> + </return> <description> - Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file). + Get the next 32 bits from the file as an integer. </description> </method> - <method name="seek_end"> - <argument index="0" name="pos" type="int" default="0"> - </argument> + <method name="get_64" qualifiers="const"> + <return type="int"> + </return> <description> - 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. + Get the next 64 bits from the file as an integer. </description> </method> - <method name="get_pos" qualifiers="const"> + <method name="get_8" qualifiers="const"> <return type="int"> </return> <description> - Return the file cursor position. + Get the next 8 bits from the file as an integer. </description> </method> - <method name="get_len" qualifiers="const"> - <return type="int"> + <method name="get_as_text" qualifiers="const"> + <return type="String"> </return> <description> - Return the size of the file in bytes. + Get the whole file as a [String]. </description> </method> - <method name="eof_reached" qualifiers="const"> - <return type="bool"> + <method name="get_buffer" qualifiers="const"> + <return type="RawArray"> </return> + <argument index="0" name="len" type="int"> + </argument> <description> - Return whether the file cursor reached the end of the file. + Get next len bytes of the file as a [RawArray]. </description> </method> - <method name="get_8" qualifiers="const"> - <return type="int"> + <method name="get_csv_line" qualifiers="const"> + <return type="StringArray"> </return> + <argument index="0" name="delim" type="String" default="",""> + </argument> <description> - Get the next 8 bits from the file as an integer. + 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). </description> </method> - <method name="get_16" qualifiers="const"> - <return type="int"> + <method name="get_double" qualifiers="const"> + <return type="float"> </return> <description> - Get the next 16 bits from the file as an integer. + Get the next 64 bits from the file as a floating point number. </description> </method> - <method name="get_32" qualifiers="const"> - <return type="int"> + <method name="get_endian_swap"> + <return type="bool"> </return> <description> - Get the next 32 bits from the file as an integer. + Get whether endian swap is enabled for this file. </description> </method> - <method name="get_64" qualifiers="const"> - <return type="int"> + <method name="get_error" qualifiers="const"> + <return type="Error"> </return> <description> - Get the next 64 bits from the file as an integer. + Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope]. </description> </method> <method name="get_float" qualifiers="const"> @@ -12437,50 +12490,48 @@ This approximation makes straight segments between each point, then subdivides t Get the next 32 bits from the file as a floating point number. </description> </method> - <method name="get_double" qualifiers="const"> - <return type="float"> + <method name="get_len" qualifiers="const"> + <return type="int"> </return> <description> - Get the next 64 bits from the file as a floating point number. + Return the size of the file in bytes. </description> </method> - <method name="get_real" qualifiers="const"> - <return type="float"> + <method name="get_line" qualifiers="const"> + <return type="String"> </return> <description> - Get the next bits from the file as a floating point number. + Get the next line of the file as a [String]. </description> </method> - <method name="get_buffer" qualifiers="const"> - <return type="RawArray"> + <method name="get_md5" qualifiers="const"> + <return type="String"> </return> - <argument index="0" name="len" type="int"> + <argument index="0" name="path" type="String"> </argument> <description> - Get next len bytes of the file as a [RawArray]. + Return a md5 String representing the file at the given path or an empty [String] on failure. </description> </method> - <method name="get_line" qualifiers="const"> + <method name="get_pascal_string"> <return type="String"> </return> <description> - Get the next line of the file as a [String]. + Get a [String] saved in Pascal format from the file. </description> </method> - <method name="get_as_text" qualifiers="const"> - <return type="String"> + <method name="get_pos" qualifiers="const"> + <return type="int"> </return> <description> - Get the whole file as a [String]. + Return the file cursor position. </description> </method> - <method name="get_md5" qualifiers="const"> - <return type="String"> + <method name="get_real" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="path" type="String"> - </argument> <description> - Return a md5 String representing the file at the given path or an empty [String] on failure. + Get the next bits from the file as a floating point number. </description> </method> <method name="get_sha256" qualifiers="const"> @@ -12492,48 +12543,76 @@ This approximation makes straight segments between each point, then subdivides t Return a sha256 String representing the file at the given path or an empty [String] on failure. </description> </method> - <method name="get_endian_swap"> + <method name="get_var" qualifiers="const"> + <description> + Get the next Variant value from the file. + </description> + </method> + <method name="is_open" qualifiers="const"> <return type="bool"> </return> <description> - Get whether endian swap is enabled for this file. + Return whether the file is currently opened. </description> </method> - <method name="set_endian_swap"> - <argument index="0" name="enable" type="bool"> + <method name="open"> + <return type="int"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="flags" type="int"> </argument> <description> - Set whether to swap the endianess of the file. Enable this if you're dealing with files written in big endian machines. - - Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file. + Open the file for writing or reading, depending on the flags. </description> </method> - <method name="get_error" qualifiers="const"> - <return type="Error"> + <method name="open_encrypted"> + <return type="int"> </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="mode_flags" type="int"> + </argument> + <argument index="2" name="key" type="RawArray"> + </argument> <description> - Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope]. + Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. </description> </method> - <method name="get_var" qualifiers="const"> + <method name="open_encrypted_with_pass"> + <return type="int"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="mode_flags" type="int"> + </argument> + <argument index="2" name="pass" type="String"> + </argument> <description> - Get the next Variant value from the file. + Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. </description> </method> - <method name="get_csv_line" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="delim" type="String" default="",""> + <method name="seek"> + <argument index="0" name="pos" type="int"> </argument> <description> - 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). + Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file). </description> </method> - <method name="store_8"> - <argument index="0" name="value" type="int"> + <method name="seek_end"> + <argument index="0" name="pos" type="int" default="0"> </argument> <description> - Store an integer as 8 bits in the file. + 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. + </description> + </method> + <method name="set_endian_swap"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether to swap the endianess of the file. Enable this if you're dealing with files written in big endian machines. + + Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file. </description> </method> <method name="store_16"> @@ -12557,32 +12636,32 @@ This approximation makes straight segments between each point, then subdivides t Store an integer as 64 bits in the file. </description> </method> - <method name="store_float"> - <argument index="0" name="value" type="float"> + <method name="store_8"> + <argument index="0" name="value" type="int"> </argument> <description> - Store a floating point number as 32 bits in the file. + Store an integer as 8 bits in the file. </description> </method> - <method name="store_double"> - <argument index="0" name="value" type="float"> + <method name="store_buffer"> + <argument index="0" name="buffer" type="RawArray"> </argument> <description> - Store a floating point number as 64 bits in the file. + Store the given array of bytes in the file. </description> </method> - <method name="store_real"> + <method name="store_double"> <argument index="0" name="value" type="float"> </argument> <description> - Store a floating point number in the file. + Store a floating point number as 64 bits in the file. </description> </method> - <method name="store_buffer"> - <argument index="0" name="buffer" type="RawArray"> + <method name="store_float"> + <argument index="0" name="value" type="float"> </argument> <description> - Store the given array of bytes in the file. + Store a floating point number as 32 bits in the file. </description> </method> <method name="store_line"> @@ -12592,41 +12671,32 @@ This approximation makes straight segments between each point, then subdivides t Store the given [String] as a line in the file. </description> </method> - <method name="store_string"> + <method name="store_pascal_string"> <argument index="0" name="string" type="String"> </argument> <description> - Store the given [String] 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). </description> </method> - <method name="store_var"> - <argument index="0" name="value" type="Variant"> + <method name="store_real"> + <argument index="0" name="value" type="float"> </argument> <description> - Store any Variant value in the file. + Store a floating point number in the file. </description> </method> - <method name="store_pascal_string"> + <method name="store_string"> <argument index="0" name="string" type="String"> </argument> <description> - Store the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). - </description> - </method> - <method name="get_pascal_string"> - <return type="String"> - </return> - <description> - Get a [String] saved in Pascal format from the file. + Store the given [String] in the file. </description> </method> - <method name="file_exists" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="path" type="String"> + <method name="store_var"> + <argument index="0" name="value" type="Variant"> </argument> <description> - Get whether or not the file in the specified path exists. + Store any Variant value in the file. </description> </method> </methods> @@ -12634,12 +12704,12 @@ This approximation makes straight segments between each point, then subdivides t <constant name="READ" value="1"> Open the file for reading. </constant> - <constant name="WRITE" value="2"> - Open the file for writing. Create it if the file not exists and truncate if it exists. - </constant> <constant name="READ_WRITE" value="3"> Open the file for reading and writing, without truncating the file. </constant> + <constant name="WRITE" value="2"> + Open the file for writing. Create it if the file not exists and truncate if it exists. + </constant> <constant name="WRITE_READ" value="7"> Open the file for reading and writing. Create it if the file not exists and truncate if it exists. </constant> @@ -12653,16 +12723,23 @@ 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. </description> <methods> + <method name="add_filter"> + <argument index="0" name="filter" type="String"> + </argument> + <description> + Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images"); + </description> + </method> <method name="clear_filters"> <description> Clear all the added filters in the dialog. </description> </method> - <method name="add_filter"> - <argument index="0" name="filter" type="String"> - </argument> + <method name="get_access" qualifiers="const"> + <return type="int"> + </return> <description> - Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images"); + Return the file access permission of the dialog. </description> </method> <method name="get_current_dir" qualifiers="const"> @@ -12686,34 +12763,6 @@ 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). </description> </method> - <method name="set_current_dir"> - <argument index="0" name="dir" type="String"> - </argument> - <description> - Set the current working directory of the file dialog. - </description> - </method> - <method name="set_current_file"> - <argument index="0" name="file" type="String"> - </argument> - <description> - Set the current selected file name of the file dialog. - </description> - </method> - <method name="set_current_path"> - <argument index="0" name="path" type="String"> - </argument> - <description> - Set the current selected file path of the file dialog. - </description> - </method> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - Set the file dialog mode from the MODE_* enum. - </description> - </method> <method name="get_mode" qualifiers="const"> <return type="int"> </return> @@ -12728,6 +12777,18 @@ This approximation makes straight segments between each point, then subdivides t Return the vertical box container of the dialog, custom controls can be added to it. </description> </method> + <method name="invalidate"> + <description> + Invalidate and update the current dialog content list. + </description> + </method> + <method name="is_showing_hidden_files" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the diaog allows show hidden files. + </description> + </method> <method name="set_access"> <argument index="0" name="access" type="int"> </argument> @@ -12735,41 +12796,43 @@ This approximation makes straight segments between each point, then subdivides t Set the file access permission of the dialog(Must be one of [ACCESS_RESOURCES], [ACCESS_USERDATA] or [ACCESS_FILESYSTEM]). </description> </method> - <method name="get_access" qualifiers="const"> - <return type="int"> - </return> + <method name="set_current_dir"> + <argument index="0" name="dir" type="String"> + </argument> <description> - Return the file access permission of the dialog. + Set the current working directory of the file dialog. </description> </method> - <method name="set_show_hidden_files"> - <argument index="0" name="show" type="bool"> + <method name="set_current_file"> + <argument index="0" name="file" type="String"> </argument> <description> - Set the dialog should show hidden files. + Set the current selected file name of the file dialog. </description> </method> - <method name="is_showing_hidden_files" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_current_path"> + <argument index="0" name="path" type="String"> + </argument> <description> - Return true if the diaog allows show hidden files. + Set the current selected file path of the file dialog. </description> </method> - <method name="invalidate"> + <method name="set_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> - Invalidate and update the current dialog content list. + Set the file dialog mode from the MODE_* enum. </description> </method> - </methods> - <signals> - <signal name="files_selected"> - <argument index="0" name="paths" type="StringArray"> + <method name="set_show_hidden_files"> + <argument index="0" name="show" type="bool"> </argument> <description> - Event emitted when the user selects multiple files. + Set the dialog should show hidden files. </description> - </signal> + </method> + </methods> + <signals> <signal name="dir_selected"> <argument index="0" name="dir" type="String"> </argument> @@ -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). </description> </signal> + <signal name="files_selected"> + <argument index="0" name="paths" type="StringArray"> + </argument> + <description> + Event emitted when the user selects multiple files. + </description> + </signal> </signals> <constants> + <constant name="ACCESS_RESOURCES" value="0"> + The dialog allows the selection of file and directory. + </constant> + <constant name="ACCESS_USERDATA" value="1"> + The dialog allows ascess files under [Resource] path(res://) . + </constant> + <constant name="ACCESS_FILESYSTEM" value="2"> + The dialog allows ascess files in whole file system. + </constant> <constant name="MODE_OPEN_FILE" value="0"> The dialog allows the selection of one, and only one file. </constant> @@ -12801,15 +12880,6 @@ This approximation makes straight segments between each point, then subdivides t <constant name="MODE_SAVE_FILE" value="4"> The dialog will warn when a file exists. </constant> - <constant name="ACCESS_RESOURCES" value="0"> - The dialog allows the selection of file and directory. - </constant> - <constant name="ACCESS_USERDATA" value="1"> - The dialog allows ascess files under [Resource] path(res://) . - </constant> - <constant name="ACCESS_FILESYSTEM" value="2"> - The dialog allows ascess files in whole file system. - </constant> </constants> <theme_items> <theme_item name="files_disabled" type="Color"> @@ -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. </description> <methods> - <method name="set_parameter"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="Variant"> + <method name="get_fixed_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int"> </argument> <description> - 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. + </description> + </method> + <method name="get_light_shader" qualifiers="const"> + <return type="int"> + </return> + <description> </description> </method> <method name="get_parameter" qualifiers="const"> @@ -12844,40 +12919,35 @@ 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. </description> </method> - <method name="set_texture"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> + <method name="get_point_size" qualifiers="const"> + <return type="float"> + </return> <description> - Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]). </description> </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> + <method name="get_texcoord_mode" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="param" type="int"> </argument> <description> - Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]). + Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. </description> </method> - <method name="set_texcoord_mode"> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> <argument index="0" name="param" type="int"> </argument> - <argument index="1" name="mode" type="int"> - </argument> <description> - Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. + Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]). </description> </method> - <method name="get_texcoord_mode" qualifiers="const"> - <return type="int"> + <method name="get_uv_transform" qualifiers="const"> + <return type="Transform"> </return> - <argument index="0" name="param" type="int"> - </argument> <description> - Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. + Returns the special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. </description> </method> <method name="set_fixed_flag"> @@ -12888,54 +12958,70 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="get_fixed_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int"> + <method name="set_light_shader"> + <argument index="0" name="shader" type="int"> </argument> <description> </description> </method> - <method name="set_uv_transform"> - <argument index="0" name="transform" type="Transform"> + <method name="set_parameter"> + <argument index="0" name="param" type="int"> + </argument> + <argument index="1" name="value" type="Variant"> </argument> <description> - Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. - </description> - </method> - <method name="get_uv_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - 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. </description> </method> - <method name="set_light_shader"> - <argument index="0" name="shader" type="int"> + <method name="set_point_size"> + <argument index="0" name="size" type="float"> </argument> <description> </description> </method> - <method name="get_light_shader" qualifiers="const"> - <return type="int"> - </return> + <method name="set_texcoord_mode"> + <argument index="0" name="param" type="int"> + </argument> + <argument index="1" name="mode" type="int"> + </argument> <description> + Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. </description> </method> - <method name="set_point_size"> - <argument index="0" name="size" type="float"> + <method name="set_texture"> + <argument index="0" name="param" type="int"> + </argument> + <argument index="1" name="texture" type="Texture"> </argument> <description> + Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]). </description> </method> - <method name="get_point_size" qualifiers="const"> - <return type="float"> - </return> + <method name="set_uv_transform"> + <argument index="0" name="transform" type="Transform"> + </argument> <description> + Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. </description> </method> </methods> <constants> + <constant name="FLAG_USE_ALPHA" value="0"> + </constant> + <constant name="FLAG_USE_COLOR_ARRAY" value="1"> + </constant> + <constant name="FLAG_USE_POINT_SIZE" value="2"> + </constant> + <constant name="FLAG_DISCARD_ALPHA" value="3"> + </constant> + <constant name="LIGHT_SHADER_LAMBERT" value="0"> + </constant> + <constant name="LIGHT_SHADER_WRAP" value="1"> + </constant> + <constant name="LIGHT_SHADER_VELVET" value="2"> + </constant> + <constant name="LIGHT_SHADER_TOON" value="3"> + </constant> <constant name="PARAM_DIFFUSE" value="0"> Diffuse Lighting (light scattered from surface). </constant> @@ -12962,8 +13048,6 @@ This approximation makes straight segments between each point, then subdivides t <constant name="PARAM_MAX" value="8"> Maximum amount of parameters. </constant> - <constant name="TEXCOORD_SPHERE" value="3"> - </constant> <constant name="TEXCOORD_UV" value="0"> Read texture coordinates from the UV array. </constant> @@ -12973,21 +13057,7 @@ This approximation makes straight segments between each point, then subdivides t <constant name="TEXCOORD_UV2" value="2"> Read texture coordinates from the UV2 array. </constant> - <constant name="FLAG_USE_ALPHA" value="0"> - </constant> - <constant name="FLAG_USE_COLOR_ARRAY" value="1"> - </constant> - <constant name="FLAG_USE_POINT_SIZE" value="2"> - </constant> - <constant name="FLAG_DISCARD_ALPHA" value="3"> - </constant> - <constant name="LIGHT_SHADER_LAMBERT" value="0"> - </constant> - <constant name="LIGHT_SHADER_WRAP" value="1"> - </constant> - <constant name="LIGHT_SHADER_VELVET" value="2"> - </constant> - <constant name="LIGHT_SHADER_TOON" value="3"> + <constant name="TEXCOORD_SPHERE" value="3"> </constant> </constants> </class> @@ -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. </description> </method> + <method name="draw_char" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="canvas_item" type="RID"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="char" type="int"> + </argument> + <argument index="3" name="next" type="int" default="-1"> + </argument> + <argument index="4" name="modulate" type="Color" default="Color(1,1,1,1)"> + </argument> + <description> + 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. + </description> + </method> <method name="get_ascent" qualifiers="const"> <return type="float"> </return> @@ -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. </description> </method> - <method name="is_distance_field_hint" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="get_string_size" qualifiers="const"> <return type="Vector2"> </return> @@ -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. </description> </method> - <method name="draw_char" qualifiers="const"> - <return type="float"> + <method name="is_distance_field_hint" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="canvas_item" type="RID"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <argument index="2" name="char" type="int"> - </argument> - <argument index="3" name="next" type="int" default="-1"> - </argument> - <argument index="4" name="modulate" type="Color" default="Color(1,1,1,1)"> - </argument> <description> - 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. </description> </method> </methods> @@ -13101,14 +13171,14 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="set_instance"> - <argument index="0" name="instance" type="Object"> + <method name="set_function"> + <argument index="0" name="name" type="String"> </argument> <description> </description> </method> - <method name="set_function"> - <argument index="0" name="name" type="String"> + <method name="set_instance"> + <argument index="0" name="instance" type="Object"> </argument> <description> </description> @@ -13123,19 +13193,19 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> <methods> - <method name="resume"> - <return type="Variant"> + <method name="is_valid" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="arg" type="Variant" default="NULL"> - </argument> <description> + Should put children to the top left corner instead of center of the container. </description> </method> - <method name="is_valid" qualifiers="const"> - <return type="bool"> + <method name="resume"> + <return type="Variant"> </return> + <argument index="0" name="arg" type="Variant" default="NULL"> + </argument> <description> - Should put children to the top left corner instead of center of the container. </description> </method> </methods> @@ -13162,16 +13232,16 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> <methods> - <method name="new"> - <description> - </description> - </method> <method name="get_as_byte_code" qualifiers="const"> <return type="RawArray"> </return> <description> </description> </method> + <method name="new"> + <description> + </description> + </method> </methods> <constants> </constants> @@ -13182,31 +13252,31 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> <methods> - <method name="set_param_x"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="float"> + <method name="get_flag_x" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int"> </argument> <description> </description> </method> - <method name="get_param_x" qualifiers="const"> - <return type="float"> + <method name="get_flag_y" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="param" type="int"> + <argument index="0" name="flag" type="int"> </argument> <description> </description> </method> - <method name="set_param_y"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="float"> + <method name="get_flag_z" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int"> </argument> <description> </description> </method> - <method name="get_param_y" qualifiers="const"> + <method name="get_param_x" qualifiers="const"> <return type="float"> </return> <argument index="0" name="param" type="int"> @@ -13214,11 +13284,11 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="set_param_z"> + <method name="get_param_y" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="param" type="int"> </argument> - <argument index="1" name="value" type="float"> - </argument> <description> </description> </method> @@ -13238,15 +13308,15 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="get_flag_x" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_flag_y"> <argument index="0" name="flag" type="int"> </argument> + <argument index="1" name="value" type="bool"> + </argument> <description> </description> </method> - <method name="set_flag_y"> + <method name="set_flag_z"> <argument index="0" name="flag" type="int"> </argument> <argument index="1" name="value" type="bool"> @@ -13254,51 +13324,43 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="get_flag_y" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int"> + <method name="set_param_x"> + <argument index="0" name="param" type="int"> + </argument> + <argument index="1" name="value" type="float"> </argument> <description> </description> </method> - <method name="set_flag_z"> - <argument index="0" name="flag" type="int"> + <method name="set_param_y"> + <argument index="0" name="param" type="int"> </argument> - <argument index="1" name="value" type="bool"> + <argument index="1" name="value" type="float"> </argument> <description> </description> </method> - <method name="get_flag_z" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int"> + <method name="set_param_z"> + <argument index="0" name="param" type="int"> + </argument> + <argument index="1" name="value" type="float"> </argument> <description> </description> </method> </methods> <constants> - <constant name="PARAM_LINEAR_LOWER_LIMIT" value="0"> - </constant> - <constant name="PARAM_LINEAR_UPPER_LIMIT" value="1"> - </constant> - <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2"> - </constant> - <constant name="PARAM_LINEAR_RESTITUTION" value="3"> - </constant> - <constant name="PARAM_LINEAR_DAMPING" value="4"> + <constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0"> </constant> - <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5"> + <constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1"> </constant> - <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6"> + <constant name="FLAG_ENABLE_MOTOR" value="2"> </constant> - <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7"> + <constant name="FLAG_MAX" value="3"> </constant> - <constant name="PARAM_ANGULAR_DAMPING" value="8"> + <constant name="PARAM_LINEAR_LOWER_LIMIT" value="0"> </constant> - <constant name="PARAM_ANGULAR_RESTITUTION" value="9"> + <constant name="PARAM_LINEAR_UPPER_LIMIT" value="1"> </constant> <constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10"> </constant> @@ -13310,13 +13372,21 @@ This approximation makes straight segments between each point, then subdivides t </constant> <constant name="PARAM_MAX" value="14"> </constant> - <constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0"> + <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2"> </constant> - <constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1"> + <constant name="PARAM_LINEAR_RESTITUTION" value="3"> </constant> - <constant name="FLAG_ENABLE_MOTOR" value="2"> + <constant name="PARAM_LINEAR_DAMPING" value="4"> </constant> - <constant name="FLAG_MAX" value="3"> + <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5"> + </constant> + <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6"> + </constant> + <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7"> + </constant> + <constant name="PARAM_ANGULAR_DAMPING" value="8"> + </constant> + <constant name="PARAM_ANGULAR_RESTITUTION" value="9"> </constant> </constants> </class> @@ -13334,7 +13404,7 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="build_cylinder_planes"> + <method name="build_capsule_planes"> <return type="Array"> </return> <argument index="0" name="radius" type="float"> @@ -13343,12 +13413,14 @@ This approximation makes straight segments between each point, then subdivides t </argument> <argument index="2" name="sides" type="int"> </argument> - <argument index="3" name="axis" type="int" default="2"> + <argument index="3" name="lats" type="int"> + </argument> + <argument index="4" name="axis" type="int" default="2"> </argument> <description> </description> </method> - <method name="build_capsule_planes"> + <method name="build_cylinder_planes"> <return type="Array"> </return> <argument index="0" name="radius" type="float"> @@ -13357,35 +13429,33 @@ This approximation makes straight segments between each point, then subdivides t </argument> <argument index="2" name="sides" type="int"> </argument> - <argument index="3" name="lats" type="int"> - </argument> - <argument index="4" name="axis" type="int" default="2"> + <argument index="3" name="axis" type="int" default="2"> </argument> <description> </description> </method> - <method name="segment_intersects_circle"> - <return type="float"> + <method name="get_closest_point_to_segment"> + <return type="Vector3"> </return> - <argument index="0" name="segment_from" type="Vector2"> - </argument> - <argument index="1" name="segment_to" type="Vector2"> + <argument index="0" name="point" type="Vector3"> </argument> - <argument index="2" name="circle_pos" type="Vector2"> + <argument index="1" name="s1" type="Vector3"> </argument> - <argument index="3" name="circle_radius" type="float"> + <argument index="2" name="s2" type="Vector3"> </argument> <description> </description> </method> - <method name="segment_intersects_segment_2d"> - <argument index="0" name="from_a" type="Vector2"> + <method name="get_closest_points_between_segments"> + <return type="Vector3Array"> + </return> + <argument index="0" name="p1" type="Vector3"> </argument> - <argument index="1" name="to_a" type="Vector2"> + <argument index="1" name="p2" type="Vector3"> </argument> - <argument index="2" name="from_b" type="Vector2"> + <argument index="2" name="q1" type="Vector3"> </argument> - <argument index="3" name="to_b" type="Vector2"> + <argument index="3" name="q2" type="Vector3"> </argument> <description> </description> @@ -13404,36 +13474,32 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="get_closest_points_between_segments"> - <return type="Vector3Array"> + <method name="get_uv84_normal_bit"> + <return type="int"> </return> - <argument index="0" name="p1" type="Vector3"> - </argument> - <argument index="1" name="p2" type="Vector3"> - </argument> - <argument index="2" name="q1" type="Vector3"> - </argument> - <argument index="3" name="q2" type="Vector3"> + <argument index="0" name="normal" type="Vector3"> </argument> <description> </description> </method> - <method name="get_closest_point_to_segment"> - <return type="Vector3"> + <method name="make_atlas"> + <return type="Dictionary"> </return> - <argument index="0" name="point" type="Vector3"> - </argument> - <argument index="1" name="s1" type="Vector3"> - </argument> - <argument index="2" name="s2" type="Vector3"> + <argument index="0" name="sizes" type="Vector2Array"> </argument> <description> </description> </method> - <method name="get_uv84_normal_bit"> - <return type="int"> + <method name="point_is_inside_triangle" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="normal" type="Vector3"> + <argument index="0" name="point" type="Vector2"> + </argument> + <argument index="1" name="a" type="Vector2"> + </argument> + <argument index="2" name="b" type="Vector2"> + </argument> + <argument index="3" name="c" type="Vector2"> </argument> <description> </description> @@ -13452,30 +13518,28 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="segment_intersects_triangle"> - <argument index="0" name="from" type="Vector3"> - </argument> - <argument index="1" name="to" type="Vector3"> + <method name="segment_intersects_circle"> + <return type="float"> + </return> + <argument index="0" name="segment_from" type="Vector2"> </argument> - <argument index="2" name="a" type="Vector3"> + <argument index="1" name="segment_to" type="Vector2"> </argument> - <argument index="3" name="b" type="Vector3"> + <argument index="2" name="circle_pos" type="Vector2"> </argument> - <argument index="4" name="c" type="Vector3"> + <argument index="3" name="circle_radius" type="float"> </argument> <description> </description> </method> - <method name="segment_intersects_sphere"> + <method name="segment_intersects_convex"> <return type="Vector3Array"> </return> <argument index="0" name="from" type="Vector3"> </argument> <argument index="1" name="to" type="Vector3"> </argument> - <argument index="2" name="spos" type="Vector3"> - </argument> - <argument index="3" name="sradius" type="float"> + <argument index="2" name="planes" type="Array"> </argument> <description> </description> @@ -13494,28 +13558,42 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="segment_intersects_convex"> + <method name="segment_intersects_segment_2d"> + <argument index="0" name="from_a" type="Vector2"> + </argument> + <argument index="1" name="to_a" type="Vector2"> + </argument> + <argument index="2" name="from_b" type="Vector2"> + </argument> + <argument index="3" name="to_b" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="segment_intersects_sphere"> <return type="Vector3Array"> </return> <argument index="0" name="from" type="Vector3"> </argument> <argument index="1" name="to" type="Vector3"> </argument> - <argument index="2" name="planes" type="Array"> + <argument index="2" name="spos" type="Vector3"> + </argument> + <argument index="3" name="sradius" type="float"> </argument> <description> </description> </method> - <method name="point_is_inside_triangle" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="point" type="Vector2"> + <method name="segment_intersects_triangle"> + <argument index="0" name="from" type="Vector3"> </argument> - <argument index="1" name="a" type="Vector2"> + <argument index="1" name="to" type="Vector3"> </argument> - <argument index="2" name="b" type="Vector2"> + <argument index="2" name="a" type="Vector3"> </argument> - <argument index="3" name="c" type="Vector2"> + <argument index="3" name="b" type="Vector3"> + </argument> + <argument index="4" name="c" type="Vector3"> </argument> <description> </description> @@ -13528,14 +13606,6 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="make_atlas"> - <return type="Dictionary"> - </return> - <argument index="0" name="sizes" type="Vector2Array"> - </argument> - <description> - </description> - </method> </methods> <constants> </constants> @@ -13548,81 +13618,72 @@ 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. </description> <methods> - <method name="set_material_override"> - <argument index="0" name="material" type="Object"> - </argument> - <description> - Set the material override for the whole geometry. - </description> - </method> - <method name="get_material_override" qualifiers="const"> - <return type="Object"> + <method name="get_baked_light_texture_id" qualifiers="const"> + <return type="int"> </return> <description> - Return the material override for the whole geometry. </description> </method> - <method name="set_flag"> - <argument index="0" name="flag" type="int"> - </argument> - <argument index="1" name="value" type="bool"> - </argument> + <method name="get_cast_shadows_setting" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_flag" qualifiers="const"> - <return type="bool"> + <method name="get_draw_range_begin" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="flag" type="int"> - </argument> <description> </description> </method> - <method name="set_cast_shadows_setting"> - <argument index="0" name="shadow_casting_setting" type="int"> - </argument> + <method name="get_draw_range_end" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_cast_shadows_setting" qualifiers="const"> - <return type="int"> + <method name="get_extra_cull_margin" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="set_draw_range_begin"> - <argument index="0" name="mode" type="float"> + <method name="get_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int"> </argument> <description> </description> </method> - <method name="get_draw_range_begin" qualifiers="const"> - <return type="float"> + <method name="get_material_override" qualifiers="const"> + <return type="Object"> </return> <description> + Return the material override for the whole geometry. </description> </method> - <method name="set_draw_range_end"> - <argument index="0" name="mode" type="float"> + <method name="set_baked_light_texture_id"> + <argument index="0" name="id" type="int"> </argument> <description> </description> </method> - <method name="get_draw_range_end" qualifiers="const"> - <return type="float"> - </return> + <method name="set_cast_shadows_setting"> + <argument index="0" name="shadow_casting_setting" type="int"> + </argument> <description> </description> </method> - <method name="set_baked_light_texture_id"> - <argument index="0" name="id" type="int"> + <method name="set_draw_range_begin"> + <argument index="0" name="mode" type="float"> </argument> <description> </description> </method> - <method name="get_baked_light_texture_id" qualifiers="const"> - <return type="int"> - </return> + <method name="set_draw_range_end"> + <argument index="0" name="mode" type="float"> + </argument> <description> </description> </method> @@ -13632,24 +13693,33 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="get_extra_cull_margin" qualifiers="const"> - <return type="float"> - </return> + <method name="set_flag"> + <argument index="0" name="flag" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> <description> </description> </method> + <method name="set_material_override"> + <argument index="0" name="material" type="Object"> + </argument> + <description> + Set the material override for the whole geometry. + </description> + </method> </methods> <constants> <constant name="FLAG_VISIBLE" value="0"> </constant> - <constant name="FLAG_CAST_SHADOW" value="3"> - </constant> - <constant name="FLAG_RECEIVE_SHADOWS" value="4"> - </constant> <constant name="FLAG_BILLBOARD" value="1"> </constant> <constant name="FLAG_BILLBOARD_FIX_Y" value="2"> </constant> + <constant name="FLAG_CAST_SHADOW" value="3"> + </constant> + <constant name="FLAG_RECEIVE_SHADOWS" value="4"> + </constant> <constant name="FLAG_DEPH_SCALE" value="5"> </constant> <constant name="FLAG_VISIBLE_IN_ALL_ROOMS" value="6"> @@ -13674,74 +13744,80 @@ 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. </description> <methods> - <method name="has" qualifiers="const"> - <return type="bool"> - </return> + <method name="clear"> <argument index="0" name="name" type="String"> </argument> <description> - Return true if a configuration value is present. + Clear the whole configuration (not recommended, may break things). </description> </method> - <method name="set_order"> + <method name="get_order" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="pos" type="int"> - </argument> <description> - Set the order of a configuration value (influences when saved to the config file). + Return the order of a configuration value (influences when saved to the config file). </description> </method> - <method name="get_order" qualifiers="const"> - <return type="int"> + <method name="get_singleton" qualifiers="const"> + <return type="Object"> </return> <argument index="0" name="name" type="String"> </argument> <description> - Return the order of a configuration value (influences when saved to the config file). </description> </method> - <method name="set_persisting"> - <argument index="0" name="name" type="String"> + <method name="globalize_path" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="path" type="String"> </argument> - <argument index="1" name="enable" type="bool"> + <description> + Convert a localized path (res://) to a full native OS path. + </description> + </method> + <method name="has" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> </argument> <description> - If set to true, this value can be saved to the configuration file. This is useful for editors. + Return true if a configuration value is present. </description> </method> - <method name="is_persisting" qualifiers="const"> + <method name="has_singleton" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="name" type="String"> </argument> <description> - If returns true, this value can be saved to the configuration file. This is useful for editors. </description> </method> - <method name="clear"> + <method name="is_persisting" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="name" type="String"> </argument> <description> - Clear the whole configuration (not recommended, may break things). + If returns true, this value can be saved to the configuration file. This is useful for editors. </description> </method> - <method name="localize_path" qualifiers="const"> - <return type="String"> + <method name="load_resource_pack"> + <return type="bool"> </return> - <argument index="0" name="path" type="String"> + <argument index="0" name="pack" type="String"> </argument> <description> - Convert a path to a localized path (res:// path). </description> </method> - <method name="globalize_path" qualifiers="const"> + <method name="localize_path" qualifiers="const"> <return type="String"> </return> <argument index="0" name="path" type="String"> </argument> <description> - Convert a localized path (res://) to a full native OS path. + Convert a path to a localized path (res:// path). </description> </method> <method name="save"> @@ -13750,36 +13826,30 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="has_singleton" qualifiers="const"> - <return type="bool"> + <method name="save_custom"> + <return type="int"> </return> - <argument index="0" name="name" type="String"> + <argument index="0" name="file" type="String"> </argument> <description> </description> </method> - <method name="get_singleton" qualifiers="const"> - <return type="Object"> - </return> + <method name="set_order"> <argument index="0" name="name" type="String"> </argument> - <description> - </description> - </method> - <method name="load_resource_pack"> - <return type="bool"> - </return> - <argument index="0" name="pack" type="String"> + <argument index="1" name="pos" type="int"> </argument> <description> + Set the order of a configuration value (influences when saved to the config file). </description> </method> - <method name="save_custom"> - <return type="int"> - </return> - <argument index="0" name="file" type="String"> + <method name="set_persisting"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="enable" type="bool"> </argument> <description> + If set to true, this value can be saved to the configuration file. This is useful for editors. </description> </method> </methods> @@ -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. </description> </method> - <method name="is_node_connected"> - <return type="bool"> - </return> - <argument index="0" name="from" type="String"> - </argument> - <argument index="1" name="from_port" type="int"> - </argument> - <argument index="2" name="to" type="String"> - </argument> - <argument index="3" name="to_port" type="int"> - </argument> - <description> - Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. - </description> - </method> <method name="disconnect_node"> <argument index="0" name="from" type="String"> </argument> @@ -13852,13 +13907,6 @@ This approximation makes straight segments between each point, then subdivides t Return the scroll offset. </description> </method> - <method name="set_zoom"> - <argument index="0" name="p_zoom" type="float"> - </argument> - <description> - Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728]. - </description> - </method> <method name="get_zoom" qualifiers="const"> <return type="float"> </return> @@ -13866,11 +13914,19 @@ This approximation makes straight segments between each point, then subdivides t Return the current zoom value. </description> </method> - <method name="set_right_disconnects"> - <argument index="0" name="enable" type="bool"> + <method name="is_node_connected"> + <return type="bool"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="from_port" type="int"> + </argument> + <argument index="2" name="to" type="String"> + </argument> + <argument index="3" name="to_port" type="int"> </argument> <description> - 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. </description> </method> <method name="is_right_disconnects_enabled" qualifiers="const"> @@ -13880,31 +13936,33 @@ 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. </description> </method> - </methods> - <signals> - <signal name="delete_nodes_request"> - <description> - Signal sent when a GraphNode is attempted to be removed from the GraphEdit. - </description> - </signal> - <signal name="duplicate_nodes_request"> + <method name="set_right_disconnects"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. + Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. </description> - </signal> - <signal name="popup_request"> - <argument index="0" name="p_position" type="Vector2"> + </method> + <method name="set_zoom"> + <argument index="0" name="p_zoom" type="float"> </argument> <description> - 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. + Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728]. </description> - </signal> + </method> + </methods> + <signals> <signal name="_begin_node_move"> <description> Signal sent at the beginning of a GraphNode movement. </description> </signal> - <signal name="disconnection_request"> + <signal name="_end_node_move"> + <description> + Signal sent at the end of a GraphNode movement. + </description> + </signal> + <signal name="connection_request"> <argument index="0" name="from" type="String"> </argument> <argument index="1" name="from_slot" type="int"> @@ -13914,10 +13972,15 @@ This approximation makes straight segments between each point, then subdivides t <argument index="3" name="to_slot" type="int"> </argument> <description> - 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 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. </description> </signal> - <signal name="connection_request"> + <signal name="delete_nodes_request"> + <description> + Signal sent when a GraphNode is attempted to be removed from the GraphEdit. + </description> + </signal> + <signal name="disconnection_request"> <argument index="0" name="from" type="String"> </argument> <argument index="1" name="from_slot" type="int"> @@ -13927,25 +13990,32 @@ This approximation makes straight segments between each point, then subdivides t <argument index="3" name="to_slot" type="int"> </argument> <description> - 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 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. </description> </signal> - <signal name="_end_node_move"> + <signal name="duplicate_nodes_request"> <description> - Signal sent at the end of a GraphNode movement. + Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. + </description> + </signal> + <signal name="popup_request"> + <argument index="0" name="p_position" type="Vector2"> + </argument> + <description> + 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. </description> </signal> </signals> <constants> </constants> <theme_items> - <theme_item name="more" type="Texture"> - </theme_item> - <theme_item name="reset" type="Texture"> + <theme_item name="bg" type="StyleBox"> </theme_item> <theme_item name="minus" type="Texture"> </theme_item> - <theme_item name="bg" type="StyleBox"> + <theme_item name="more" type="Texture"> + </theme_item> + <theme_item name="reset" type="Texture"> </theme_item> </theme_items> </class> @@ -13957,110 +14027,84 @@ 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. </description> <methods> - <method name="set_title"> - <argument index="0" name="title" type="String"> - </argument> - <description> - Set the title of the GraphNode. - </description> - </method> - <method name="get_title" qualifiers="const"> - <return type="String"> - </return> + <method name="clear_all_slots"> <description> - Return the title of the GraphNode. + Disable all input and output slots of the GraphNode. </description> </method> - <method name="set_slot"> + <method name="clear_slot"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="enable_left" type="bool"> - </argument> - <argument index="2" name="type_left" type="int"> - </argument> - <argument index="3" name="color_left" type="Color"> - </argument> - <argument index="4" name="enable_right" type="bool"> - </argument> - <argument index="5" name="type_right" type="int"> - </argument> - <argument index="6" name="color_right" type="Color"> - </argument> <description> - 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'. </description> </method> - <method name="clear_slot"> + <method name="get_connection_input_color"> + <return type="Color"> + </return> <argument index="0" name="idx" type="int"> </argument> <description> - Disable input and output slot whose index is 'idx'. + Return the color of the input connection 'idx'. </description> </method> - <method name="clear_all_slots"> + <method name="get_connection_input_count"> + <return type="int"> + </return> <description> - Disable all input and output slots of the GraphNode. + Return the number of enabled input slots (connections) to the GraphNode. </description> </method> - <method name="is_slot_enabled_left" qualifiers="const"> - <return type="bool"> + <method name="get_connection_input_pos"> + <return type="Vector2"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return true if left (input) slot 'idx' is enabled. False otherwise. + Return the position of the input connection 'idx'. </description> </method> - <method name="get_slot_type_left" qualifiers="const"> + <method name="get_connection_input_type"> <return type="int"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return the (integer) type of left (input) 'idx' slot. + Return the type of the input connection 'idx'. </description> </method> - <method name="get_slot_color_left" qualifiers="const"> + <method name="get_connection_output_color"> <return type="Color"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return the color set to 'idx' left (input) slot. + Return the color of the output connection 'idx'. </description> </method> - <method name="is_slot_enabled_right" qualifiers="const"> - <return type="bool"> + <method name="get_connection_output_count"> + <return type="int"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - Return true if right (output) slot 'idx' is enabled. False otherwise. + Return the number of enabled output slots (connections) of the GraphNode. </description> </method> - <method name="get_slot_type_right" qualifiers="const"> - <return type="int"> + <method name="get_connection_output_pos"> + <return type="Vector2"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return the (integer) type of right (output) 'idx' slot. + Return the position of the output connection 'idx'. </description> </method> - <method name="get_slot_color_right" qualifiers="const"> - <return type="Color"> + <method name="get_connection_output_type"> + <return type="int"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return the color set to 'idx' right (output) slot. - </description> - </method> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - Set the offset of the GraphNode. + Return the type of the output connection 'idx'. </description> </method> <method name="get_offset" qualifiers="const"> @@ -14070,72 +14114,79 @@ This approximation makes straight segments between each point, then subdivides t Return the offset of the GraphNode. </description> </method> - <method name="get_connection_output_count"> - <return type="int"> + <method name="get_slot_color_left" qualifiers="const"> + <return type="Color"> </return> + <argument index="0" name="idx" type="int"> + </argument> <description> - Return the number of enabled output slots (connections) of the GraphNode. + Return the color set to 'idx' left (input) slot. </description> </method> - <method name="get_connection_input_count"> - <return type="int"> + <method name="get_slot_color_right" qualifiers="const"> + <return type="Color"> </return> + <argument index="0" name="idx" type="int"> + </argument> <description> - Return the number of enabled input slots (connections) to the GraphNode. + Return the color set to 'idx' right (output) slot. </description> </method> - <method name="get_connection_output_pos"> - <return type="Vector2"> + <method name="get_slot_type_left" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return the position of the output connection 'idx'. + Return the (integer) type of left (input) 'idx' slot. </description> </method> - <method name="get_connection_output_type"> + <method name="get_slot_type_right" qualifiers="const"> <return type="int"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return the type of the output connection 'idx'. + Return the (integer) type of right (output) 'idx' slot. </description> </method> - <method name="get_connection_output_color"> - <return type="Color"> + <method name="get_title" qualifiers="const"> + <return type="String"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - Return the color of the output connection 'idx'. + Return the title of the GraphNode. </description> </method> - <method name="get_connection_input_pos"> - <return type="Vector2"> + <method name="is_close_button_visible" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - Return the position of the input connection 'idx'. + Returns true if the close button is shown. False otherwise. </description> </method> - <method name="get_connection_input_type"> - <return type="int"> + <method name="is_slot_enabled_left" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return the type of the input connection 'idx'. + Return true if left (input) slot 'idx' is enabled. False otherwise. </description> </method> - <method name="get_connection_input_color"> - <return type="Color"> + <method name="is_slot_enabled_right" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return the color of the input connection 'idx'. + Return true if right (output) slot 'idx' is enabled. False otherwise. + </description> + </method> + <method name="set_offset"> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Set the offset of the GraphNode. </description> </method> <method name="set_show_close_button"> @@ -14145,20 +14196,34 @@ This approximation makes straight segments between each point, then subdivides t 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. </description> </method> - <method name="is_close_button_visible" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_slot"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="enable_left" type="bool"> + </argument> + <argument index="2" name="type_left" type="int"> + </argument> + <argument index="3" name="color_left" type="Color"> + </argument> + <argument index="4" name="enable_right" type="bool"> + </argument> + <argument index="5" name="type_right" type="int"> + </argument> + <argument index="6" name="color_right" type="Color"> + </argument> <description> - Returns true if the close button is shown. False otherwise. + 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. </description> </method> - </methods> - <signals> - <signal name="raise_request"> + <method name="set_title"> + <argument index="0" name="title" type="String"> + </argument> <description> - Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. + Set the title of the GraphNode. </description> - </signal> + </method> + </methods> + <signals> <signal name="close_request"> <description> Signal sent on closing the GraphNode. @@ -14178,33 +14243,38 @@ This approximation makes straight segments between each point, then subdivides t Signal sent when the GraphNode is moved. </description> </signal> + <signal name="raise_request"> + <description> + Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. + </description> + </signal> </signals> <constants> </constants> <theme_items> - <theme_item name="port_offset" type="int"> + <theme_item name="close" type="Texture"> </theme_item> <theme_item name="close_offset" type="int"> </theme_item> - <theme_item name="separation" type="int"> + <theme_item name="defaultfocus" type="StyleBox"> </theme_item> - <theme_item name="title_offset" type="int"> + <theme_item name="defaultframe" type="StyleBox"> </theme_item> - <theme_item name="title_color" type="Color"> + <theme_item name="frame" type="StyleBox"> </theme_item> <theme_item name="port" type="Texture"> </theme_item> - <theme_item name="close" type="Texture"> + <theme_item name="port_offset" type="int"> </theme_item> - <theme_item name="title_font" type="Font"> + <theme_item name="selectedframe" type="StyleBox"> </theme_item> - <theme_item name="frame" type="StyleBox"> + <theme_item name="separation" type="int"> </theme_item> - <theme_item name="selectedframe" type="StyleBox"> + <theme_item name="title_color" type="Color"> </theme_item> - <theme_item name="defaultfocus" type="StyleBox"> + <theme_item name="title_font" type="Font"> </theme_item> - <theme_item name="defaultframe" type="StyleBox"> + <theme_item name="title_offset" type="int"> </theme_item> </theme_items> </class> @@ -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. </description> <methods> - <method name="set_columns"> - <argument index="0" name="columns" type="int"> - </argument> - <description> - Sets the numbers of columns in the container, then reorder its children to accommodate the new layout - </description> - </method> <method name="get_columns" qualifiers="const"> <return type="int"> </return> @@ -14230,14 +14293,21 @@ This approximation makes straight segments between each point, then subdivides t Returns the number of columns in this container </description> </method> + <method name="set_columns"> + <argument index="0" name="columns" type="int"> + </argument> + <description> + Sets the numbers of columns in the container, then reorder its children to accommodate the new layout + </description> + </method> </methods> <constants> </constants> <theme_items> - <theme_item name="vseparation" type="int"> - </theme_item> <theme_item name="hseparation" type="int"> </theme_item> + <theme_item name="vseparation" type="int"> + </theme_item> </theme_items> </class> <class name="GridMap" inherits="Spatial" category="Core"> @@ -14246,64 +14316,98 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> <methods> - <method name="set_theme"> - <argument index="0" name="theme" type="MeshLibrary"> + <method name="area_get_bounds" qualifiers="const"> + <return type="AABB"> + </return> + <argument index="0" name="area" type="int"> </argument> <description> </description> </method> - <method name="get_theme" qualifiers="const"> - <return type="MeshLibrary"> + <method name="area_get_name" qualifiers="const"> + <return type="String"> </return> + <argument index="0" name="area" type="int"> + </argument> <description> </description> </method> - <method name="set_bake"> - <argument index="0" name="enable" type="bool"> + <method name="area_get_portal_disable_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="area" type="int"> </argument> <description> </description> </method> - <method name="is_baking_enabled" qualifiers="const"> - <return type="bool"> + <method name="area_get_portal_disable_distance" qualifiers="const"> + <return type="float"> </return> + <argument index="0" name="area" type="int"> + </argument> <description> </description> </method> - <method name="set_cell_size"> - <argument index="0" name="size" type="float"> + <method name="area_is_exterior_portal" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="area" type="int"> </argument> <description> </description> </method> - <method name="get_cell_size" qualifiers="const"> - <return type="float"> - </return> + <method name="area_set_exterior_portal"> + <argument index="0" name="area" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> <description> </description> </method> - <method name="set_octant_size"> - <argument index="0" name="size" type="int"> + <method name="area_set_name"> + <argument index="0" name="area" type="int"> + </argument> + <argument index="1" name="name" type="String"> </argument> <description> </description> </method> - <method name="get_octant_size" qualifiers="const"> - <return type="int"> - </return> + <method name="area_set_portal_disable_color"> + <argument index="0" name="area" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> <description> </description> </method> - <method name="set_cell_item"> - <argument index="0" name="x" type="int"> + <method name="area_set_portal_disable_distance"> + <argument index="0" name="area" type="int"> </argument> - <argument index="1" name="y" type="int"> + <argument index="1" name="distance" type="float"> </argument> - <argument index="2" name="z" type="int"> + <description> + </description> + </method> + <method name="bake_geometry"> + <description> + </description> + </method> + <method name="clear"> + <description> + </description> + </method> + <method name="create_area"> + <return type="int"> + </return> + <argument index="0" name="id" type="int"> </argument> - <argument index="3" name="item" type="int"> + <argument index="1" name="area" type="AABB"> </argument> - <argument index="4" name="orientation" type="int" default="0"> + <description> + </description> + </method> + <method name="erase_area"> + <argument index="0" name="area" type="int"> </argument> <description> </description> @@ -14332,15 +14436,9 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="resource_changed"> - <argument index="0" name="resource" type="Object"> - </argument> - <description> - </description> - </method> - <method name="set_center_x"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_cell_size" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> @@ -14350,137 +14448,119 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="set_center_y"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> <method name="get_center_y" qualifiers="const"> <return type="bool"> </return> <description> </description> </method> - <method name="set_center_z"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_center_z" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_center_z" qualifiers="const"> - <return type="bool"> + <method name="get_octant_size" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="set_clip"> - <argument index="0" name="enabled" type="bool"> - </argument> - <argument index="1" name="clipabove" type="bool" default="true"> - </argument> - <argument index="2" name="floor" type="int" default="0"> - </argument> - <argument index="3" name="axis" type="int" default="0"> - </argument> + <method name="get_theme" qualifiers="const"> + <return type="MeshLibrary"> + </return> <description> </description> </method> - <method name="create_area"> + <method name="get_unused_area_id" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="area" type="AABB"> - </argument> <description> </description> </method> - <method name="area_get_bounds" qualifiers="const"> - <return type="AABB"> + <method name="is_baking_enabled" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="area" type="int"> - </argument> <description> </description> </method> - <method name="area_set_exterior_portal"> - <argument index="0" name="area" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> + <method name="is_using_baked_light" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="area_set_name"> - <argument index="0" name="area" type="int"> - </argument> - <argument index="1" name="name" type="String"> + <method name="resource_changed"> + <argument index="0" name="resource" type="Object"> </argument> <description> </description> </method> - <method name="area_get_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="area" type="int"> + <method name="set_bake"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="area_is_exterior_portal" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="area" type="int"> + <method name="set_cell_item"> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <argument index="2" name="z" type="int"> + </argument> + <argument index="3" name="item" type="int"> + </argument> + <argument index="4" name="orientation" type="int" default="0"> </argument> <description> </description> </method> - <method name="area_set_portal_disable_distance"> - <argument index="0" name="area" type="int"> - </argument> - <argument index="1" name="distance" type="float"> + <method name="set_cell_size"> + <argument index="0" name="size" type="float"> </argument> <description> </description> </method> - <method name="area_get_portal_disable_distance" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="area" type="int"> + <method name="set_center_x"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="area_set_portal_disable_color"> - <argument index="0" name="area" type="int"> - </argument> - <argument index="1" name="color" type="Color"> + <method name="set_center_y"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="area_get_portal_disable_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="area" type="int"> + <method name="set_center_z"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="erase_area"> - <argument index="0" name="area" type="int"> + <method name="set_clip"> + <argument index="0" name="enabled" type="bool"> + </argument> + <argument index="1" name="clipabove" type="bool" default="true"> + </argument> + <argument index="2" name="floor" type="int" default="0"> + </argument> + <argument index="3" name="axis" type="int" default="0"> </argument> <description> </description> </method> - <method name="get_unused_area_id" qualifiers="const"> - <return type="int"> - </return> + <method name="set_octant_size"> + <argument index="0" name="size" type="int"> + </argument> <description> </description> </method> - <method name="bake_geometry"> + <method name="set_theme"> + <argument index="0" name="theme" type="MeshLibrary"> + </argument> <description> </description> </method> @@ -14490,16 +14570,6 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="is_using_baked_light" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> </methods> <constants> <constant name="INVALID_CELL_ITEM" value="-1"> @@ -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. </description> <methods> - <method name="set_length"> - <argument index="0" name="length" type="float"> - </argument> + <method name="get_initial_offset" qualifiers="const"> + <return type="float"> + </return> <description> - Set the length of the groove. + Set the final offset of the groove on body A. </description> </method> <method name="get_length" qualifiers="const"> @@ -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. </description> </method> - <method name="get_initial_offset" qualifiers="const"> - <return type="float"> - </return> + <method name="set_length"> + <argument index="0" name="length" type="float"> + </argument> <description> - Set the final offset of the groove on body A. + Set the length of the groove. </description> </method> </methods> @@ -14576,24 +14646,24 @@ This approximation makes straight segments between each point, then subdivides t <theme_items> <theme_item name="button_separator" type="int"> </theme_item> - <theme_item name="icon_separator" type="int"> + <theme_item name="focus" type="StyleBox"> </theme_item> - <theme_item name="font_color_selected" type="Color"> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> - <theme_item name="font_selected" type="Font"> + <theme_item name="font_color_selected" type="Color"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="font_selected" type="Font"> </theme_item> <theme_item name="hover" type="StyleBox"> </theme_item> - <theme_item name="focus" type="StyleBox"> - </theme_item> - <theme_item name="selected" type="StyleBox"> + <theme_item name="icon_separator" type="int"> </theme_item> <theme_item name="normal" type="StyleBox"> </theme_item> + <theme_item name="selected" type="StyleBox"> + </theme_item> </theme_items> </class> <class name="HScrollBar" inherits="ScrollBar" category="Core"> @@ -14608,22 +14678,22 @@ This approximation makes straight segments between each point, then subdivides t <constants> </constants> <theme_items> - <theme_item name="increment_hilite" type="Texture"> + <theme_item name="decrement" type="Texture"> </theme_item> <theme_item name="decrement_hilite" type="Texture"> </theme_item> - <theme_item name="increment" type="Texture"> - </theme_item> - <theme_item name="decrement" type="Texture"> + <theme_item name="grabber" type="StyleBox"> </theme_item> <theme_item name="grabber_hilite" type="StyleBox"> </theme_item> - <theme_item name="grabber" type="StyleBox"> + <theme_item name="increment" type="Texture"> </theme_item> - <theme_item name="scroll_focus" type="StyleBox"> + <theme_item name="increment_hilite" type="Texture"> </theme_item> <theme_item name="scroll" type="StyleBox"> </theme_item> + <theme_item name="scroll_focus" type="StyleBox"> + </theme_item> </theme_items> </class> <class name="HSeparator" inherits="Separator" category="Core"> @@ -14656,17 +14726,17 @@ This approximation makes straight segments between each point, then subdivides t <constants> </constants> <theme_items> - <theme_item name="tick" type="Texture"> - </theme_item> - <theme_item name="grabber_hilite" type="Texture"> + <theme_item name="focus" type="StyleBox"> </theme_item> <theme_item name="grabber" type="Texture"> </theme_item> + <theme_item name="grabber_hilite" type="Texture"> + </theme_item> <theme_item name="grabber_hilite" type="StyleBox"> </theme_item> <theme_item name="slider" type="StyleBox"> </theme_item> - <theme_item name="focus" type="StyleBox"> + <theme_item name="tick" type="Texture"> </theme_item> </theme_items> </class> @@ -14684,11 +14754,11 @@ This approximation makes straight segments between each point, then subdivides t <theme_items> <theme_item name="autohide" type="int"> </theme_item> - <theme_item name="separation" type="int"> + <theme_item name="bg" type="StyleBox"> </theme_item> <theme_item name="grabber" type="Texture"> </theme_item> - <theme_item name="bg" type="StyleBox"> + <theme_item name="separation" type="int"> </theme_item> </theme_items> </class> @@ -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. </description> <methods> + <method name="close"> + <description> + Cloces the current connection, allows for reusal of [HTTPClient]. + </description> + </method> <method name="connect"> <return type="Error"> </return> @@ -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. </description> </method> - <method name="set_connection"> - <argument index="0" name="connection" type="StreamPeer"> - </argument> - <description> - Set connection to use, for this client. - </description> - </method> <method name="get_connection" qualifiers="const"> <return type="StreamPeer"> </return> @@ -14732,67 +14800,41 @@ This approximation makes straight segments between each point, then subdivides t Return current connection. </description> </method> - <method name="request_raw"> + <method name="get_response_body_length" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="method" type="int"> - </argument> - <argument index="1" name="url" type="String"> - </argument> - <argument index="2" name="headers" type="StringArray"> - </argument> - <argument index="3" name="body" type="RawArray"> - </argument> <description> - 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. + Return the response's body length. </description> </method> - <method name="request"> + <method name="get_response_code" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="method" type="int"> - </argument> - <argument index="1" name="url" type="String"> - </argument> - <argument index="2" name="headers" type="StringArray"> - </argument> - <argument index="3" name="body" type="String" default=""""> - </argument> <description> - 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] + Return the HTTP status code of the response. </description> </method> - <method name="send_body_text"> - <return type="int"> + <method name="get_response_headers"> + <return type="StringArray"> </return> - <argument index="0" name="body" type="String"> - </argument> <description> - Stub function + Return the response headers. </description> </method> - <method name="send_body_data"> - <return type="int"> + <method name="get_response_headers_as_dictionary"> + <return type="Dictionary"> </return> - <argument index="0" name="body" type="RawArray"> - </argument> <description> - Stub function + Returns all response headers as dictionary where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. +Structure: ("key":"value1; value2") +Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </description> </method> - <method name="close"> + <method name="get_status" qualifiers="const"> + <return type="int"> + </return> <description> - Cloces the current connection, allows for reusal of [HTTPClient]. + Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates. </description> </method> <method name="has_response" qualifiers="const"> @@ -14802,41 +14844,39 @@ This approximation makes straight segments between each point, then subdivides t Return whether this [HTTPClient] has a response available. </description> </method> - <method name="is_response_chunked" qualifiers="const"> + <method name="is_blocking_mode_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this [HTTPClient] has a response that is chunked. - </description> - </method> - <method name="get_response_code" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the HTTP status code of the response. + Return whether blocking mode is enabled. </description> </method> - <method name="get_response_headers"> - <return type="StringArray"> + <method name="is_response_chunked" qualifiers="const"> + <return type="bool"> </return> <description> - Return the response headers. + Return whether this [HTTPClient] has a response that is chunked. </description> </method> - <method name="get_response_headers_as_dictionary"> - <return type="Dictionary"> + <method name="poll"> + <return type="Error"> </return> <description> - Returns all response headers as dictionary where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. -Structure: ("key":"value1; value2") -Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + This needs to be called in order to have any request processed. Check results with [method get_status] </description> </method> - <method name="get_response_body_length" qualifiers="const"> - <return type="int"> + <method name="query_string_from_dict"> + <return type="String"> </return> + <argument index="0" name="fields" type="Dictionary"> + </argument> <description> - Return the response's body length. + Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: + [codeblock] + var fields = {"username": "user", "password": "pass"} + String queryString = httpClient.query_string_from_dict(fields) + returns:= "username=user&password=pass" + [/codeblock] </description> </method> <method name="read_response_body_chunk"> @@ -14846,53 +14886,83 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Reads one chunk from the response. </description> </method> - <method name="set_read_chunk_size"> - <argument index="0" name="bytes" type="int"> + <method name="request"> + <return type="int"> + </return> + <argument index="0" name="method" type="int"> + </argument> + <argument index="1" name="url" type="String"> + </argument> + <argument index="2" name="headers" type="StringArray"> + </argument> + <argument index="3" name="body" type="String" default=""""> </argument> <description> - Sets the size of the buffer used and maximum bytes to read per iteration. see [method read_response_body_chunk] + 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] </description> </method> - <method name="set_blocking_mode"> - <argument index="0" name="enabled" type="bool"> + <method name="request_raw"> + <return type="int"> + </return> + <argument index="0" name="method" type="int"> + </argument> + <argument index="1" name="url" type="String"> + </argument> + <argument index="2" name="headers" type="StringArray"> + </argument> + <argument index="3" name="body" type="RawArray"> </argument> <description> - If set to true, execution will block until all data is read from the response. + 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. </description> </method> - <method name="is_blocking_mode_enabled" qualifiers="const"> - <return type="bool"> + <method name="send_body_data"> + <return type="int"> </return> + <argument index="0" name="body" type="RawArray"> + </argument> <description> - Return whether blocking mode is enabled. + Stub function </description> </method> - <method name="get_status" qualifiers="const"> + <method name="send_body_text"> <return type="int"> </return> + <argument index="0" name="body" type="String"> + </argument> <description> - Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates. + Stub function </description> </method> - <method name="poll"> - <return type="Error"> - </return> + <method name="set_blocking_mode"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> - This needs to be called in order to have any request processed. Check results with [method get_status] + If set to true, execution will block until all data is read from the response. </description> </method> - <method name="query_string_from_dict"> - <return type="String"> - </return> - <argument index="0" name="fields" type="Dictionary"> + <method name="set_connection"> + <argument index="0" name="connection" type="StreamPeer"> </argument> <description> - Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: - [codeblock] - var fields = {"username": "user", "password": "pass"} - String queryString = httpClient.query_string_from_dict(fields) - returns:= "username=user&password=pass" - [/codeblock] + Set connection to use, for this client. + </description> + </method> + <method name="set_read_chunk_size"> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + Sets the size of the buffer used and maximum bytes to read per iteration. see [method read_response_body_chunk] </description> </method> </methods> @@ -14915,26 +14985,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="METHOD_MAX" value="8"> </constant> - <constant name="STATUS_DISCONNECTED" value="0"> - </constant> - <constant name="STATUS_RESOLVING" value="1"> - </constant> - <constant name="STATUS_CANT_RESOLVE" value="2"> - </constant> - <constant name="STATUS_CONNECTING" value="3"> - </constant> - <constant name="STATUS_CANT_CONNECT" value="4"> - </constant> - <constant name="STATUS_CONNECTED" value="5"> - </constant> - <constant name="STATUS_REQUESTING" value="6"> - </constant> - <constant name="STATUS_BODY" value="7"> - </constant> - <constant name="STATUS_CONNECTION_ERROR" value="8"> - </constant> - <constant name="STATUS_SSL_HANDSHAKE_ERROR" value="9"> - </constant> <constant name="RESPONSE_CONTINUE" value="100"> </constant> <constant name="RESPONSE_SWITCHING_PROTOCOLS" value="101"> @@ -15033,6 +15083,26 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="RESPONSE_NOT_EXTENDED" value="510"> </constant> + <constant name="STATUS_DISCONNECTED" value="0"> + </constant> + <constant name="STATUS_RESOLVING" value="1"> + </constant> + <constant name="STATUS_CANT_RESOLVE" value="2"> + </constant> + <constant name="STATUS_CONNECTING" value="3"> + </constant> + <constant name="STATUS_CANT_CONNECT" value="4"> + </constant> + <constant name="STATUS_CONNECTED" value="5"> + </constant> + <constant name="STATUS_REQUESTING" value="6"> + </constant> + <constant name="STATUS_BODY" value="7"> + </constant> + <constant name="STATUS_CONNECTION_ERROR" value="8"> + </constant> + <constant name="STATUS_SSL_HANDSHAKE_ERROR" value="9"> + </constant> </constants> </class> <class name="HTTPRequest" inherits="Node" category="Core"> @@ -15044,101 +15114,101 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Can be used to make HTTP requests or download files via HTTP. </description> <methods> - <method name="request"> - <return type="int"> - </return> - <argument index="0" name="url" type="String"> - </argument> - <argument index="1" name="custom_headers" type="StringArray" default="StringArray()"> - </argument> - <argument index="2" name="ssl_validate_domain" type="bool" default="true"> - </argument> + <method name="cancel_request"> <description> - 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. </description> </method> - <method name="cancel_request"> + <method name="get_body_size" qualifiers="const"> + <return type="int"> + </return> <description> - Cancel the current request. + Return the response body length. </description> </method> - <method name="get_http_client_status" qualifiers="const"> + <method name="get_body_size_limit" qualifiers="const"> <return type="int"> </return> <description> - Return the current status of the underlying [HTTPClient]. + Return current body size limit. </description> </method> - <method name="set_use_threads"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_download_file" qualifiers="const"> + <return type="String"> + </return> <description> - Make this HTTPRequest use threads. + Return the file this request will download into. </description> </method> - <method name="is_using_threads" qualifiers="const"> - <return type="bool"> + <method name="get_downloaded_bytes" qualifiers="const"> + <return type="int"> </return> <description> - Whether this request is using threads. + Return the amount of bytes this HTTPRequest downloaded. </description> </method> - <method name="set_body_size_limit"> - <argument index="0" name="bytes" type="int"> - </argument> + <method name="get_http_client_status" qualifiers="const"> + <return type="int"> + </return> <description> - Set the response body size limit. + Return the current status of the underlying [HTTPClient]. </description> </method> - <method name="get_body_size_limit" qualifiers="const"> + <method name="get_max_redirects" qualifiers="const"> <return type="int"> </return> <description> - Return current body size limit. + Return the maximum amount of redirects that will be followed. </description> </method> - <method name="set_max_redirects"> - <argument index="0" name="amount" type="int"> - </argument> + <method name="is_using_threads" qualifiers="const"> + <return type="bool"> + </return> <description> - Set the maximum amount of redirects the request will follow. + Whether this request is using threads. </description> </method> - <method name="get_max_redirects" qualifiers="const"> + <method name="request"> <return type="int"> </return> + <argument index="0" name="url" type="String"> + </argument> + <argument index="1" name="custom_headers" type="StringArray" default="StringArray()"> + </argument> + <argument index="2" name="ssl_validate_domain" type="bool" default="true"> + </argument> <description> - Return the maximum amount of redirects that will be followed. + 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. </description> </method> - <method name="set_download_file"> - <argument index="0" name="path" type="String"> + <method name="set_body_size_limit"> + <argument index="0" name="bytes" type="int"> </argument> <description> - Set the file to download into. Outputs the response body into the file. + Set the response body size limit. </description> </method> - <method name="get_download_file" qualifiers="const"> - <return type="String"> - </return> + <method name="set_download_file"> + <argument index="0" name="path" type="String"> + </argument> <description> - Return the file this request will download into. + Set the file to download into. Outputs the response body into the file. </description> </method> - <method name="get_downloaded_bytes" qualifiers="const"> - <return type="int"> - </return> + <method name="set_max_redirects"> + <argument index="0" name="amount" type="int"> + </argument> <description> - Return the amount of bytes this HTTPRequest downloaded. + Set the maximum amount of redirects the request will follow. </description> </method> - <method name="get_body_size" qualifiers="const"> - <return type="int"> - </return> + <method name="set_use_threads"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return the response body length. + Make this HTTPRequest use threads. </description> </method> </methods> @@ -15163,6 +15233,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="RESULT_CHUNKED_BODY_SIZE_MISMATCH" value="1"> </constant> + <constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="10"> + HTTPRequest couldn't write to the download file. + </constant> + <constant name="RESULT_REDIRECT_LIMIT_REACHED" value="11"> + Request reached it's maximum redirect limit, see [method set_max_redirects]. + </constant> <constant name="RESULT_CANT_CONNECT" value="2"> Request failed while connecting. </constant> @@ -15187,12 +15263,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constant name="RESULT_DOWNLOAD_FILE_CANT_OPEN" value="9"> HTTPRequest couldn't open the download file. </constant> - <constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="10"> - HTTPRequest couldn't write to the download file. - </constant> - <constant name="RESULT_REDIRECT_LIMIT_REACHED" value="11"> - Request reached it's maximum redirect limit, see [method set_max_redirects]. - </constant> </constants> </class> <class name="HingeJoint" inherits="Joint" category="Core"> @@ -15201,10 +15271,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_param"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="float"> + <method name="get_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int"> </argument> <description> </description> @@ -15225,16 +15295,22 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int"> + <method name="set_param"> + <argument index="0" name="param" type="int"> + </argument> + <argument index="1" name="value" type="float"> </argument> <description> </description> </method> </methods> <constants> + <constant name="FLAG_USE_LIMIT" value="0"> + </constant> + <constant name="FLAG_ENABLE_MOTOR" value="1"> + </constant> + <constant name="FLAG_MAX" value="2"> + </constant> <constant name="PARAM_BIAS" value="0"> </constant> <constant name="PARAM_LIMIT_UPPER" value="1"> @@ -15253,12 +15329,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="PARAM_MAX" value="8"> </constant> - <constant name="FLAG_USE_LIMIT" value="0"> - </constant> - <constant name="FLAG_ENABLE_MOTOR" value="1"> - </constant> - <constant name="FLAG_MAX" value="2"> - </constant> </constants> </class> <class name="IP" inherits="Object" category="Core"> @@ -15269,57 +15339,59 @@ 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. </description> <methods> - <method name="resolve_hostname"> - <return type="String"> - </return> - <argument index="0" name="host" type="String"> + <method name="erase_resolve_item"> + <argument index="0" name="id" type="int"> </argument> <description> - Resolve a given hostname, blocking. Resolved hostname is returned as an IP. + 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. </description> </method> - <method name="resolve_hostname_queue_item"> - <return type="int"> + <method name="get_local_addresses" qualifiers="const"> + <return type="Array"> </return> - <argument index="0" name="host" type="String"> - </argument> <description> - Create a queue item for resolving a given hostname. The queue ID is returned, or RESOLVER_INVALID_ID on error. </description> </method> - <method name="get_resolve_item_status" qualifiers="const"> - <return type="int"> + <method name="get_resolve_item_address" qualifiers="const"> + <return type="String"> </return> <argument index="0" name="id" type="int"> </argument> <description> - 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]). </description> </method> - <method name="get_resolve_item_address" qualifiers="const"> - <return type="String"> + <method name="get_resolve_item_status" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="id" type="int"> </argument> <description> - 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. </description> </method> - <method name="erase_resolve_item"> - <argument index="0" name="id" type="int"> + <method name="resolve_hostname"> + <return type="String"> + </return> + <argument index="0" name="host" type="String"> </argument> <description> - 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. + Resolve a given hostname, blocking. Resolved hostname is returned as an IP. </description> </method> - <method name="get_local_addresses" qualifiers="const"> - <return type="Array"> + <method name="resolve_hostname_queue_item"> + <return type="int"> </return> + <argument index="0" name="host" type="String"> + </argument> <description> + Create a queue item for resolving a given hostname. The queue ID is returned, or RESOLVER_INVALID_ID on error. </description> </method> </methods> <constants> + <constant name="RESOLVER_INVALID_ID" value="-1"> + </constant> <constant name="RESOLVER_STATUS_NONE" value="0"> </constant> <constant name="RESOLVER_STATUS_WAITING" value="1"> @@ -15330,8 +15402,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="RESOLVER_MAX_QUERIES" value="32"> </constant> - <constant name="RESOLVER_INVALID_ID" value="-1"> - </constant> </constants> </class> <class name="IP_Unix" inherits="IP" category="Core"> @@ -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. </description> <methods> + <method name="Image"> + <return type="Image"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="mipmaps" type="bool"> + </argument> + <argument index="3" name="format" type="int"> + </argument> + <description> + Create an empty image of a specific size and format. + </description> + </method> <method name="blit_rect"> <argument index="0" name="src" type="Image"> </argument> @@ -15524,21 +15609,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Save this [Image] as a png. </description> </method> - <method name="Image"> - <return type="Image"> - </return> - <argument index="0" name="width" type="int"> - </argument> - <argument index="1" name="height" type="int"> - </argument> - <argument index="2" name="mipmaps" type="bool"> - </argument> - <argument index="3" name="format" type="int"> - </argument> - <description> - Create an empty image of a specific size and format. - </description> - </method> </methods> <constants> <constant name="COMPRESS_BC" value="0"> @@ -15553,22 +15623,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="FORMAT_INTENSITY" value="1"> </constant> - <constant name="FORMAT_GRAYSCALE_ALPHA" value="2"> - </constant> - <constant name="FORMAT_RGB" value="3"> - </constant> - <constant name="FORMAT_RGBA" value="4"> - </constant> - <constant name="FORMAT_INDEXED" value="5"> - </constant> - <constant name="FORMAT_INDEXED_ALPHA" value="6"> - </constant> - <constant name="FORMAT_YUV_422" value="7"> - </constant> - <constant name="FORMAT_YUV_444" value="8"> - </constant> - <constant name="FORMAT_BC1" value="9"> - </constant> <constant name="FORMAT_BC2" value="10"> </constant> <constant name="FORMAT_BC3" value="11"> @@ -15589,12 +15643,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="FORMAT_ATC" value="19"> </constant> + <constant name="FORMAT_GRAYSCALE_ALPHA" value="2"> + </constant> <constant name="FORMAT_ATC_ALPHA_EXPLICIT" value="20"> </constant> <constant name="FORMAT_ATC_ALPHA_INTERPOLATED" value="21"> </constant> <constant name="FORMAT_CUSTOM" value="22"> </constant> + <constant name="FORMAT_RGB" value="3"> + </constant> + <constant name="FORMAT_RGBA" value="4"> + </constant> + <constant name="FORMAT_INDEXED" value="5"> + </constant> + <constant name="FORMAT_INDEXED_ALPHA" value="6"> + </constant> + <constant name="FORMAT_YUV_422" value="7"> + </constant> + <constant name="FORMAT_YUV_444" value="8"> + </constant> + <constant name="FORMAT_BC1" value="9"> + </constant> <constant name="INTERPOLATE_NEAREST" value="0"> </constant> <constant name="INTERPOLATE_BILINEAR" value="1"> @@ -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_*. </description> </method> - <method name="get_format" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the format of the [ImageTexture], one of [Image].FORMAT_*. - </description> - </method> - <method name="load"> - <argument index="0" name="path" type="String"> - </argument> - <description> - Load an [ImageTexure]. - </description> - </method> - <method name="set_data"> - <argument index="0" name="image" type="Image"> - </argument> + <method name="fix_alpha_edges"> <description> - Set the [Image] of this [ImageTexture]. </description> </method> <method name="get_data" qualifiers="const"> @@ -15663,11 +15716,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the [Image] of this [ImageTexture]. </description> </method> - <method name="set_storage"> - <argument index="0" name="mode" type="int"> - </argument> + <method name="get_format" qualifiers="const"> + <return type="int"> + </return> <description> - Set the storage type. One of [ImageTexture].STORAGE_*. + Return the format of the [ImageTexture], one of [Image].FORMAT_*. + </description> + </method> + <method name="get_lossy_storage_quality" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the storage quality for [ImageTexture].STORAGE_COMPRESS_LOSSY. </description> </method> <method name="get_storage" qualifiers="const"> @@ -15677,21 +15737,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the storage type. One of [ImageTexture].STORAGE_*. </description> </method> - <method name="set_lossy_storage_quality"> - <argument index="0" name="quality" type="float"> + <method name="load"> + <argument index="0" name="path" type="String"> </argument> <description> - Set the storage quality in case of [ImageTexture].STORAGE_COMPRESS_LOSSY. - </description> - </method> - <method name="get_lossy_storage_quality" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the storage quality for [ImageTexture].STORAGE_COMPRESS_LOSSY. + Load an [ImageTexure]. </description> </method> - <method name="fix_alpha_edges"> + <method name="normal_to_xy"> <description> </description> </method> @@ -15699,12 +15752,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="normal_to_xy"> + <method name="set_data"> + <argument index="0" name="image" type="Image"> + </argument> <description> + Set the [Image] of this [ImageTexture]. </description> </method> - <method name="shrink_x2_and_keep_size"> + <method name="set_lossy_storage_quality"> + <argument index="0" name="quality" type="float"> + </argument> <description> + Set the storage quality in case of [ImageTexture].STORAGE_COMPRESS_LOSSY. </description> </method> <method name="set_size_override"> @@ -15713,6 +15772,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> + <method name="set_storage"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + Set the storage type. One of [ImageTexture].STORAGE_*. + </description> + </method> + <method name="shrink_x2_and_keep_size"> + <description> + </description> + </method> </methods> <constants> <constant name="STORAGE_RAW" value="0"> @@ -15732,65 +15802,65 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="begin"> - <argument index="0" name="primitive" type="int"> + <method name="add_sphere"> + <argument index="0" name="lats" type="int"> </argument> - <argument index="1" name="texture" type="Texture"> + <argument index="1" name="lons" type="int"> + </argument> + <argument index="2" name="radius" type="float"> </argument> <description> </description> </method> - <method name="set_normal"> - <argument index="0" name="normal" type="Vector3"> + <method name="add_vertex"> + <argument index="0" name="pos" type="Vector3"> </argument> <description> </description> </method> - <method name="set_tangent"> - <argument index="0" name="tangent" type="Plane"> + <method name="begin"> + <argument index="0" name="primitive" type="int"> + </argument> + <argument index="1" name="texture" type="Texture"> </argument> <description> </description> </method> - <method name="set_color"> - <argument index="0" name="color" type="Color"> - </argument> + <method name="clear"> <description> </description> </method> - <method name="set_uv"> - <argument index="0" name="uv" type="Vector2"> - </argument> + <method name="end"> <description> </description> </method> - <method name="set_uv2"> - <argument index="0" name="uv" type="Vector2"> + <method name="set_color"> + <argument index="0" name="color" type="Color"> </argument> <description> </description> </method> - <method name="add_vertex"> - <argument index="0" name="pos" type="Vector3"> + <method name="set_normal"> + <argument index="0" name="normal" type="Vector3"> </argument> <description> </description> </method> - <method name="add_sphere"> - <argument index="0" name="lats" type="int"> - </argument> - <argument index="1" name="lons" type="int"> - </argument> - <argument index="2" name="radius" type="float"> + <method name="set_tangent"> + <argument index="0" name="tangent" type="Plane"> </argument> <description> </description> </method> - <method name="end"> + <method name="set_uv"> + <argument index="0" name="uv" type="Vector2"> + </argument> <description> </description> </method> - <method name="clear"> + <method name="set_uv2"> + <argument index="0" name="uv" type="Vector2"> + </argument> <description> </description> </method> @@ -15806,42 +15876,18 @@ 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. </description> <methods> - <method name="is_key_pressed"> - <return type="bool"> - </return> - <argument index="0" name="scancode" type="int"> - </argument> - <description> - Returns true or false depending on whether the key is pressed or not. You can pass KEY_*, which are pre-defined constants listed in [@Global Scope]. - </description> - </method> - <method name="is_mouse_button_pressed"> - <return type="bool"> - </return> - <argument index="0" name="button" type="int"> - </argument> - <description> - 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]. - </description> - </method> - <method name="is_joy_button_pressed"> - <return type="bool"> - </return> - <argument index="0" name="device" type="int"> - </argument> - <argument index="1" name="button" type="int"> + <method name="action_press"> + <argument index="0" name="action" type="String"> </argument> <description> - Returns if the joystick button at the given index is currently pressed. (see JOY_* constants in [@Global Scope]) + This will simulate pressing the specificed action. </description> </method> - <method name="is_action_pressed"> - <return type="bool"> - </return> + <method name="action_release"> <argument index="0" name="action" type="String"> </argument> <description> - 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]. + If the specified action is already pressed, this will release it. </description> </method> <method name="add_joy_mapping"> @@ -15853,20 +15899,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. </description> </method> - <method name="remove_joy_mapping"> - <argument index="0" name="guid" type="String"> - </argument> - <description> - Removes all mappings from the internal db that match the given uid. - </description> - </method> - <method name="is_joy_known"> - <return type="bool"> + <method name="get_accelerometer"> + <return type="Vector3"> </return> - <argument index="0" name="device" type="int"> - </argument> <description> - 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. + If the device has an accelerometer, this will return the movement. </description> </method> <method name="get_joy_axis"> @@ -15880,15 +15917,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the current value of the joystick axis at given index (see JOY_* constants in [@Global Scope]) </description> </method> - <method name="get_joy_name"> - <return type="String"> - </return> - <argument index="0" name="device" type="int"> - </argument> - <description> - Returns the name of the joystick at the specified device index - </description> - </method> <method name="get_joy_guid" qualifiers="const"> <return type="String"> </return> @@ -15898,13 +15926,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise. </description> </method> - <method name="get_joy_vibration_strength"> - <return type="Vector2"> + <method name="get_joy_name"> + <return type="String"> </return> <argument index="0" name="device" type="int"> </argument> <description> - 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 name of the joystick at the specified device index </description> </method> <method name="get_joy_vibration_duration"> @@ -15916,38 +15944,34 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the duration of the current vibration effect in seconds. </description> </method> - <method name="start_joy_vibration"> + <method name="get_joy_vibration_strength"> + <return type="Vector2"> + </return> <argument index="0" name="device" type="int"> </argument> - <argument index="1" name="weak_magnitude" type="float"> - </argument> - <argument index="2" name="strong_magnitude" type="float"> - </argument> - <argument index="3" name="duration" type="float"> - </argument> <description> - 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). + Returns the strength of the joystick vibration: x is the strength of the weak motor, and y is the strength of the strong motor. </description> </method> - <method name="stop_joy_vibration"> - <argument index="0" name="device" type="int"> - </argument> + <method name="get_magnetometer"> + <return type="Vector3"> + </return> <description> - Stops the vibration of the joystick. + If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. </description> </method> - <method name="get_accelerometer"> - <return type="Vector3"> + <method name="get_mouse_button_mask" qualifiers="const"> + <return type="int"> </return> <description> - If the device has an accelerometer, this will return the movement. + Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together. </description> </method> - <method name="get_magnetometer"> - <return type="Vector3"> + <method name="get_mouse_mode" qualifiers="const"> + <return type="int"> </return> <description> - If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. + Return the mouse mode. See the constants for more information. </description> </method> <method name="get_mouse_speed" qualifiers="const"> @@ -15957,46 +15981,58 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the mouse speed. </description> </method> - <method name="get_mouse_button_mask" qualifiers="const"> - <return type="int"> + <method name="is_action_pressed"> + <return type="bool"> </return> + <argument index="0" name="action" type="String"> + </argument> <description> - Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together. + 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]. </description> </method> - <method name="set_mouse_mode"> - <argument index="0" name="mode" type="int"> + <method name="is_joy_button_pressed"> + <return type="bool"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <argument index="1" name="button" type="int"> </argument> <description> - Set the mouse mode. See the constants for more information. + Returns if the joystick button at the given index is currently pressed. (see JOY_* constants in [@Global Scope]) </description> </method> - <method name="get_mouse_mode" qualifiers="const"> - <return type="int"> + <method name="is_joy_known"> + <return type="bool"> </return> + <argument index="0" name="device" type="int"> + </argument> <description> - Return the mouse mode. See the constants for more information. + 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. </description> </method> - <method name="warp_mouse_pos"> - <argument index="0" name="to" type="Vector2"> + <method name="is_key_pressed"> + <return type="bool"> + </return> + <argument index="0" name="scancode" type="int"> </argument> <description> - Sets the mouse position to the specified vector. + Returns true or false depending on whether the key is pressed or not. You can pass KEY_*, which are pre-defined constants listed in [@Global Scope]. </description> </method> - <method name="action_press"> - <argument index="0" name="action" type="String"> + <method name="is_mouse_button_pressed"> + <return type="bool"> + </return> + <argument index="0" name="button" type="int"> </argument> <description> - This will simulate pressing the specificed action. + 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]. </description> </method> - <method name="action_release"> - <argument index="0" name="action" type="String"> + <method name="remove_joy_mapping"> + <argument index="0" name="guid" type="String"> </argument> <description> - If the specified action is already pressed, this will release it. + Removes all mappings from the internal db that match the given uid. </description> </method> <method name="set_custom_mouse_cursor"> @@ -16008,6 +16044,40 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. </description> </method> + <method name="set_mouse_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + Set the mouse mode. See the constants for more information. + </description> + </method> + <method name="start_joy_vibration"> + <argument index="0" name="device" type="int"> + </argument> + <argument index="1" name="weak_magnitude" type="float"> + </argument> + <argument index="2" name="strong_magnitude" type="float"> + </argument> + <argument index="3" name="duration" type="float" default="0"> + </argument> + <description> + 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). + </description> + </method> + <method name="stop_joy_vibration"> + <argument index="0" name="device" type="int"> + </argument> + <description> + Stops the vibration of the joystick. + </description> + </method> + <method name="warp_mouse_pos"> + <argument index="0" name="to" type="Vector2"> + </argument> + <description> + Sets the mouse position to the specified vector. + </description> + </method> </methods> <signals> <signal name="joy_connection_changed"> @@ -16099,16 +16169,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> </methods> <members> - <member name="type" type="int"> + <member name="ID" type="int"> </member> <member name="device" type="int"> </member> - <member name="ID" type="int"> + <member name="type" type="int"> </member> </members> <constants> - <constant name="NONE" value="0"> - Empty input event. + <constant name="ACTION" value="8"> + </constant> + <constant name="JOYSTICK_MOTION" value="4"> + Joystick motion event. + </constant> + <constant name="JOYSTICK_BUTTON" value="5"> + Joystick button event. </constant> <constant name="KEY" value="1"> Key event. @@ -16119,18 +16194,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constant name="MOUSE_BUTTON" value="3"> Mouse button event. </constant> - <constant name="JOYSTICK_MOTION" value="4"> - Joystick motion event. - </constant> - <constant name="JOYSTICK_BUTTON" value="5"> - Joystick button event. + <constant name="NONE" value="0"> + Empty input event. </constant> <constant name="SCREEN_TOUCH" value="6"> </constant> <constant name="SCREEN_DRAG" value="7"> </constant> - <constant name="ACTION" value="8"> - </constant> </constants> </class> <class name="InputEventAction" category="Built-In Types"> @@ -16185,15 +16255,19 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> </methods> <members> - <member name="type" type="int"> + <member name="ID" type="int"> </member> <member name="device" type="int"> </member> - <member name="ID" type="int"> + <member name="type" type="int"> </member> </members> <constants> - <constant name="NONE" value="0"> + <constant name="ACTION" value="8"> + </constant> + <constant name="JOYSTICK_MOTION" value="4"> + </constant> + <constant name="JOYSTICK_BUTTON" value="5"> </constant> <constant name="KEY" value="1"> </constant> @@ -16201,16 +16275,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="MOUSE_BUTTON" value="3"> </constant> - <constant name="JOYSTICK_MOTION" value="4"> - </constant> - <constant name="JOYSTICK_BUTTON" value="5"> + <constant name="NONE" value="0"> </constant> <constant name="SCREEN_TOUCH" value="6"> </constant> <constant name="SCREEN_DRAG" value="7"> </constant> - <constant name="ACTION" value="8"> - </constant> </constants> </class> <class name="InputEventJoystickButton" category="Built-In Types"> @@ -16265,21 +16335,25 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> </methods> <members> - <member name="type" type="int"> - </member> - <member name="device" type="int"> - </member> <member name="ID" type="int"> </member> <member name="button_index" type="int"> </member> + <member name="device" type="int"> + </member> <member name="pressed" type="bool"> </member> <member name="pressure" type="float"> </member> + <member name="type" type="int"> + </member> </members> <constants> - <constant name="NONE" value="0"> + <constant name="ACTION" value="8"> + </constant> + <constant name="JOYSTICK_MOTION" value="4"> + </constant> + <constant name="JOYSTICK_BUTTON" value="5"> </constant> <constant name="KEY" value="1"> </constant> @@ -16287,16 +16361,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="MOUSE_BUTTON" value="3"> </constant> - <constant name="JOYSTICK_MOTION" value="4"> - </constant> - <constant name="JOYSTICK_BUTTON" value="5"> + <constant name="NONE" value="0"> </constant> <constant name="SCREEN_TOUCH" value="6"> </constant> <constant name="SCREEN_DRAG" value="7"> </constant> - <constant name="ACTION" value="8"> - </constant> </constants> </class> <class name="InputEventJoystickMotion" category="Built-In Types"> @@ -16351,19 +16421,23 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> </methods> <members> - <member name="type" type="int"> - </member> - <member name="device" type="int"> - </member> <member name="ID" type="int"> </member> <member name="axis" type="int"> </member> + <member name="device" type="int"> + </member> + <member name="type" type="int"> + </member> <member name="value" type="float"> </member> </members> <constants> - <constant name="NONE" value="0"> + <constant name="ACTION" value="8"> + </constant> + <constant name="JOYSTICK_MOTION" value="4"> + </constant> + <constant name="JOYSTICK_BUTTON" value="5"> </constant> <constant name="KEY" value="1"> </constant> @@ -16371,16 +16445,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="MOUSE_BUTTON" value="3"> </constant> - <constant name="JOYSTICK_MOTION" value="4"> - </constant> - <constant name="JOYSTICK_BUTTON" value="5"> + <constant name="NONE" value="0"> </constant> <constant name="SCREEN_TOUCH" value="6"> </constant> <constant name="SCREEN_DRAG" value="7"> </constant> - <constant name="ACTION" value="8"> - </constant> </constants> </class> <class name="InputEventKey" category="Built-In Types"> @@ -16435,31 +16505,35 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> </methods> <members> - <member name="type" type="int"> - </member> - <member name="device" type="int"> - </member> <member name="ID" type="int"> </member> - <member name="shift" type="bool"> - </member> <member name="alt" type="bool"> </member> <member name="control" type="bool"> </member> + <member name="device" type="int"> + </member> + <member name="echo" type="bool"> + </member> <member name="meta" type="bool"> </member> <member name="pressed" type="bool"> </member> - <member name="echo" type="bool"> - </member> <member name="scancode" type="int"> </member> + <member name="shift" type="bool"> + </member> + <member name="type" type="int"> + </member> <member name="unicode" type="int"> </member> </members> <constants> - <constant name="NONE" value="0"> + <constant name="ACTION" value="8"> + </constant> + <constant name="JOYSTICK_MOTION" value="4"> + </constant> + <constant name="JOYSTICK_BUTTON" value="5"> </constant> <constant name="KEY" value="1"> </constant> @@ -16467,16 +16541,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="MOUSE_BUTTON" value="3"> </constant> - <constant name="JOYSTICK_MOTION" value="4"> - </constant> - <constant name="JOYSTICK_BUTTON" value="5"> + <constant name="NONE" value="0"> </constant> <constant name="SCREEN_TOUCH" value="6"> </constant> <constant name="SCREEN_DRAG" value="7"> </constant> - <constant name="ACTION" value="8"> - </constant> </constants> </class> <class name="InputEventMouseButton" category="Built-In Types"> @@ -16531,43 +16601,47 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> </methods> <members> - <member name="type" type="int"> - </member> - <member name="device" type="int"> - </member> <member name="ID" type="int"> </member> - <member name="shift" type="bool"> - </member> <member name="alt" type="bool"> </member> - <member name="control" type="bool"> - </member> - <member name="meta" type="bool"> + <member name="button_index" type="int"> </member> <member name="button_mask" type="int"> </member> - <member name="x" type="int"> + <member name="control" type="bool"> </member> - <member name="y" type="int"> + <member name="device" type="int"> </member> - <member name="pos" type="Vector2"> + <member name="doubleclick" type="bool"> + </member> + <member name="global_pos" type="Vector2"> </member> <member name="global_x" type="int"> </member> <member name="global_y" type="int"> </member> - <member name="global_pos" type="Vector2"> + <member name="meta" type="bool"> </member> - <member name="button_index" type="int"> + <member name="pos" type="Vector2"> </member> <member name="pressed" type="bool"> </member> - <member name="doubleclick" type="bool"> + <member name="shift" type="bool"> + </member> + <member name="type" type="int"> + </member> + <member name="x" type="int"> + </member> + <member name="y" type="int"> </member> </members> <constants> - <constant name="NONE" value="0"> + <constant name="ACTION" value="8"> + </constant> + <constant name="JOYSTICK_MOTION" value="4"> + </constant> + <constant name="JOYSTICK_BUTTON" value="5"> </constant> <constant name="KEY" value="1"> </constant> @@ -16575,16 +16649,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="MOUSE_BUTTON" value="3"> </constant> - <constant name="JOYSTICK_MOTION" value="4"> - </constant> - <constant name="JOYSTICK_BUTTON" value="5"> + <constant name="NONE" value="0"> </constant> <constant name="SCREEN_TOUCH" value="6"> </constant> <constant name="SCREEN_DRAG" value="7"> </constant> - <constant name="ACTION" value="8"> - </constant> </constants> </class> <class name="InputEventMouseMotion" category="Built-In Types"> @@ -16639,49 +16709,53 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> </methods> <members> - <member name="type" type="int"> - </member> - <member name="device" type="int"> - </member> <member name="ID" type="int"> </member> - <member name="shift" type="bool"> - </member> <member name="alt" type="bool"> </member> - <member name="control" type="bool"> - </member> - <member name="meta" type="bool"> - </member> <member name="button_mask" type="int"> </member> - <member name="x" type="int"> + <member name="control" type="bool"> </member> - <member name="y" type="int"> + <member name="device" type="int"> </member> - <member name="pos" type="Vector2"> + <member name="global_pos" type="Vector2"> </member> <member name="global_x" type="int"> </member> <member name="global_y" type="int"> </member> - <member name="global_pos" type="Vector2"> + <member name="meta" type="bool"> + </member> + <member name="pos" type="Vector2"> + </member> + <member name="relative_pos" type="Vector2"> </member> <member name="relative_x" type="int"> </member> <member name="relative_y" type="int"> </member> - <member name="relative_pos" type="Vector2"> + <member name="shift" type="bool"> + </member> + <member name="speed" type="Vector2"> </member> <member name="speed_x" type="float"> </member> <member name="speed_y" type="float"> </member> - <member name="speed" type="Vector2"> + <member name="type" type="int"> + </member> + <member name="x" type="int"> + </member> + <member name="y" type="int"> </member> </members> <constants> - <constant name="NONE" value="0"> + <constant name="ACTION" value="8"> + </constant> + <constant name="JOYSTICK_MOTION" value="4"> + </constant> + <constant name="JOYSTICK_BUTTON" value="5"> </constant> <constant name="KEY" value="1"> </constant> @@ -16689,16 +16763,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="MOUSE_BUTTON" value="3"> </constant> - <constant name="JOYSTICK_MOTION" value="4"> - </constant> - <constant name="JOYSTICK_BUTTON" value="5"> + <constant name="NONE" value="0"> </constant> <constant name="SCREEN_TOUCH" value="6"> </constant> <constant name="SCREEN_DRAG" value="7"> </constant> - <constant name="ACTION" value="8"> - </constant> </constants> </class> <class name="InputEventScreenDrag" category="Built-In Types"> @@ -16753,35 +16823,39 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> </methods> <members> - <member name="type" type="int"> + <member name="ID" type="int"> </member> <member name="device" type="int"> </member> - <member name="ID" type="int"> - </member> <member name="index" type="int"> </member> - <member name="x" type="float"> - </member> - <member name="y" type="float"> - </member> <member name="pos" type="Vector2"> </member> + <member name="relative_pos" type="Vector2"> + </member> <member name="relative_x" type="float"> </member> <member name="relative_y" type="float"> </member> - <member name="relative_pos" type="Vector2"> + <member name="speed" type="Vector2"> </member> <member name="speed_x" type="float"> </member> <member name="speed_y" type="float"> </member> - <member name="speed" type="Vector2"> + <member name="type" type="int"> + </member> + <member name="x" type="float"> + </member> + <member name="y" type="float"> </member> </members> <constants> - <constant name="NONE" value="0"> + <constant name="ACTION" value="8"> + </constant> + <constant name="JOYSTICK_MOTION" value="4"> + </constant> + <constant name="JOYSTICK_BUTTON" value="5"> </constant> <constant name="KEY" value="1"> </constant> @@ -16789,16 +16863,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="MOUSE_BUTTON" value="3"> </constant> - <constant name="JOYSTICK_MOTION" value="4"> - </constant> - <constant name="JOYSTICK_BUTTON" value="5"> + <constant name="NONE" value="0"> </constant> <constant name="SCREEN_TOUCH" value="6"> </constant> <constant name="SCREEN_DRAG" value="7"> </constant> - <constant name="ACTION" value="8"> - </constant> </constants> </class> <class name="InputEventScreenTouch" category="Built-In Types"> @@ -16853,25 +16923,29 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> </methods> <members> - <member name="type" type="int"> + <member name="ID" type="int"> </member> <member name="device" type="int"> </member> - <member name="ID" type="int"> - </member> <member name="index" type="int"> </member> - <member name="x" type="float"> - </member> - <member name="y" type="float"> - </member> <member name="pos" type="Vector2"> </member> <member name="pressed" type="bool"> </member> + <member name="type" type="int"> + </member> + <member name="x" type="float"> + </member> + <member name="y" type="float"> + </member> </members> <constants> - <constant name="NONE" value="0"> + <constant name="ACTION" value="8"> + </constant> + <constant name="JOYSTICK_MOTION" value="4"> + </constant> + <constant name="JOYSTICK_BUTTON" value="5"> </constant> <constant name="KEY" value="1"> </constant> @@ -16879,16 +16953,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="MOUSE_BUTTON" value="3"> </constant> - <constant name="JOYSTICK_MOTION" value="4"> - </constant> - <constant name="JOYSTICK_BUTTON" value="5"> + <constant name="NONE" value="0"> </constant> <constant name="SCREEN_TOUCH" value="6"> </constant> <constant name="SCREEN_DRAG" value="7"> </constant> - <constant name="ACTION" value="8"> - </constant> </constants> </class> <class name="InputMap" inherits="Object" category="Core"> @@ -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. </description> <methods> - <method name="has_action" qualifiers="const"> - <return type="bool"> - </return> + <method name="action_add_event"> <argument index="0" name="action" type="String"> </argument> + <argument index="1" name="event" type="InputEvent"> + </argument> <description> - Whether this InputMap has an action with name "action". + Add an [InputEvent] to action. This [InputEvent] will trigger the action. </description> </method> - <method name="get_action_id" qualifiers="const"> - <return type="int"> - </return> + <method name="action_erase_event"> <argument index="0" name="action" type="String"> </argument> - <description> - Return the id of an action. - </description> - </method> - <method name="get_action_from_id" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="id" type="int"> + <argument index="1" name="event" type="InputEvent"> </argument> <description> - Return the action from an id. + Remove an [InputEvent] from an action. </description> </method> - <method name="get_actions"> - <return type="Array"> + <method name="action_has_event"> + <return type="bool"> </return> + <argument index="0" name="action" type="String"> + </argument> + <argument index="1" name="event" type="InputEvent"> + </argument> <description> - Return an [Array] of all actions in the [InputMap]. + Whether an action has an [InputEvent] associated with it. </description> </method> <method name="add_action"> @@ -16947,33 +17012,32 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Remove an action from the [InputMap]. </description> </method> - <method name="action_add_event"> - <argument index="0" name="action" type="String"> + <method name="event_is_action" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="event" type="InputEvent"> </argument> - <argument index="1" name="event" type="InputEvent"> + <argument index="1" name="action" type="String"> </argument> <description> - Add an [InputEvent] to action. This [InputEvent] will trigger the action. </description> </method> - <method name="action_has_event"> - <return type="bool"> + <method name="get_action_from_id" qualifiers="const"> + <return type="String"> </return> - <argument index="0" name="action" type="String"> - </argument> - <argument index="1" name="event" type="InputEvent"> + <argument index="0" name="id" type="int"> </argument> <description> - Whether an action has an [InputEvent] associated with it. + Return the action from an id. </description> </method> - <method name="action_erase_event"> + <method name="get_action_id" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="action" type="String"> </argument> - <argument index="1" name="event" type="InputEvent"> - </argument> <description> - Remove an [InputEvent] from an action. + Return the id of an action. </description> </method> <method name="get_action_list"> @@ -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. </description> </method> - <method name="event_is_action" qualifiers="const"> + <method name="get_actions"> + <return type="Array"> + </return> + <description> + Return an [Array] of all actions in the [InputMap]. + </description> + </method> + <method name="has_action" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="event" type="InputEvent"> - </argument> - <argument index="1" name="action" type="String"> + <argument index="0" name="action" type="String"> </argument> <description> + Whether this InputMap has an action with name "action". </description> </method> <method name="load_from_globals"> @@ -17010,18 +17080,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="replace_by_instance"> - <argument index="0" name="custom_scene" type="PackedScene" default="NULL"> - </argument> - <description> - </description> - </method> <method name="get_instance_path" qualifiers="const"> <return type="String"> </return> <description> </description> </method> + <method name="replace_by_instance"> + <argument index="0" name="custom_scene" type="PackedScene" default="NULL"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -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. </description> <methods> + <method name="IntArray"> + <return type="IntArray"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Create from a generic array. + </description> + </method> <method name="push_back"> <argument index="0" name="integer" type="int"> </argument> @@ -17064,15 +17143,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the array size. </description> </method> - <method name="IntArray"> - <return type="IntArray"> - </return> - <argument index="0" name="from" type="Array"> - </argument> - <description> - Create from a generic array. - </description> - </method> </methods> <constants> </constants> @@ -17083,9 +17153,9 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_target_path"> - <argument index="0" name="target_path" type="NodePath"> - </argument> + <method name="get_speed" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> @@ -17095,33 +17165,33 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_target"> - <argument index="0" name="target" type="Camera"> - </argument> + <method name="is_interpolation_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="set_speed"> - <argument index="0" name="speed" type="float"> + <method name="set_interpolation_enabled"> + <argument index="0" name="target_path" type="bool"> </argument> <description> </description> </method> - <method name="get_speed" qualifiers="const"> - <return type="float"> - </return> + <method name="set_speed"> + <argument index="0" name="speed" type="float"> + </argument> <description> </description> </method> - <method name="set_interpolation_enabled"> - <argument index="0" name="target_path" type="bool"> + <method name="set_target"> + <argument index="0" name="target" type="Camera"> </argument> <description> </description> </method> - <method name="is_interpolation_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_target_path"> + <argument index="0" name="target_path" type="NodePath"> + </argument> <description> </description> </method> @@ -17135,21 +17205,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_bone_name"> - <argument index="0" name="ik_bone" type="String"> - </argument> - <description> - </description> - </method> <method name="get_bone_name" qualifiers="const"> <return type="String"> </return> <description> </description> </method> - <method name="set_iterations"> - <argument index="0" name="iterations" type="int"> - </argument> + <method name="get_chain_size" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> @@ -17159,39 +17223,45 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_chain_size"> - <argument index="0" name="chain_size" type="int"> - </argument> + <method name="get_precision" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_chain_size" qualifiers="const"> - <return type="int"> + <method name="get_speed" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="set_precision"> - <argument index="0" name="precision" type="float"> + <method name="set_bone_name"> + <argument index="0" name="ik_bone" type="String"> </argument> <description> </description> </method> - <method name="get_precision" qualifiers="const"> - <return type="float"> - </return> + <method name="set_chain_size"> + <argument index="0" name="chain_size" type="int"> + </argument> <description> </description> </method> - <method name="set_speed"> - <argument index="0" name="speed" type="float"> + <method name="set_iterations"> + <argument index="0" name="iterations" type="int"> </argument> <description> </description> </method> - <method name="get_speed" qualifiers="const"> - <return type="float"> - </return> + <method name="set_precision"> + <argument index="0" name="precision" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_speed"> + <argument index="0" name="speed" type="float"> + </argument> <description> </description> </method> @@ -17205,6 +17275,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> + <method name="add_icon_item"> + <argument index="0" name="icon" type="Texture"> + </argument> + <argument index="1" name="selectable" type="bool" default="true"> + </argument> + <description> + </description> + </method> <method name="add_item"> <argument index="0" name="text" type="String"> </argument> @@ -17215,99 +17293,81 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="add_icon_item"> - <argument index="0" name="icon" type="Texture"> - </argument> - <argument index="1" name="selectable" type="bool" default="true"> - </argument> + <method name="clear"> <description> </description> </method> - <method name="set_item_text"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="text" type="String"> - </argument> + <method name="ensure_current_is_visible"> <description> </description> </method> - <method name="get_item_text" qualifiers="const"> - <return type="String"> + <method name="get_allow_rmb_select" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="set_item_icon"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="icon" type="Texture"> - </argument> + <method name="get_fixed_column_width" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_item_icon" qualifiers="const"> - <return type="Texture"> + <method name="get_fixed_icon_size" qualifiers="const"> + <return type="Vector2"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="set_item_icon_region"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="rect" type="Rect2"> - </argument> + <method name="get_icon_mode" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_item_icon_region" qualifiers="const"> - <return type="Rect2"> + <method name="get_icon_scale" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="set_item_selectable"> - <argument index="0" name="idx" type="int"> + <method name="get_item_at_pos" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="pos" type="Vector2"> </argument> - <argument index="1" name="selectable" type="bool"> + <argument index="1" name="exact" type="bool" default="false"> </argument> <description> </description> </method> - <method name="is_item_selectable" qualifiers="const"> - <return type="bool"> + <method name="get_item_count" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="set_item_disabled"> + <method name="get_item_custom_bg_color" qualifiers="const"> + <return type="Color"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="disabled" type="bool"> - </argument> <description> </description> </method> - <method name="is_item_disabled" qualifiers="const"> - <return type="bool"> + <method name="get_item_icon" qualifiers="const"> + <return type="Texture"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="set_item_metadata"> + <method name="get_item_icon_region" qualifiers="const"> + <return type="Rect2"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="metadata" type="Variant"> - </argument> <description> </description> </method> @@ -17317,53 +17377,49 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_item_custom_bg_color"> + <method name="get_item_text" qualifiers="const"> + <return type="String"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="custom_bg_color" type="Color"> - </argument> <description> </description> </method> - <method name="get_item_custom_bg_color" qualifiers="const"> - <return type="Color"> + <method name="get_item_tooltip" qualifiers="const"> + <return type="String"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="set_item_tooltip"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="tooltip" type="String"> - </argument> + <method name="get_max_columns" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_item_tooltip" qualifiers="const"> - <return type="String"> + <method name="get_max_text_lines" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="select"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="single" type="bool" default="true"> - </argument> + <method name="get_select_mode" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="unselect"> + <method name="is_item_disabled" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="is_selected" qualifiers="const"> + <method name="is_item_selectable" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="idx" type="int"> @@ -17371,148 +17427,162 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_item_count" qualifiers="const"> + <method name="is_same_column_width" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="remove_item"> + <method name="is_selected" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="clear"> + <method name="remove_item"> + <argument index="0" name="idx" type="int"> + </argument> <description> </description> </method> - <method name="sort_items_by_text"> + <method name="select"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="single" type="bool" default="true"> + </argument> <description> </description> </method> - <method name="set_fixed_column_width"> - <argument index="0" name="width" type="int"> + <method name="set_allow_rmb_select"> + <argument index="0" name="allow" type="bool"> </argument> <description> </description> </method> - <method name="get_fixed_column_width" qualifiers="const"> - <return type="int"> - </return> + <method name="set_fixed_column_width"> + <argument index="0" name="width" type="int"> + </argument> <description> </description> </method> - <method name="set_same_column_width"> - <argument index="0" name="enable" type="bool"> + <method name="set_fixed_icon_size"> + <argument index="0" name="size" type="Vector2"> </argument> <description> </description> </method> - <method name="is_same_column_width" qualifiers="const"> - <return type="int"> - </return> + <method name="set_icon_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> </description> </method> - <method name="set_max_text_lines"> - <argument index="0" name="lines" type="int"> + <method name="set_icon_scale"> + <argument index="0" name="scale" type="float"> </argument> <description> </description> </method> - <method name="get_max_text_lines" qualifiers="const"> - <return type="int"> - </return> + <method name="set_item_custom_bg_color"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="custom_bg_color" type="Color"> + </argument> <description> </description> </method> - <method name="set_max_columns"> - <argument index="0" name="amount" type="int"> + <method name="set_item_disabled"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> </argument> <description> </description> </method> - <method name="get_max_columns" qualifiers="const"> - <return type="int"> - </return> + <method name="set_item_icon"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="icon" type="Texture"> + </argument> <description> </description> </method> - <method name="set_select_mode"> - <argument index="0" name="mode" type="int"> + <method name="set_item_icon_region"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="rect" type="Rect2"> </argument> <description> </description> </method> - <method name="get_select_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_item_metadata"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="metadata" type="Variant"> + </argument> <description> </description> </method> - <method name="set_icon_mode"> - <argument index="0" name="mode" type="int"> + <method name="set_item_selectable"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="selectable" type="bool"> </argument> <description> </description> </method> - <method name="get_icon_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_item_text"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="text" type="String"> + </argument> <description> </description> </method> - <method name="set_fixed_icon_size"> - <argument index="0" name="size" type="Vector2"> + <method name="set_item_tooltip"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="tooltip" type="String"> </argument> <description> </description> </method> - <method name="get_fixed_icon_size" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_max_columns"> + <argument index="0" name="amount" type="int"> + </argument> <description> </description> </method> - <method name="set_icon_scale"> - <argument index="0" name="scale" type="float"> + <method name="set_max_text_lines"> + <argument index="0" name="lines" type="int"> </argument> <description> </description> </method> - <method name="get_icon_scale" qualifiers="const"> - <return type="float"> - </return> + <method name="set_same_column_width"> + <argument index="0" name="enable" type="bool"> + </argument> <description> </description> </method> - <method name="set_allow_rmb_select"> - <argument index="0" name="allow" type="bool"> + <method name="set_select_mode"> + <argument index="0" name="mode" type="int"> </argument> <description> </description> </method> - <method name="get_allow_rmb_select" qualifiers="const"> - <return type="bool"> - </return> + <method name="sort_items_by_text"> <description> </description> </method> - <method name="get_item_at_pos" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="pos" type="Vector2"> - </argument> - <argument index="1" name="exact" type="bool" default="false"> + <method name="unselect"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="ensure_current_is_visible"> - <description> - </description> - </method> </methods> <signals> <signal name="item_activated"> @@ -17521,25 +17591,25 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </signal> - <signal name="multi_selected"> + <signal name="item_rmb_selected"> <argument index="0" name="index" type="int"> </argument> - <argument index="1" name="selected" type="bool"> + <argument index="1" name="atpos" type="Vector2"> </argument> <description> </description> </signal> - <signal name="item_rmb_selected"> + <signal name="item_selected"> <argument index="0" name="index" type="int"> </argument> - <argument index="1" name="atpos" type="Vector2"> - </argument> <description> </description> </signal> - <signal name="item_selected"> + <signal name="multi_selected"> <argument index="0" name="index" type="int"> </argument> + <argument index="1" name="selected" type="bool"> + </argument> <description> </description> </signal> @@ -17555,33 +17625,33 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> </constants> <theme_items> - <theme_item name="vseparation" type="int"> - </theme_item> - <theme_item name="line_separation" type="int"> + <theme_item name="bg" type="StyleBox"> </theme_item> - <theme_item name="icon_margin" type="int"> + <theme_item name="bg_focus" type="StyleBox"> </theme_item> - <theme_item name="hseparation" type="int"> + <theme_item name="cursor" type="StyleBox"> </theme_item> - <theme_item name="guide_color" type="Color"> + <theme_item name="cursor_unfocused" type="StyleBox"> </theme_item> - <theme_item name="font_color_selected" type="Color"> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="font_color_selected" type="Color"> </theme_item> - <theme_item name="cursor" type="StyleBox"> + <theme_item name="guide_color" type="Color"> </theme_item> - <theme_item name="selected_focus" type="StyleBox"> + <theme_item name="hseparation" type="int"> </theme_item> - <theme_item name="bg_focus" type="StyleBox"> + <theme_item name="icon_margin" type="int"> </theme_item> - <theme_item name="cursor_unfocused" type="StyleBox"> + <theme_item name="line_separation" type="int"> </theme_item> <theme_item name="selected" type="StyleBox"> </theme_item> - <theme_item name="bg" type="StyleBox"> + <theme_item name="selected_focus" type="StyleBox"> + </theme_item> + <theme_item name="vseparation" type="int"> </theme_item> </theme_items> </class> @@ -17591,9 +17661,9 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_node_a"> - <argument index="0" name="node" type="NodePath"> - </argument> + <method name="get_exclude_nodes_from_collision" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> @@ -17603,24 +17673,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_node_b"> - <argument index="0" name="node" type="NodePath"> - </argument> - <description> - </description> - </method> <method name="get_node_b" qualifiers="const"> <return type="NodePath"> </return> <description> </description> </method> - <method name="set_solver_priority"> - <argument index="0" name="priority" type="int"> - </argument> - <description> - </description> - </method> <method name="get_solver_priority" qualifiers="const"> <return type="int"> </return> @@ -17633,9 +17691,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_exclude_nodes_from_collision" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_node_a"> + <argument index="0" name="node" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_node_b"> + <argument index="0" name="node" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_solver_priority"> + <argument index="0" name="priority" type="int"> + </argument> <description> </description> </method> @@ -17651,25 +17721,23 @@ 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. </description> <methods> - <method name="set_node_a"> - <argument index="0" name="node" type="NodePath"> - </argument> + <method name="get_bias" qualifiers="const"> + <return type="float"> + </return> <description> - Set the path to the A node for the joint. Must be of type [PhysicsBody2D]. </description> </method> - <method name="get_node_a" qualifiers="const"> - <return type="NodePath"> + <method name="get_exclude_nodes_from_collision" qualifiers="const"> + <return type="bool"> </return> <description> - Return the path to the A node for the joint. </description> </method> - <method name="set_node_b"> - <argument index="0" name="node" type="NodePath"> - </argument> + <method name="get_node_a" qualifiers="const"> + <return type="NodePath"> + </return> <description> - Set the path to the B node for the joint. Must be of type [PhysicsBody2D]. + Return the path to the A node for the joint. </description> </method> <method name="get_node_b" qualifiers="const"> @@ -17685,22 +17753,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_bias" qualifiers="const"> - <return type="float"> - </return> + <method name="set_exclude_nodes_from_collision"> + <argument index="0" name="enable" type="bool"> + </argument> <description> </description> </method> - <method name="set_exclude_nodes_from_collision"> - <argument index="0" name="enable" type="bool"> + <method name="set_node_a"> + <argument index="0" name="node" type="NodePath"> </argument> <description> + Set the path to the A node for the joint. Must be of type [PhysicsBody2D]. </description> </method> - <method name="get_exclude_nodes_from_collision" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_node_b"> + <argument index="0" name="node" type="NodePath"> + </argument> <description> + Set the path to the B node for the joint. Must be of type [PhysicsBody2D]. </description> </method> </methods> @@ -17717,52 +17787,55 @@ 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. </description> <methods> - <method name="move"> - <return type="Vector3"> + <method name="can_collide_with_character_bodies" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="rel_vec" type="Vector3"> - </argument> <description> - Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. + Return if this body can collide with character bodies. </description> </method> - <method name="move_to"> - <return type="Vector3"> + <method name="can_collide_with_kinematic_bodies" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="position" type="Vector3"> - </argument> <description> - 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 if this body can collide with kinematic bodies. </description> </method> - <method name="can_teleport_to"> + <method name="can_collide_with_rigid_bodies" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="position" type="Vector3"> - </argument> <description> - 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 if this body can collide with rigid bodies. </description> </method> - <method name="is_colliding" qualifiers="const"> + <method name="can_collide_with_static_bodies" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the body is colliding with another. + Return if this body can collide with static bodies. </description> </method> - <method name="get_collision_pos" qualifiers="const"> - <return type="Vector3"> + <method name="can_teleport_to"> + <return type="bool"> </return> + <argument index="0" name="position" type="Vector3"> + </argument> <description> - 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]. + 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. </description> </method> - <method name="get_collision_normal" qualifiers="const"> - <return type="Vector3"> + <method name="get_collider" qualifiers="const"> + <return type="Object"> </return> <description> - Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. + Return the body that collided with this one. + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="int"> + </return> + <description> + 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]. </description> </method> <method name="get_collider_velocity" qualifiers="const"> @@ -17772,74 +17845,78 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the velocity of the body that collided with this one. </description> </method> - <method name="get_collider" qualifiers="const"> - <return type="Object"> + <method name="get_collision_margin" qualifiers="const"> + <return type="float"> </return> <description> - Return the body that collided with this one. + Return the collision margin for this object. </description> </method> - <method name="get_collider_shape" qualifiers="const"> - <return type="int"> + <method name="get_collision_normal" qualifiers="const"> + <return type="Vector3"> </return> <description> - 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 normal of the surface the body collided with. This is useful to implement sliding along a surface. </description> </method> - <method name="set_collide_with_static_bodies"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_collision_pos" qualifiers="const"> + <return type="Vector3"> + </return> <description> - Set if this body should collide with static bodies. + 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]. </description> </method> - <method name="can_collide_with_static_bodies" qualifiers="const"> + <method name="is_colliding" qualifiers="const"> <return type="bool"> </return> <description> - Return if this body can collide with static bodies. + Return whether the body is colliding with another. </description> </method> - <method name="set_collide_with_kinematic_bodies"> - <argument index="0" name="enable" type="bool"> + <method name="move"> + <return type="Vector3"> + </return> + <argument index="0" name="rel_vec" type="Vector3"> </argument> <description> - Set if this body should collide with kinematic bodies. + Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. </description> </method> - <method name="can_collide_with_kinematic_bodies" qualifiers="const"> - <return type="bool"> + <method name="move_to"> + <return type="Vector3"> </return> + <argument index="0" name="position" type="Vector3"> + </argument> <description> - Return if this body can collide with kinematic bodies. + 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. </description> </method> - <method name="set_collide_with_rigid_bodies"> + <method name="set_collide_with_character_bodies"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set if this body should collide with rigid bodies. + Set if this body should collide with character bodies. </description> </method> - <method name="can_collide_with_rigid_bodies" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_collide_with_kinematic_bodies"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return if this body can collide with rigid bodies. + Set if this body should collide with kinematic bodies. </description> </method> - <method name="set_collide_with_character_bodies"> + <method name="set_collide_with_rigid_bodies"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set if this body should collide with character bodies. + Set if this body should collide with rigid bodies. </description> </method> - <method name="can_collide_with_character_bodies" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_collide_with_static_bodies"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return if this body can collide with character bodies. + Set if this body should collide with static bodies. </description> </method> <method name="set_collision_margin"> @@ -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. </description> </method> - <method name="get_collision_margin" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the collision margin for this object. - </description> - </method> </methods> <constants> </constants> @@ -17870,50 +17940,46 @@ 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. </description> <methods> - <method name="move"> - <return type="Vector2"> + <method name="get_collider" qualifiers="const"> + <return type="Object"> </return> - <argument index="0" name="rel_vec" type="Vector2"> - </argument> <description> - Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. + Return the body that collided with this one. </description> </method> - <method name="move_to"> - <return type="Vector2"> + <method name="get_collider_metadata" qualifiers="const"> + <return type="Variant"> </return> - <argument index="0" name="position" type="Vector2"> - </argument> <description> - 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 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]. </description> </method> - <method name="test_move"> - <return type="bool"> + <method name="get_collider_shape" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="rel_vec" type="Vector2"> - </argument> <description> - Return true if there would be a collision if the body moved in the given direction. + 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]. </description> </method> - <method name="get_travel" qualifiers="const"> + <method name="get_collider_velocity" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the last movement done by the body. + Return the velocity of the body that collided with this one. </description> </method> - <method name="revert_motion"> + <method name="get_collision_margin" qualifiers="const"> + <return type="float"> + </return> <description> - Undo the last movement done by the body. + Return the collision margin for this object. </description> </method> - <method name="is_colliding" qualifiers="const"> - <return type="bool"> + <method name="get_collision_normal" qualifiers="const"> + <return type="Vector2"> </return> <description> - Return whether the body is colliding with another. + Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. </description> </method> <method name="get_collision_pos" qualifiers="const"> @@ -17923,39 +17989,41 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) 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]. </description> </method> - <method name="get_collision_normal" qualifiers="const"> + <method name="get_travel" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. + Return the last movement done by the body. </description> </method> - <method name="get_collider_velocity" qualifiers="const"> - <return type="Vector2"> + <method name="is_colliding" qualifiers="const"> + <return type="bool"> </return> <description> - Return the velocity of the body that collided with this one. + Return whether the body is colliding with another. </description> </method> - <method name="get_collider" qualifiers="const"> - <return type="Object"> + <method name="move"> + <return type="Vector2"> </return> + <argument index="0" name="rel_vec" type="Vector2"> + </argument> <description> - Return the body that collided with this one. + Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. </description> </method> - <method name="get_collider_shape" qualifiers="const"> - <return type="int"> + <method name="move_to"> + <return type="Vector2"> </return> + <argument index="0" name="position" type="Vector2"> + </argument> <description> - 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]. + 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. </description> </method> - <method name="get_collider_metadata" qualifiers="const"> - <return type="Variant"> - </return> + <method name="revert_motion"> <description> - 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]. + Undo the last movement done by the body. </description> </method> <method name="set_collision_margin"> @@ -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. </description> </method> - <method name="get_collision_margin" qualifiers="const"> - <return type="float"> + <method name="test_move"> + <return type="bool"> </return> + <argument index="0" name="rel_vec" type="Vector2"> + </argument> <description> - Return the collision margin for this object. + Return true if there would be a collision if the body moved in the given direction. </description> </method> </methods> @@ -17984,39 +18054,46 @@ 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. </description> <methods> - <method name="set_align"> - <argument index="0" name="align" type="int"> - </argument> + <method name="get_align" qualifiers="const"> + <return type="int"> + </return> <description> - Sets the alignment mode to any of the ALIGN_* enumeration values. + Return the alignment mode (any of the ALIGN_* enumeration values). </description> </method> - <method name="get_align" qualifiers="const"> + <method name="get_line_count" qualifiers="const"> <return type="int"> </return> <description> - Return the alignment mode (any of the ALIGN_* enumeration values). + Return the amount of lines. </description> </method> - <method name="set_valign"> - <argument index="0" name="valign" type="int"> - </argument> + <method name="get_line_height" qualifiers="const"> + <return type="int"> + </return> <description> - Sets the vertical alignment mode to any of the VALIGN_* enumeration values. + Return the height of a line. </description> </method> - <method name="get_valign" qualifiers="const"> + <method name="get_lines_skipped" qualifiers="const"> <return type="int"> </return> <description> - Return the vertical alignment mode (any of the VALIGN_* enumeration values). + Return the the number of lines to skipped before displaying. </description> </method> - <method name="set_text"> - <argument index="0" name="text" type="String"> - </argument> + <method name="get_max_lines_visible" qualifiers="const"> + <return type="int"> + </return> <description> - Set the label text. Text can contain newlines. + Return the restricted number of lines to display. Returns -1 if unrestricted. + </description> + </method> + <method name="get_percent_visible" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the restricted number of characters to display (as a percentage of the total text). </description> </method> <method name="get_text" qualifiers="const"> @@ -18026,39 +18103,39 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the label text. Text can contain newlines. </description> </method> - <method name="set_autowrap"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_total_character_count" qualifiers="const"> + <return type="int"> + </return> <description> - 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 total length of the text. </description> </method> - <method name="has_autowrap" qualifiers="const"> - <return type="bool"> + <method name="get_valign" qualifiers="const"> + <return type="int"> </return> <description> - Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]). + Return the vertical alignment mode (any of the VALIGN_* enumeration values). </description> </method> - <method name="set_clip_text"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_visible_characters" qualifiers="const"> + <return type="int"> + </return> <description> - Cuts off the rest of the text if it is too wide. + Return the restricted number of characters to display. Returns -1 if unrestricted. </description> </method> - <method name="is_clipping_text" qualifiers="const"> + <method name="has_autowrap" qualifiers="const"> <return type="bool"> </return> <description> - Return true if text would be cut off if it is too wide. + Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]). </description> </method> - <method name="set_uppercase"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="is_clipping_text" qualifiers="const"> + <return type="bool"> + </return> <description> - Display text in all capitals. + Return true if text would be cut off if it is too wide. </description> </method> <method name="is_uppercase" qualifiers="const"> @@ -18068,39 +18145,39 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return true if text is displayed in all capitals. </description> </method> - <method name="get_line_height" qualifiers="const"> - <return type="int"> - </return> + <method name="set_align"> + <argument index="0" name="align" type="int"> + </argument> <description> - Return the height of a line. + Sets the alignment mode to any of the ALIGN_* enumeration values. </description> </method> - <method name="get_line_count" qualifiers="const"> - <return type="int"> - </return> + <method name="set_autowrap"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return the amount of lines. + 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. </description> </method> - <method name="get_total_character_count" qualifiers="const"> - <return type="int"> - </return> + <method name="set_clip_text"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return the total length of the text. + Cuts off the rest of the text if it is too wide. </description> </method> - <method name="set_visible_characters"> - <argument index="0" name="amount" type="int"> + <method name="set_lines_skipped"> + <argument index="0" name="lines_skipped" type="int"> </argument> <description> - Restricts the number of characters to display. Set to -1 to disable. + Sets the number of lines to skip before displaying. Useful for scrolling text. </description> </method> - <method name="get_visible_characters" qualifiers="const"> - <return type="int"> - </return> + <method name="set_max_lines_visible"> + <argument index="0" name="lines_visible" type="int"> + </argument> <description> - Return the restricted number of characters to display. Returns -1 if unrestricted. + Restricts the number of lines to display. Set to -1 to disable. </description> </method> <method name="set_percent_visible"> @@ -18110,39 +18187,32 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Restricts the number of characters to display (as a percentage of the total text). </description> </method> - <method name="get_percent_visible" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the restricted number of characters to display (as a percentage of the total text). - </description> - </method> - <method name="set_lines_skipped"> - <argument index="0" name="lines_skipped" type="int"> + <method name="set_text"> + <argument index="0" name="text" type="String"> </argument> <description> - Sets the number of lines to skip before displaying. Useful for scrolling text. + Set the label text. Text can contain newlines. </description> </method> - <method name="get_lines_skipped" qualifiers="const"> - <return type="int"> - </return> + <method name="set_uppercase"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return the the number of lines to skipped before displaying. + Display text in all capitals. </description> </method> - <method name="set_max_lines_visible"> - <argument index="0" name="lines_visible" type="int"> + <method name="set_valign"> + <argument index="0" name="valign" type="int"> </argument> <description> - Restricts the number of lines to display. Set to -1 to disable. + Sets the vertical alignment mode to any of the VALIGN_* enumeration values. </description> </method> - <method name="get_max_lines_visible" qualifiers="const"> - <return type="int"> - </return> + <method name="set_visible_characters"> + <argument index="0" name="amount" type="int"> + </argument> <description> - Return the restricted number of lines to display. Returns -1 if unrestricted. + Restricts the number of characters to display. Set to -1 to disable. </description> </method> </methods> @@ -18173,19 +18243,19 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> </constants> <theme_items> - <theme_item name="shadow_offset_x" type="int"> + <theme_item name="font" type="Font"> </theme_item> - <theme_item name="line_spacing" type="int"> + <theme_item name="font_color" type="Color"> </theme_item> - <theme_item name="shadow_offset_y" type="int"> + <theme_item name="font_color_shadow" type="Color"> </theme_item> - <theme_item name="shadow_as_outline" type="int"> + <theme_item name="line_spacing" type="int"> </theme_item> - <theme_item name="font_color" type="Color"> + <theme_item name="shadow_as_outline" type="int"> </theme_item> - <theme_item name="font_color_shadow" type="Color"> + <theme_item name="shadow_offset_x" type="int"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="shadow_offset_y" type="int"> </theme_item> </theme_items> </class> @@ -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". </description> </method> - <method name="set_piece_offset"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="ofs" type="Vector2"> - </argument> - <description> - Set the offset of the piece with index "idx" to "ofs". - </description> - </method> - <method name="set_piece_texture"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> - <description> - Set the [Texture] of the piece with index "idx" to "ofs". - </description> - </method> - <method name="set_size"> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - Set the size of this [LargeTexture]. - </description> - </method> <method name="clear"> <description> 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". </description> </method> + <method name="set_piece_offset"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="ofs" type="Vector2"> + </argument> + <description> + Set the offset of the piece with index "idx" to "ofs". + </description> + </method> + <method name="set_piece_texture"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + Set the [Texture] of the piece with index "idx" to "ofs". + </description> + </method> + <method name="set_size"> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Set the size of this [LargeTexture]. + </description> + </method> </methods> <constants> </constants> @@ -18276,41 +18346,37 @@ 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. </description> <methods> - <method name="set_parameter"> - <argument index="0" name="variable" type="int"> - </argument> - <argument index="1" name="value" type="float"> - </argument> + <method name="get_bake_mode" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_parameter" qualifiers="const"> - <return type="float"> + <method name="get_color" qualifiers="const"> + <return type="Color"> </return> - <argument index="0" name="variable" type="int"> + <argument index="0" name="color" type="int"> </argument> <description> </description> </method> - <method name="set_color"> - <argument index="0" name="color" type="int"> - </argument> - <argument index="1" name="value" type="Color"> - </argument> + <method name="get_operator" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> + <method name="get_parameter" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="color" type="int"> + <argument index="0" name="variable" type="int"> </argument> <description> </description> </method> - <method name="set_project_shadows"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_projector" qualifiers="const"> + <return type="Texture"> + </return> <description> </description> </method> @@ -18320,93 +18386,97 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_projector"> - <argument index="0" name="projector" type="Texture"> - </argument> + <method name="is_editor_only" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_projector" qualifiers="const"> - <return type="Texture"> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_operator"> - <argument index="0" name="operator" type="int"> + <method name="set_bake_mode"> + <argument index="0" name="bake_mode" type="int"> </argument> <description> </description> </method> - <method name="get_operator" qualifiers="const"> - <return type="int"> - </return> + <method name="set_color"> + <argument index="0" name="color" type="int"> + </argument> + <argument index="1" name="value" type="Color"> + </argument> <description> </description> </method> - <method name="set_bake_mode"> - <argument index="0" name="bake_mode" type="int"> + <method name="set_editor_only"> + <argument index="0" name="editor_only" type="bool"> </argument> <description> </description> </method> - <method name="get_bake_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> </description> </method> - <method name="set_enabled"> - <argument index="0" name="enabled" type="bool"> + <method name="set_operator"> + <argument index="0" name="operator" type="int"> </argument> <description> </description> </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_parameter"> + <argument index="0" name="variable" type="int"> + </argument> + <argument index="1" name="value" type="float"> + </argument> <description> </description> </method> - <method name="set_editor_only"> - <argument index="0" name="editor_only" type="bool"> + <method name="set_project_shadows"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="is_editor_only" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_projector"> + <argument index="0" name="projector" type="Texture"> + </argument> <description> </description> </method> </methods> <constants> - <constant name="PARAM_RADIUS" value="2"> + <constant name="BAKE_MODE_DISABLED" value="0"> </constant> - <constant name="PARAM_ENERGY" value="3"> + <constant name="BAKE_MODE_INDIRECT" value="1"> </constant> - <constant name="PARAM_ATTENUATION" value="4"> + <constant name="BAKE_MODE_INDIRECT_AND_SHADOWS" value="2"> </constant> - <constant name="PARAM_SPOT_ANGLE" value="1"> + <constant name="BAKE_MODE_FULL" value="3"> </constant> - <constant name="PARAM_SPOT_ATTENUATION" value="0"> + <constant name="COLOR_DIFFUSE" value="0"> </constant> - <constant name="PARAM_SHADOW_DARKENING" value="5"> + <constant name="COLOR_SPECULAR" value="1"> </constant> - <constant name="PARAM_SHADOW_Z_OFFSET" value="6"> + <constant name="PARAM_SPOT_ATTENUATION" value="0"> </constant> - <constant name="COLOR_DIFFUSE" value="0"> + <constant name="PARAM_SPOT_ANGLE" value="1"> </constant> - <constant name="COLOR_SPECULAR" value="1"> + <constant name="PARAM_RADIUS" value="2"> </constant> - <constant name="BAKE_MODE_DISABLED" value="0"> + <constant name="PARAM_ENERGY" value="3"> </constant> - <constant name="BAKE_MODE_INDIRECT" value="1"> + <constant name="PARAM_ATTENUATION" value="4"> </constant> - <constant name="BAKE_MODE_INDIRECT_AND_SHADOWS" value="2"> + <constant name="PARAM_SHADOW_DARKENING" value="5"> </constant> - <constant name="BAKE_MODE_FULL" value="3"> + <constant name="PARAM_SHADOW_Z_OFFSET" value="6"> </constant> </constants> </class> @@ -18418,95 +18488,95 @@ 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. </description> <methods> - <method name="set_enabled"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> <description> - Switches the Light2D on or off, depending on the 'enabled' parameter. + Return the color of the Light2D. </description> </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> + <method name="get_energy" qualifiers="const"> + <return type="float"> </return> <description> - Return true if the Light2D is enabled, false if it is not. + Return the energy value of the Light2D. </description> </method> - <method name="set_texture"> - <argument index="0" name="texture" type="Object"> - </argument> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> <description> - Set the texture of the Light2D. + Return the height of the Light2D. Used with 2D normalmapping. </description> </method> - <method name="get_texture" qualifiers="const"> - <return type="Object"> + <method name="get_item_mask" qualifiers="const"> + <return type="int"> </return> <description> - Return the texture of the Light2D. + Return the item mask of the Light2D. </description> </method> - <method name="set_texture_offset"> - <argument index="0" name="texture_offset" type="Vector2"> - </argument> + <method name="get_item_shadow_mask" qualifiers="const"> + <return type="int"> + </return> <description> - Set the offset of the light texture. + Return the item shadow mask of the Light2D. </description> </method> - <method name="get_texture_offset" qualifiers="const"> - <return type="Vector2"> + <method name="get_layer_range_max" qualifiers="const"> + <return type="int"> </return> <description> - Return the offset of the light texture. + Set the maximum layer value of objects of the scene that are affected by the Light2D. </description> </method> - <method name="set_color"> - <argument index="0" name="color" type="Color"> - </argument> + <method name="get_layer_range_min" qualifiers="const"> + <return type="int"> + </return> <description> - Set the color of the Light2D. + Get the minimum layer value of objects of the scene that are affected by the Light2D. </description> </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> + <method name="get_mode" qualifiers="const"> + <return type="int"> </return> <description> - Return the color of the Light2D. + Return the current mode set to the Light2D. </description> </method> - <method name="set_height"> - <argument index="0" name="height" type="float"> - </argument> + <method name="get_shadow_buffer_size" qualifiers="const"> + <return type="int"> + </return> <description> - Set the height of the Light2D. Used with 2D normalmapping. + Return the shadow buffer size. </description> </method> - <method name="get_height" qualifiers="const"> - <return type="float"> + <method name="get_shadow_color" qualifiers="const"> + <return type="Color"> </return> <description> - Return the height of the Light2D. Used with 2D normalmapping. + Return the color of casted shadows for this Light2D. </description> </method> - <method name="set_energy"> - <argument index="0" name="energy" type="float"> - </argument> + <method name="get_shadow_esm_multiplier" qualifiers="const"> + <return type="float"> + </return> <description> - Set the energy value of the Light2D. The bigger the value, the stronger the light. + Return the Exponential Shadow Multiplier (ESM) value of the Light2D. </description> </method> - <method name="get_energy" qualifiers="const"> - <return type="float"> + <method name="get_texture" qualifiers="const"> + <return type="Object"> </return> <description> - Return the energy value of the Light2D. + Return the texture of the Light2D. </description> </method> - <method name="set_texture_scale"> - <argument index="0" name="texture_scale" type="float"> - </argument> + <method name="get_texture_offset" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Set the scale value of the light texture. + Return the offset of the light texture. </description> </method> <method name="get_texture_scale" qualifiers="const"> @@ -18516,11 +18586,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the scale value of the light texture. </description> </method> - <method name="set_z_range_min"> - <argument index="0" name="z" type="int"> - </argument> + <method name="get_z_range_max" qualifiers="const"> + <return type="int"> + </return> <description> - Set the minimum Z value that objects of the scene have to 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. </description> </method> <method name="get_z_range_min" qualifiers="const"> @@ -18530,46 +18600,46 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. </description> </method> - <method name="set_z_range_max"> - <argument index="0" name="z" type="int"> - </argument> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> - Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D. + Return true if the Light2D is enabled, false if it is not. </description> </method> - <method name="get_z_range_max" qualifiers="const"> - <return type="int"> + <method name="is_shadow_enabled" qualifiers="const"> + <return type="bool"> </return> <description> - Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D. + Return true if shadow casting is enabled for this Light2D, else return false. </description> </method> - <method name="set_layer_range_min"> - <argument index="0" name="layer" type="int"> + <method name="set_color"> + <argument index="0" name="color" type="Color"> </argument> <description> - Set the minimum layer value of objects of the scene that are affected by the Light2D. + Set the color of the Light2D. </description> </method> - <method name="get_layer_range_min" qualifiers="const"> - <return type="int"> - </return> + <method name="set_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> - Get the minimum layer value of objects of the scene that are affected by the Light2D. + Switches the Light2D on or off, depending on the 'enabled' parameter. </description> </method> - <method name="set_layer_range_max"> - <argument index="0" name="layer" type="int"> + <method name="set_energy"> + <argument index="0" name="energy" type="float"> </argument> <description> - Set the maximum layer value of objects of the scene that are affected by the Light2D. + Set the energy value of the Light2D. The bigger the value, the stronger the light. </description> </method> - <method name="get_layer_range_max" qualifiers="const"> - <return type="int"> - </return> + <method name="set_height"> + <argument index="0" name="height" type="float"> + </argument> <description> - Set the maximum layer value of objects of the scene that are affected by the Light2D. + Set the height of the Light2D. Used with 2D normalmapping. </description> </method> <method name="set_item_mask"> @@ -18579,13 +18649,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Set the item mask of the Light2D to 'item_mask' value. </description> </method> - <method name="get_item_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the item mask of the Light2D. - </description> - </method> <method name="set_item_shadow_mask"> <argument index="0" name="item_shadow_mask" type="int"> </argument> @@ -18593,11 +18656,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Set the item shadow mask to 'item_shadow_mask' value. </description> </method> - <method name="get_item_shadow_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_layer_range_max"> + <argument index="0" name="layer" type="int"> + </argument> <description> - Return the item shadow mask of the Light2D. + Set the maximum layer value of objects of the scene that are affected by the Light2D. + </description> + </method> + <method name="set_layer_range_min"> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Set the minimum layer value of objects of the scene that are affected by the Light2D. </description> </method> <method name="set_mode"> @@ -18607,67 +18677,67 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Set the behaviour mode of the Light2D. Use constants defined in the constants section. </description> </method> - <method name="get_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_shadow_buffer_size"> + <argument index="0" name="size" type="int"> + </argument> <description> - Return the current mode set to the Light2D. + Set the shadow buffer size. </description> </method> - <method name="set_shadow_enabled"> - <argument index="0" name="enabled" type="bool"> + <method name="set_shadow_color"> + <argument index="0" name="shadow_color" type="Color"> </argument> <description> - Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. + Set the color of casted shadows for this Light2D. </description> </method> - <method name="is_shadow_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_shadow_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> - Return true if shadow casting is enabled for this Light2D, else return false. + Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. </description> </method> - <method name="set_shadow_buffer_size"> - <argument index="0" name="size" type="int"> + <method name="set_shadow_esm_multiplier"> + <argument index="0" name="multiplier" type="float"> </argument> <description> - Set the shadow buffer size. + Set the Exponential Shadow Multiplier (ESM) value of the Light2D. </description> </method> - <method name="get_shadow_buffer_size" qualifiers="const"> - <return type="int"> - </return> + <method name="set_texture"> + <argument index="0" name="texture" type="Object"> + </argument> <description> - Return the shadow buffer size. + Set the texture of the Light2D. </description> </method> - <method name="set_shadow_esm_multiplier"> - <argument index="0" name="multiplier" type="float"> + <method name="set_texture_offset"> + <argument index="0" name="texture_offset" type="Vector2"> </argument> <description> - Set the Exponential Shadow Multiplier (ESM) value of the Light2D. + Set the offset of the light texture. </description> </method> - <method name="get_shadow_esm_multiplier" qualifiers="const"> - <return type="float"> - </return> + <method name="set_texture_scale"> + <argument index="0" name="texture_scale" type="float"> + </argument> <description> - Return the Exponential Shadow Multiplier (ESM) value of the Light2D. + Set the scale value of the light texture. </description> </method> - <method name="set_shadow_color"> - <argument index="0" name="shadow_color" type="Color"> + <method name="set_z_range_max"> + <argument index="0" name="z" type="int"> </argument> <description> - Set the color of casted shadows for this Light2D. + Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D. </description> </method> - <method name="get_shadow_color" qualifiers="const"> - <return type="Color"> - </return> + <method name="set_z_range_min"> + <argument index="0" name="z" type="int"> + </argument> <description> - Return the color of casted shadows for this Light2D. + Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. </description> </method> </methods> @@ -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. </description> <methods> - <method name="set_occluder_polygon"> - <argument index="0" name="polygon" type="OccluderPolygon2D"> - </argument> + <method name="get_occluder_light_mask" qualifiers="const"> + <return type="int"> + </return> <description> - Set the OccluderPolygon2D that defines the LightOccluder2D. + Return the light mask of the LightOccluder2D. </description> </method> <method name="get_occluder_polygon" qualifiers="const"> @@ -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). </description> </method> - <method name="get_occluder_light_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_occluder_polygon"> + <argument index="0" name="polygon" type="OccluderPolygon2D"> + </argument> <description> - Return the light mask of the LightOccluder2D. + Set the OccluderPolygon2D that defines the LightOccluder2D. </description> </method> </methods> @@ -18734,10 +18804,16 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) LineEdit provides a single line string editor, used for text fields. </description> <methods> - <method name="set_align"> - <argument index="0" name="align" type="int"> + <method name="append_at_cursor"> + <argument index="0" name="text" type="String"> </argument> <description> + Append text at cursor, scrolling the [LineEdit] when needed. + </description> + </method> + <method name="clear"> + <description> + Clear the [LineEdit] text. </description> </method> <method name="get_align" qualifiers="const"> @@ -18746,21 +18822,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="clear"> + <method name="get_cursor_pos" qualifiers="const"> + <return type="int"> + </return> <description> - Clear the [LineEdit] text. + Return the cursor position inside the [LineEdit]. </description> </method> - <method name="select_all"> + <method name="get_max_length" qualifiers="const"> + <return type="int"> + </return> <description> - Select the whole string. + Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists. </description> </method> - <method name="set_text"> - <argument index="0" name="text" type="String"> - </argument> + <method name="get_menu" qualifiers="const"> + <return type="PopupMenu"> + </return> <description> - Set the text in the [LineEdit], clearing the existing one and the selection. </description> </method> <method name="get_text" qualifiers="const"> @@ -18770,103 +18849,94 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the text in the [LineEdit]. </description> </method> - <method name="set_cursor_pos"> - <argument index="0" name="pos" type="int"> - </argument> + <method name="is_editable" qualifiers="const"> + <return type="bool"> + </return> <description> - Set the cursor position inside the [LineEdit], causing it to scroll if needed. + Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]). </description> </method> - <method name="get_cursor_pos" qualifiers="const"> - <return type="int"> + <method name="is_secret" qualifiers="const"> + <return type="bool"> </return> <description> - Return the cursor position inside the [LineEdit]. + Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]). </description> </method> - <method name="set_max_length"> - <argument index="0" name="chars" type="int"> + <method name="menu_option"> + <argument index="0" name="option" type="int"> </argument> <description> - 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. </description> </method> - <method name="get_max_length" qualifiers="const"> - <return type="int"> - </return> + <method name="select"> + <argument index="0" name="from" type="int" default="0"> + </argument> + <argument index="1" name="to" type="int" default="-1"> + </argument> <description> - Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists. </description> </method> - <method name="append_at_cursor"> - <argument index="0" name="text" type="String"> - </argument> + <method name="select_all"> <description> - Append text at cursor, scrolling the [LineEdit] when needed. + Select the whole string. </description> </method> - <method name="set_editable"> - <argument index="0" name="enabled" type="bool"> + <method name="set_align"> + <argument index="0" name="align" type="int"> </argument> <description> - Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added. </description> </method> - <method name="is_editable" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_cursor_pos"> + <argument index="0" name="pos" type="int"> + </argument> <description> - Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]). + Set the cursor position inside the [LineEdit], causing it to scroll if needed. </description> </method> - <method name="set_secret"> + <method name="set_editable"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*". - </description> - </method> - <method name="is_secret" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]). + Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added. </description> </method> - <method name="select"> - <argument index="0" name="from" type="int" default="0"> - </argument> - <argument index="1" name="to" type="int" default="-1"> + <method name="set_max_length"> + <argument index="0" name="chars" type="int"> </argument> <description> + 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. </description> </method> - <method name="menu_option"> - <argument index="0" name="option" type="int"> + <method name="set_secret"> + <argument index="0" name="enabled" type="bool"> </argument> <description> + Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*". </description> </method> - <method name="get_menu" qualifiers="const"> - <return type="PopupMenu"> - </return> + <method name="set_text"> + <argument index="0" name="text" type="String"> + </argument> <description> + Set the text in the [LineEdit], clearing the existing one and the selection. </description> </method> </methods> <signals> - <signal name="text_entered"> + <signal name="text_changed"> <argument index="0" name="text" type="String"> </argument> <description> - 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. + When the text changes, this signal is emitted. </description> </signal> - <signal name="text_changed"> + <signal name="text_entered"> <argument index="0" name="text" type="String"> </argument> <description> - 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. </description> </signal> </signals> @@ -18895,23 +18965,23 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> </constants> <theme_items> - <theme_item name="minimum_spaces" type="int"> + <theme_item name="cursor_color" type="Color"> </theme_item> - <theme_item name="selection_color" type="Color"> + <theme_item name="focus" type="StyleBox"> </theme_item> - <theme_item name="cursor_color" type="Color"> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> </theme_item> <theme_item name="font_color_selected" type="Color"> </theme_item> - <theme_item name="font_color" type="Color"> + <theme_item name="minimum_spaces" type="int"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="normal" type="StyleBox"> </theme_item> <theme_item name="read_only" type="StyleBox"> </theme_item> - <theme_item name="focus" type="StyleBox"> - </theme_item> - <theme_item name="normal" type="StyleBox"> + <theme_item name="selection_color" type="Color"> </theme_item> </theme_items> </class> @@ -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. </description> <methods> - <method name="set_normal"> - <argument index="0" name="normal" type="Vector2"> - </argument> + <method name="get_d" qualifiers="const"> + <return type="float"> + </return> <description> - Set the line normal. + Return the line distance from the origin. </description> </method> <method name="get_normal" qualifiers="const"> @@ -18944,11 +19014,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Set the line distance from the origin. </description> </method> - <method name="get_d" qualifiers="const"> - <return type="float"> - </return> + <method name="set_normal"> + <argument index="0" name="normal" type="Vector2"> + </argument> <description> - Return the line distance from the origin. + Set the line normal. </description> </method> </methods> @@ -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). </description> <methods> - <method name="set_text"> - <argument index="0" name="text" type="String"> - </argument> - <description> - Sets the text of the button. - </description> - </method> <method name="get_text" qualifiers="const"> <return type="String"> </return> @@ -18977,13 +19040,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the text of the button. </description> </method> - <method name="set_underline_mode"> - <argument index="0" name="underline_mode" type="int"> - </argument> - <description> - Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section). - </description> - </method> <method name="get_underline_mode" qualifiers="const"> <return type="int"> </return> @@ -18991,6 +19047,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the underline mode for this button. </description> </method> + <method name="set_text"> + <argument index="0" name="text" type="String"> + </argument> + <description> + Sets the text of the button. + </description> + </method> + <method name="set_underline_mode"> + <argument index="0" name="underline_mode" type="int"> + </argument> + <description> + Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section). + </description> + </method> </methods> <constants> <constant name="UNDERLINE_MODE_ALWAYS" value="0"> @@ -19001,7 +19071,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> </constants> <theme_items> - <theme_item name="underline_spacing" type="int"> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> @@ -19009,7 +19079,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </theme_item> <theme_item name="font_color_pressed" type="Color"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="underline_spacing" type="int"> </theme_item> </theme_items> </class> @@ -19019,11 +19089,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="make_current"> + <method name="clear_current"> <description> </description> </method> - <method name="clear_current"> + <method name="get_listener_transform" qualifiers="const"> + <return type="Transform"> + </return> <description> </description> </method> @@ -19033,9 +19105,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_listener_transform" qualifiers="const"> - <return type="Transform"> - </return> + <method name="make_current"> <description> </description> </method> @@ -19091,14 +19161,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="input_event"> - <argument index="0" name="ev" type="InputEvent"> - </argument> + <method name="finish"> <description> </description> </method> - <method name="input_text"> - <argument index="0" name="text" type="String"> + <method name="idle"> + <return type="bool"> + </return> + <argument index="0" name="delta" type="float"> </argument> <description> </description> @@ -19107,23 +19177,23 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="iteration"> - <return type="bool"> - </return> - <argument index="0" name="delta" type="float"> + <method name="input_event"> + <argument index="0" name="ev" type="InputEvent"> </argument> <description> </description> </method> - <method name="idle"> - <return type="bool"> - </return> - <argument index="0" name="delta" type="float"> + <method name="input_text"> + <argument index="0" name="text" type="String"> </argument> <description> </description> </method> - <method name="finish"> + <method name="iteration"> + <return type="bool"> + </return> + <argument index="0" name="delta" type="float"> + </argument> <description> </description> </method> @@ -19157,13 +19227,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constants> </constants> <theme_items> - <theme_item name="margin_right" type="int"> - </theme_item> - <theme_item name="margin_top" type="int"> + <theme_item name="margin_bottom" type="int"> </theme_item> <theme_item name="margin_left" type="int"> </theme_item> - <theme_item name="margin_bottom" type="int"> + <theme_item name="margin_right" type="int"> + </theme_item> + <theme_item name="margin_top" type="int"> </theme_item> </theme_items> </class> @@ -19173,10 +19243,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="variant_to_base64"> + <method name="base64_to_raw"> + <return type="RawArray"> + </return> + <argument index="0" name="base64_str" type="String"> + </argument> + <description> + </description> + </method> + <method name="base64_to_utf8"> <return type="String"> </return> - <argument index="0" name="variant" type="Variant"> + <argument index="0" name="base64_str" type="String"> </argument> <description> </description> @@ -19197,14 +19275,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="base64_to_raw"> - <return type="RawArray"> - </return> - <argument index="0" name="base64_str" type="String"> - </argument> - <description> - </description> - </method> <method name="utf8_to_base64"> <return type="String"> </return> @@ -19213,10 +19283,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="base64_to_utf8"> + <method name="variant_to_base64"> <return type="String"> </return> - <argument index="0" name="base64_str" type="String"> + <argument index="0" name="variant" type="Variant"> </argument> <description> </description> @@ -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. </description> <methods> - <method name="set_flag"> - <argument index="0" name="flag" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> + <method name="get_blend_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + 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. + </description> + </method> + <method name="get_depth_draw_mode" qualifiers="const"> + <return type="int"> + </return> <description> - Set a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. </description> </method> <method name="get_flag" qualifiers="const"> @@ -19251,48 +19325,65 @@ 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. </description> </method> - <method name="set_blend_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - 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. - </description> - </method> - <method name="get_blend_mode" qualifiers="const"> - <return type="int"> + <method name="get_line_width" qualifiers="const"> + <return type="float"> </return> <description> - 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. + 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). </description> </method> - <method name="set_line_width"> - <argument index="0" name="width" type="float"> + <method name="set_blend_mode"> + <argument index="0" name="mode" type="int"> </argument> <description> - 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). + 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. </description> </method> - <method name="get_line_width" qualifiers="const"> - <return type="float"> - </return> + <method name="set_depth_draw_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> - 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). </description> </method> - <method name="set_depth_draw_mode"> - <argument index="0" name="mode" type="int"> + <method name="set_flag"> + <argument index="0" name="flag" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> </argument> <description> + Set a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. </description> </method> - <method name="get_depth_draw_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_line_width"> + <argument index="0" name="width" type="float"> + </argument> <description> + 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). </description> </method> </methods> <constants> + <constant name="BLEND_MODE_MIX" value="0"> + Use the regular alpha blending equation (source and dest colors are faded) (default). + </constant> + <constant name="BLEND_MODE_ADD" value="1"> + Use additive blending equation, often used for particle effects such as fire or light decals. + </constant> + <constant name="BLEND_MODE_SUB" value="2"> + Use subtractive blending equation, often used for some smoke effects or types of glass. + </constant> + <constant name="BLEND_MODE_MUL" value="3"> + </constant> + <constant name="BLEND_MODE_PREMULT_ALPHA" value="4"> + </constant> + <constant name="DEPTH_DRAW_ALWAYS" value="0"> + </constant> + <constant name="DEPTH_DRAW_OPAQUE_ONLY" value="1"> + </constant> + <constant name="DEPTH_DRAW_OPAQUE_PRE_PASS_ALPHA" value="2"> + </constant> + <constant name="DEPTH_DRAW_NEVER" value="3"> + </constant> <constant name="FLAG_VISIBLE" value="0"> Geometry is visible when this flag is enabled (default). </constant> @@ -19314,27 +19405,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constant name="FLAG_MAX" value="7"> Maximum amount of flags. </constant> - <constant name="DEPTH_DRAW_ALWAYS" value="0"> - </constant> - <constant name="DEPTH_DRAW_OPAQUE_ONLY" value="1"> - </constant> - <constant name="DEPTH_DRAW_OPAQUE_PRE_PASS_ALPHA" value="2"> - </constant> - <constant name="DEPTH_DRAW_NEVER" value="3"> - </constant> - <constant name="BLEND_MODE_MIX" value="0"> - Use the regular alpha blending equation (source and dest colors are faded) (default). - </constant> - <constant name="BLEND_MODE_ADD" value="1"> - Use additive blending equation, often used for particle effects such as fire or light decals. - </constant> - <constant name="BLEND_MODE_SUB" value="2"> - Use subtractive blending equation, often used for some smoke effects or types of glass. - </constant> - <constant name="BLEND_MODE_MUL" value="3"> - </constant> - <constant name="BLEND_MODE_PREMULT_ALPHA" value="4"> - </constant> </constants> </class> <class name="MaterialShader" inherits="Shader" category="Core"> @@ -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]. </description> <methods> + <method name="Matrix3"> + <return type="Matrix3"> + </return> + <argument index="0" name="from" type="Quat"> + </argument> + <description> + Create a matrix from a quaternion. + </description> + </method> + <method name="Matrix3"> + <return type="Matrix3"> + </return> + <argument index="0" name="axis" type="Vector3"> + </argument> + <argument index="1" name="phi" type="float"> + </argument> + <description> + Create a matrix from an axis vector and an angle. + </description> + </method> + <method name="Matrix3"> + <return type="Matrix3"> + </return> + <argument index="0" name="x_axis" type="Vector3"> + </argument> + <argument index="1" name="y_axis" type="Vector3"> + </argument> + <argument index="2" name="z_axis" type="Vector3"> + </argument> + <description> + Create a matrix from 3 axis vectors. + </description> + </method> <method name="determinant"> <return type="float"> </return> @@ -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. </description> </method> - <method name="Matrix3"> - <return type="Matrix3"> - </return> - <argument index="0" name="x_axis" type="Vector3"> - </argument> - <argument index="1" name="y_axis" type="Vector3"> - </argument> - <argument index="2" name="z_axis" type="Vector3"> - </argument> - <description> - Create a matrix from 3 axis vectors. - </description> - </method> - <method name="Matrix3"> - <return type="Matrix3"> - </return> - <argument index="0" name="axis" type="Vector3"> - </argument> - <argument index="1" name="phi" type="float"> - </argument> - <description> - Create a matrix from an axis vector and an angle. - </description> - </method> - <method name="Matrix3"> - <return type="Matrix3"> - </return> - <argument index="0" name="from" type="Quat"> - </argument> - <description> - Create a matrix from a quaternion. - </description> - </method> </methods> <members> <member name="x" type="Vector3"> @@ -19530,6 +19600,36 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) 3x2 Matrix for 2D transforms. </description> <methods> + <method name="Matrix32"> + <return type="Matrix32"> + </return> + <argument index="0" name="from" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="Matrix32"> + <return type="Matrix32"> + </return> + <argument index="0" name="x_axis" type="Vector2"> + </argument> + <argument index="1" name="y_axis" type="Vector2"> + </argument> + <argument index="2" name="origin" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="Matrix32"> + <return type="Matrix32"> + </return> + <argument index="0" name="rot" type="float"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="affine_inverse"> <return type="Matrix32"> </return> @@ -19632,44 +19732,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="Matrix32"> - <return type="Matrix32"> - </return> - <argument index="0" name="rot" type="float"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="Matrix32"> - <return type="Matrix32"> - </return> - <argument index="0" name="x_axis" type="Vector2"> - </argument> - <argument index="1" name="y_axis" type="Vector2"> - </argument> - <argument index="2" name="origin" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="Matrix32"> - <return type="Matrix32"> - </return> - <argument index="0" name="from" type="Transform"> - </argument> - <description> - </description> - </method> </methods> <members> + <member name="o" type="Vector2"> + </member> <member name="x" type="Vector2"> </member> <member name="y" type="Vector2"> </member> - <member name="o" type="Vector2"> - </member> </members> <constants> </constants> @@ -19699,28 +19769,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constants> </constants> <theme_items> - <theme_item name="hseparation" type="int"> + <theme_item name="disabled" type="StyleBox"> </theme_item> - <theme_item name="font_color_disabled" type="Color"> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> <theme_item name="font_color_hover" type="Color"> </theme_item> <theme_item name="font_color_pressed" type="Color"> </theme_item> - <theme_item name="font" type="Font"> - </theme_item> <theme_item name="hover" type="StyleBox"> </theme_item> - <theme_item name="pressed" type="StyleBox"> - </theme_item> - <theme_item name="focus" type="StyleBox"> - </theme_item> - <theme_item name="disabled" type="StyleBox"> + <theme_item name="hseparation" type="int"> </theme_item> <theme_item name="normal" type="StyleBox"> </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> </theme_items> </class> <class name="Mesh" inherits="Resource" category="Core"> @@ -19737,17 +19807,22 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_morph_target_count" qualifiers="const"> - <return type="int"> - </return> + <method name="add_surface"> + <argument index="0" name="primitive" type="int"> + </argument> + <argument index="1" name="arrays" type="Array"> + </argument> + <argument index="2" name="morph_arrays" type="Array" default="Array()"> + </argument> + <argument index="3" name="alphasort" type="bool" default="false"> + </argument> <description> + Create a new surface ([method get_surface_count] that will become surf_idx for this. + Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). + The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed. </description> </method> - <method name="get_morph_target_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="index" type="int"> - </argument> + <method name="center_geometry"> <description> </description> </method> @@ -19755,9 +19830,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_morph_target_mode"> - <argument index="0" name="mode" type="int"> - </argument> + <method name="get_custom_aabb" qualifiers="const"> + <return type="AABB"> + </return> + <description> + </description> + </method> + <method name="get_morph_target_count" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> @@ -19767,19 +19848,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="add_surface"> - <argument index="0" name="primitive" type="int"> - </argument> - <argument index="1" name="arrays" type="Array"> - </argument> - <argument index="2" name="morph_arrays" type="Array" default="Array()"> - </argument> - <argument index="3" name="alphasort" type="bool" default="false"> + <method name="get_morph_target_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="index" type="int"> </argument> <description> - Create a new surface ([method get_surface_count] that will become surf_idx for this. - Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). - The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed. </description> </method> <method name="get_surface_count" qualifiers="const"> @@ -19789,20 +19863,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the amount of surfaces that the [Mesh] holds. </description> </method> - <method name="surface_remove"> - <argument index="0" name="surf_idx" type="int"> + <method name="regen_normalmaps"> + <description> + </description> + </method> + <method name="set_custom_aabb"> + <argument index="0" name="aabb" type="AABB"> </argument> <description> - Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. </description> </method> - <method name="surface_get_array_len" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="surf_idx" type="int"> + <method name="set_morph_target_mode"> + <argument index="0" name="mode" type="int"> </argument> <description> - Return the length in vertices of the vertex array in the requested surface (see [method add_surface]). </description> </method> <method name="surface_get_array_index_len" qualifiers="const"> @@ -19814,31 +19888,22 @@ 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]). </description> </method> - <method name="surface_get_format" qualifiers="const"> + <method name="surface_get_array_len" qualifiers="const"> <return type="int"> </return> <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the format mask of the requested surface (see [method add_surface]). + Return the length in vertices of the vertex array in the requested surface (see [method add_surface]). </description> </method> - <method name="surface_get_primitive_type" qualifiers="const"> + <method name="surface_get_format" qualifiers="const"> <return type="int"> </return> <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the primitive type of the requested surface (see [method add_surface]). - </description> - </method> - <method name="surface_set_material"> - <argument index="0" name="surf_idx" type="int"> - </argument> - <argument index="1" name="material" type="Material"> - </argument> - <description> - Set a [Material] for a given surface. Surface will be rendered using this material. + Return the format mask of the requested surface (see [method add_surface]). </description> </method> <method name="surface_get_material" qualifiers="const"> @@ -19850,14 +19915,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return a [Material] in a given surface. Surface is rendered using this material. </description> </method> - <method name="surface_set_name"> - <argument index="0" name="surf_idx" type="int"> - </argument> - <argument index="1" name="name" type="String"> - </argument> - <description> - </description> - </method> <method name="surface_get_name" qualifiers="const"> <return type="String"> </return> @@ -19866,87 +19923,100 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="center_geometry"> + <method name="surface_get_primitive_type" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> <description> + Return the primitive type of the requested surface (see [method add_surface]). </description> </method> - <method name="regen_normalmaps"> + <method name="surface_remove"> + <argument index="0" name="surf_idx" type="int"> + </argument> <description> + Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. </description> </method> - <method name="set_custom_aabb"> - <argument index="0" name="aabb" type="AABB"> + <method name="surface_set_material"> + <argument index="0" name="surf_idx" type="int"> + </argument> + <argument index="1" name="material" type="Material"> </argument> <description> + Set a [Material] for a given surface. Surface will be rendered using this material. </description> </method> - <method name="get_custom_aabb" qualifiers="const"> - <return type="AABB"> - </return> + <method name="surface_set_name"> + <argument index="0" name="surf_idx" type="int"> + </argument> + <argument index="1" name="name" type="String"> + </argument> <description> </description> </method> </methods> <constants> - <constant name="NO_INDEX_ARRAY" value="-1"> - Default value used for index_array_len when no indices are present. - </constant> - <constant name="ARRAY_WEIGHTS_SIZE" value="4"> - Amount of weights/bone indices per vertex (always 4). - </constant> <constant name="ARRAY_VERTEX" value="0"> Vertex array (array of [Vector3] vertices). </constant> + <constant name="ARRAY_FORMAT_VERTEX" value="1"> + Array format will include vertices (mandatory). + </constant> <constant name="ARRAY_NORMAL" value="1"> Normal array (array of [Vector3] normals). </constant> + <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> + Array format will include bone weights. + </constant> + <constant name="ARRAY_FORMAT_TEX_UV" value="16"> + Array format will include UVs. + </constant> + <constant name="ARRAY_FORMAT_NORMAL" value="2"> + Array format will include normals + </constant> <constant name="ARRAY_TANGENT" value="2"> Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. </constant> + <constant name="ARRAY_FORMAT_INDEX" value="256"> + Index array will be used. + </constant> <constant name="ARRAY_COLOR" value="3"> Vertex array (array of [Color] colors). </constant> + <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> + Array format will include another set of UVs. + </constant> + <constant name="ARRAY_FORMAT_TANGENT" value="4"> + Array format will include tangents + </constant> <constant name="ARRAY_TEX_UV" value="4"> UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). </constant> + <constant name="ARRAY_WEIGHTS_SIZE" value="4"> + Amount of weights/bone indices per vertex (always 4). + </constant> <constant name="ARRAY_TEX_UV2" value="5"> Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). </constant> <constant name="ARRAY_BONES" value="6"> Array of bone indices, as a float array. Each element in groups of 4 floats. </constant> + <constant name="ARRAY_FORMAT_BONES" value="64"> + Array format will include bone indices. + </constant> <constant name="ARRAY_WEIGHTS" value="7"> Array of bone weights, as a float array. Each element in groups of 4 floats. </constant> - <constant name="ARRAY_INDEX" value="8"> - Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size. - </constant> - <constant name="ARRAY_FORMAT_VERTEX" value="1"> - Array format will include vertices (mandatory). - </constant> - <constant name="ARRAY_FORMAT_NORMAL" value="2"> - Array format will include normals - </constant> - <constant name="ARRAY_FORMAT_TANGENT" value="4"> - Array format will include tangents - </constant> <constant name="ARRAY_FORMAT_COLOR" value="8"> Array format will include a color array. </constant> - <constant name="ARRAY_FORMAT_TEX_UV" value="16"> - Array format will include UVs. - </constant> - <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> - Array format will include another set of UVs. - </constant> - <constant name="ARRAY_FORMAT_BONES" value="64"> - Array format will include bone indices. - </constant> - <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> - Array format will include bone weights. + <constant name="ARRAY_INDEX" value="8"> + Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size. </constant> - <constant name="ARRAY_FORMAT_INDEX" value="256"> - Index array will be used. + <constant name="NO_INDEX_ARRAY" value="-1"> + Default value used for index_array_len when no indices are present. </constant> <constant name="PRIMITIVE_POINTS" value="0"> Render array as points (one vertex equals one point). @@ -19981,39 +20051,51 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="create_from_surface"> + <method name="commit_to_surface"> <return type="int"> </return> <argument index="0" name="mesh" type="Object"> </argument> - <argument index="1" name="surface" type="int"> - </argument> <description> </description> </method> - <method name="commit_to_surface"> + <method name="create_from_surface"> <return type="int"> </return> <argument index="0" name="mesh" type="Object"> </argument> + <argument index="1" name="surface" type="int"> + </argument> <description> </description> </method> - <method name="get_format" qualifiers="const"> + <method name="get_edge_count" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="get_vertex_count" qualifiers="const"> - <return type="int"> + <method name="get_edge_faces" qualifiers="const"> + <return type="IntArray"> </return> + <argument index="0" name="idx" type="int"> + </argument> <description> </description> </method> - <method name="get_edge_count" qualifiers="const"> + <method name="get_edge_meta" qualifiers="const"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_edge_vertex" qualifiers="const"> <return type="int"> </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="vertex" type="int"> + </argument> <description> </description> </method> @@ -20023,15 +20105,23 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_vertex"> + <method name="get_face_edge" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="vertex" type="Vector3"> + <argument index="1" name="edge" type="int"> </argument> <description> </description> </method> - <method name="get_vertex" qualifiers="const"> + <method name="get_face_meta" qualifiers="const"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_face_normal" qualifiers="const"> <return type="Vector3"> </return> <argument index="0" name="idx" type="int"> @@ -20039,107 +20129,109 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_vertex_normal"> + <method name="get_face_vertex" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="normal" type="Vector3"> + <argument index="1" name="vertex" type="int"> </argument> <description> </description> </method> - <method name="get_vertex_normal" qualifiers="const"> - <return type="Vector3"> + <method name="get_format" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="set_vertex_tangent"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="tangent" type="Plane"> - </argument> + <method name="get_material" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> - <method name="get_vertex_tangent" qualifiers="const"> - <return type="Plane"> + <method name="get_vertex" qualifiers="const"> + <return type="Vector3"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="set_vertex_uv"> + <method name="get_vertex_bones" qualifiers="const"> + <return type="IntArray"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="uv" type="Vector2"> - </argument> <description> </description> </method> - <method name="get_vertex_uv" qualifiers="const"> - <return type="Vector2"> + <method name="get_vertex_color" qualifiers="const"> + <return type="Color"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="set_vertex_uv2"> + <method name="get_vertex_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_vertex_edges" qualifiers="const"> + <return type="IntArray"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="uv2" type="Vector2"> - </argument> <description> </description> </method> - <method name="get_vertex_uv2" qualifiers="const"> - <return type="Vector2"> + <method name="get_vertex_faces" qualifiers="const"> + <return type="IntArray"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="set_vertex_color"> + <method name="get_vertex_meta" qualifiers="const"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="color" type="Color"> - </argument> <description> </description> </method> - <method name="get_vertex_color" qualifiers="const"> - <return type="Color"> + <method name="get_vertex_normal" qualifiers="const"> + <return type="Vector3"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="set_vertex_bones"> + <method name="get_vertex_tangent" qualifiers="const"> + <return type="Plane"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="bones" type="IntArray"> - </argument> <description> </description> </method> - <method name="get_vertex_bones" qualifiers="const"> - <return type="IntArray"> + <method name="get_vertex_uv" qualifiers="const"> + <return type="Vector2"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="set_vertex_weights"> + <method name="get_vertex_uv2" qualifiers="const"> + <return type="Vector2"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="weights" type="RealArray"> - </argument> <description> </description> </method> @@ -20151,7 +20243,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_vertex_meta"> + <method name="set_edge_meta"> <argument index="0" name="idx" type="int"> </argument> <argument index="1" name="meta" type="Variant"> @@ -20159,114 +20251,92 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_vertex_meta" qualifiers="const"> + <method name="set_face_meta"> <argument index="0" name="idx" type="int"> </argument> - <description> - </description> - </method> - <method name="get_vertex_edges" qualifiers="const"> - <return type="IntArray"> - </return> - <argument index="0" name="idx" type="int"> + <argument index="1" name="meta" type="Variant"> </argument> <description> </description> </method> - <method name="get_vertex_faces" qualifiers="const"> - <return type="IntArray"> - </return> - <argument index="0" name="idx" type="int"> + <method name="set_material"> + <argument index="0" name="material" type="Material"> </argument> <description> </description> </method> - <method name="get_edge_vertex" qualifiers="const"> - <return type="int"> - </return> + <method name="set_vertex"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="vertex" type="int"> + <argument index="1" name="vertex" type="Vector3"> </argument> <description> </description> </method> - <method name="get_edge_faces" qualifiers="const"> - <return type="IntArray"> - </return> + <method name="set_vertex_bones"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="bones" type="IntArray"> + </argument> <description> </description> </method> - <method name="set_edge_meta"> + <method name="set_vertex_color"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="meta" type="Variant"> + <argument index="1" name="color" type="Color"> </argument> <description> </description> </method> - <method name="get_edge_meta" qualifiers="const"> + <method name="set_vertex_meta"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="meta" type="Variant"> + </argument> <description> </description> </method> - <method name="get_face_vertex" qualifiers="const"> - <return type="int"> - </return> + <method name="set_vertex_normal"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="vertex" type="int"> + <argument index="1" name="normal" type="Vector3"> </argument> <description> </description> </method> - <method name="get_face_edge" qualifiers="const"> - <return type="int"> - </return> + <method name="set_vertex_tangent"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="edge" type="int"> + <argument index="1" name="tangent" type="Plane"> </argument> <description> </description> </method> - <method name="set_face_meta"> + <method name="set_vertex_uv"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="meta" type="Variant"> + <argument index="1" name="uv" type="Vector2"> </argument> <description> </description> </method> - <method name="get_face_meta" qualifiers="const"> + <method name="set_vertex_uv2"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="uv2" type="Vector2"> + </argument> <description> </description> </method> - <method name="get_face_normal" qualifiers="const"> - <return type="Vector3"> - </return> + <method name="set_vertex_weights"> <argument index="0" name="idx" type="int"> </argument> - <description> - </description> - </method> - <method name="set_material"> - <argument index="0" name="material" type="Material"> + <argument index="1" name="weights" type="RealArray"> </argument> <description> </description> </method> - <method name="get_material" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> </methods> <constants> </constants> @@ -20279,45 +20349,45 @@ 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. </description> <methods> - <method name="set_mesh"> - <argument index="0" name="mesh" type="Mesh"> - </argument> + <method name="create_convex_collision"> <description> - Set the [Mesh] resource for the instance. </description> </method> - <method name="get_mesh" qualifiers="const"> - <return type="Mesh"> - </return> + <method name="create_trimesh_collision"> <description> - 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. </description> </method> - <method name="set_skeleton_path"> - <argument index="0" name="skeleton_path" type="NodePath"> - </argument> + <method name="get_aabb" qualifiers="const"> + <return type="AABB"> + </return> <description> + Return the AABB of the mesh, in local coordinates. </description> </method> - <method name="get_skeleton_path"> - <return type="NodePath"> + <method name="get_mesh" qualifiers="const"> + <return type="Mesh"> </return> <description> + Return the current [Mesh] resource for the instance. </description> </method> - <method name="get_aabb" qualifiers="const"> - <return type="AABB"> + <method name="get_skeleton_path"> + <return type="NodePath"> </return> <description> - Return the AABB of the mesh, in local coordinates. </description> </method> - <method name="create_trimesh_collision"> + <method name="set_mesh"> + <argument index="0" name="mesh" type="Mesh"> + </argument> <description> - This helper creates a [StaticBody] child [Node] using the mesh geometry as collision. It's mainly used for testing. + Set the [Mesh] resource for the instance. </description> </method> - <method name="create_convex_collision"> + <method name="set_skeleton_path"> + <argument index="0" name="skeleton_path" type="NodePath"> + </argument> <description> </description> </method> @@ -20333,45 +20403,32 @@ 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. </description> <methods> - <method name="create_item"> - <argument index="0" name="id" type="int"> - </argument> - <description> - Create a new item in the library, supplied an id. - </description> - </method> - <method name="set_item_name"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="name" type="String"> - </argument> + <method name="clear"> <description> - Set the name of the item. + Clear the library. </description> </method> - <method name="set_item_mesh"> + <method name="create_item"> <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="mesh" type="Mesh"> - </argument> <description> - Set the mesh of the item. + Create a new item in the library, supplied an id. </description> </method> - <method name="set_item_navmesh"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="navmesh" type="NavigationMesh"> - </argument> + <method name="get_item_list" qualifiers="const"> + <return type="IntArray"> + </return> <description> + Return the list of items. </description> </method> - <method name="set_item_shape"> + <method name="get_item_mesh" qualifiers="const"> + <return type="Mesh"> + </return> <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="shape" type="Shape"> - </argument> <description> + Return the mesh of the item. </description> </method> <method name="get_item_name" qualifiers="const"> @@ -20383,15 +20440,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the name of the item. </description> </method> - <method name="get_item_mesh" qualifiers="const"> - <return type="Mesh"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - Return the mesh of the item. - </description> - </method> <method name="get_item_navmesh" qualifiers="const"> <return type="NavigationMesh"> </return> @@ -20408,6 +20456,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> + <method name="get_last_unused_item_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Get an unused id for a new item. + </description> + </method> <method name="remove_item"> <argument index="0" name="id" type="int"> </argument> @@ -20415,23 +20470,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Remove the item. </description> </method> - <method name="clear"> + <method name="set_item_mesh"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="mesh" type="Mesh"> + </argument> <description> - Clear the library. + Set the mesh of the item. </description> </method> - <method name="get_item_list" qualifiers="const"> - <return type="IntArray"> - </return> + <method name="set_item_name"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="name" type="String"> + </argument> <description> - Return the list of items. + Set the name of the item. </description> </method> - <method name="get_last_unused_item_id" qualifiers="const"> - <return type="int"> - </return> + <method name="set_item_navmesh"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="navmesh" type="NavigationMesh"> + </argument> + <description> + </description> + </method> + <method name="set_item_shape"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shape" type="Shape"> + </argument> <description> - Get an unused id for a new item. </description> </method> </methods> @@ -20449,25 +20519,25 @@ 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]. </description> <methods> - <method name="set_mesh"> - <argument index="0" name="mesh" type="Mesh"> - </argument> + <method name="generate_aabb"> <description> - 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. </description> </method> - <method name="get_mesh" qualifiers="const"> - <return type="Mesh"> + <method name="get_aabb" qualifiers="const"> + <return type="AABB"> </return> <description> - Return the [Mesh] resource drawn as multiple instances. + Return the visibility AABB. </description> </method> - <method name="set_instance_count"> - <argument index="0" name="count" type="int"> + <method name="get_instance_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="instance" type="int"> </argument> <description> - Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data. + Get the color of a specific instance. </description> </method> <method name="get_instance_count" qualifiers="const"> @@ -20477,22 +20547,27 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the amount of instances that is going to be drawn. </description> </method> - <method name="set_instance_transform"> + <method name="get_instance_transform" qualifiers="const"> + <return type="Transform"> + </return> <argument index="0" name="instance" type="int"> </argument> - <argument index="1" name="transform" type="Transform"> - </argument> <description> - Set the transform for a specific instance. + Return the transform of a specific instance. </description> </method> - <method name="get_instance_transform" qualifiers="const"> - <return type="Transform"> + <method name="get_mesh" qualifiers="const"> + <return type="Mesh"> </return> - <argument index="0" name="instance" type="int"> + <description> + Return the [Mesh] resource drawn as multiple instances. + </description> + </method> + <method name="set_aabb"> + <argument index="0" name="visibility_aabb" type="AABB"> </argument> <description> - Return the transform of a specific instance. + Set the visibility AABB. If not provided, MultiMesh will not be visible. </description> </method> <method name="set_instance_color"> @@ -20504,32 +20579,27 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Set the color of a specific instance. </description> </method> - <method name="get_instance_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="instance" type="int"> + <method name="set_instance_count"> + <argument index="0" name="count" type="int"> </argument> <description> - Get the color of a specific instance. + Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data. </description> </method> - <method name="set_aabb"> - <argument index="0" name="visibility_aabb" type="AABB"> + <method name="set_instance_transform"> + <argument index="0" name="instance" type="int"> + </argument> + <argument index="1" name="transform" type="Transform"> </argument> <description> - Set the visibility AABB. If not provided, MultiMesh will not be visible. - </description> - </method> - <method name="get_aabb" qualifiers="const"> - <return type="AABB"> - </return> - <description> - Return the visibility AABB. + Set the transform for a specific instance. </description> </method> - <method name="generate_aabb"> + <method name="set_mesh"> + <argument index="0" name="mesh" type="Mesh"> + </argument> <description> - 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 [Mesh] resource to be drawn in multiple instances. </description> </method> </methods> @@ -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). </description> <methods> - <method name="set_multimesh"> - <argument index="0" name="multimesh" type="Object"> - </argument> - <description> - Set the [MultiMesh] to be instance. - </description> - </method> <method name="get_multimesh" qualifiers="const"> <return type="Object"> </return> @@ -20558,6 +20621,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the [MultiMesh] that is used for instancing. </description> </method> + <method name="set_multimesh"> + <argument index="0" name="multimesh" type="Object"> + </argument> + <description> + Set the [MultiMesh] to be instance. + </description> + </method> </methods> <constants> </constants> @@ -20597,89 +20667,89 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="navmesh_create"> - <return type="int"> + <method name="get_closest_point"> + <return type="Vector3"> </return> - <argument index="0" name="mesh" type="NavigationMesh"> - </argument> - <argument index="1" name="xform" type="Transform"> - </argument> - <argument index="2" name="owner" type="Object" default="NULL"> + <argument index="0" name="to_point" type="Vector3"> </argument> <description> </description> </method> - <method name="navmesh_set_transform"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="xform" type="Transform"> + <method name="get_closest_point_normal"> + <return type="Vector3"> + </return> + <argument index="0" name="to_point" type="Vector3"> </argument> <description> </description> </method> - <method name="navmesh_remove"> - <argument index="0" name="id" type="int"> + <method name="get_closest_point_owner"> + <return type="Object"> + </return> + <argument index="0" name="to_point" type="Vector3"> </argument> <description> </description> </method> - <method name="get_simple_path"> - <return type="Vector3Array"> + <method name="get_closest_point_to_segment"> + <return type="Vector3"> </return> <argument index="0" name="start" type="Vector3"> </argument> <argument index="1" name="end" type="Vector3"> </argument> - <argument index="2" name="optimize" type="bool" default="true"> + <argument index="2" name="use_collision" type="bool" default="false"> </argument> <description> </description> </method> - <method name="get_closest_point_to_segment"> - <return type="Vector3"> + <method name="get_simple_path"> + <return type="Vector3Array"> </return> <argument index="0" name="start" type="Vector3"> </argument> <argument index="1" name="end" type="Vector3"> </argument> - <argument index="2" name="use_collision" type="bool" default="false"> + <argument index="2" name="optimize" type="bool" default="true"> </argument> <description> </description> </method> - <method name="get_closest_point"> + <method name="get_up_vector" qualifiers="const"> <return type="Vector3"> </return> - <argument index="0" name="to_point" type="Vector3"> - </argument> <description> </description> </method> - <method name="get_closest_point_normal"> - <return type="Vector3"> + <method name="navmesh_create"> + <return type="int"> </return> - <argument index="0" name="to_point" type="Vector3"> + <argument index="0" name="mesh" type="NavigationMesh"> + </argument> + <argument index="1" name="xform" type="Transform"> + </argument> + <argument index="2" name="owner" type="Object" default="NULL"> </argument> <description> </description> </method> - <method name="get_closest_point_owner"> - <return type="Object"> - </return> - <argument index="0" name="to_point" type="Vector3"> + <method name="navmesh_remove"> + <argument index="0" name="id" type="int"> </argument> <description> </description> </method> - <method name="set_up_vector"> - <argument index="0" name="up" type="Vector3"> + <method name="navmesh_set_transform"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="xform" type="Transform"> </argument> <description> </description> </method> - <method name="get_up_vector" qualifiers="const"> - <return type="Vector3"> - </return> + <method name="set_up_vector"> + <argument index="0" name="up" type="Vector3"> + </argument> <description> </description> </method> @@ -20693,28 +20763,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="navpoly_create"> - <return type="int"> + <method name="get_closest_point"> + <return type="Vector2"> </return> - <argument index="0" name="mesh" type="NavigationPolygon"> - </argument> - <argument index="1" name="xform" type="Matrix32"> - </argument> - <argument index="2" name="owner" type="Object" default="NULL"> - </argument> - <description> - </description> - </method> - <method name="navpoly_set_transform"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="xform" type="Matrix32"> + <argument index="0" name="to_point" type="Vector2"> </argument> <description> </description> </method> - <method name="navpoly_remove"> - <argument index="0" name="id" type="int"> + <method name="get_closest_point_owner"> + <return type="Object"> + </return> + <argument index="0" name="to_point" type="Vector2"> </argument> <description> </description> @@ -20731,18 +20791,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_closest_point"> - <return type="Vector2"> + <method name="navpoly_create"> + <return type="int"> </return> - <argument index="0" name="to_point" type="Vector2"> + <argument index="0" name="mesh" type="NavigationPolygon"> + </argument> + <argument index="1" name="xform" type="Matrix32"> + </argument> + <argument index="2" name="owner" type="Object" default="NULL"> </argument> <description> </description> </method> - <method name="get_closest_point_owner"> - <return type="Object"> - </return> - <argument index="0" name="to_point" type="Vector2"> + <method name="navpoly_remove"> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="navpoly_set_transform"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="xform" type="Matrix32"> </argument> <description> </description> @@ -20757,20 +20827,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_vertices"> - <argument index="0" name="vertices" type="Vector3Array"> + <method name="add_polygon"> + <argument index="0" name="polygon" type="IntArray"> </argument> <description> </description> </method> - <method name="get_vertices" qualifiers="const"> - <return type="Vector3Array"> - </return> + <method name="clear_polygons"> <description> </description> </method> - <method name="add_polygon"> - <argument index="0" name="polygon" type="IntArray"> + <method name="get_polygon"> + <return type="IntArray"> + </return> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -20781,15 +20851,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_polygon"> - <return type="IntArray"> + <method name="get_vertices" qualifiers="const"> + <return type="Vector3Array"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="clear_polygons"> + <method name="set_vertices"> + <argument index="0" name="vertices" type="Vector3Array"> + </argument> <description> </description> </method> @@ -20803,14 +20873,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_navigation_mesh"> - <argument index="0" name="navmesh" type="Object"> - </argument> + <method name="get_navigation_mesh" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> - <method name="get_navigation_mesh" qualifiers="const"> - <return type="Object"> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> </return> <description> </description> @@ -20821,9 +20891,9 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_navigation_mesh"> + <argument index="0" name="navmesh" type="Object"> + </argument> <description> </description> </method> @@ -20837,15 +20907,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_vertices"> - <argument index="0" name="vertices" type="Vector2Array"> + <method name="add_outline"> + <argument index="0" name="outline" type="Vector2Array"> </argument> <description> </description> </method> - <method name="get_vertices" qualifiers="const"> - <return type="Vector2Array"> - </return> + <method name="add_outline_at_index"> + <argument index="0" name="outline" type="Vector2Array"> + </argument> + <argument index="1" name="index" type="int"> + </argument> <description> </description> </method> @@ -20855,17 +20927,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_polygon_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_polygon"> - <return type="IntArray"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <method name="clear_outlines"> <description> </description> </method> @@ -20873,16 +20935,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="add_outline"> - <argument index="0" name="outline" type="Vector2Array"> - </argument> - <description> - </description> - </method> - <method name="add_outline_at_index"> - <argument index="0" name="outline" type="Vector2Array"> - </argument> - <argument index="1" name="index" type="int"> + <method name="get_outline" qualifiers="const"> + <return type="Vector2Array"> + </return> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -20893,19 +20949,27 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_outline"> + <method name="get_polygon"> + <return type="IntArray"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="outline" type="Vector2Array"> - </argument> <description> </description> </method> - <method name="get_outline" qualifiers="const"> + <method name="get_polygon_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_vertices" qualifiers="const"> <return type="Vector2Array"> </return> - <argument index="0" name="idx" type="int"> - </argument> + <description> + </description> + </method> + <method name="make_polygons_from_outlines"> <description> </description> </method> @@ -20915,11 +20979,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="clear_outlines"> + <method name="set_outline"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="outline" type="Vector2Array"> + </argument> <description> </description> </method> - <method name="make_polygons_from_outlines"> + <method name="set_vertices"> + <argument index="0" name="vertices" type="Vector2Array"> + </argument> <description> </description> </method> @@ -20933,14 +21003,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_navigation_polygon"> - <argument index="0" name="navpoly" type="NavigationPolygon"> - </argument> + <method name="get_navigation_polygon" qualifiers="const"> + <return type="NavigationPolygon"> + </return> <description> </description> </method> - <method name="get_navigation_polygon" qualifiers="const"> - <return type="NavigationPolygon"> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> </return> <description> </description> @@ -20951,9 +21021,9 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_navigation_polygon"> + <argument index="0" name="navpoly" type="NavigationPolygon"> + </argument> <description> </description> </method> @@ -20968,169 +21038,169 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </description> <methods> <method name="Nil"> - <argument index="0" name="from" type="bool"> + <argument index="0" name="from" type="ColorArray"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="int"> + <argument index="0" name="from" type="Vector3Array"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="float"> + <argument index="0" name="from" type="Vector2Array"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="String"> + <argument index="0" name="from" type="StringArray"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Vector2"> + <argument index="0" name="from" type="RealArray"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Rect2"> + <argument index="0" name="from" type="IntArray"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Vector3"> + <argument index="0" name="from" type="RawArray"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Matrix32"> + <argument index="0" name="from" type="Array"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Plane"> + <argument index="0" name="from" type="Dictionary"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Quat"> + <argument index="0" name="from" type="InputEvent"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="AABB"> + <argument index="0" name="from" type="Object"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Matrix3"> + <argument index="0" name="from" type="RID"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Transform"> + <argument index="0" name="from" type="NodePath"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Color"> + <argument index="0" name="from" type="Image"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Image"> + <argument index="0" name="from" type="Color"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="NodePath"> + <argument index="0" name="from" type="Transform"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="RID"> + <argument index="0" name="from" type="Matrix3"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Object"> + <argument index="0" name="from" type="AABB"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="InputEvent"> + <argument index="0" name="from" type="Quat"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Dictionary"> + <argument index="0" name="from" type="Plane"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Array"> + <argument index="0" name="from" type="Matrix32"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="RawArray"> + <argument index="0" name="from" type="Vector3"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="IntArray"> + <argument index="0" name="from" type="Rect2"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="RealArray"> + <argument index="0" name="from" type="Vector2"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="StringArray"> + <argument index="0" name="from" type="String"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Vector2Array"> + <argument index="0" name="from" type="float"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="Vector3Array"> + <argument index="0" name="from" type="int"> </argument> <description> </description> </method> <method name="Nil"> - <argument index="0" name="from" type="ColorArray"> + <argument index="0" name="from" type="bool"> </argument> <description> </description> @@ -21203,35 +21273,60 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Called when any key input happens that was not handled by something else. </description> </method> - <method name="set_name"> - <argument index="0" name="name" type="String"> + <method name="add_child"> + <argument index="0" name="node" type="Node"> + </argument> + <argument index="1" name="legible_unique_name" type="bool" default="false"> </argument> <description> - 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. + Add a child [Node]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. + 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. </description> </method> - <method name="get_name" qualifiers="const"> - <return type="String"> + <method name="add_to_group"> + <argument index="0" name="group" type="String"> + </argument> + <argument index="1" name="persistent" type="bool" default="false"> + </argument> + <description> + 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]). + </description> + </method> + <method name="can_process" qualifiers="const"> + <return type="bool"> </return> <description> - Return the name of the [Node]. Name is be unique within parent. + Return true if the node can process. </description> </method> - <method name="add_child"> - <argument index="0" name="node" type="Node"> + <method name="duplicate" qualifiers="const"> + <return type="Node"> + </return> + <argument index="0" name="use_instancing" type="bool" default="false"> </argument> - <argument index="1" name="legible_unique_name" type="bool" default="false"> + <description> + </description> + </method> + <method name="find_node" qualifiers="const"> + <return type="Node"> + </return> + <argument index="0" name="mask" type="String"> + </argument> + <argument index="1" name="recursive" type="bool" default="true"> + </argument> + <argument index="2" name="owned" type="bool" default="true"> </argument> <description> - Add a child [Node]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. - 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. + 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. </description> </method> - <method name="remove_child"> - <argument index="0" name="node" type="Node"> + <method name="get_child" qualifiers="const"> + <return type="Node"> + </return> + <argument index="0" name="idx" type="int"> </argument> <description> - Remove a child [Node]. Node is NOT deleted and will have to be deleted manually. + 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. </description> </method> <method name="get_child_count" qualifiers="const"> @@ -21247,21 +21342,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_child" qualifiers="const"> - <return type="Node"> + <method name="get_filename" qualifiers="const"> + <return type="String"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - 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]). </description> </method> - <method name="has_node" qualifiers="const"> - <return type="bool"> + <method name="get_fixed_process_delta_time" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="path" type="NodePath"> - </argument> <description> + 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]. + </description> + </method> + <method name="get_groups" qualifiers="const"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_index" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the node index in the parent (assuming it has a parent). + </description> + </method> + <method name="get_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the name of the [Node]. Name is be unique within parent. </description> </method> <method name="get_node" qualifiers="const"> @@ -21288,34 +21400,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) - get_node("/root/MyGame") </description> </method> - <method name="get_parent" qualifiers="const"> - <return type="Node"> - </return> - <description> - Return the parent [Node] of the current [Node], or an empty Object if the node lacks a parent. - </description> - </method> - <method name="find_node" qualifiers="const"> - <return type="Node"> - </return> - <argument index="0" name="mask" type="String"> - </argument> - <argument index="1" name="recursive" type="bool" default="true"> - </argument> - <argument index="2" name="owned" type="bool" default="true"> - </argument> - <description> - 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. - </description> - </method> - <method name="has_node_and_resource" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> <method name="get_node_and_resource"> <return type="Array"> </return> @@ -21324,28 +21408,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="is_inside_tree" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_a_parent_of" qualifiers="const"> - <return type="bool"> + <method name="get_owner" qualifiers="const"> + <return type="Node"> </return> - <argument index="0" name="node" type="Node"> - </argument> <description> - Return [i]true[/i] if the "node" argument is a direct or indirect child of the current node, otherwise return [i]false[/i]. + Get the node owner (see [method set_owner]). </description> </method> - <method name="is_greater_than" qualifiers="const"> - <return type="bool"> + <method name="get_parent" qualifiers="const"> + <return type="Node"> </return> - <argument index="0" name="node" type="Node"> - </argument> <description> - 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. </description> </method> <method name="get_path" qualifiers="const"> @@ -21364,271 +21438,267 @@ 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. </description> </method> - <method name="add_to_group"> - <argument index="0" name="group" type="String"> - </argument> - <argument index="1" name="persistent" type="bool" default="false"> - </argument> + <method name="get_pause_mode" qualifiers="const"> + <return type="int"> + </return> <description> - 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]). </description> </method> - <method name="remove_from_group"> - <argument index="0" name="group" type="String"> - </argument> + <method name="get_position_in_parent" qualifiers="const"> + <return type="int"> + </return> <description> - Remove a node from a group. </description> </method> - <method name="is_in_group" qualifiers="const"> - <return type="bool"> + <method name="get_process_delta_time" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="group" type="String"> - </argument> <description> + Return the time elapsed (in seconds) since the last process callback. This is almost always different each time. </description> </method> - <method name="move_child"> - <argument index="0" name="child_node" type="Node"> - </argument> - <argument index="1" name="to_pos" type="int"> - </argument> + <method name="get_scene_instance_load_placeholder" qualifiers="const"> + <return type="bool"> + </return> <description> - 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. </description> </method> - <method name="get_groups" qualifiers="const"> - <return type="Array"> + <method name="get_tree" qualifiers="const"> + <return type="SceneTree"> </return> <description> </description> </method> - <method name="raise"> + <method name="get_viewport" qualifiers="const"> + <return type="Object"> + </return> <description> - 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. </description> </method> - <method name="set_owner"> - <argument index="0" name="owner" type="Node"> + <method name="has_node" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="path" type="NodePath"> </argument> <description> - 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. </description> </method> - <method name="get_owner" qualifiers="const"> - <return type="Node"> + <method name="has_node_and_resource" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="path" type="NodePath"> + </argument> <description> - Get the node owner (see [method set_owner]). </description> </method> - <method name="remove_and_skip"> + <method name="is_a_parent_of" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="node" type="Node"> + </argument> <description> - 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. + Return [i]true[/i] if the "node" argument is a direct or indirect child of the current node, otherwise return [i]false[/i]. </description> </method> - <method name="get_index" qualifiers="const"> - <return type="int"> + <method name="is_fixed_processing" qualifiers="const"> + <return type="bool"> </return> <description> - Get the node index in the parent (assuming it has a parent). + Return true if fixed processing is enabled (see [method set_fixed_process]). </description> </method> - <method name="print_tree"> + <method name="is_greater_than" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="node" type="Node"> + </argument> <description> - Print the scene to stdout. Used mainly for debugging purposes. + Return [i]true[/i] if "node" occurs later in the scene hierarchy than the current node, otherwise return [i]false[/i]. </description> </method> - <method name="set_filename"> - <argument index="0" name="filename" type="String"> + <method name="is_in_group" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="group" type="String"> </argument> <description> - 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. </description> </method> - <method name="get_filename" qualifiers="const"> - <return type="String"> + <method name="is_inside_tree" qualifiers="const"> + <return type="bool"> </return> <description> - 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]). </description> </method> - <method name="propagate_notification"> - <argument index="0" name="what" type="int"> - </argument> + <method name="is_processing" qualifiers="const"> + <return type="bool"> + </return> <description> - Notify the current node and all its children recursively by calling notification() in all of them. + Return whether processing is enabled in the current node (see [method set_process]). </description> </method> - <method name="set_fixed_process"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="is_processing_input" qualifiers="const"> + <return type="bool"> + </return> <description> - 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]. + Return true if the node is processing input (see [method set_process_input]). </description> </method> - <method name="get_fixed_process_delta_time" qualifiers="const"> - <return type="float"> + <method name="is_processing_unhandled_input" qualifiers="const"> + <return type="bool"> </return> <description> - 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 the node is processing unhandled input (see [method set_process_unhandled_input]). </description> </method> - <method name="is_fixed_processing" qualifiers="const"> + <method name="is_processing_unhandled_key_input" qualifiers="const"> <return type="bool"> </return> <description> - Return true if fixed processing is enabled (see [method set_fixed_process]). </description> </method> - <method name="set_process"> - <argument index="0" name="enable" type="bool"> + <method name="move_child"> + <argument index="0" name="child_node" type="Node"> + </argument> + <argument index="1" name="to_pos" type="int"> </argument> <description> - 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]. + 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. </description> </method> - <method name="get_process_delta_time" qualifiers="const"> - <return type="float"> - </return> + <method name="print_stray_nodes"> <description> - Return the time elapsed (in seconds) since the last process callback. This is almost always different each time. </description> </method> - <method name="is_processing" qualifiers="const"> - <return type="bool"> - </return> + <method name="print_tree"> <description> - Return whether processing is enabled in the current node (see [method set_process]). + Print the scene to stdout. Used mainly for debugging purposes. </description> </method> - <method name="set_process_input"> - <argument index="0" name="enable" type="bool"> + <method name="propagate_notification"> + <argument index="0" name="what" type="int"> </argument> <description> - Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]). + Notify the current node and all its children recursively by calling notification() in all of them. </description> </method> - <method name="is_processing_input" qualifiers="const"> - <return type="bool"> - </return> + <method name="queue_free"> <description> - Return true if the node is processing input (see [method set_process_input]). </description> </method> - <method name="set_process_unhandled_input"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="raise"> <description> - 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]). + 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. </description> </method> - <method name="is_processing_unhandled_input" qualifiers="const"> - <return type="bool"> - </return> + <method name="remove_and_skip"> <description> - Return true if the node is processing unhandled input (see [method set_process_unhandled_input]). + 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. </description> </method> - <method name="set_process_unhandled_key_input"> - <argument index="0" name="enable" type="bool"> + <method name="remove_child"> + <argument index="0" name="node" type="Node"> </argument> <description> + Remove a child [Node]. Node is NOT deleted and will have to be deleted manually. </description> </method> - <method name="is_processing_unhandled_key_input" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_pause_mode"> - <argument index="0" name="mode" type="int"> + <method name="remove_from_group"> + <argument index="0" name="group" type="String"> </argument> <description> + Remove a node from a group. </description> </method> - <method name="get_pause_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="replace_by"> + <argument index="0" name="node" type="Node"> + </argument> + <argument index="1" name="keep_data" type="bool" default="false"> + </argument> <description> + Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. </description> </method> - <method name="can_process" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_filename"> + <argument index="0" name="filename" type="String"> + </argument> <description> - Return true if the node can process. + 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. </description> </method> - <method name="print_stray_nodes"> + <method name="set_fixed_process"> + <argument index="0" name="enable" type="bool"> + </argument> <description> + 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]. </description> </method> - <method name="get_position_in_parent" qualifiers="const"> - <return type="int"> - </return> + <method name="set_name"> + <argument index="0" name="name" type="String"> + </argument> <description> + 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. </description> </method> - <method name="get_tree" qualifiers="const"> - <return type="SceneTree"> - </return> + <method name="set_owner"> + <argument index="0" name="owner" type="Node"> + </argument> <description> + 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. </description> </method> - <method name="duplicate" qualifiers="const"> - <return type="Node"> - </return> - <argument index="0" name="use_instancing" type="bool" default="false"> + <method name="set_pause_mode"> + <argument index="0" name="mode" type="int"> </argument> <description> </description> </method> - <method name="replace_by"> - <argument index="0" name="node" type="Node"> - </argument> - <argument index="1" name="keep_data" type="bool" default="false"> + <method name="set_process"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. + 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]. </description> </method> - <method name="set_scene_instance_load_placeholder"> - <argument index="0" name="load_placeholder" type="bool"> + <method name="set_process_input"> + <argument index="0" name="enable" type="bool"> </argument> <description> + Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]). </description> </method> - <method name="get_scene_instance_load_placeholder" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_process_unhandled_input"> + <argument index="0" name="enable" type="bool"> + </argument> <description> + 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]). </description> </method> - <method name="get_viewport" qualifiers="const"> - <return type="Object"> - </return> + <method name="set_process_unhandled_key_input"> + <argument index="0" name="enable" type="bool"> + </argument> <description> </description> </method> - <method name="queue_free"> + <method name="set_scene_instance_load_placeholder"> + <argument index="0" name="load_placeholder" type="bool"> + </argument> <description> </description> </method> </methods> <signals> - <signal name="renamed"> + <signal name="enter_tree"> <description> - Emitted when the node is renamed. </description> </signal> - <signal name="enter_tree"> + <signal name="exit_tree"> <description> </description> </signal> - <signal name="exit_tree"> + <signal name="renamed"> <description> + Emitted when the node is renamed. </description> </signal> </signals> @@ -21641,6 +21711,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="NOTIFICATION_READY" value="13"> </constant> + <constant name="NOTIFICATION_PAUSED" value="14"> + </constant> + <constant name="NOTIFICATION_UNPAUSED" value="15"> + </constant> <constant name="NOTIFICATION_FIXED_PROCESS" value="16"> </constant> <constant name="NOTIFICATION_PROCESS" value="17"> @@ -21652,10 +21726,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constant name="NOTIFICATION_UNPARENTED" value="19"> Notification received when a node is unparented (parent removed it from the list of children). </constant> - <constant name="NOTIFICATION_PAUSED" value="14"> - </constant> - <constant name="NOTIFICATION_UNPAUSED" value="15"> - </constant> <constant name="NOTIFICATION_INSTANCED" value="20"> </constant> <constant name="NOTIFICATION_DRAG_BEGIN" value="21"> @@ -21678,32 +21748,27 @@ 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. </description> <methods> - <method name="set_pos"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <description> - Set the position of the 2D node. - </description> - </method> - <method name="set_rot"> - <argument index="0" name="radians" type="float"> + <method name="edit_set_pivot"> + <argument index="0" name="pivot" type="Vector2"> </argument> <description> - Set the rotation of the 2D node. + Set the pivot position of the 2D node to 'pivot' value. This method is implemented only in some nodes that inherit Node2D. </description> </method> - <method name="set_rotd"> - <argument index="0" name="degrees" type="float"> + <method name="get_angle_to" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="point" type="Vector2"> </argument> <description> - Set the rotation of the 2D node. + Return the rotation angle in radians needed for the 2d node to point at 'point' position. </description> </method> - <method name="set_scale"> - <argument index="0" name="scale" type="Vector2"> - </argument> + <method name="get_global_pos" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Set the scale of the 2D node. + Return the global position of the 2D node. </description> </method> <method name="get_pos" qualifiers="const"> @@ -21713,6 +21778,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the position of the 2D node. </description> </method> + <method name="get_relative_transform_to_parent" qualifiers="const"> + <return type="Matrix32"> + </return> + <argument index="0" name="parent" type="Object"> + </argument> + <description> + Return the transform [Matrix32] calculated relatively to the parent of this 2D node. + </description> + </method> <method name="get_rot" qualifiers="const"> <return type="float"> </return> @@ -21733,11 +21807,32 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the scale of the 2D node. </description> </method> - <method name="rotate"> - <argument index="0" name="radians" type="float"> + <method name="get_z" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the Z-index of the 2D node. + </description> + </method> + <method name="global_translate"> + <argument index="0" name="offset" type="Vector2"> </argument> <description> - Apply a 'radians' rotation to the 2D node, starting from its current rotation. + Apply a global translation of 'offset' to the 2D node, starting from its current global position. + </description> + </method> + <method name="is_z_relative" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the Z-index value of this 2D node is relative to its parent's. Else, return false. + </description> + </method> + <method name="look_at"> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + Rotate the 2d node so it points at 'point' position. </description> </method> <method name="move_local_x"> @@ -21758,18 +21853,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) 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. </description> </method> - <method name="translate"> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - Apply a local translation of 'offset' to the 2D node, starting from its current local position. - </description> - </method> - <method name="global_translate"> - <argument index="0" name="offset" type="Vector2"> + <method name="rotate"> + <argument index="0" name="radians" type="float"> </argument> <description> - Apply a global translation of 'offset' to the 2D node, starting from its current global position. + Apply a 'radians' rotation to the 2D node, starting from its current rotation. </description> </method> <method name="scale"> @@ -21786,20 +21874,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Set the global position of the 2D node to 'pos'. </description> </method> - <method name="get_global_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the global position of the 2D node. - </description> - </method> - <method name="set_transform"> - <argument index="0" name="xform" type="Matrix32"> - </argument> - <description> - Set the local transform [Matrix32] of the 2D node. - </description> - </method> <method name="set_global_transform"> <argument index="0" name="xform" type="Matrix32"> </argument> @@ -21807,64 +21881,60 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Set the global transform [Matrix32] of the 2D node. </description> </method> - <method name="look_at"> - <argument index="0" name="point" type="Vector2"> + <method name="set_pos"> + <argument index="0" name="pos" type="Vector2"> </argument> <description> - Rotate the 2d node so it points at 'point' position. + Set the position of the 2D node. </description> </method> - <method name="get_angle_to" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="point" type="Vector2"> + <method name="set_rot"> + <argument index="0" name="radians" type="float"> </argument> <description> - Return the rotation angle in radians needed for the 2d node to point at 'point' position. + Set the rotation of the 2D node. </description> </method> - <method name="set_z"> - <argument index="0" name="z" type="int"> + <method name="set_rotd"> + <argument index="0" name="degrees" type="float"> </argument> <description> - Set the Z-index value of the 2D node. + Set the rotation of the 2D node. </description> </method> - <method name="get_z" qualifiers="const"> - <return type="int"> - </return> + <method name="set_scale"> + <argument index="0" name="scale" type="Vector2"> + </argument> <description> - Return the Z-index of the 2D node. + Set the scale of the 2D node. </description> </method> - <method name="set_z_as_relative"> - <argument index="0" name="enable" type="bool"> + <method name="set_transform"> + <argument index="0" name="xform" type="Matrix32"> </argument> <description> - 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. + Set the local transform [Matrix32] of the 2D node. </description> </method> - <method name="is_z_relative" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_z"> + <argument index="0" name="z" type="int"> + </argument> <description> - Return true if the Z-index value of this 2D node is relative to its parent's. Else, return false. + Set the Z-index value of the 2D node. </description> </method> - <method name="edit_set_pivot"> - <argument index="0" name="pivot" type="Vector2"> + <method name="set_z_as_relative"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Set the pivot position of the 2D node to 'pivot' value. This method is implemented only in some nodes that inherit Node2D. + 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. </description> </method> - <method name="get_relative_transform_to_parent" qualifiers="const"> - <return type="Matrix32"> - </return> - <argument index="0" name="parent" type="Object"> + <method name="translate"> + <argument index="0" name="offset" type="Vector2"> </argument> <description> - 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. </description> </method> </methods> @@ -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. </description> <methods> + <method name="NodePath"> + <return type="NodePath"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <description> + 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. + </description> + </method> <method name="get_name"> <return type="String"> </return> @@ -21934,15 +22013,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return true if the node path is empty. </description> </method> - <method name="NodePath"> - <return type="NodePath"> - </return> - <argument index="0" name="from" type="String"> - </argument> - <description> - 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. - </description> - </method> </methods> <constants> </constants> @@ -21964,243 +22034,188 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) -Command Line </description> <methods> - <method name="set_clipboard"> - <argument index="0" name="clipboard" type="String"> - </argument> - <description> - Set clipboard to the OS. - </description> - </method> - <method name="get_clipboard" qualifiers="const"> - <return type="String"> - </return> - <description> - Get clipboard from the host OS. - </description> - </method> - <method name="set_video_mode"> - <argument index="0" name="size" type="Vector2"> - </argument> - <argument index="1" name="fullscreen" type="bool"> - </argument> - <argument index="2" name="resizable" type="bool"> - </argument> - <argument index="3" name="screen" type="int" default="0"> + <method name="alert"> + <argument index="0" name="text" type="String"> </argument> - <description> - Change the video mode. - </description> - </method> - <method name="get_video_mode_size" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="screen" type="int" default="0"> + <argument index="1" name="title" type="String" default=""Alert!""> </argument> <description> - Return the current video mode size. </description> </method> - <method name="is_video_mode_fullscreen" qualifiers="const"> + <method name="can_draw" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="screen" type="int" default="0"> - </argument> <description> - Return true if the current video mode is fullscreen. + Return true if the host OS allows drawing. </description> </method> - <method name="is_video_mode_resizable" qualifiers="const"> + <method name="can_use_threads" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="screen" type="int" default="0"> - </argument> <description> - Return true if the window is resizable. </description> </method> - <method name="get_fullscreen_mode_list" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="screen" type="int" default="0"> + <method name="delay_msec" qualifiers="const"> + <argument index="0" name="msec" type="int"> </argument> <description> - Return the list of fullscreen modes. - </description> - </method> - <method name="get_screen_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the number of displays attached to the host machine + Delay executing of the current thread by given milliseconds. </description> </method> - <method name="get_current_screen" qualifiers="const"> - <return type="int"> - </return> + <method name="delay_usec" qualifiers="const"> + <argument index="0" name="usec" type="int"> + </argument> <description> - Returns the current screen index (0 padded). + Delay executing of the current thread by given microseconds. </description> </method> - <method name="set_current_screen"> - <argument index="0" name="screen" type="int"> + <method name="dump_memory_to_file"> + <argument index="0" name="file" type="String"> </argument> <description> </description> </method> - <method name="get_screen_position" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="screen" type="int" default="0"> + <method name="dump_resources_to_file"> + <argument index="0" name="file" type="String"> </argument> <description> </description> </method> - <method name="get_screen_size" qualifiers="const"> - <return type="Vector2"> + <method name="execute"> + <return type="int"> </return> - <argument index="0" name="screen" type="int" default="0"> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="arguments" type="StringArray"> + </argument> + <argument index="2" name="blocking" type="bool"> + </argument> + <argument index="3" name="output" type="Array" default="Array()"> </argument> <description> - Returns the dimensions in pixels of the specified screen. + Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. </description> </method> - <method name="get_screen_dpi" qualifiers="const"> + <method name="find_scancode_from_string" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="screen" type="int" default="0"> + <argument index="0" name="string" type="String"> </argument> <description> </description> </method> - <method name="get_window_position" qualifiers="const"> - <return type="Vector2"> + <method name="get_borderless_window" qualifiers="const"> + <return type="bool"> </return> <description> - 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. </description> </method> - <method name="set_window_position"> - <argument index="0" name="position" type="Vector2"> - </argument> + <method name="get_clipboard" qualifiers="const"> + <return type="String"> + </return> <description> - 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). + Get clipboard from the host OS. </description> </method> - <method name="get_window_size" qualifiers="const"> - <return type="Vector2"> + <method name="get_cmdline_args"> + <return type="StringArray"> </return> <description> - Returns the size of the window (without counting window manager decorations). + Return the commandline passed to the engine. </description> </method> - <method name="set_window_size"> - <argument index="0" name="size" type="Vector2"> - </argument> + <method name="get_current_screen" qualifiers="const"> + <return type="int"> + </return> <description> - Sets the window size to the specified size. + Returns the current screen index (0 padded). </description> </method> - <method name="set_window_fullscreen"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_custom_level" qualifiers="const"> + <return type="String"> + </return> <description> - 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. </description> </method> - <method name="is_window_fullscreen" qualifiers="const"> - <return type="bool"> + <method name="get_data_dir" qualifiers="const"> + <return type="String"> </return> <description> - Returns whether the window is in fullscreen mode or not. + Return the absolute directory path of user data path([user://]). </description> </method> - <method name="set_window_resizable"> - <argument index="0" name="enabled" type="bool"> + <method name="get_date" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="utc" type="bool" default="false"> </argument> <description> - Set the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings. + Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time). </description> </method> - <method name="is_window_resizable" qualifiers="const"> - <return type="bool"> + <method name="get_datetime" qualifiers="const"> + <return type="Dictionary"> </return> - <description> - Returns whether the window is resizable or not. - </description> - </method> - <method name="set_window_minimized"> - <argument index="0" name="enabled" type="bool"> + <argument index="0" name="utc" type="bool" default="false"> </argument> <description> - Set whether the window is minimized. + Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second. </description> </method> - <method name="is_window_minimized" qualifiers="const"> - <return type="bool"> + <method name="get_datetime_from_unix_time" qualifiers="const"> + <return type="Dictionary"> </return> - <description> - Return true if the window is minimized. - </description> - </method> - <method name="set_window_maximized"> - <argument index="0" name="enabled" type="bool"> + <argument index="0" name="unix_time_val" type="int"> </argument> <description> - Set the window size to maximized. + 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). </description> </method> - <method name="is_window_maximized" qualifiers="const"> - <return type="bool"> + <method name="get_dynamic_memory_usage" qualifiers="const"> + <return type="int"> </return> <description> - Return true if the window is maximized. + Return the total amount of dynamic memory used (only works in debug). </description> </method> - <method name="set_borderless_window"> - <argument index="0" name="borderless" type="bool"> + <method name="get_environment" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="environment" type="String"> </argument> <description> + Return an environment variable. </description> </method> - <method name="get_borderless_window" qualifiers="const"> - <return type="bool"> + <method name="get_executable_path" qualifiers="const"> + <return type="String"> </return> <description> + Return the path to the current engine executable. </description> </method> - <method name="set_screen_orientation"> - <argument index="0" name="orientation" type="int"> - </argument> - <description> - Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. - </description> - </method> - <method name="get_screen_orientation" qualifiers="const"> + <method name="get_frames_drawn"> <return type="int"> </return> <description> - Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class. - </description> - </method> - <method name="set_keep_screen_on"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS) + Return the total amount of frames drawn. </description> </method> - <method name="is_keep_screen_on" qualifiers="const"> - <return type="bool"> + <method name="get_frames_per_second" qualifiers="const"> + <return type="float"> </return> <description> - Returns whether the screen is being kept on or not. + Returns the frames per second of the running game. </description> </method> - <method name="set_iterations_per_second"> - <argument index="0" name="iterations_per_second" type="int"> + <method name="get_fullscreen_mode_list" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="screen" type="int" default="0"> </argument> <description> - Set the amount of fixed iterations per second (for fixed process and physics). + Return the list of fullscreen modes. </description> </method> <method name="get_iterations_per_second" qualifiers="const"> @@ -22210,179 +22225,163 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the amount of fixed iterations per second (for fixed process and physics). </description> </method> - <method name="set_target_fps"> - <argument index="0" name="target_fps" type="int"> - </argument> + <method name="get_locale" qualifiers="const"> + <return type="String"> + </return> <description> + Return the host OS locale. </description> </method> - <method name="get_target_fps" qualifiers="const"> - <return type="float"> + <method name="get_main_loop" qualifiers="const"> + <return type="Object"> </return> <description> + Return the main loop object (see [MainLoop]). </description> </method> - <method name="set_time_scale"> - <argument index="0" name="time_scale" type="float"> - </argument> + <method name="get_model_name" qualifiers="const"> + <return type="String"> + </return> <description> - Speeds up or slows down the physics by changing the delta variable. (delta * time_scale) </description> </method> - <method name="get_time_scale"> - <return type="float"> + <method name="get_name" qualifiers="const"> + <return type="String"> </return> <description> + Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "WinRT", "X11" </description> </method> - <method name="has_touchscreen_ui_hint" qualifiers="const"> - <return type="bool"> + <method name="get_process_ID" qualifiers="const"> + <return type="int"> </return> <description> + Returns the game process ID </description> </method> - <method name="set_window_title"> - <argument index="0" name="title" type="String"> - </argument> + <method name="get_processor_count" qualifiers="const"> + <return type="int"> + </return> <description> - Sets the window title to the specified string. + Returns the number of cores available in the host machine. </description> </method> - <method name="set_low_processor_usage_mode"> - <argument index="0" name="enable" type="bool"> + <method name="get_scancode_string" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="code" type="int"> </argument> <description> - 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. </description> </method> - <method name="is_in_low_processor_usage_mode" qualifiers="const"> - <return type="bool"> + <method name="get_screen_count" qualifiers="const"> + <return type="int"> </return> <description> - Return true if low cpu usage mode is enabled. + Returns the number of displays attached to the host machine </description> </method> - <method name="get_processor_count" qualifiers="const"> + <method name="get_screen_dpi" qualifiers="const"> <return type="int"> </return> + <argument index="0" name="screen" type="int" default="0"> + </argument> <description> - Returns the number of cores available in the host machine. </description> </method> - <method name="get_executable_path" qualifiers="const"> - <return type="String"> + <method name="get_screen_orientation" qualifiers="const"> + <return type="int"> </return> <description> - Return the path to the current engine executable. + Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class. </description> </method> - <method name="execute"> - <return type="int"> + <method name="get_screen_position" qualifiers="const"> + <return type="Vector2"> </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="arguments" type="StringArray"> - </argument> - <argument index="2" name="blocking" type="bool"> - </argument> - <argument index="3" name="output" type="Array" default="Array()"> + <argument index="0" name="screen" type="int" default="0"> </argument> <description> - Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. </description> </method> - <method name="kill"> - <return type="int"> + <method name="get_screen_size" qualifiers="const"> + <return type="Vector2"> </return> - <argument index="0" name="pid" type="int"> + <argument index="0" name="screen" type="int" default="0"> </argument> <description> - Kill a process ID (this method can be used to kill processes that were not spawned by the game). + Returns the dimensions in pixels of the specified screen. </description> </method> - <method name="shell_open"> + <method name="get_splash_tick_msec" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="uri" type="String"> - </argument> <description> </description> </method> - <method name="get_process_ID" qualifiers="const"> + <method name="get_static_memory_peak_usage" qualifiers="const"> <return type="int"> </return> <description> - Returns the game process ID + Return the max amount of static memory used (only works in debug). </description> </method> - <method name="get_environment" qualifiers="const"> - <return type="String"> + <method name="get_static_memory_usage" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="environment" type="String"> - </argument> <description> - Return an environment variable. </description> </method> - <method name="has_environment" qualifiers="const"> - <return type="bool"> + <method name="get_system_dir" qualifiers="const"> + <return type="String"> </return> - <argument index="0" name="environment" type="String"> + <argument index="0" name="dir" type="int"> </argument> <description> - Return true if an environment variable exists. </description> </method> - <method name="get_name" qualifiers="const"> - <return type="String"> + <method name="get_system_time_secs" qualifiers="const"> + <return type="int"> </return> <description> - Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "WinRT", "X11" </description> </method> - <method name="get_cmdline_args"> - <return type="StringArray"> + <method name="get_target_fps" qualifiers="const"> + <return type="float"> </return> <description> - Return the commandline passed to the engine. </description> </method> - <method name="get_main_loop" qualifiers="const"> - <return type="Object"> + <method name="get_ticks_msec" qualifiers="const"> + <return type="int"> </return> <description> - Return the main loop object (see [MainLoop]). + Return the amount of time passed in milliseconds since the engine started. </description> </method> - <method name="get_datetime" qualifiers="const"> + <method name="get_time" qualifiers="const"> <return type="Dictionary"> </return> <argument index="0" name="utc" type="bool" default="false"> </argument> <description> - Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second. + Returns current time as a dictionary of keys: hour, minute, second </description> </method> - <method name="get_date" qualifiers="const"> - <return type="Dictionary"> + <method name="get_time_scale"> + <return type="float"> </return> - <argument index="0" name="utc" type="bool" default="false"> - </argument> <description> - Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time). </description> </method> - <method name="get_time" qualifiers="const"> + <method name="get_time_zone_info" qualifiers="const"> <return type="Dictionary"> </return> - <argument index="0" name="utc" type="bool" default="false"> - </argument> <description> - Returns current time as a dictionary of keys: hour, minute, second </description> </method> - <method name="get_time_zone_info" qualifiers="const"> - <return type="Dictionary"> + <method name="get_unique_ID" qualifiers="const"> + <return type="String"> </return> <description> </description> @@ -22394,16 +22393,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the current unix timestamp. </description> </method> - <method name="get_datetime_from_unix_time" qualifiers="const"> - <return type="Dictionary"> - </return> - <argument index="0" name="unix_time_val" type="int"> - </argument> - <description> - 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). - </description> - </method> <method name="get_unix_time_from_datetime" qualifiers="const"> <return type="int"> </return> @@ -22415,76 +22404,76 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored. </description> </method> - <method name="get_system_time_secs" qualifiers="const"> - <return type="int"> + <method name="get_video_mode_size" qualifiers="const"> + <return type="Vector2"> </return> - <description> - </description> - </method> - <method name="set_icon"> - <argument index="0" name="icon" type="Image"> + <argument index="0" name="screen" type="int" default="0"> </argument> <description> + Return the current video mode size. </description> </method> - <method name="delay_usec" qualifiers="const"> - <argument index="0" name="usec" type="int"> - </argument> + <method name="get_window_position" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Delay executing of the current thread by given microseconds. + 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. </description> </method> - <method name="delay_msec" qualifiers="const"> - <argument index="0" name="msec" type="int"> - </argument> + <method name="get_window_size" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Delay executing of the current thread by given milliseconds. + Returns the size of the window (without counting window manager decorations). </description> </method> - <method name="get_ticks_msec" qualifiers="const"> - <return type="int"> + <method name="has_environment" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="environment" type="String"> + </argument> <description> - Return the amount of time passed in milliseconds since the engine started. + Return true if an environment variable exists. </description> </method> - <method name="get_splash_tick_msec" qualifiers="const"> - <return type="int"> + <method name="has_touchscreen_ui_hint" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="get_locale" qualifiers="const"> - <return type="String"> + <method name="is_debug_build" qualifiers="const"> + <return type="bool"> </return> <description> - Return the host OS locale. </description> </method> - <method name="get_model_name" qualifiers="const"> - <return type="String"> + <method name="is_in_low_processor_usage_mode" qualifiers="const"> + <return type="bool"> </return> <description> + Return true if low cpu usage mode is enabled. </description> </method> - <method name="get_custom_level" qualifiers="const"> - <return type="String"> + <method name="is_keep_screen_on" qualifiers="const"> + <return type="bool"> </return> <description> + Returns whether the screen is being kept on or not. </description> </method> - <method name="can_draw" qualifiers="const"> + <method name="is_ok_left_and_cancel_right" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the host OS allows drawing. </description> </method> - <method name="get_frames_drawn"> - <return type="int"> + <method name="is_scancode_unicode" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="code" type="int"> + </argument> <description> - Return the total amount of frames drawn. </description> </method> <method name="is_stdout_verbose" qualifiers="const"> @@ -22494,94 +22483,103 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return true if the engine was executed with -v (verbose stdout). </description> </method> - <method name="can_use_threads" qualifiers="const"> + <method name="is_video_mode_fullscreen" qualifiers="const"> <return type="bool"> </return> + <argument index="0" name="screen" type="int" default="0"> + </argument> <description> + Return true if the current video mode is fullscreen. </description> </method> - <method name="is_debug_build" qualifiers="const"> + <method name="is_video_mode_resizable" qualifiers="const"> <return type="bool"> </return> + <argument index="0" name="screen" type="int" default="0"> + </argument> <description> + Return true if the window is resizable. </description> </method> - <method name="dump_memory_to_file"> - <argument index="0" name="file" type="String"> - </argument> + <method name="is_vsnc_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="dump_resources_to_file"> - <argument index="0" name="file" type="String"> - </argument> + <method name="is_window_fullscreen" qualifiers="const"> + <return type="bool"> + </return> <description> + Returns whether the window is in fullscreen mode or not. </description> </method> - <method name="print_resources_in_use"> - <argument index="0" name="short" type="bool" default="false"> - </argument> + <method name="is_window_maximized" qualifiers="const"> + <return type="bool"> + </return> <description> + Return true if the window is maximized. </description> </method> - <method name="print_all_resources"> - <argument index="0" name="tofile" type="String" default=""""> - </argument> + <method name="is_window_minimized" qualifiers="const"> + <return type="bool"> + </return> <description> + Return true if the window is minimized. </description> </method> - <method name="get_static_memory_usage" qualifiers="const"> - <return type="int"> + <method name="is_window_resizable" qualifiers="const"> + <return type="bool"> </return> <description> + Returns whether the window is resizable or not. </description> </method> - <method name="get_static_memory_peak_usage" qualifiers="const"> + <method name="kill"> <return type="int"> </return> + <argument index="0" name="pid" type="int"> + </argument> <description> - Return the max amount of static memory used (only works in debug). + Kill a process ID (this method can be used to kill processes that were not spawned by the game). </description> </method> - <method name="get_dynamic_memory_usage" qualifiers="const"> - <return type="int"> + <method name="native_video_is_playing"> + <return type="bool"> </return> <description> - Return the total amount of dynamic memory used (only works in debug). </description> </method> - <method name="get_data_dir" qualifiers="const"> - <return type="String"> - </return> + <method name="native_video_pause"> <description> - Return the absolute directory path of user data path([user://]). </description> </method> - <method name="get_system_dir" qualifiers="const"> - <return type="String"> + <method name="native_video_play"> + <return type="int"> </return> - <argument index="0" name="dir" type="int"> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="volume" type="float"> + </argument> + <argument index="2" name="audio_track" type="String"> + </argument> + <argument index="3" name="subtitle_track" type="String"> </argument> <description> </description> </method> - <method name="get_unique_ID" qualifiers="const"> - <return type="String"> - </return> + <method name="native_video_stop"> <description> </description> </method> - <method name="is_ok_left_and_cancel_right" qualifiers="const"> - <return type="bool"> - </return> + <method name="native_video_unpause"> <description> </description> </method> - <method name="get_frames_per_second" qualifiers="const"> - <return type="float"> - </return> + <method name="print_all_resources"> + <argument index="0" name="tofile" type="String" default=""""> + </argument> <description> - Returns the frames per second of the running game. </description> </method> <method name="print_all_textures_by_size"> @@ -22594,93 +22592,165 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="native_video_play"> - <return type="int"> - </return> - <argument index="0" name="path" type="String"> + <method name="print_resources_in_use"> + <argument index="0" name="short" type="bool" default="false"> </argument> - <argument index="1" name="volume" type="float"> + <description> + </description> + </method> + <method name="set_borderless_window"> + <argument index="0" name="borderless" type="bool"> </argument> - <argument index="2" name="audio_track" type="String"> + <description> + </description> + </method> + <method name="set_clipboard"> + <argument index="0" name="clipboard" type="String"> </argument> - <argument index="3" name="subtitle_track" type="String"> + <description> + Set clipboard to the OS. + </description> + </method> + <method name="set_current_screen"> + <argument index="0" name="screen" type="int"> </argument> <description> </description> </method> - <method name="native_video_is_playing"> - <return type="bool"> - </return> + <method name="set_icon"> + <argument index="0" name="icon" type="Image"> + </argument> <description> </description> </method> - <method name="native_video_stop"> + <method name="set_iterations_per_second"> + <argument index="0" name="iterations_per_second" type="int"> + </argument> <description> + Set the amount of fixed iterations per second (for fixed process and physics). </description> </method> - <method name="native_video_pause"> + <method name="set_keep_screen_on"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> + Set keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS) </description> </method> - <method name="native_video_unpause"> + <method name="set_low_processor_usage_mode"> + <argument index="0" name="enable" type="bool"> + </argument> <description> + 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. </description> </method> - <method name="get_scancode_string" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="code" type="int"> + <method name="set_screen_orientation"> + <argument index="0" name="orientation" type="int"> </argument> <description> + Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. </description> </method> - <method name="is_scancode_unicode" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="code" type="int"> + <method name="set_target_fps"> + <argument index="0" name="target_fps" type="int"> </argument> <description> </description> </method> - <method name="find_scancode_from_string" qualifiers="const"> + <method name="set_thread_name"> <return type="int"> </return> - <argument index="0" name="string" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> </method> + <method name="set_time_scale"> + <argument index="0" name="time_scale" type="float"> + </argument> + <description> + Speeds up or slows down the physics by changing the delta variable. (delta * time_scale) + </description> + </method> <method name="set_use_file_access_save_and_swap"> <argument index="0" name="enabled" type="bool"> </argument> <description> </description> </method> - <method name="alert"> - <argument index="0" name="text" type="String"> + <method name="set_use_vsync"> + <argument index="0" name="enable" type="bool"> </argument> - <argument index="1" name="title" type="String" default=""Alert!""> + <description> + </description> + </method> + <method name="set_video_mode"> + <argument index="0" name="size" type="Vector2"> + </argument> + <argument index="1" name="fullscreen" type="bool"> + </argument> + <argument index="2" name="resizable" type="bool"> + </argument> + <argument index="3" name="screen" type="int" default="0"> </argument> <description> + Change the video mode. </description> </method> - <method name="set_thread_name"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> + <method name="set_window_fullscreen"> + <argument index="0" name="enabled" type="bool"> </argument> <description> + 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. </description> </method> - <method name="set_use_vsync"> - <argument index="0" name="enable" type="bool"> + <method name="set_window_maximized"> + <argument index="0" name="enabled" type="bool"> </argument> <description> + Set the window size to maximized. </description> </method> - <method name="is_vsnc_enabled" qualifiers="const"> - <return type="bool"> + <method name="set_window_minimized"> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set whether the window is minimized. + </description> + </method> + <method name="set_window_position"> + <argument index="0" name="position" type="Vector2"> + </argument> + <description> + 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). + </description> + </method> + <method name="set_window_resizable"> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings. + </description> + </method> + <method name="set_window_size"> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Sets the window size to the specified size. + </description> + </method> + <method name="set_window_title"> + <argument index="0" name="title" type="String"> + </argument> + <description> + Sets the window title to the specified string. + </description> + </method> + <method name="shell_open"> + <return type="int"> </return> + <argument index="0" name="uri" type="String"> + </argument> <description> </description> </method> @@ -22702,6 +22772,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="MONTH_JANUARY" value="1"> </constant> + <constant name="MONTH_OCTOBER" value="10"> + </constant> + <constant name="MONTH_NOVEMBER" value="11"> + </constant> + <constant name="MONTH_DECEMBER" value="12"> + </constant> <constant name="MONTH_FEBRUARY" value="2"> </constant> <constant name="MONTH_MARCH" value="3"> @@ -22718,12 +22794,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="MONTH_SEPTEMBER" value="9"> </constant> - <constant name="MONTH_OCTOBER" value="10"> - </constant> - <constant name="MONTH_NOVEMBER" value="11"> - </constant> - <constant name="MONTH_DECEMBER" value="12"> - </constant> <constant name="SCREEN_ORIENTATION_LANDSCAPE" value="0"> </constant> <constant name="SCREEN_ORIENTATION_PORTRAIT" value="1"> @@ -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. </description> <methods> + <method name="XL_MESSAGE" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="message" type="String"> + </argument> + <description> + Deprecated, will go away. + </description> + </method> <method name="_get" qualifiers="virtual"> <argument index="0" name="property" type="String"> </argument> @@ -22802,92 +22881,137 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Set a property. Return true if the property was found. </description> </method> - <method name="free"> - <description> - </description> - </method> - <method name="get_type" qualifiers="const"> - <return type="String"> - </return> + <method name="add_user_signal"> + <argument index="0" name="signal" type="String"> + </argument> + <argument index="1" name="arguments" type="Array" default="Array()"> + </argument> <description> - Return the type of the object as a string. + 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_*). </description> </method> - <method name="is_type" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="type" type="String"> + <method name="call"> + <argument index="0" name="method" type="String"> + </argument> + <argument index="1" name="arg0" type="Variant" default="NULL"> + </argument> + <argument index="2" name="arg1" type="Variant" default="NULL"> + </argument> + <argument index="3" name="arg2" type="Variant" default="NULL"> + </argument> + <argument index="4" name="arg3" type="Variant" default="NULL"> + </argument> + <argument index="5" name="arg4" type="Variant" default="NULL"> + </argument> + <argument index="6" name="arg5" type="Variant" default="NULL"> + </argument> + <argument index="7" name="arg6" type="Variant" default="NULL"> + </argument> + <argument index="8" name="arg7" type="Variant" default="NULL"> + </argument> + <argument index="9" name="arg8" type="Variant" default="NULL"> + </argument> + <argument index="10" name="arg9" type="Variant" default="NULL"> </argument> <description> - Check the type of the object against a string (including inheritance). + Call a function in the object, result is returned. </description> </method> - <method name="set"> - <argument index="0" name="property" type="String"> + <method name="call_deferred"> + <argument index="0" name="method" type="String"> </argument> - <argument index="1" name="value" type="Variant"> + <argument index="1" name="arg0" type="Variant" default="NULL"> + </argument> + <argument index="2" name="arg1" type="Variant" default="NULL"> + </argument> + <argument index="3" name="arg2" type="Variant" default="NULL"> + </argument> + <argument index="4" name="arg3" type="Variant" default="NULL"> + </argument> + <argument index="5" name="arg4" type="Variant" default="NULL"> </argument> <description> - Set property into the object. + Create and store a function in the object. The call will take place on idle time. </description> </method> - <method name="get" qualifiers="const"> - <argument index="0" name="property" type="String"> + <method name="callv"> + <return type="Variant"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <argument index="1" name="arg_array" type="Array"> </argument> <description> - Get a property from the object. </description> </method> - <method name="get_property_list" qualifiers="const"> - <return type="Array"> + <method name="can_translate_messages" qualifiers="const"> + <return type="bool"> </return> <description> - 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 true if this object can translate strings. </description> </method> - <method name="get_method_list" qualifiers="const"> - <return type="Array"> + <method name="connect"> + <return type="int"> </return> + <argument index="0" name="signal" type="String"> + </argument> + <argument index="1" name="target" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <argument index="3" name="binds" type="Array" default="Array()"> + </argument> + <argument index="4" name="flags" type="int" default="0"> + </argument> <description> + Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT_*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use [method is_connected] to check. </description> </method> - <method name="notification"> - <argument index="0" name="what" type="int"> + <method name="disconnect"> + <argument index="0" name="signal" type="String"> </argument> - <argument index="1" name="reversed" type="bool" default="false"> + <argument index="1" name="target" type="Object"> + </argument> + <argument index="2" name="method" type="String"> </argument> <description> - Notify the object of something. + Disconnect a signal from a method. </description> </method> - <method name="get_instance_ID" qualifiers="const"> - <return type="int"> - </return> + <method name="emit_signal"> + <argument index="0" name="signal" type="String"> + </argument> + <argument index="1" name="arg0" type="Variant" default="NULL"> + </argument> + <argument index="2" name="arg1" type="Variant" default="NULL"> + </argument> + <argument index="3" name="arg2" type="Variant" default="NULL"> + </argument> + <argument index="4" name="arg3" type="Variant" default="NULL"> + </argument> + <argument index="5" name="arg4" type="Variant" default="NULL"> + </argument> <description> - Return the instance ID. All objects have a unique instance ID. + Emit a signal. Arguments are passed in an array. </description> </method> - <method name="set_script"> - <argument index="0" name="script" type="Script"> - </argument> + <method name="free"> <description> - Set a script into the object, scripts extend the object functionality. </description> </method> - <method name="get_script" qualifiers="const"> - <return type="Script"> - </return> + <method name="get" qualifiers="const"> + <argument index="0" name="property" type="String"> + </argument> <description> - Return the object script (or null if it doesn't have one). + Get a property from the object. </description> </method> - <method name="set_meta"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="value" type="Variant"> - </argument> + <method name="get_instance_ID" qualifiers="const"> + <return type="int"> + </return> <description> - Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i]. + Return the instance ID. All objects have a unique instance ID. </description> </method> <method name="get_meta" qualifiers="const"> @@ -22897,108 +23021,62 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return a metadata from the object. </description> </method> - <method name="has_meta" qualifiers="const"> - <return type="bool"> + <method name="get_meta_list" qualifiers="const"> + <return type="StringArray"> </return> - <argument index="0" name="name" type="String"> - </argument> <description> - Return true if a metadata is found with the requested name. + Return the list of metadata in the object. </description> </method> - <method name="get_meta_list" qualifiers="const"> - <return type="StringArray"> + <method name="get_method_list" qualifiers="const"> + <return type="Array"> </return> <description> - Return the list of metadata in the object. </description> </method> - <method name="add_user_signal"> - <argument index="0" name="signal" type="String"> - </argument> - <argument index="1" name="arguments" type="Array" default="Array()"> - </argument> + <method name="get_property_list" qualifiers="const"> + <return type="Array"> + </return> <description> - 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_*). + 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). </description> </method> - <method name="has_user_signal" qualifiers="const"> - <return type="bool"> + <method name="get_script" qualifiers="const"> + <return type="Script"> </return> - <argument index="0" name="signal" type="String"> - </argument> <description> + Return the object script (or null if it doesn't have one). </description> </method> - <method name="emit_signal"> + <method name="get_signal_connection_list" qualifiers="const"> + <return type="Array"> + </return> <argument index="0" name="signal" type="String"> </argument> - <argument index="1" name="arg0" type="Variant" default="NULL"> - </argument> - <argument index="2" name="arg1" type="Variant" default="NULL"> - </argument> - <argument index="3" name="arg2" type="Variant" default="NULL"> - </argument> - <argument index="4" name="arg3" type="Variant" default="NULL"> - </argument> - <argument index="5" name="arg4" type="Variant" default="NULL"> - </argument> <description> - Emit a signal. Arguments are passed in an array. </description> </method> - <method name="call"> - <argument index="0" name="method" type="String"> - </argument> - <argument index="1" name="arg0" type="Variant" default="NULL"> - </argument> - <argument index="2" name="arg1" type="Variant" default="NULL"> - </argument> - <argument index="3" name="arg2" type="Variant" default="NULL"> - </argument> - <argument index="4" name="arg3" type="Variant" default="NULL"> - </argument> - <argument index="5" name="arg4" type="Variant" default="NULL"> - </argument> - <argument index="6" name="arg5" type="Variant" default="NULL"> - </argument> - <argument index="7" name="arg6" type="Variant" default="NULL"> - </argument> - <argument index="8" name="arg7" type="Variant" default="NULL"> - </argument> - <argument index="9" name="arg8" type="Variant" default="NULL"> - </argument> - <argument index="10" name="arg9" type="Variant" default="NULL"> - </argument> + <method name="get_signal_list" qualifiers="const"> + <return type="Array"> + </return> <description> - Call a function in the object, result is returned. + Return the list of signals as an array of dictionaries. </description> </method> - <method name="call_deferred"> - <argument index="0" name="method" type="String"> - </argument> - <argument index="1" name="arg0" type="Variant" default="NULL"> - </argument> - <argument index="2" name="arg1" type="Variant" default="NULL"> - </argument> - <argument index="3" name="arg2" type="Variant" default="NULL"> - </argument> - <argument index="4" name="arg3" type="Variant" default="NULL"> - </argument> - <argument index="5" name="arg4" type="Variant" default="NULL"> - </argument> + <method name="get_type" qualifiers="const"> + <return type="String"> + </return> <description> - Create and store a function in the object. The call will take place on idle time. + Return the type of the object as a string. </description> </method> - <method name="callv"> - <return type="Variant"> + <method name="has_meta" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="method" type="String"> - </argument> - <argument index="1" name="arg_array" type="Array"> + <argument index="0" name="name" type="String"> </argument> <description> + Return true if a metadata is found with the requested name. </description> </method> <method name="has_method" qualifiers="const"> @@ -23009,23 +23087,23 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_signal_list" qualifiers="const"> - <return type="Array"> + <method name="has_user_signal" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="signal" type="String"> + </argument> <description> - Return the list of signals as an array of dictionaries. </description> </method> - <method name="get_signal_connection_list" qualifiers="const"> - <return type="Array"> + <method name="is_blocking_signals" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="signal" type="String"> - </argument> <description> + Return true if signal emission blocking is enabled. </description> </method> - <method name="connect"> - <return type="int"> + <method name="is_connected" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="signal" type="String"> </argument> @@ -23033,77 +23111,75 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </argument> <argument index="2" name="method" type="String"> </argument> - <argument index="3" name="binds" type="Array" default="Array()"> - </argument> - <argument index="4" name="flags" type="int" default="0"> - </argument> <description> - Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT_*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use [method is_connected] to check. + Return true if a connection exists for a given signal and target/method. </description> </method> - <method name="disconnect"> - <argument index="0" name="signal" type="String"> - </argument> - <argument index="1" name="target" type="Object"> - </argument> - <argument index="2" name="method" type="String"> - </argument> + <method name="is_queued_for_deletion" qualifiers="const"> + <return type="bool"> + </return> <description> - Disconnect a signal from a method. </description> </method> - <method name="is_connected" qualifiers="const"> + <method name="is_type" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="signal" type="String"> + <argument index="0" name="type" type="String"> </argument> - <argument index="1" name="target" type="Object"> + <description> + Check the type of the object against a string (including inheritance). + </description> + </method> + <method name="notification"> + <argument index="0" name="what" type="int"> </argument> - <argument index="2" name="method" type="String"> + <argument index="1" name="reversed" type="bool" default="false"> </argument> <description> - Return true if a connection exists for a given signal and target/method. + Notify the object of something. </description> </method> - <method name="set_block_signals"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="property_list_changed_notify"> <description> - If set to true, signal emission is blocked. </description> </method> - <method name="is_blocking_signals" qualifiers="const"> - <return type="bool"> - </return> + <method name="set"> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> <description> - Return true if signal emission blocking is enabled. + Set property into the object. </description> </method> - <method name="set_message_translation"> + <method name="set_block_signals"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set true if this object can translate strings (in calls to tr() ). Default is true. + If set to true, signal emission is blocked. </description> </method> - <method name="can_translate_messages" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_message_translation"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return true if this object can translate strings. + Set true if this object can translate strings (in calls to tr() ). Default is true. </description> </method> - <method name="property_list_changed_notify"> + <method name="set_meta"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> <description> + Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i]. </description> </method> - <method name="XL_MESSAGE" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="message" type="String"> + <method name="set_script"> + <argument index="0" name="script" type="Script"> </argument> <description> - Deprecated, will go away. + Set a script into the object, scripts extend the object functionality. </description> </method> <method name="tr" qualifiers="const"> @@ -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]. </description> </method> - <method name="is_queued_for_deletion" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> </methods> <signals> <signal name="script_changed"> @@ -23129,12 +23199,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </signal> </signals> <constants> - <constant name="NOTIFICATION_POSTINITIALIZE" value="0"> - Called right when the object is initialized. Not available in script. - </constant> - <constant name="NOTIFICATION_PREDELETE" value="1"> - Called before the object is about to be deleted. - </constant> <constant name="CONNECT_DEFERRED" value="1"> Connect a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time. </constant> @@ -23144,6 +23208,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constant name="CONNECT_ONESHOT" value="4"> One short connections disconnect themselves after emission. </constant> + <constant name="NOTIFICATION_POSTINITIALIZE" value="0"> + Called right when the object is initialized. Not available in script. + </constant> + <constant name="NOTIFICATION_PREDELETE" value="1"> + Called before the object is about to be deleted. + </constant> </constants> </class> <class name="OccluderPolygon2D" inherits="Resource" category="Core"> @@ -23152,9 +23222,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_closed"> - <argument index="0" name="closed" type="bool"> - </argument> + <method name="get_cull_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_polygon" qualifiers="const"> + <return type="Vector2Array"> + </return> <description> </description> </method> @@ -23164,15 +23240,15 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_cull_mode"> - <argument index="0" name="cull_mode" type="int"> + <method name="set_closed"> + <argument index="0" name="closed" type="bool"> </argument> <description> </description> </method> - <method name="get_cull_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_cull_mode"> + <argument index="0" name="cull_mode" type="int"> + </argument> <description> </description> </method> @@ -23182,12 +23258,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_polygon" qualifiers="const"> - <return type="Vector2Array"> - </return> - <description> - </description> - </method> </methods> <constants> <constant name="CULL_DISABLED" value="0"> @@ -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. </description> <methods> - <method name="add_item"> - <argument index="0" name="label" type="String"> - </argument> - <argument index="1" name="id" type="int" default="-1"> - </argument> - <description> - 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. - </description> - </method> <method name="add_icon_item"> <argument index="0" name="texture" type="Texture"> </argument> @@ -23238,46 +23299,53 @@ 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. </description> </method> - <method name="set_item_text"> - <argument index="0" name="idx" type="int"> + <method name="add_item"> + <argument index="0" name="label" type="String"> </argument> - <argument index="1" name="text" type="String"> + <argument index="1" name="id" type="int" default="-1"> </argument> <description> - Set the text of an item at index "idx". + 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. </description> </method> - <method name="set_item_icon"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> + <method name="add_separator"> <description> - Set the icon of an item at index "idx". + Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. </description> </method> - <method name="set_item_disabled"> + <method name="clear"> + <description> + Clear all the items in the [OptionButton]. + </description> + </method> + <method name="get_item_ID" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="disabled" type="bool"> - </argument> <description> + Return the ID of the item at index "idx". </description> </method> - <method name="set_item_ID"> + <method name="get_item_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of items in the OptionButton. + </description> + </method> + <method name="get_item_icon" qualifiers="const"> + <return type="Texture"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="id" type="int"> - </argument> <description> - Set the ID of an item at index "idx". + Return the icon of the item at index "idx". </description> </method> - <method name="set_item_metadata"> + <method name="get_item_metadata" qualifiers="const"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="metadata" type="Variant"> - </argument> <description> </description> </method> @@ -23290,27 +23358,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the text of the item at index "idx". </description> </method> - <method name="get_item_icon" qualifiers="const"> - <return type="Texture"> + <method name="get_selected" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - Return the icon of the item at index "idx". + Return the current item index </description> </method> - <method name="get_item_ID" qualifiers="const"> + <method name="get_selected_ID" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> - Return the ID of the item at index "idx". </description> </method> - <method name="get_item_metadata" qualifiers="const"> - <argument index="0" name="idx" type="int"> - </argument> + <method name="get_selected_metadata" qualifiers="const"> <description> </description> </method> @@ -23322,51 +23383,60 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_item_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the amount of items in the OptionButton. - </description> - </method> - <method name="add_separator"> + <method name="remove_item"> + <argument index="0" name="idx" type="int"> + </argument> <description> - Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. </description> </method> - <method name="clear"> + <method name="select"> + <argument index="0" name="idx" type="int"> + </argument> <description> - Clear all the items in the [OptionButton]. + Select an item by index and make it the current item. </description> </method> - <method name="select"> + <method name="set_item_ID"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="id" type="int"> + </argument> <description> - Select an item by index and make it the current item. + Set the ID of an item at index "idx". </description> </method> - <method name="get_selected" qualifiers="const"> - <return type="int"> - </return> + <method name="set_item_disabled"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> <description> - Return the current item index </description> </method> - <method name="get_selected_ID" qualifiers="const"> - <return type="int"> - </return> + <method name="set_item_icon"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> <description> + Set the icon of an item at index "idx". </description> </method> - <method name="get_selected_metadata" qualifiers="const"> + <method name="set_item_metadata"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="metadata" type="Variant"> + </argument> <description> </description> </method> - <method name="remove_item"> + <method name="set_item_text"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="text" type="String"> + </argument> <description> + Set the text of an item at index "idx". </description> </method> </methods> @@ -23382,32 +23452,32 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constants> </constants> <theme_items> - <theme_item name="hseparation" type="int"> + <theme_item name="arrow" type="Texture"> </theme_item> <theme_item name="arrow_margin" type="int"> </theme_item> - <theme_item name="font_color_disabled" type="Color"> + <theme_item name="disabled" type="StyleBox"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> <theme_item name="font_color_hover" type="Color"> </theme_item> <theme_item name="font_color_pressed" type="Color"> </theme_item> - <theme_item name="arrow" type="Texture"> - </theme_item> - <theme_item name="font" type="Font"> - </theme_item> <theme_item name="hover" type="StyleBox"> </theme_item> - <theme_item name="pressed" type="StyleBox"> - </theme_item> - <theme_item name="focus" type="StyleBox"> - </theme_item> - <theme_item name="disabled" type="StyleBox"> + <theme_item name="hseparation" type="int"> </theme_item> <theme_item name="normal" type="StyleBox"> </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> </theme_items> </class> <class name="PCKPacker" inherits="Reference" category="Core"> @@ -23416,30 +23486,30 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="pck_start"> + <method name="add_file"> <return type="int"> </return> - <argument index="0" name="pck_name" type="String"> + <argument index="0" name="pck_path" type="String"> </argument> - <argument index="1" name="alignment" type="int"> + <argument index="1" name="source_path" type="String"> </argument> <description> </description> </method> - <method name="add_file"> + <method name="flush"> <return type="int"> </return> - <argument index="0" name="pck_path" type="String"> - </argument> - <argument index="1" name="source_path" type="String"> + <argument index="0" name="verbose" type="bool"> </argument> <description> </description> </method> - <method name="flush"> + <method name="pck_start"> <return type="int"> </return> - <argument index="0" name="verbose" type="bool"> + <argument index="0" name="pck_name" type="String"> + </argument> + <argument index="1" name="alignment" type="int"> </argument> <description> </description> @@ -23513,33 +23583,33 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) TODO: explain ownership, and that node does not need to own itself </description> <methods> - <method name="pack"> - <return type="int"> + <method name="can_instance" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="path" type="Node"> - </argument> <description> - Pack will ignore any sub-nodes not owned by given node. See [method Node.set_owner]. </description> </method> - <method name="instance" qualifiers="const"> - <return type="Node"> + <method name="get_state"> + <return type="SceneState"> </return> - <argument index="0" name="gen_edit_state" type="bool" default="false"> - </argument> <description> </description> </method> - <method name="can_instance" qualifiers="const"> - <return type="bool"> + <method name="instance" qualifiers="const"> + <return type="Node"> </return> + <argument index="0" name="gen_edit_state" type="bool" default="false"> + </argument> <description> </description> </method> - <method name="get_state"> - <return type="SceneState"> + <method name="pack"> + <return type="int"> </return> + <argument index="0" name="path" type="Node"> + </argument> <description> + Pack will ignore any sub-nodes not owned by given node. See [method Node.set_owner]. </description> </method> </methods> @@ -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. </description> <methods> - <method name="get_var" qualifiers="const"> - <return type="Variant"> - </return> - <description> - Get a Variant. - </description> - </method> - <method name="put_var"> + <method name="get_available_packet_count" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="var" type="Variant"> - </argument> <description> - Send a Variant as a packet. + Return the number of packets currently available in the ring-buffer. </description> </method> <method name="get_packet" qualifiers="const"> @@ -23577,27 +23638,36 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Get a raw packet. </description> </method> - <method name="put_packet"> + <method name="get_packet_error" qualifiers="const"> <return type="Error"> </return> - <argument index="0" name="buffer" type="RawArray"> - </argument> <description> - Send a raw packet. + Return the error state of the last packet received (via [method get_packet] and [method get_var]). </description> </method> - <method name="get_packet_error" qualifiers="const"> + <method name="get_var" qualifiers="const"> + <return type="Variant"> + </return> + <description> + Get a Variant. + </description> + </method> + <method name="put_packet"> <return type="Error"> </return> + <argument index="0" name="buffer" type="RawArray"> + </argument> <description> - Return the error state of the last packet received (via [method get_packet] and [method get_var]). + Send a raw packet. </description> </method> - <method name="get_available_packet_count" qualifiers="const"> + <method name="put_var"> <return type="int"> </return> + <argument index="0" name="var" type="Variant"> + </argument> <description> - Return the number of packets currently available in the ring-buffer. + Send a Variant as a packet. </description> </method> </methods> @@ -23631,34 +23701,16 @@ 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. </description> <methods> - <method name="listen"> - <return type="Error"> - </return> - <argument index="0" name="port" type="int"> - </argument> - <argument index="1" name="recv_buf_size" type="int" default="65536"> - </argument> - <description> - Make this [PacketPeerUDP] listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses. - </description> - </method> <method name="close"> <description> Close the UDP socket the [PacketPeerUDP] is currently listening on. </description> </method> - <method name="wait"> - <return type="Error"> - </return> - <description> - Wait for a packet to arrive on the listening port, see [method listen]. - </description> - </method> - <method name="is_listening" qualifiers="const"> - <return type="bool"> + <method name="get_packet_address" qualifiers="const"> + <return type="int"> </return> <description> - Return whether this [PacketPeerUDP] is listening. + 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]). </description> </method> <method name="get_packet_ip" qualifiers="const"> @@ -23668,18 +23720,29 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the IP of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). </description> </method> - <method name="get_packet_address" qualifiers="const"> + <method name="get_packet_port" qualifiers="const"> <return type="int"> </return> <description> - 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]). </description> </method> - <method name="get_packet_port" qualifiers="const"> - <return type="int"> + <method name="is_listening" qualifiers="const"> + <return type="bool"> </return> <description> - 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. + </description> + </method> + <method name="listen"> + <return type="Error"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <argument index="1" name="recv_buf_size" type="int" default="65536"> + </argument> + <description> + Make this [PacketPeerUDP] listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses. </description> </method> <method name="set_send_address"> @@ -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. </description> </method> + <method name="wait"> + <return type="Error"> + </return> + <description> + Wait for a packet to arrive on the listening port, see [method listen]. + </description> + </method> </methods> <constants> </constants> @@ -23709,10 +23779,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constants> </constants> <theme_items> - <theme_item name="panelf" type="StyleBox"> - </theme_item> <theme_item name="panel" type="StyleBox"> </theme_item> + <theme_item name="panelf" type="StyleBox"> + </theme_item> <theme_item name="panelnc" type="StyleBox"> </theme_item> </theme_items> @@ -23741,23 +23811,18 @@ 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. </description> <methods> - <method name="set_scroll_offset"> - <argument index="0" name="ofs" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_scroll_offset" qualifiers="const"> + <method name="get_limit_begin" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the beginning limit. </description> </method> - <method name="set_scroll_base_offset"> - <argument index="0" name="ofs" type="Vector2"> - </argument> + <method name="get_limit_end" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Set the base offset in pixels of all children [ParallaxLayer] nodes. + Return the ending limit. </description> </method> <method name="get_scroll_base_offset" qualifiers="const"> @@ -23767,32 +23832,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the base offset. </description> </method> - <method name="set_scroll_base_scale"> - <argument index="0" name="scale" type="Vector2"> - </argument> + <method name="get_scroll_base_scale" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Set the base motion scale of all children [ParallaxLayer] nodes. + Return the base motion scale. </description> </method> - <method name="get_scroll_base_scale" qualifiers="const"> + <method name="get_scroll_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the base motion scale. </description> </method> - <method name="set_limit_begin"> - <argument index="0" name="ofs" type="Vector2"> + <method name="is_ignore_camera_zoom"> + <return type="bool"> + </return> + <description> + Return ignoring camera zoom. + </description> + </method> + <method name="set_ignore_camera_zoom"> + <argument index="0" name="ignore" type="bool"> </argument> <description> - 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 to true for all child [ParallaxLayer] nodes to not be affected by the zoom level of the camera. </description> </method> - <method name="get_limit_begin" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_limit_begin"> + <argument index="0" name="ofs" type="Vector2"> + </argument> <description> - Return the beginning limit. + 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. </description> </method> <method name="set_limit_end"> @@ -23802,25 +23873,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) 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. </description> </method> - <method name="get_limit_end" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_scroll_base_offset"> + <argument index="0" name="ofs" type="Vector2"> + </argument> <description> - Return the ending limit. + Set the base offset in pixels of all children [ParallaxLayer] nodes. </description> </method> - <method name="set_ignore_camera_zoom"> - <argument index="0" name="ignore" type="bool"> + <method name="set_scroll_base_scale"> + <argument index="0" name="scale" type="Vector2"> </argument> <description> - Set to true for all child [ParallaxLayer] nodes to not be affected by the zoom level of the camera. + Set the base motion scale of all children [ParallaxLayer] nodes. </description> </method> - <method name="is_ignore_camera_zoom"> - <return type="bool"> - </return> + <method name="set_scroll_offset"> + <argument index="0" name="ofs" type="Vector2"> + </argument> <description> - Return ignoring camera zoom. </description> </method> </methods> @@ -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. </description> <methods> - <method name="set_motion_scale"> - <argument index="0" name="scale" type="Vector2"> - </argument> + <method name="get_mirroring" qualifiers="const"> + <return type="Vector2"> + </return> <description> - 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. </description> </method> <method name="get_motion_scale" qualifiers="const"> @@ -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. </description> </method> - <method name="get_mirroring" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_motion_scale"> + <argument index="0" name="scale" type="Vector2"> + </argument> <description> - 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. </description> </method> </methods> @@ -23873,63 +23943,63 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_enabled"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_absorption" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> + <method name="get_disable_radius" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="set_radius"> - <argument index="0" name="radius" type="float"> - </argument> + <method name="get_gravity" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_radius" qualifiers="const"> - <return type="float"> + <method name="get_particles_path" qualifiers="const"> + <return type="NodePath"> </return> <description> </description> </method> - <method name="set_disable_radius"> - <argument index="0" name="radius" type="float"> - </argument> + <method name="get_radius" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_disable_radius" qualifiers="const"> - <return type="float"> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_gravity"> - <argument index="0" name="gravity" type="float"> + <method name="set_absorption"> + <argument index="0" name="absorption" type="float"> </argument> <description> </description> </method> - <method name="get_gravity" qualifiers="const"> - <return type="float"> - </return> + <method name="set_disable_radius"> + <argument index="0" name="radius" type="float"> + </argument> <description> </description> </method> - <method name="set_absorption"> - <argument index="0" name="absorption" type="float"> + <method name="set_enabled"> + <argument index="0" name="enabled" type="bool"> </argument> <description> </description> </method> - <method name="get_absorption" qualifiers="const"> - <return type="float"> - </return> + <method name="set_gravity"> + <argument index="0" name="gravity" type="float"> + </argument> <description> </description> </method> @@ -23939,9 +24009,9 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_particles_path" qualifiers="const"> - <return type="NodePath"> - </return> + <method name="set_radius"> + <argument index="0" name="radius" type="float"> + </argument> <description> </description> </method> @@ -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). </description> <methods> - <method name="set_amount"> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Set total amount of particles in the system. - </description> - </method> <method name="get_amount" qualifiers="const"> <return type="int"> </return> @@ -23971,52 +24034,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the total amount of particles in the system. </description> </method> - <method name="set_emitting"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate. - </description> - </method> - <method name="is_emitting" qualifiers="const"> - <return type="bool"> + <method name="get_color_phase_color" qualifiers="const"> + <return type="Color"> </return> - <description> - Return the "emitting" property state (see [method set_emitting]). - </description> - </method> - <method name="set_visibility_aabb"> - <argument index="0" name="aabb" type="AABB"> + <argument index="0" name="phase" type="int"> </argument> <description> - Set the visibility AABB for the particle system, since the default one will not work properly most of the time. + Return the color of a color phase. </description> </method> - <method name="get_visibility_aabb" qualifiers="const"> - <return type="AABB"> + <method name="get_color_phase_pos" qualifiers="const"> + <return type="float"> </return> - <description> - Return the current visibility AABB. - </description> - </method> - <method name="set_emission_half_extents"> - <argument index="0" name="half_extents" type="Vector3"> + <argument index="0" name="phase" type="int"> </argument> <description> - Set the half extents for the emission box. + Return the position of a color phase (0 to 1). </description> </method> - <method name="get_emission_half_extents" qualifiers="const"> - <return type="Vector3"> + <method name="get_color_phases" qualifiers="const"> + <return type="int"> </return> <description> - Return the half extents for the emission box. - </description> - </method> - <method name="set_emission_base_velocity"> - <argument index="0" name="base_velocity" type="Vector3"> - </argument> - <description> </description> </method> <method name="get_emission_base_velocity" qualifiers="const"> @@ -24025,10 +24064,11 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_emission_points"> - <argument index="0" name="points" type="Vector3Array"> - </argument> + <method name="get_emission_half_extents" qualifiers="const"> + <return type="Vector3"> + </return> <description> + Return the half extents for the emission box. </description> </method> <method name="get_emission_points" qualifiers="const"> @@ -24037,11 +24077,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="set_gravity_normal"> - <argument index="0" name="normal" type="Vector3"> - </argument> + <method name="get_emit_timeout" qualifiers="const"> + <return type="float"> + </return> <description> - Set the normal vector towards where gravity is pulling (by default, negative Y). </description> </method> <method name="get_gravity_normal" qualifiers="const"> @@ -24051,13 +24090,20 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the normal vector towards where gravity is pulling (by default, negative Y). </description> </method> - <method name="set_variable"> + <method name="get_material" qualifiers="const"> + <return type="Material"> + </return> + <description> + Return the material used to draw particles. + </description> + </method> + <method name="get_randomness" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="variable" type="int"> </argument> - <argument index="1" name="value" type="float"> - </argument> <description> - Set a specific variable for the particle system (see VAR_* enum). + Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. </description> </method> <method name="get_variable" qualifiers="const"> @@ -24069,40 +24115,37 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return a specific variable for the particle system (see VAR_* enum). </description> </method> - <method name="set_randomness"> - <argument index="0" name="variable" type="int"> - </argument> - <argument index="1" name="randomness" type="float"> - </argument> + <method name="get_visibility_aabb" qualifiers="const"> + <return type="AABB"> + </return> <description> - 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 current visibility AABB. </description> </method> - <method name="get_randomness" qualifiers="const"> - <return type="float"> + <method name="has_height_from_velocity" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="variable" type="int"> - </argument> <description> - Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. </description> </method> - <method name="set_color_phase_pos"> - <argument index="0" name="phase" type="int"> - </argument> - <argument index="1" name="pos" type="float"> - </argument> + <method name="is_emitting" qualifiers="const"> + <return type="bool"> + </return> <description> - Set the position of a color phase (0 to 1). + Return the "emitting" property state (see [method set_emitting]). </description> </method> - <method name="get_color_phase_pos" qualifiers="const"> - <return type="float"> + <method name="is_using_local_coordinates" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="phase" type="int"> + <description> + </description> + </method> + <method name="set_amount"> + <argument index="0" name="amount" type="int"> </argument> <description> - Return the position of a color phase (0 to 1). + Set total amount of particles in the system. </description> </method> <method name="set_color_phase_color"> @@ -24114,27 +24157,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Set the color of a color phase. </description> </method> - <method name="get_color_phase_color" qualifiers="const"> - <return type="Color"> - </return> + <method name="set_color_phase_pos"> <argument index="0" name="phase" type="int"> </argument> + <argument index="1" name="pos" type="float"> + </argument> <description> - Return the color of a color phase. + Set the position of a color phase (0 to 1). </description> </method> - <method name="set_material"> - <argument index="0" name="material" type="Material"> + <method name="set_color_phases"> + <argument index="0" name="count" type="int"> </argument> <description> - Set the material used to draw particles. </description> </method> - <method name="get_material" qualifiers="const"> - <return type="Material"> - </return> + <method name="set_emission_base_velocity"> + <argument index="0" name="base_velocity" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_emission_half_extents"> + <argument index="0" name="half_extents" type="Vector3"> + </argument> + <description> + Set the half extents for the emission box. + </description> + </method> + <method name="set_emission_points"> + <argument index="0" name="points" type="Vector3Array"> + </argument> <description> - Return the material used to draw particles. </description> </method> <method name="set_emit_timeout"> @@ -24143,10 +24197,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="get_emit_timeout" qualifiers="const"> - <return type="float"> - </return> + <method name="set_emitting"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> + Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate. + </description> + </method> + <method name="set_gravity_normal"> + <argument index="0" name="normal" type="Vector3"> + </argument> + <description> + Set the normal vector towards where gravity is pulling (by default, negative Y). </description> </method> <method name="set_height_from_velocity"> @@ -24155,34 +24217,42 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> </method> - <method name="has_height_from_velocity" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_material"> + <argument index="0" name="material" type="Material"> + </argument> <description> + Set the material used to draw particles. </description> </method> - <method name="set_use_local_coordinates"> - <argument index="0" name="enable" type="bool"> + <method name="set_randomness"> + <argument index="0" name="variable" type="int"> + </argument> + <argument index="1" name="randomness" type="float"> </argument> <description> + Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. </description> </method> - <method name="is_using_local_coordinates" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_use_local_coordinates"> + <argument index="0" name="enable" type="bool"> + </argument> <description> </description> </method> - <method name="set_color_phases"> - <argument index="0" name="count" type="int"> + <method name="set_variable"> + <argument index="0" name="variable" type="int"> + </argument> + <argument index="1" name="value" type="float"> </argument> <description> + Set a specific variable for the particle system (see VAR_* enum). </description> </method> - <method name="get_color_phases" qualifiers="const"> - <return type="int"> - </return> + <method name="set_visibility_aabb"> + <argument index="0" name="aabb" type="AABB"> + </argument> <description> + Set the visibility AABB for the particle system, since the default one will not work properly most of the time. </description> </method> </methods> @@ -24191,6 +24261,16 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="VAR_SPREAD" value="1"> </constant> + <constant name="VAR_FINAL_SIZE" value="10"> + </constant> + <constant name="VAR_INITIAL_ANGLE" value="11"> + </constant> + <constant name="VAR_HEIGHT" value="12"> + </constant> + <constant name="VAR_HEIGHT_SPEED_SCALE" value="13"> + </constant> + <constant name="VAR_MAX" value="14"> + </constant> <constant name="VAR_GRAVITY" value="2"> </constant> <constant name="VAR_LINEAR_VELOCITY" value="3"> @@ -24205,16 +24285,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </constant> <constant name="VAR_INITIAL_SIZE" value="9"> </constant> - <constant name="VAR_FINAL_SIZE" value="10"> - </constant> - <constant name="VAR_INITIAL_ANGLE" value="11"> - </constant> - <constant name="VAR_HEIGHT" value="12"> - </constant> - <constant name="VAR_HEIGHT_SPEED_SCALE" value="13"> - </constant> - <constant name="VAR_MAX" value="14"> - </constant> </constants> </class> <class name="Particles2D" inherits="Node2D" category="Core"> @@ -24225,95 +24295,99 @@ 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). </description> <methods> - <method name="set_emitting"> - <argument index="0" name="active" type="bool"> - </argument> + <method name="get_amount" qualifiers="const"> + <return type="int"> + </return> <description> - If this is set to true then the particle emitter will emit particles, if its false it will not. + Returns the amount of particles spawned at each emission </description> </method> - <method name="is_emitting" qualifiers="const"> - <return type="bool"> + <method name="get_color" qualifiers="const"> + <return type="Color"> </return> <description> - Returns whether this emitter is currently emitting or not + Returns the tint color for each particle. </description> </method> - <method name="set_amount"> - <argument index="0" name="amount" type="int"> + <method name="get_color_phase_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="phase" type="int"> </argument> <description> - Sets the amount of particles spawned at each emission </description> </method> - <method name="get_amount" qualifiers="const"> + <method name="get_color_phase_pos" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="phase" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_color_phases" qualifiers="const"> <return type="int"> </return> <description> - Returns the amount of particles spawned at each emission </description> </method> - <method name="set_lifetime"> - <argument index="0" name="lifetime" type="float"> - </argument> + <method name="get_color_ramp" qualifiers="const"> + <return type="ColorRamp"> + </return> <description> - Sets the amount of seconds that each particle will be visible. + Returns the [ColorRamp] used to tint each particle </description> </method> - <method name="get_lifetime" qualifiers="const"> - <return type="float"> + <method name="get_emission_half_extents" qualifiers="const"> + <return type="Vector2"> </return> <description> - Gets the amount of seconds that each particle will be visible. + Returns the half extents of the emission box. </description> </method> - <method name="set_time_scale"> - <argument index="0" name="time_scale" type="float"> - </argument> + <method name="get_emission_points" qualifiers="const"> + <return type="Vector2Array"> + </return> <description> - 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. </description> </method> - <method name="get_time_scale" qualifiers="const"> - <return type="float"> + <method name="get_emissor_offset" qualifiers="const"> + <return type="Vector2"> </return> <description> - Returns the emitter time scale + Returns the particle spawn origin position relative to the emitter. </description> </method> - <method name="set_pre_process_time"> - <argument index="0" name="time" type="float"> - </argument> + <method name="get_emit_timeout" qualifiers="const"> + <return type="float"> + </return> <description> + Returns the amount of seconds during which the emitter will spawn particles </description> </method> - <method name="get_pre_process_time" qualifiers="const"> + <method name="get_explosiveness" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="set_emit_timeout"> - <argument index="0" name="value" type="float"> - </argument> + <method name="get_h_frames" qualifiers="const"> + <return type="int"> + </return> <description> - 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. </description> </method> - <method name="get_emit_timeout" qualifiers="const"> - <return type="float"> + <method name="get_initial_velocity" qualifiers="const"> + <return type="Vector2"> </return> <description> - Returns the amount of seconds during which the emitter will spawn particles </description> </method> - <method name="set_param"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="float"> - </argument> + <method name="get_lifetime" qualifiers="const"> + <return type="float"> + </return> <description> - 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. </description> </method> <method name="get_param" qualifiers="const"> @@ -24325,13 +24399,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the value of the specified emitter parameter </description> </method> - <method name="set_randomness"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="float"> - </argument> + <method name="get_pre_process_time" qualifiers="const"> + <return type="float"> + </return> <description> - 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. </description> </method> <method name="get_randomness" qualifiers="const"> @@ -24343,15 +24414,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the randomness value of the specified emitter parameter </description> </method> - <method name="set_texture"> - <return type="Texture"> - </return> - <argument index="0" name="texture" type="Object"> - </argument> - <description> - Sets the texture for each particle - </description> - </method> <method name="get_texture" qualifiers="const"> <return type="Texture"> </return> @@ -24359,96 +24421,97 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the texture for emitted particles </description> </method> - <method name="set_color"> - <argument index="0" name="color" type="Color"> - </argument> + <method name="get_time_scale" qualifiers="const"> + <return type="float"> + </return> <description> - Set the tint color for each particle. + Returns the emitter time scale </description> </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> + <method name="get_v_frames" qualifiers="const"> + <return type="int"> </return> <description> - Returns the tint color for each particle. </description> </method> - <method name="set_color_ramp"> - <return type="ColorRamp"> + <method name="is_emitting" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="color_ramp" type="Object"> - </argument> <description> - Sets the [ColorRamp] used to tint each particle. Particle will be tinted according to their lifetimes. + Returns whether this emitter is currently emitting or not </description> </method> - <method name="get_color_ramp" qualifiers="const"> - <return type="ColorRamp"> + <method name="is_flipped_h" qualifiers="const"> + <return type="bool"> </return> <description> - Returns the [ColorRamp] used to tint each particle </description> </method> - <method name="set_emissor_offset"> - <argument index="0" name="offset" type="Vector2"> - </argument> + <method name="is_flipped_v" qualifiers="const"> + <return type="bool"> + </return> <description> - 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. </description> </method> - <method name="get_emissor_offset" qualifiers="const"> - <return type="Vector2"> + <method name="is_using_local_space" qualifiers="const"> + <return type="bool"> </return> <description> - Returns the particle spawn origin position relative to the emitter. </description> </method> - <method name="set_flip_h"> - <argument index="0" name="enable" type="bool"> + <method name="pre_process"> + <argument index="0" name="time" type="float"> </argument> <description> </description> </method> - <method name="is_flipped_h" qualifiers="const"> - <return type="bool"> - </return> + <method name="reset"> <description> </description> </method> - <method name="set_flip_v"> - <argument index="0" name="enable" type="bool"> + <method name="set_amount"> + <argument index="0" name="amount" type="int"> </argument> <description> + Sets the amount of particles spawned at each emission </description> </method> - <method name="is_flipped_v" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_color"> + <argument index="0" name="color" type="Color"> + </argument> <description> + Set the tint color for each particle. </description> </method> - <method name="set_h_frames"> - <argument index="0" name="enable" type="int"> + <method name="set_color_phase_color"> + <argument index="0" name="phase" type="int"> + </argument> + <argument index="1" name="color" type="Color"> </argument> <description> </description> </method> - <method name="get_h_frames" qualifiers="const"> - <return type="int"> - </return> + <method name="set_color_phase_pos"> + <argument index="0" name="phase" type="int"> + </argument> + <argument index="1" name="pos" type="float"> + </argument> <description> </description> </method> - <method name="set_v_frames"> - <argument index="0" name="enable" type="int"> + <method name="set_color_phases"> + <argument index="0" name="phases" type="int"> </argument> <description> </description> </method> - <method name="get_v_frames" qualifiers="const"> - <return type="int"> + <method name="set_color_ramp"> + <return type="ColorRamp"> </return> + <argument index="0" name="color_ramp" type="Object"> + </argument> <description> + Sets the [ColorRamp] used to tint each particle. Particle will be tinted according to their lifetimes. </description> </method> <method name="set_emission_half_extents"> @@ -24458,122 +24521,148 @@ 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. </description> </method> - <method name="get_emission_half_extents" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_emission_points"> + <argument index="0" name="points" type="Vector2Array"> + </argument> <description> - Returns the half extents of the emission box. </description> </method> - <method name="set_color_phases"> - <argument index="0" name="phases" type="int"> + <method name="set_emissor_offset"> + <argument index="0" name="offset" type="Vector2"> </argument> <description> + 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. </description> </method> - <method name="get_color_phases" qualifiers="const"> - <return type="int"> - </return> + <method name="set_emit_timeout"> + <argument index="0" name="value" type="float"> + </argument> <description> + 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. </description> </method> - <method name="set_color_phase_color"> - <argument index="0" name="phase" type="int"> - </argument> - <argument index="1" name="color" type="Color"> + <method name="set_emitting"> + <argument index="0" name="active" type="bool"> </argument> <description> + If this is set to true then the particle emitter will emit particles, if its false it will not. </description> </method> - <method name="get_color_phase_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="phase" type="int"> + <method name="set_explosiveness"> + <argument index="0" name="amount" type="float"> </argument> <description> </description> </method> - <method name="set_color_phase_pos"> - <argument index="0" name="phase" type="int"> - </argument> - <argument index="1" name="pos" type="float"> + <method name="set_flip_h"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="get_color_phase_pos" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="phase" type="int"> + <method name="set_flip_v"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="pre_process"> - <argument index="0" name="time" type="float"> + <method name="set_h_frames"> + <argument index="0" name="enable" type="int"> </argument> <description> </description> </method> - <method name="reset"> + <method name="set_initial_velocity"> + <argument index="0" name="velocity" type="Vector2"> + </argument> <description> </description> </method> - <method name="set_use_local_space"> - <argument index="0" name="enable" type="bool"> + <method name="set_lifetime"> + <argument index="0" name="lifetime" type="float"> </argument> <description> + Sets the amount of seconds that each particle will be visible. </description> </method> - <method name="is_using_local_space" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_param"> + <argument index="0" name="param" type="int"> + </argument> + <argument index="1" name="value" type="float"> + </argument> <description> + Sets the value of the specified emitter parameter (see the constants secction for the list of parameters) </description> </method> - <method name="set_initial_velocity"> - <argument index="0" name="velocity" type="Vector2"> + <method name="set_pre_process_time"> + <argument index="0" name="time" type="float"> </argument> <description> </description> </method> - <method name="get_initial_velocity" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_randomness"> + <argument index="0" name="param" type="int"> + </argument> + <argument index="1" name="value" type="float"> + </argument> <description> + 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. </description> </method> - <method name="set_explosiveness"> - <argument index="0" name="amount" type="float"> + <method name="set_texture"> + <return type="Texture"> + </return> + <argument index="0" name="texture" type="Object"> </argument> <description> + Sets the texture for each particle </description> </method> - <method name="get_explosiveness" qualifiers="const"> - <return type="float"> - </return> + <method name="set_time_scale"> + <argument index="0" name="time_scale" type="float"> + </argument> <description> + 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. </description> </method> - <method name="set_emission_points"> - <argument index="0" name="points" type="Vector2Array"> + <method name="set_use_local_space"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="get_emission_points" qualifiers="const"> - <return type="Vector2Array"> - </return> + <method name="set_v_frames"> + <argument index="0" name="enable" type="int"> + </argument> <description> </description> </method> </methods> <constants> + <constant name="MAX_COLOR_PHASES" value="4"> + </constant> <constant name="PARAM_DIRECTION" value="0"> 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 </constant> <constant name="PARAM_SPREAD" value="1"> </constant> + <constant name="PARAM_INITIAL_ANGLE" value="10"> + Initial angle in radians at which each particle will be spawned + </constant> + <constant name="PARAM_INITIAL_SIZE" value="11"> + Initial size of each particle + </constant> + <constant name="PARAM_FINAL_SIZE" value="12"> + Final size of each particle, the particle size will interpolate to this value during its lifetime. + </constant> + <constant name="PARAM_HUE_VARIATION" value="13"> + </constant> + <constant name="PARAM_ANIM_SPEED_SCALE" value="14"> + </constant> + <constant name="PARAM_ANIM_INITIAL_POS" value="15"> + </constant> + <constant name="PARAM_MAX" value="16"> + </constant> <constant name="PARAM_LINEAR_VELOCITY" value="2"> Velocity at which the particles will be launched. </constant> @@ -24596,25 +24685,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <constant name="PARAM_DAMPING" value="9"> Amount of damping for each particle </constant> - <constant name="PARAM_INITIAL_ANGLE" value="10"> - Initial angle in radians at which each particle will be spawned - </constant> - <constant name="PARAM_INITIAL_SIZE" value="11"> - Initial size of each particle - </constant> - <constant name="PARAM_FINAL_SIZE" value="12"> - Final size of each particle, the particle size will interpolate to this value during its lifetime. - </constant> - <constant name="PARAM_HUE_VARIATION" value="13"> - </constant> - <constant name="PARAM_ANIM_SPEED_SCALE" value="14"> - </constant> - <constant name="PARAM_ANIM_INITIAL_POS" value="15"> - </constant> - <constant name="PARAM_MAX" value="16"> - </constant> - <constant name="MAX_COLOR_PHASES" value="4"> - </constant> </constants> </class> <class name="Patch9Frame" inherits="Control" category="Core"> @@ -24623,67 +24693,67 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <description> </description> <methods> - <method name="set_texture"> - <argument index="0" name="texture" type="Object"> - </argument> + <method name="get_draw_center" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_texture" qualifiers="const"> - <return type="Object"> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> </return> <description> </description> </method> - <method name="set_modulate"> - <argument index="0" name="modulate" type="Color"> + <method name="get_patch_margin" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="margin" type="int"> </argument> <description> </description> </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> + <method name="get_region_rect" qualifiers="const"> + <return type="Rect2"> </return> <description> </description> </method> - <method name="set_patch_margin"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="value" type="int"> - </argument> + <method name="get_texture" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> - <method name="get_patch_margin" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="margin" type="int"> + <method name="set_draw_center"> + <argument index="0" name="draw_center" type="bool"> </argument> <description> </description> </method> - <method name="set_region_rect"> - <argument index="0" name="rect" type="Rect2"> + <method name="set_modulate"> + <argument index="0" name="modulate" type="Color"> </argument> <description> </description> </method> - <method name="get_region_rect" qualifiers="const"> - <return type="Rect2"> - </return> + <method name="set_patch_margin"> + <argument index="0" name="margin" type="int"> + </argument> + <argument index="1" name="value" type="int"> + </argument> <description> </description> </method> - <method name="set_draw_center"> - <argument index="0" name="draw_center" type="bool"> + <method name="set_region_rect"> + <argument index="0" name="rect" type="Rect2"> </argument> <description> </description> </method> - <method name="get_draw_center" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_texture"> + <argument index="0" name="texture" type="Object"> + </argument> <description> </description> </method> @@ -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. </description> <methods> - <method name="set_curve"> - <argument index="0" name="curve" type="Curve3D"> - </argument> - <description> - Sets the [Curve3D]. - </description> - </method> <method name="get_curve" qualifiers="const"> <return type="Curve3D"> </return> @@ -24713,6 +24776,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the [Curve3D] contained. </description> </method> + <method name="set_curve"> + <argument index="0" name="curve" type="Curve3D"> + </argument> + <description> + Sets the [Curve3D]. + </description> + </method> </methods> <constants> </constants> @@ -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. </description> <methods> - <method name="set_curve"> - <argument index="0" name="curve" type="Curve2D"> - </argument> - <description> - Sets the [Curve2D]. - </description> - </method> <method name="get_curve" qualifiers="const"> <return type="Curve2D"> </return> @@ -24739,6 +24802,13 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Returns the [Curve2D] contained. </description> </method> + <method name="set_curve"> + <argument index="0" name="curve" type="Curve2D"> + </argument> + <description> + Sets the [Curve2D]. + </description> + </method> </methods> <constants> </constants> @@ -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. </description> <methods> - <method name="set_offset"> - <argument index="0" name="offset" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="float"> + <method name="get_cubic_interpolation" qualifiers="const"> + <return type="bool"> </return> <description> - Returns the distance along the path in 3D units. - </description> - </method> - <method name="set_h_offset"> - <argument index="0" name="h_offset" type="float"> - </argument> - <description> - 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. </description> </method> <method name="get_h_offset" qualifiers="const"> @@ -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]. </description> </method> - <method name="set_v_offset"> - <argument index="0" name="v_offset" type="float"> - </argument> - <description> - Moves this node in the Y axis, for the same reasons of [method set_h_offset]. - </description> - </method> - <method name="get_v_offset" qualifiers="const"> + <method name="get_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the Y displacement this node has from its parent [Path]. + Returns the distance along the path in 3D units. </description> </method> - <method name="set_unit_offset"> - <argument index="0" name="unit_offset" type="float"> - </argument> + <method name="get_rotation_mode" qualifiers="const"> + <return type="int"> + </return> <description> - 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. </description> </method> <method name="get_unit_offset" qualifiers="const"> @@ -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). </description> </method> - <method name="set_rotation_mode"> - <argument index="0" name="rotation_mode" type="int"> - </argument> + <method name="get_v_offset" qualifiers="const"> + <return type="float"> + </return> <description> - Allows or forbids rotation on one or more axes, per the constants below. + Returns the Y displacement this node has from its parent [Path]. </description> </method> - <method name="get_rotation_mode" qualifiers="const"> - <return type="int"> + <method name="has_loop" qualifiers="const"> + <return type="bool"> </return> <description> - Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode. + Returns whether this node wraps its offsets around, or truncates them to the path ends. </description> </method> <method name="set_cubic_interpolation"> @@ -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. </description> </method> - <method name="get_cubic_interpolation" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_h_offset"> + <argument index="0" name="h_offset" type="float"> + </argument> <description> - 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. </description> </method> <method name="set_loop"> @@ -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. </description> </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_offset"> + <argument index="0" name="offset" type="float"> + </argument> <description> - 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. + </description> + </method> + <method name="set_rotation_mode"> + <argument index="0" name="rotation_mode" type="int"> + </argument> + <description> + Allows or forbids rotation on one or more axes, per the constants below. + </description> + </method> + <method name="set_unit_offset"> + <argument index="0" name="unit_offset" type="float"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_v_offset"> + <argument index="0" name="v_offset" type="float"> + </argument> + <description> + Moves this node in the Y axis, for the same reasons of [method set_h_offset]. </description> </method> </methods> @@ -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. </description> <methods> - <method name="set_offset"> - <argument index="0" name="offset" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="float"> + <method name="get_cubic_interpolation" qualifiers="const"> + <return type="bool"> </return> <description> - Returns the distance along the path in pixels. - </description> - </method> - <method name="set_h_offset"> - <argument index="0" name="h_offset" type="float"> - </argument> - <description> - 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. </description> </method> <method name="get_h_offset" qualifiers="const"> @@ -24907,39 +24962,32 @@ A similar effect may be achieved moving this node's descendants. Returns the horizontal displacement this node has from its parent [Path2D]. </description> </method> - <method name="set_v_offset"> - <argument index="0" name="v_offset" type="float"> - </argument> - <description> - Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset]. - </description> - </method> - <method name="get_v_offset" qualifiers="const"> + <method name="get_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the vertical displacement this node has from its parent [Path2D]. + Returns the distance along the path in pixels. </description> </method> - <method name="set_unit_offset"> - <argument index="0" name="unit_offset" type="float"> - </argument> + <method name="get_unit_offset" qualifiers="const"> + <return type="float"> + </return> <description> - 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 as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). </description> </method> - <method name="get_unit_offset" qualifiers="const"> + <method name="get_v_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). + Returns the vertical displacement this node has from its parent [Path2D]. </description> </method> - <method name="set_rotate"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="has_loop" qualifiers="const"> + <return type="bool"> + </return> <description> - If set, this node rotates to follow the path, making its descendants rotate. + Returns whether this node wraps its offsets around, or truncates them to the path ends. </description> </method> <method name="is_rotating" qualifiers="const"> @@ -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. </description> </method> - <method name="get_cubic_interpolation" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_h_offset"> + <argument index="0" name="h_offset" type="float"> + </argument> <description> - 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. </description> </method> <method name="set_loop"> @@ -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. </description> </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_offset"> + <argument index="0" name="offset" type="float"> + </argument> <description> - 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. + </description> + </method> + <method name="set_rotate"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + If set, this node rotates to follow the path, making its descendants rotate. + </description> + </method> + <method name="set_unit_offset"> + <argument index="0" name="unit_offset" type="float"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_v_offset"> + <argument index="0" name="v_offset" type="float"> + </argument> + <description> + Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset]. </description> </method> </methods> @@ -25002,13 +25072,16 @@ This method controls whether the position between two cached points is interpola Add a remap from a file to another. </description> </method> - <method name="has_remap" qualifiers="const"> - <return type="bool"> - </return> + <method name="clear_remaps"> + <description> + Clear all remaps. + </description> + </method> + <method name="erase_remap"> <argument index="0" name="path" type="String"> </argument> <description> - Return true if a file is being remapped. + Erase a remap. </description> </method> <method name="get_remap" qualifiers="const"> @@ -25020,16 +25093,13 @@ This method controls whether the position between two cached points is interpola Return the remapped new path of a file. </description> </method> - <method name="erase_remap"> + <method name="has_remap" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="path" type="String"> </argument> <description> - Erase a remap. - </description> - </method> - <method name="clear_remaps"> - <description> - Clear all remaps. + Return true if a file is being remapped. </description> </method> </methods> @@ -25052,12 +25122,6 @@ This method controls whether the position between two cached points is interpola </method> </methods> <constants> - <constant name="TIME_FPS" value="0"> - </constant> - <constant name="TIME_PROCESS" value="1"> - </constant> - <constant name="TIME_FIXED_PROCESS" value="2"> - </constant> <constant name="MEMORY_STATIC" value="3"> </constant> <constant name="MEMORY_DYNAMIC" value="4"> @@ -25068,11 +25132,25 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="MEMORY_MESSAGE_BUFFER_MAX" value="7"> </constant> + <constant name="MONITOR_MAX" value="27"> + </constant> + <constant name="OBJECT_NODE_COUNT" value="10"> + </constant> <constant name="OBJECT_COUNT" value="8"> </constant> <constant name="OBJECT_RESOURCE_COUNT" value="9"> </constant> - <constant name="OBJECT_NODE_COUNT" value="10"> + <constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21"> + </constant> + <constant name="PHYSICS_2D_COLLISION_PAIRS" value="22"> + </constant> + <constant name="PHYSICS_2D_ISLAND_COUNT" value="23"> + </constant> + <constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="24"> + </constant> + <constant name="PHYSICS_3D_COLLISION_PAIRS" value="25"> + </constant> + <constant name="PHYSICS_3D_ISLAND_COUNT" value="26"> </constant> <constant name="RENDER_OBJECTS_IN_FRAME" value="11"> </constant> @@ -25086,27 +25164,19 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="RENDER_DRAW_CALLS_IN_FRAME" value="16"> </constant> - <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20"> - </constant> <constant name="RENDER_VIDEO_MEM_USED" value="17"> </constant> <constant name="RENDER_TEXTURE_MEM_USED" value="18"> </constant> <constant name="RENDER_VERTEX_MEM_USED" value="19"> </constant> - <constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21"> - </constant> - <constant name="PHYSICS_2D_COLLISION_PAIRS" value="22"> - </constant> - <constant name="PHYSICS_2D_ISLAND_COUNT" value="23"> - </constant> - <constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="24"> + <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20"> </constant> - <constant name="PHYSICS_3D_COLLISION_PAIRS" value="25"> + <constant name="TIME_FPS" value="0"> </constant> - <constant name="PHYSICS_3D_ISLAND_COUNT" value="26"> + <constant name="TIME_PROCESS" value="1"> </constant> - <constant name="MONITOR_MAX" value="27"> + <constant name="TIME_FIXED_PROCESS" value="2"> </constant> </constants> </class> @@ -25118,95 +25188,74 @@ 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. </description> <methods> - <method name="get_total_gravity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the total gravity vector being currently applied to this body. - </description> - </method> - <method name="get_total_linear_damp" qualifiers="const"> + <method name="get_angular_velocity" qualifiers="const"> <return type="float"> </return> <description> - Return the rate at which the body stops moving, if there are not any other forces moving it. + Return the angular velocity of the body. </description> </method> - <method name="get_total_angular_damp" qualifiers="const"> - <return type="float"> + <method name="get_contact_collider" qualifiers="const"> + <return type="RID"> </return> + <argument index="0" name="contact_idx" type="int"> + </argument> <description> - Return the rate at which the body stops rotating, if there are not any other forces moving it. + Return the [RID] of the collider. </description> </method> - <method name="get_inverse_mass" qualifiers="const"> - <return type="float"> + <method name="get_contact_collider_id" qualifiers="const"> + <return type="int"> </return> + <argument index="0" name="contact_idx" type="int"> + </argument> <description> - Return the inverse of the mass of the body. + Return the object id of the collider. </description> </method> - <method name="get_inverse_inertia" qualifiers="const"> - <return type="float"> + <method name="get_contact_collider_object" qualifiers="const"> + <return type="Object"> </return> - <description> - Return the inverse of the inertia of the body. - </description> - </method> - <method name="set_linear_velocity"> - <argument index="0" name="velocity" type="Vector2"> + <argument index="0" name="contact_idx" type="int"> </argument> <description> - Change the linear velocity of the body. + Return the collider object, this depends on how it was created (will return a scene node if such was used to create it). </description> </method> - <method name="get_linear_velocity" qualifiers="const"> + <method name="get_contact_collider_pos" qualifiers="const"> <return type="Vector2"> </return> - <description> - Return the current linear velocity of the body. - </description> - </method> - <method name="set_angular_velocity"> - <argument index="0" name="velocity" type="float"> + <argument index="0" name="contact_idx" type="int"> </argument> <description> - Change the angular velocity of the body. + Return the contact position in the collider. </description> </method> - <method name="get_angular_velocity" qualifiers="const"> - <return type="float"> + <method name="get_contact_collider_shape" qualifiers="const"> + <return type="int"> </return> - <description> - Return the angular velocity of the body. - </description> - </method> - <method name="set_transform"> - <argument index="0" name="transform" type="Matrix32"> + <argument index="0" name="contact_idx" type="int"> </argument> <description> - Change the transform matrix of the body. + Return the collider shape index. </description> </method> - <method name="get_transform" qualifiers="const"> - <return type="Matrix32"> + <method name="get_contact_collider_shape_metadata" qualifiers="const"> + <return type="Variant"> </return> - <description> - Return the transform matrix of the body. - </description> - </method> - <method name="set_sleep_state"> - <argument index="0" name="enabled" type="bool"> + <argument index="0" name="contact_idx" type="int"> </argument> <description> - Set the sleeping state of the body, only affects character/rigid bodies. + Return the metadata of the collided shape. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. </description> </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> + <method name="get_contact_collider_velocity_at_pos" qualifiers="const"> + <return type="Vector2"> </return> + <argument index="0" name="contact_idx" type="int"> + </argument> <description> - Return true if this body is currently sleeping (not active). + Return the linear velocity vector at contact point of the collider. </description> </method> <method name="get_contact_count" qualifiers="const"> @@ -25216,22 +25265,22 @@ This method controls whether the position between two cached points is interpola 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. </description> </method> - <method name="get_contact_local_pos" qualifiers="const"> + <method name="get_contact_local_normal" qualifiers="const"> <return type="Vector2"> </return> <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the local position (of this body) of the contact point. + Return the local normal (of this body) of the contact point. </description> </method> - <method name="get_contact_local_normal" qualifiers="const"> + <method name="get_contact_local_pos" qualifiers="const"> <return type="Vector2"> </return> <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the local normal (of this body) of the contact point. + Return the local position (of this body) of the contact point. </description> </method> <method name="get_contact_local_shape" qualifiers="const"> @@ -25243,74 +25292,67 @@ This method controls whether the position between two cached points is interpola Return the local shape index of the collision. </description> </method> - <method name="get_contact_collider" qualifiers="const"> - <return type="RID"> + <method name="get_inverse_inertia" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> - Return the [RID] of the collider. + Return the inverse of the inertia of the body. </description> </method> - <method name="get_contact_collider_pos" qualifiers="const"> - <return type="Vector2"> + <method name="get_inverse_mass" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> - Return the contact position in the collider. + Return the inverse of the mass of the body. </description> </method> - <method name="get_contact_collider_id" qualifiers="const"> - <return type="int"> + <method name="get_linear_velocity" qualifiers="const"> + <return type="Vector2"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> - Return the object id of the collider. + Return the current linear velocity of the body. </description> </method> - <method name="get_contact_collider_object" qualifiers="const"> - <return type="Object"> + <method name="get_space_state"> + <return type="Physics2DDirectSpaceState"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> - 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 current state of space, useful for queries. </description> </method> - <method name="get_contact_collider_shape" qualifiers="const"> - <return type="int"> + <method name="get_step" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> - Return the collider shape index. + Return the timestep (delta) used for the simulation. </description> </method> - <method name="get_contact_collider_shape_metadata" qualifiers="const"> - <return type="Variant"> + <method name="get_total_angular_damp" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> - Return the metadata of the collided shape. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. + Return the rate at which the body stops rotating, if there are not any other forces moving it. </description> </method> - <method name="get_contact_collider_velocity_at_pos" qualifiers="const"> + <method name="get_total_gravity" qualifiers="const"> <return type="Vector2"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> - Return the linear velocity vector at contact point of the collider. + Return the total gravity vector being currently applied to this body. </description> </method> - <method name="get_step" qualifiers="const"> + <method name="get_total_linear_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the timestep (delta) used for the simulation. + Return the rate at which the body stops moving, if there are not any other forces moving it. + </description> + </method> + <method name="get_transform" qualifiers="const"> + <return type="Matrix32"> + </return> + <description> + Return the transform matrix of the body. </description> </method> <method name="integrate_forces"> @@ -25318,11 +25360,39 @@ This method controls whether the position between two cached points is interpola Call the built-in force integration code. </description> </method> - <method name="get_space_state"> - <return type="Physics2DDirectSpaceState"> + <method name="is_sleeping" qualifiers="const"> + <return type="bool"> </return> <description> - Return the current state of space, useful for queries. + Return true if this body is currently sleeping (not active). + </description> + </method> + <method name="set_angular_velocity"> + <argument index="0" name="velocity" type="float"> + </argument> + <description> + Change the angular velocity of the body. + </description> + </method> + <method name="set_linear_velocity"> + <argument index="0" name="velocity" type="Vector2"> + </argument> + <description> + Change the linear velocity of the body. + </description> + </method> + <method name="set_sleep_state"> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set the sleeping state of the body, only affects character/rigid bodies. + </description> + </method> + <method name="set_transform"> + <argument index="0" name="transform" type="Matrix32"> + </argument> + <description> + Change the transform matrix of the body. </description> </method> </methods> @@ -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. </description> <methods> + <method name="cast_motion"> + <return type="Array"> + </return> + <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> + </argument> + <description> + 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. + </description> + </method> + <method name="collide_shape"> + <return type="Array"> + </return> + <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> + </argument> + <argument index="1" name="max_results" type="int" default="32"> + </argument> + <description> + 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. + </description> + </method> + <method name="get_rest_info"> + <return type="Dictionary"> + </return> + <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> + </argument> + <description> + 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. + </description> + </method> <method name="intersect_point"> <return type="Array"> </return> @@ -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. </description> </method> - <method name="cast_motion"> - <return type="Array"> - </return> - <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> - </argument> - <description> - 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. - </description> - </method> - <method name="collide_shape"> - <return type="Array"> - </return> - <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> - </argument> - <argument index="1" name="max_results" type="int" default="32"> - </argument> - <description> - 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. - </description> - </method> - <method name="get_rest_info"> - <return type="Dictionary"> - </return> - <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> - </argument> - <description> - 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. - </description> - </method> </methods> <constants> <constant name="TYPE_MASK_STATIC_BODY" value="1"> Check for collisions with static bodies. </constant> + <constant name="TYPE_MASK_COLLISION" value="15"> + Check for collisions with any kind of bodies (but not areas). + </constant> + <constant name="TYPE_MASK_AREA" value="16"> + Check for collisions with areas. + </constant> <constant name="TYPE_MASK_KINEMATIC_BODY" value="2"> Check for collisions with kinematic bodies. </constant> @@ -25468,12 +25544,6 @@ This method controls whether the position between two cached points is interpola <constant name="TYPE_MASK_CHARACTER_BODY" value="8"> Check for collisions with rigid bodies in character mode. </constant> - <constant name="TYPE_MASK_AREA" value="16"> - Check for collisions with areas. - </constant> - <constant name="TYPE_MASK_COLLISION" value="15"> - Check for collisions with any kind of bodies (but not areas). - </constant> </constants> </class> <class name="Physics2DServer" inherits="Object" category="Core"> @@ -25484,110 +25554,87 @@ 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. </description> <methods> - <method name="shape_create"> - <return type="RID"> - </return> - <argument index="0" name="type" type="int"> + <method name="area_add_shape"> + <argument index="0" name="area" type="RID"> </argument> - <description> - 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]. - </description> - </method> - <method name="shape_set_data"> - <argument index="0" name="shape" type="RID"> + <argument index="1" name="shape" type="RID"> </argument> - <argument index="1" name="data" type="Variant"> + <argument index="2" name="transform" type="Matrix32" default="1,0, 0,1, 0,0"> </argument> <description> - 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]. + 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. </description> </method> - <method name="shape_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="shape" type="RID"> + <method name="area_attach_object_instance_ID"> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="id" type="int"> </argument> <description> - Return the type of shape (see SHAPE_* constants). + Assign the area to a descendant of [Object], so it can exist in the node tree. </description> </method> - <method name="shape_get_data" qualifiers="const"> - <argument index="0" name="shape" type="RID"> + <method name="area_clear_shapes"> + <argument index="0" name="area" type="RID"> </argument> <description> - Return the shape data. + Remove all shapes from an area. It does not delete the shapes, so they can be reassigned later. </description> </method> - <method name="space_create"> + <method name="area_create"> <return type="RID"> </return> <description> - 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]. - </description> - </method> - <method name="space_set_active"> - <argument index="0" name="space" type="RID"> - </argument> - <argument index="1" name="active" type="bool"> - </argument> - <description> - Mark a space as active. It will not have an effect, unless it is assigned to an area or body. + Create an [Area2D]. </description> </method> - <method name="space_is_active" qualifiers="const"> - <return type="bool"> + <method name="area_get_object_instance_ID" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="space" type="RID"> + <argument index="0" name="area" type="RID"> </argument> <description> - Return whether the space is active. + Get the instance ID of the object the area is assigned to. </description> </method> - <method name="space_set_param"> - <argument index="0" name="space" type="RID"> + <method name="area_get_param" qualifiers="const"> + <argument index="0" name="area" type="RID"> </argument> <argument index="1" name="param" type="int"> </argument> - <argument index="2" name="value" type="float"> - </argument> <description> - Set the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants. + Return an area parameter value. </description> </method> - <method name="space_get_param" qualifiers="const"> - <return type="float"> + <method name="area_get_shape" qualifiers="const"> + <return type="RID"> </return> - <argument index="0" name="space" type="RID"> + <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="param" type="int"> + <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the value of a space parameter. + Return the [RID] of the nth shape of an area. </description> </method> - <method name="space_get_direct_state"> - <return type="Physics2DDirectSpaceState"> + <method name="area_get_shape_count" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="space" type="RID"> + <argument index="0" name="area" type="RID"> </argument> <description> - Return the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries. + Return the number of shapes assigned to an area. </description> </method> - <method name="area_create"> - <return type="RID"> + <method name="area_get_shape_transform" qualifiers="const"> + <return type="Matrix32"> </return> - <description> - Create an [Area2D]. - </description> - </method> - <method name="area_set_space"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="space" type="RID"> + <argument index="1" name="shape_idx" type="int"> </argument> <description> - Assign a space to the area. + Return the transform matrix of a shape within an area. </description> </method> <method name="area_get_space" qualifiers="const"> @@ -25599,15 +25646,6 @@ This method controls whether the position between two cached points is interpola Return the space assigned to the area. </description> </method> - <method name="area_set_space_override_mode"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="mode" type="int"> - </argument> - <description> - Set the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*. - </description> - </method> <method name="area_get_space_override_mode" qualifiers="const"> <return type="int"> </return> @@ -25617,113 +25655,107 @@ This method controls whether the position between two cached points is interpola Return the space override mode for the area. </description> </method> - <method name="area_add_shape"> + <method name="area_get_transform" qualifiers="const"> + <return type="Matrix32"> + </return> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="shape" type="RID"> - </argument> - <argument index="2" name="transform" type="Matrix32" default="1,0, 0,1, 0,0"> - </argument> <description> - 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. + Return the transform matrix for an area. </description> </method> - <method name="area_set_shape"> + <method name="area_remove_shape"> <argument index="0" name="area" type="RID"> </argument> <argument index="1" name="shape_idx" type="int"> </argument> - <argument index="2" name="shape" type="RID"> - </argument> <description> - Substitute a given area shape by another. The old shape is selected by its index, the new one by its [RID]. + Remove a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> - <method name="area_set_shape_transform"> + <method name="area_set_collision_mask"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <argument index="2" name="transform" type="Matrix32"> + <argument index="1" name="mask" type="int"> </argument> <description> - Set the transform matrix for an area shape. + Set which physics layers the area will monitor. </description> </method> - <method name="area_get_shape_count" qualifiers="const"> - <return type="int"> - </return> + <method name="area_set_layer_mask"> <argument index="0" name="area" type="RID"> </argument> + <argument index="1" name="mask" type="int"> + </argument> <description> - Return the number of shapes assigned to an area. + Assign the area to one or many physics layers. </description> </method> - <method name="area_get_shape" qualifiers="const"> - <return type="RID"> - </return> + <method name="area_set_monitor_callback"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> </argument> <description> - Return the [RID] of the nth shape of an area. + 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. </description> </method> - <method name="area_get_shape_transform" qualifiers="const"> - <return type="Matrix32"> - </return> + <method name="area_set_param"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> + <argument index="1" name="param" type="int"> + </argument> + <argument index="2" name="value" type="Variant"> </argument> <description> - Return the transform matrix of a shape within an area. + Set the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants. </description> </method> - <method name="area_remove_shape"> + <method name="area_set_shape"> <argument index="0" name="area" type="RID"> </argument> <argument index="1" name="shape_idx" type="int"> </argument> - <description> - Remove a shape from an area. It does not delete the shape, so it can be reassigned later. - </description> - </method> - <method name="area_clear_shapes"> - <argument index="0" name="area" type="RID"> + <argument index="2" name="shape" type="RID"> </argument> <description> - Remove all shapes from an area. It does not delete the shapes, so they can be reassigned later. + Substitute a given area shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> - <method name="area_set_layer_mask"> + <method name="area_set_shape_transform"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="mask" type="int"> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="transform" type="Matrix32"> </argument> <description> - Assign the area to one or many physics layers. + Set the transform matrix for an area shape. </description> </method> - <method name="area_set_collision_mask"> + <method name="area_set_space"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="mask" type="int"> + <argument index="1" name="space" type="RID"> </argument> <description> - Set which physics layers the area will monitor. + Assign a space to the area. </description> </method> - <method name="area_set_param"> + <method name="area_set_space_override_mode"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="Variant"> + <argument index="1" name="mode" type="int"> </argument> <description> - 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_*. </description> </method> <method name="area_set_transform"> @@ -25735,56 +25767,62 @@ This method controls whether the position between two cached points is interpola Set the transform matrix for an area. </description> </method> - <method name="area_get_param" qualifiers="const"> - <argument index="0" name="area" type="RID"> + <method name="body_add_collision_exception"> + <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="param" type="int"> + <argument index="1" name="excepted_body" type="RID"> </argument> <description> - Return an area parameter value. + Add a body to the list of bodies exempt from collisions. </description> </method> - <method name="area_get_transform" qualifiers="const"> - <return type="Matrix32"> - </return> - <argument index="0" name="area" type="RID"> + <method name="body_add_force"> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="offset" type="Vector2"> + </argument> + <argument index="2" name="force" type="Vector2"> </argument> <description> - Return the transform matrix for an area. + 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. </description> </method> - <method name="area_attach_object_instance_ID"> - <argument index="0" name="area" type="RID"> + <method name="body_add_shape"> + <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="shape" type="RID"> + </argument> + <argument index="2" name="transform" type="Matrix32" default="1,0, 0,1, 0,0"> </argument> <description> - Assign the area to a descendant of [Object], so it can exist in the node tree. + 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. </description> </method> - <method name="area_get_object_instance_ID" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="area" type="RID"> + <method name="body_apply_impulse"> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="impulse" type="Vector2"> </argument> <description> - Get the instance ID of the object the area is assigned to. + Add a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. </description> </method> - <method name="area_set_monitor_callback"> - <argument index="0" name="area" type="RID"> + <method name="body_attach_object_instance_ID"> + <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="receiver" type="Object"> + <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="method" type="String"> + <description> + Assign the area to a descendant of [Object], so it can exist in the node tree. + </description> + </method> + <method name="body_clear_shapes"> + <argument index="0" name="body" type="RID"> </argument> <description> - 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. + Remove all shapes from a body. </description> </method> <method name="body_create"> @@ -25798,31 +25836,40 @@ This method controls whether the position between two cached points is interpola 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. </description> </method> - <method name="body_set_space"> + <method name="body_get_collision_mask" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="space" type="RID"> - </argument> <description> - Assign a space to the body (see [method create_space]). + Return the physics layer or layers a body can collide with. </description> </method> - <method name="body_get_space" qualifiers="const"> - <return type="RID"> + <method name="body_get_continuous_collision_detection_mode" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="body" type="RID"> </argument> <description> - Return the [RID] of the space assigned to a body. + Return the continuous collision detection mode. </description> </method> - <method name="body_set_mode"> + <method name="body_get_layer_mask" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="mode" type="int"> + <description> + Return the physics layer or layers a body belongs to. + </description> + </method> + <method name="body_get_max_contacts_reported" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> </argument> <description> - Set the body mode, from one of the constants BODY_MODE*. + Return the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. </description> </method> <method name="body_get_mode" qualifiers="const"> @@ -25834,48 +25881,53 @@ This method controls whether the position between two cached points is interpola Return the body mode. </description> </method> - <method name="body_add_shape"> + <method name="body_get_object_instance_ID" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="shape" type="RID"> - </argument> - <argument index="2" name="transform" type="Matrix32" default="1,0, 0,1, 0,0"> - </argument> <description> - 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. + Get the instance ID of the object the area is assigned to. </description> </method> - <method name="body_set_shape"> + <method name="body_get_one_way_collision_direction" qualifiers="const"> + <return type="Vector2"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <argument index="2" name="shape" type="RID"> - </argument> <description> - Substitute a given body shape by another. The old shape is selected by its index, the new one by its [RID]. + Return the direction used for one-way collision detection. </description> </method> - <method name="body_set_shape_transform"> + <method name="body_get_one_way_collision_max_depth" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> + <description> + Return how far a body can go through the given one, when it allows one-way collisions. + </description> + </method> + <method name="body_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="body" type="RID"> </argument> - <argument index="2" name="transform" type="Matrix32"> + <argument index="1" name="param" type="int"> </argument> <description> - Set the transform matrix for a body shape. + Return the value of a body parameter. </description> </method> - <method name="body_set_shape_metadata"> + <method name="body_get_shape" qualifiers="const"> + <return type="RID"> + </return> <argument index="0" name="body" type="RID"> </argument> <argument index="1" name="shape_idx" type="int"> </argument> - <argument index="2" name="metadata" type="Variant"> - </argument> <description> - 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 [RID] of the nth shape of a body. </description> </method> <method name="body_get_shape_count" qualifiers="const"> @@ -25887,15 +25939,13 @@ This method controls whether the position between two cached points is interpola Return the number of shapes assigned to a body. </description> </method> - <method name="body_get_shape" qualifiers="const"> - <return type="RID"> - </return> + <method name="body_get_shape_metadata" qualifiers="const"> <argument index="0" name="body" type="RID"> </argument> <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the [RID] of the nth shape of a body. + Return the metadata of a shape of a body. </description> </method> <method name="body_get_shape_transform" qualifiers="const"> @@ -25909,69 +25959,78 @@ This method controls whether the position between two cached points is interpola Return the transform matrix of a body shape. </description> </method> - <method name="body_get_shape_metadata" qualifiers="const"> + <method name="body_get_space" qualifiers="const"> + <return type="RID"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> <description> - Return the metadata of a shape of a body. + Return the [RID] of the space assigned to a body. </description> </method> - <method name="body_remove_shape"> + <method name="body_get_state" qualifiers="const"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> + <argument index="1" name="state" type="int"> </argument> <description> - Remove a shape from a body. The shape is not deleted, so it can be reused afterwards. + Return a body state. </description> </method> - <method name="body_clear_shapes"> + <method name="body_is_omitting_force_integration" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="body" type="RID"> </argument> <description> - Remove all shapes from a body. + Return whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> - <method name="body_set_shape_as_trigger"> + <method name="body_is_shape_set_as_trigger" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="body" type="RID"> </argument> <argument index="1" name="shape_idx" type="int"> </argument> - <argument index="2" name="enable" type="bool"> + <description> + Return whether a body's shape is marked as a trigger. + </description> + </method> + <method name="body_remove_collision_exception"> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="excepted_body" type="RID"> </argument> <description> - Mark a body's shape as a trigger. A trigger shape cannot affect other bodies, but detects other shapes entering and exiting it. + Remove a body from the list of bodies exempt from collisions. </description> </method> - <method name="body_is_shape_set_as_trigger" qualifiers="const"> - <return type="bool"> - </return> + <method name="body_remove_shape"> <argument index="0" name="body" type="RID"> </argument> <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return whether a body's shape is marked as a trigger. + Remove a shape from a body. The shape is not deleted, so it can be reused afterwards. </description> </method> - <method name="body_attach_object_instance_ID"> + <method name="body_set_axis_velocity"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="axis_velocity" type="Vector2"> </argument> <description> - Assign the area to a descendant of [Object], so it can exist in the node tree. + 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. </description> </method> - <method name="body_get_object_instance_ID" qualifiers="const"> - <return type="int"> - </return> + <method name="body_set_collision_mask"> <argument index="0" name="body" type="RID"> </argument> + <argument index="1" name="mask" type="int"> + </argument> <description> - Get the instance ID of the object the area is assigned to. + Set the physics layer or layers a body can collide with. </description> </method> <method name="body_set_continuous_collision_detection_mode"> @@ -25984,13 +26043,17 @@ This method controls whether the position between two cached points is interpola Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. </description> </method> - <method name="body_get_continuous_collision_detection_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="body_set_force_integration_callback"> <argument index="0" name="body" type="RID"> </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <argument index="3" name="userdata" type="Variant" default="NULL"> + </argument> <description> - Return the continuous collision detection mode. + Set the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). </description> </method> <method name="body_set_layer_mask"> @@ -26002,244 +26065,240 @@ This method controls whether the position between two cached points is interpola Set the physics layer or layers a body belongs to. </description> </method> - <method name="body_get_layer_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="body_set_max_contacts_reported"> <argument index="0" name="body" type="RID"> </argument> + <argument index="1" name="amount" type="int"> + </argument> <description> - Return 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. </description> </method> - <method name="body_set_collision_mask"> + <method name="body_set_mode"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="mask" type="int"> + <argument index="1" name="mode" type="int"> </argument> <description> - Set the physics layer or layers a body can collide with. + Set the body mode, from one of the constants BODY_MODE*. </description> </method> - <method name="body_get_collision_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="body_set_omit_force_integration"> <argument index="0" name="body" type="RID"> </argument> + <argument index="1" name="enable" type="bool"> + </argument> <description> - Return the physics layer or layers a body can collide with. + Set whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> - <method name="body_set_param"> + <method name="body_set_one_way_collision_direction"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="float"> + <argument index="1" name="normal" type="Vector2"> </argument> <description> - Set a body parameter (see BODY_PARAM* constants). + 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. </description> </method> - <method name="body_get_param" qualifiers="const"> - <return type="float"> - </return> + <method name="body_set_one_way_collision_max_depth"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="param" type="int"> + <argument index="1" name="depth" type="float"> </argument> <description> - Return the value of a body parameter. + 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]). </description> </method> - <method name="body_set_state"> + <method name="body_set_param"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="state" type="int"> + <argument index="1" name="param" type="int"> </argument> - <argument index="2" name="value" type="Variant"> + <argument index="2" name="value" type="float"> </argument> <description> - Set a body state (see BODY_STATE* constants). + Set a body parameter (see BODY_PARAM* constants). </description> </method> - <method name="body_get_state" qualifiers="const"> + <method name="body_set_shape"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="state" type="int"> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="shape" type="RID"> </argument> <description> - Return a body state. + Substitute a given body shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> - <method name="body_apply_impulse"> + <method name="body_set_shape_as_trigger"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="pos" type="Vector2"> + <argument index="1" name="shape_idx" type="int"> </argument> - <argument index="2" name="impulse" type="Vector2"> + <argument index="2" name="enable" type="bool"> </argument> <description> - Add a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. + Mark a body's shape as a trigger. A trigger shape cannot affect other bodies, but detects other shapes entering and exiting it. </description> </method> - <method name="body_add_force"> + <method name="body_set_shape_metadata"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="offset" type="Vector2"> + <argument index="1" name="shape_idx" type="int"> </argument> - <argument index="2" name="force" type="Vector2"> + <argument index="2" name="metadata" type="Variant"> </argument> <description> - 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 metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries. </description> </method> - <method name="body_set_axis_velocity"> + <method name="body_set_shape_transform"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="axis_velocity" type="Vector2"> - </argument> - <description> - 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. - </description> - </method> - <method name="body_add_collision_exception"> - <argument index="0" name="body" type="RID"> + <argument index="1" name="shape_idx" type="int"> </argument> - <argument index="1" name="excepted_body" type="RID"> + <argument index="2" name="transform" type="Matrix32"> </argument> <description> - Add a body to the list of bodies exempt from collisions. + Set the transform matrix for a body shape. </description> </method> - <method name="body_remove_collision_exception"> + <method name="body_set_space"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="excepted_body" type="RID"> + <argument index="1" name="space" type="RID"> </argument> <description> - Remove a body from the list of bodies exempt from collisions. + Assign a space to the body (see [method create_space]). </description> </method> - <method name="body_set_max_contacts_reported"> + <method name="body_set_state"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="amount" type="int"> + <argument index="1" name="state" type="int"> + </argument> + <argument index="2" name="value" type="Variant"> </argument> <description> - 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 a body state (see BODY_STATE* constants). </description> </method> - <method name="body_get_max_contacts_reported" qualifiers="const"> - <return type="int"> + <method name="body_test_motion"> + <return type="bool"> </return> <argument index="0" name="body" type="RID"> </argument> - <description> - Return the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. - </description> - </method> - <method name="body_set_one_way_collision_direction"> - <argument index="0" name="body" type="RID"> + <argument index="1" name="motion" type="Vector2"> </argument> - <argument index="1" name="normal" type="Vector2"> + <argument index="2" name="margin" type="float" default="0.08"> + </argument> + <argument index="3" name="result" type="Physics2DTestMotionResult" default="NULL"> </argument> <description> - 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. + 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. </description> </method> - <method name="body_get_one_way_collision_direction" qualifiers="const"> - <return type="Vector2"> + <method name="damped_spring_joint_create"> + <return type="RID"> </return> - <argument index="0" name="body" type="RID"> + <argument index="0" name="anchor_a" type="Vector2"> </argument> - <description> - Return the direction used for one-way collision detection. - </description> - </method> - <method name="body_set_one_way_collision_max_depth"> - <argument index="0" name="body" type="RID"> + <argument index="1" name="anchor_b" type="Vector2"> </argument> - <argument index="1" name="depth" type="float"> + <argument index="2" name="body_a" type="RID"> + </argument> + <argument index="3" name="body_b" type="RID" default="RID()"> </argument> <description> - 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]). + Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. </description> </method> - <method name="body_get_one_way_collision_max_depth" qualifiers="const"> + <method name="damped_string_joint_get_param" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="body" type="RID"> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int"> </argument> <description> - Return how far a body can go through the given one, when it allows one-way collisions. + Return the value of a damped spring joint parameter. </description> </method> - <method name="body_set_omit_force_integration"> - <argument index="0" name="body" type="RID"> + <method name="damped_string_joint_set_param"> + <argument index="0" name="joint" type="RID"> </argument> - <argument index="1" name="enable" type="bool"> + <argument index="1" name="param" type="int"> + </argument> + <argument index="2" name="value" type="float"> </argument> <description> - Set whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). + Set a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants. </description> </method> - <method name="body_is_omitting_force_integration" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="body" type="RID"> + <method name="free_rid"> + <argument index="0" name="rid" type="RID"> </argument> <description> - Return whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). + 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. </description> </method> - <method name="body_set_force_integration_callback"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="receiver" type="Object"> - </argument> - <argument index="2" name="method" type="String"> - </argument> - <argument index="3" name="userdata" type="Variant" default="NULL"> + <method name="get_process_info"> + <return type="int"> + </return> + <argument index="0" name="process_info" type="int"> </argument> <description> - Set the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). + Return information about the current state of the 2D physics engine. The states are listed under the INFO_* constants. </description> </method> - <method name="body_test_motion"> - <return type="bool"> + <method name="groove_joint_create"> + <return type="RID"> </return> - <argument index="0" name="body" type="RID"> + <argument index="0" name="groove1_a" type="Vector2"> </argument> - <argument index="1" name="motion" type="Vector2"> + <argument index="1" name="groove2_a" type="Vector2"> </argument> - <argument index="2" name="margin" type="float" default="0.08"> + <argument index="2" name="anchor_b" type="Vector2"> </argument> - <argument index="3" name="result" type="Physics2DTestMotionResult" default="NULL"> + <argument index="3" name="body_a" type="RID" default="RID()"> + </argument> + <argument index="4" name="body_b" type="RID" default="RID()"> </argument> <description> - 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. + Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. </description> </method> - <method name="joint_set_param"> + <method name="joint_get_param" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="joint" type="RID"> </argument> <argument index="1" name="param" type="int"> </argument> - <argument index="2" name="value" type="float"> - </argument> <description> - Set a joint parameter. Parameters are explained in the JOINT_PARAM* constants. + Return the value of a joint parameter. </description> </method> - <method name="joint_get_param" qualifiers="const"> - <return type="float"> + <method name="joint_get_type" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="joint" type="RID"> </argument> + <description> + Return the type of a joint (see JOINT_* constants). + </description> + </method> + <method name="joint_set_param"> + <argument index="0" name="joint" type="RID"> + </argument> <argument index="1" name="param" type="int"> </argument> + <argument index="2" name="value" type="float"> + </argument> <description> - Return the value of a joint parameter. + Set a joint parameter. Parameters are explained in the JOINT_PARAM* constants. </description> </method> <method name="pin_joint_create"> @@ -26255,154 +26314,141 @@ This method controls whether the position between two cached points is interpola Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. </description> </method> - <method name="groove_joint_create"> + <method name="set_active"> + <argument index="0" name="active" type="bool"> + </argument> + <description> + Activate or deactivate the 2D physics engine. + </description> + </method> + <method name="shape_create"> <return type="RID"> </return> - <argument index="0" name="groove1_a" type="Vector2"> + <argument index="0" name="type" type="int"> </argument> - <argument index="1" name="groove2_a" type="Vector2"> + <description> + 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]. + </description> + </method> + <method name="shape_get_data" qualifiers="const"> + <argument index="0" name="shape" type="RID"> </argument> - <argument index="2" name="anchor_b" type="Vector2"> + <description> + Return the shape data. + </description> + </method> + <method name="shape_get_type" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="shape" type="RID"> </argument> - <argument index="3" name="body_a" type="RID" default="RID()"> + <description> + Return the type of shape (see SHAPE_* constants). + </description> + </method> + <method name="shape_set_data"> + <argument index="0" name="shape" type="RID"> </argument> - <argument index="4" name="body_b" type="RID" default="RID()"> + <argument index="1" name="data" type="Variant"> </argument> <description> - Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. + 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]. </description> </method> - <method name="damped_spring_joint_create"> + <method name="space_create"> <return type="RID"> </return> - <argument index="0" name="anchor_a" type="Vector2"> - </argument> - <argument index="1" name="anchor_b" type="Vector2"> - </argument> - <argument index="2" name="body_a" type="RID"> - </argument> - <argument index="3" name="body_b" type="RID" default="RID()"> - </argument> <description> - Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. + 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]. </description> </method> - <method name="damped_string_joint_set_param"> - <argument index="0" name="joint" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="float"> + <method name="space_get_direct_state"> + <return type="Physics2DDirectSpaceState"> + </return> + <argument index="0" name="space" type="RID"> </argument> <description> - Set a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants. + Return the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries. </description> </method> - <method name="damped_string_joint_get_param" qualifiers="const"> + <method name="space_get_param" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="joint" type="RID"> + <argument index="0" name="space" type="RID"> </argument> <argument index="1" name="param" type="int"> </argument> <description> - Return the value of a damped spring joint parameter. + Return the value of a space parameter. </description> </method> - <method name="joint_get_type" qualifiers="const"> - <return type="int"> + <method name="space_is_active" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="joint" type="RID"> + <argument index="0" name="space" type="RID"> </argument> <description> - Return the type of a joint (see JOINT_* constants). + Return whether the space is active. </description> </method> - <method name="free_rid"> - <argument index="0" name="rid" type="RID"> + <method name="space_set_active"> + <argument index="0" name="space" type="RID"> </argument> - <description> - 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. - </description> - </method> - <method name="set_active"> - <argument index="0" name="active" type="bool"> + <argument index="1" name="active" type="bool"> </argument> <description> - Activate or deactivate the 2D physics engine. + Mark a space as active. It will not have an effect, unless it is assigned to an area or body. </description> </method> - <method name="get_process_info"> - <return type="int"> - </return> - <argument index="0" name="process_info" type="int"> + <method name="space_set_param"> + <argument index="0" name="space" type="RID"> + </argument> + <argument index="1" name="param" type="int"> + </argument> + <argument index="2" name="value" type="float"> </argument> <description> - Return information about the current state of the 2D physics engine. The states are listed under the INFO_* constants. + Set the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants. </description> </method> </methods> <constants> - <constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0"> - Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. - </constant> - <constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1"> - Constant to set/get the maximum distance a shape can be from another before they are considered separated. - </constant> - <constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2"> - Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. - </constant> - <constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_TRESHOLD" value="3"> - Constant to set/get the linear velocity threshold. Bodies slower than this will be marked as potentially inactive. - </constant> - <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_TRESHOLD" value="4"> - Constant to set/get the angular velocity threshold. Bodies slower than this will be marked as potentially inactive. - </constant> - <constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5"> - 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> - <constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="6"> - 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> - <constant name="SHAPE_LINE" value="0"> - 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. - </constant> - <constant name="SHAPE_SEGMENT" value="2"> - This is the constant for creating segment shapes. A segment shape is a line from a point A to a point B. It can be checked for intersections. - </constant> - <constant name="SHAPE_CIRCLE" value="3"> - This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks. - </constant> - <constant name="SHAPE_RECTANGLE" value="4"> - This is the constant for creating rectangle shapes. A rectangle shape is defined by a width and a height. It can be used for intersections and inside/outside checks. - </constant> - <constant name="SHAPE_CAPSULE" value="5"> - This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks. - </constant> - <constant name="SHAPE_CONVEX_POLYGON" value="6"> - This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method [method CollisionPolygon2D.set_polygon], polygons modified with [method shape_set_data] do not verify that the points supplied form, in fact, a convex polygon. - </constant> - <constant name="SHAPE_CONCAVE_POLYGON" value="7"> - This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks. - </constant> - <constant name="SHAPE_CUSTOM" value="8"> - This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. + <constant name="AREA_BODY_ADDED" value="0"> + The value of the first parameter and area callback function receives, when an object enters one of its shapes. </constant> <constant name="AREA_PARAM_GRAVITY" value="0"> Constant to set/get gravity strength in an area. </constant> + <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + </constant> + <constant name="AREA_BODY_REMOVED" value="1"> + The value of the first parameter and area callback function receives, when an object exits one of its shapes. + </constant> <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1"> Constant to set/get gravity vector/center in an area. </constant> + <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1"> + 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> <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2"> Constant to set/get whether the gravity vector of an area is a direction, or a center point. </constant> + <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + 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> <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3"> 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> + <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> + This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + </constant> <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4"> This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE. </constant> + <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. + </constant> <constant name="AREA_PARAM_LINEAR_DAMP" value="5"> Constant to set/get the linear dampening factor of an area. </constant> @@ -26412,48 +26458,48 @@ This method controls whether the position between two cached points is interpola <constant name="AREA_PARAM_PRIORITY" value="7"> Constant to set/get the priority (order of processing) of an area. </constant> - <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> - This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. - </constant> - <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1"> - 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> - <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> - 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> - <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> - This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. - </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> - This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. - </constant> <constant name="BODY_MODE_STATIC" value="0"> Constant for static bodies. </constant> - <constant name="BODY_MODE_KINEMATIC" value="1"> - Constant for kinematic bodies. - </constant> - <constant name="BODY_MODE_RIGID" value="2"> - Constant for rigid bodies. - </constant> - <constant name="BODY_MODE_CHARACTER" value="3"> - 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> <constant name="BODY_PARAM_BOUNCE" value="0"> Constant to set/get a body's bounce factor. </constant> + <constant name="BODY_STATE_TRANSFORM" value="0"> + Constant to set/get the current transform matrix of the body. + </constant> + <constant name="BODY_MODE_KINEMATIC" value="1"> + Constant for kinematic bodies. + </constant> <constant name="BODY_PARAM_FRICTION" value="1"> Constant to set/get a body's friction. </constant> + <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> + Constant to set/get the current linear velocity of the body. + </constant> + <constant name="BODY_MODE_RIGID" value="2"> + Constant for rigid bodies. + </constant> <constant name="BODY_PARAM_MASS" value="2"> Constant to set/get a body's mass. </constant> + <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> + Constant to set/get the current angular velocity of the body. + </constant> + <constant name="BODY_MODE_CHARACTER" value="3"> + 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> <constant name="BODY_PARAM_INERTIA" value="3"> Constant to set/get a body's inertia. </constant> + <constant name="BODY_STATE_SLEEPING" value="3"> + Constant to sleep/wake up a body, or to get whether it is sleeping. + </constant> <constant name="BODY_PARAM_GRAVITY_SCALE" value="4"> Constant to set/get a body's gravity multiplier. </constant> + <constant name="BODY_STATE_CAN_SLEEP" value="4"> + Constant to set/get whether the body can sleep. + </constant> <constant name="BODY_PARAM_LINEAR_DAMP" value="5"> Constant to set/get a body's linear dampening factor. </constant> @@ -26463,20 +26509,32 @@ This method controls whether the position between two cached points is interpola <constant name="BODY_PARAM_MAX" value="7"> This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. </constant> - <constant name="BODY_STATE_TRANSFORM" value="0"> - Constant to set/get the current transform matrix of the body. + <constant name="CCD_MODE_DISABLED" value="0"> + Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. </constant> - <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> - Constant to set/get the current linear velocity of the body. + <constant name="CCD_MODE_CAST_RAY" value="1"> + Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. </constant> - <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> - Constant to set/get the current angular velocity of the body. + <constant name="CCD_MODE_CAST_SHAPE" value="2"> + Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. </constant> - <constant name="BODY_STATE_SLEEPING" value="3"> - Constant to sleep/wake up a body, or to get whether it is sleeping. + <constant name="DAMPED_STRING_REST_LENGTH" value="0"> + Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. </constant> - <constant name="BODY_STATE_CAN_SLEEP" value="4"> - Constant to set/get whether the body can sleep. + <constant name="DAMPED_STRING_STIFFNESS" value="1"> + Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. + </constant> + <constant name="DAMPED_STRING_DAMPING" value="2"> + 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> + <constant name="INFO_ACTIVE_OBJECTS" value="0"> + Constant to get the number of objects that are not sleeping. + </constant> + <constant name="INFO_COLLISION_PAIRS" value="1"> + Constant to get the number of possible collisions. + </constant> + <constant name="INFO_ISLAND_COUNT" value="2"> + Constant to get the number of space regions where a collision could occur. </constant> <constant name="JOINT_PIN" value="0"> Constant to create pin joints. @@ -26487,38 +26545,50 @@ This method controls whether the position between two cached points is interpola <constant name="JOINT_DAMPED_SPRING" value="2"> Constant to create damped spring joints. </constant> - <constant name="DAMPED_STRING_REST_LENGTH" value="0"> - Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. + <constant name="SHAPE_LINE" value="0"> + 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. </constant> - <constant name="DAMPED_STRING_STIFFNESS" value="1"> - Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. + <constant name="SHAPE_SEGMENT" value="2"> + This is the constant for creating segment shapes. A segment shape is a line from a point A to a point B. It can be checked for intersections. </constant> - <constant name="DAMPED_STRING_DAMPING" value="2"> - 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 name="SHAPE_CIRCLE" value="3"> + This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks. </constant> - <constant name="CCD_MODE_DISABLED" value="0"> - Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. + <constant name="SHAPE_RECTANGLE" value="4"> + This is the constant for creating rectangle shapes. A rectangle shape is defined by a width and a height. It can be used for intersections and inside/outside checks. </constant> - <constant name="CCD_MODE_CAST_RAY" value="1"> - Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. + <constant name="SHAPE_CAPSULE" value="5"> + This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks. </constant> - <constant name="CCD_MODE_CAST_SHAPE" value="2"> - Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. + <constant name="SHAPE_CONVEX_POLYGON" value="6"> + This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method [method CollisionPolygon2D.set_polygon], polygons modified with [method shape_set_data] do not verify that the points supplied form, in fact, a convex polygon. </constant> - <constant name="AREA_BODY_ADDED" value="0"> - The value of the first parameter and area callback function receives, when an object enters one of its shapes. + <constant name="SHAPE_CONCAVE_POLYGON" value="7"> + This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks. </constant> - <constant name="AREA_BODY_REMOVED" value="1"> - The value of the first parameter and area callback function receives, when an object exits one of its shapes. + <constant name="SHAPE_CUSTOM" value="8"> + This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. </constant> - <constant name="INFO_ACTIVE_OBJECTS" value="0"> - Constant to get the number of objects that are not sleeping. + <constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0"> + Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. </constant> - <constant name="INFO_COLLISION_PAIRS" value="1"> - Constant to get the number of possible collisions. + <constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1"> + Constant to set/get the maximum distance a shape can be from another before they are considered separated. </constant> - <constant name="INFO_ISLAND_COUNT" value="2"> - Constant to get the number of space regions where a collision could occur. + <constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2"> + Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. + </constant> + <constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_TRESHOLD" value="3"> + Constant to set/get the linear velocity threshold. Bodies slower than this will be marked as potentially inactive. + </constant> + <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_TRESHOLD" value="4"> + Constant to set/get the angular velocity threshold. Bodies slower than this will be marked as potentially inactive. + </constant> + <constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5"> + 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> + <constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="6"> + 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> </constants> </class> @@ -26542,67 +26612,60 @@ This method controls whether the position between two cached points is interpola This class contains the shape and other parameters for intersection/collision queries. </description> <methods> - <method name="set_shape"> - <argument index="0" name="shape" type="Shape2D"> - </argument> + <method name="get_exclude" qualifiers="const"> + <return type="Array"> + </return> <description> - Set the [Shape2D] that will be used for collision/intersection queries. + Return the list of objects, or object [RID]s, that will be excluded from collisions. </description> </method> - <method name="set_shape_rid"> - <argument index="0" name="shape" type="RID"> - </argument> + <method name="get_layer_mask" qualifiers="const"> + <return type="int"> + </return> <description> - Set the [RID] of the shape to be used in queries. + Return the physics layer(s) the shape belongs to. </description> </method> - <method name="get_shape_rid" qualifiers="const"> - <return type="RID"> + <method name="get_margin" qualifiers="const"> + <return type="float"> </return> <description> - Return the [RID] of the shape queried. + Return the collision margin for the shape. </description> </method> - <method name="set_transform"> - <argument index="0" name="transform" type="Matrix32"> - </argument> + <method name="get_motion" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale. + Return the current movement speed of the shape. </description> </method> - <method name="get_transform" qualifiers="const"> - <return type="Matrix32"> + <method name="get_object_type_mask" qualifiers="const"> + <return type="int"> </return> <description> - Return the transform matrix of the shape queried. + Return the type of object the shape belongs to. </description> </method> - <method name="set_motion"> - <argument index="0" name="motion" type="Vector2"> - </argument> + <method name="get_shape_rid" qualifiers="const"> + <return type="RID"> + </return> <description> - Set the current movement speed of the shape. + Return the [RID] of the shape queried. </description> </method> - <method name="get_motion" qualifiers="const"> - <return type="Vector2"> + <method name="get_transform" qualifiers="const"> + <return type="Matrix32"> </return> <description> - Return the current movement speed of the shape. + Return the transform matrix of the shape queried. </description> </method> - <method name="set_margin"> - <argument index="0" name="margin" type="float"> + <method name="set_exclude"> + <argument index="0" name="exclude" type="Array"> </argument> <description> - 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. - </description> - </method> - <method name="get_margin" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the collision margin for the shape. + Set the list of objects, or object [RID]s, that will be excluded from collisions. </description> </method> <method name="set_layer_mask"> @@ -26612,11 +26675,18 @@ This method controls whether the position between two cached points is interpola Set the physics layer(s) the shape belongs to. </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_margin"> + <argument index="0" name="margin" type="float"> + </argument> <description> - Return 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. + </description> + </method> + <method name="set_motion"> + <argument index="0" name="motion" type="Vector2"> + </argument> + <description> + Set the current movement speed of the shape. </description> </method> <method name="set_object_type_mask"> @@ -26626,25 +26696,25 @@ This method controls whether the position between two cached points is interpola Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*). </description> </method> - <method name="get_object_type_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_shape"> + <argument index="0" name="shape" type="Shape2D"> + </argument> <description> - Return the type of object the shape belongs to. + Set the [Shape2D] that will be used for collision/intersection queries. </description> </method> - <method name="set_exclude"> - <argument index="0" name="exclude" type="Array"> + <method name="set_shape_rid"> + <argument index="0" name="shape" type="RID"> </argument> <description> - Set the list of objects, or object [RID]s, that will be excluded from collisions. + Set the [RID] of the shape to be used in queries. </description> </method> - <method name="get_exclude" qualifiers="const"> - <return type="Array"> - </return> + <method name="set_transform"> + <argument index="0" name="transform" type="Matrix32"> + </argument> <description> - Return the list of objects, or object [RID]s, that will be excluded from collisions. + Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale. </description> </method> </methods> @@ -26663,8 +26733,8 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_result_rid" qualifiers="const"> - <return type="RID"> + <method name="get_result_object" qualifiers="const"> + <return type="Object"> </return> <argument index="0" name="idx" type="int"> </argument> @@ -26679,16 +26749,16 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_result_object" qualifiers="const"> - <return type="Object"> + <method name="get_result_object_shape" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_result_object_shape" qualifiers="const"> - <return type="int"> + <method name="get_result_rid" qualifiers="const"> + <return type="RID"> </return> <argument index="0" name="idx" type="int"> </argument> @@ -26705,26 +26775,26 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="get_motion" qualifiers="const"> - <return type="Vector2"> + <method name="get_collider" qualifiers="const"> + <return type="Object"> </return> <description> </description> </method> - <method name="get_motion_remainder" qualifiers="const"> - <return type="Vector2"> + <method name="get_collider_id" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="get_collision_point" qualifiers="const"> - <return type="Vector2"> + <method name="get_collider_rid" qualifiers="const"> + <return type="RID"> </return> <description> </description> </method> - <method name="get_collision_normal" qualifiers="const"> - <return type="Vector2"> + <method name="get_collider_shape" qualifiers="const"> + <return type="int"> </return> <description> </description> @@ -26735,26 +26805,26 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_collider_id" qualifiers="const"> - <return type="int"> + <method name="get_collision_normal" qualifiers="const"> + <return type="Vector2"> </return> <description> </description> </method> - <method name="get_collider_rid" qualifiers="const"> - <return type="RID"> + <method name="get_collision_point" qualifiers="const"> + <return type="Vector2"> </return> <description> </description> </method> - <method name="get_collider" qualifiers="const"> - <return type="Object"> + <method name="get_motion" qualifiers="const"> + <return type="Vector2"> </return> <description> </description> </method> - <method name="get_collider_shape" qualifiers="const"> - <return type="int"> + <method name="get_motion_remainder" qualifiers="const"> + <return type="Vector2"> </return> <description> </description> @@ -26771,70 +26841,70 @@ 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. </description> <methods> - <method name="set_layer_mask"> - <argument index="0" name="mask" type="int"> + <method name="add_collision_exception_with"> + <argument index="0" name="body" type="PhysicsBody"> </argument> <description> </description> </method> - <method name="get_layer_mask" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="set_collision_mask"> - <argument index="0" name="mask" type="int"> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> </argument> <description> </description> </method> - <method name="get_collision_mask" qualifiers="const"> + <method name="get_layer_mask" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="set_collision_mask_bit"> + <method name="get_layer_mask_bit" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="bit" type="int"> </argument> - <argument index="1" name="value" type="bool"> - </argument> <description> </description> </method> - <method name="get_collision_mask_bit" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="bit" type="int"> + <method name="remove_collision_exception_with"> + <argument index="0" name="body" type="PhysicsBody"> </argument> <description> </description> </method> - <method name="set_layer_mask_bit"> - <argument index="0" name="bit" type="int"> - </argument> - <argument index="1" name="value" type="bool"> + <method name="set_collision_mask"> + <argument index="0" name="mask" type="int"> </argument> <description> </description> </method> - <method name="get_layer_mask_bit" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_collision_mask_bit"> <argument index="0" name="bit" type="int"> </argument> + <argument index="1" name="value" type="bool"> + </argument> <description> </description> </method> - <method name="add_collision_exception_with"> - <argument index="0" name="body" type="PhysicsBody"> + <method name="set_layer_mask"> + <argument index="0" name="mask" type="int"> </argument> <description> </description> </method> - <method name="remove_collision_exception_with"> - <argument index="0" name="body" type="PhysicsBody"> + <method name="set_layer_mask_bit"> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> </argument> <description> </description> @@ -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. </description> <methods> - <method name="set_layer_mask"> - <argument index="0" name="mask" type="int"> - </argument> - <description> - 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. - </description> - </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the physics layer this area is in. - </description> - </method> - <method name="set_collision_mask"> - <argument index="0" name="mask" type="int"> + <method name="add_collision_exception_with"> + <argument index="0" name="body" type="PhysicsBody2D"> </argument> <description> - 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. </description> </method> <method name="get_collision_mask" qualifiers="const"> @@ -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. </description> </method> - <method name="set_collision_mask_bit"> - <argument index="0" name="bit" type="int"> - </argument> - <argument index="1" name="value" type="bool"> - </argument> - <description> - Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. - </description> - </method> <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> @@ -26899,13 +26944,11 @@ This method controls whether the position between two cached points is interpola Return an individual bit on the collision mask. </description> </method> - <method name="set_layer_mask_bit"> - <argument index="0" name="bit" type="int"> - </argument> - <argument index="1" name="value" type="bool"> - </argument> + <method name="get_layer_mask" qualifiers="const"> + <return type="int"> + </return> <description> - 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. </description> </method> <method name="get_layer_mask_bit" qualifiers="const"> @@ -26917,13 +26960,6 @@ This method controls whether the position between two cached points is interpola Return an individual bit on the collision mask. </description> </method> - <method name="set_one_way_collision_direction"> - <argument index="0" name="dir" type="Vector2"> - </argument> - <description> - 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. - </description> - </method> <method name="get_one_way_collision_direction" qualifiers="const"> <return type="Vector2"> </return> @@ -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. </description> </method> - <method name="set_one_way_collision_max_depth"> - <argument index="0" name="depth" type="float"> - </argument> - <description> - Set how far a body can go through this one, when it allows one-way collisions (see [method set_one_way_collision_direction]). - </description> - </method> <method name="get_one_way_collision_max_depth" qualifiers="const"> <return type="float"> </return> @@ -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. </description> </method> - <method name="add_collision_exception_with"> - <argument index="0" name="body" type="PhysicsBody2D"> - </argument> - <description> - Adds a body to the collision exception list. This list contains bodies that this body will not collide with. - </description> - </method> <method name="remove_collision_exception_with"> <argument index="0" name="body" type="PhysicsBody2D"> </argument> @@ -26959,60 +26981,76 @@ This method controls whether the position between two cached points is interpola Removes a body from the collision exception list. </description> </method> - </methods> - <constants> - </constants> -</class> -<class name="PhysicsDirectBodyState" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_total_gravity" qualifiers="const"> - <return type="Vector3"> - </return> + <method name="set_collision_mask"> + <argument index="0" name="mask" type="int"> + </argument> <description> + Set the physics layers this area can scan for collisions. </description> </method> - <method name="get_total_linear_damp" qualifiers="const"> - <return type="float"> - </return> + <method name="set_collision_mask_bit"> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> <description> + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> - <method name="get_total_angular_damp" qualifiers="const"> - <return type="float"> - </return> + <method name="set_layer_mask"> + <argument index="0" name="mask" type="int"> + </argument> <description> + 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. </description> </method> - <method name="get_inverse_mass" qualifiers="const"> - <return type="float"> - </return> + <method name="set_layer_mask_bit"> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> <description> + Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. </description> </method> - <method name="get_inverse_inertia" qualifiers="const"> - <return type="Vector3"> - </return> + <method name="set_one_way_collision_direction"> + <argument index="0" name="dir" type="Vector2"> + </argument> <description> + 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. </description> </method> - <method name="set_linear_velocity"> - <argument index="0" name="velocity" type="Vector3"> + <method name="set_one_way_collision_max_depth"> + <argument index="0" name="depth" type="float"> </argument> <description> + Set how far a body can go through this one, when it allows one-way collisions (see [method set_one_way_collision_direction]). </description> </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector3"> - </return> + </methods> + <constants> + </constants> +</class> +<class name="PhysicsDirectBodyState" inherits="Object" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="add_force"> + <argument index="0" name="force" type="Vector3"> + </argument> + <argument index="1" name="pos" type="Vector3"> + </argument> <description> </description> </method> - <method name="set_angular_velocity"> - <argument index="0" name="velocity" type="Vector3"> + <method name="apply_impulse"> + <argument index="0" name="pos" type="Vector3"> + </argument> + <argument index="1" name="j" type="Vector3"> </argument> <description> </description> @@ -27023,43 +27061,51 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_transform"> - <argument index="0" name="transform" type="Transform"> + <method name="get_contact_collider" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="contact_idx" type="int"> </argument> <description> </description> </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform"> + <method name="get_contact_collider_id" qualifiers="const"> + <return type="int"> </return> + <argument index="0" name="contact_idx" type="int"> + </argument> <description> </description> </method> - <method name="add_force"> - <argument index="0" name="force" type="Vector3"> - </argument> - <argument index="1" name="pos" type="Vector3"> + <method name="get_contact_collider_object" qualifiers="const"> + <return type="Object"> + </return> + <argument index="0" name="contact_idx" type="int"> </argument> <description> </description> </method> - <method name="apply_impulse"> - <argument index="0" name="pos" type="Vector3"> - </argument> - <argument index="1" name="j" type="Vector3"> + <method name="get_contact_collider_pos" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="contact_idx" type="int"> </argument> <description> </description> </method> - <method name="set_sleep_state"> - <argument index="0" name="enabled" type="bool"> + <method name="get_contact_collider_shape" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="contact_idx" type="int"> </argument> <description> </description> </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> + <method name="get_contact_collider_velocity_at_pos" qualifiers="const"> + <return type="Vector3"> </return> + <argument index="0" name="contact_idx" type="int"> + </argument> <description> </description> </method> @@ -27069,7 +27115,7 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_contact_local_pos" qualifiers="const"> + <method name="get_contact_local_normal" qualifiers="const"> <return type="Vector3"> </return> <argument index="0" name="contact_idx" type="int"> @@ -27077,7 +27123,7 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_contact_local_normal" qualifiers="const"> + <method name="get_contact_local_pos" qualifiers="const"> <return type="Vector3"> </return> <argument index="0" name="contact_idx" type="int"> @@ -27093,70 +27139,94 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_contact_collider" qualifiers="const"> - <return type="RID"> + <method name="get_inverse_inertia" qualifiers="const"> + <return type="Vector3"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> </description> </method> - <method name="get_contact_collider_pos" qualifiers="const"> + <method name="get_inverse_mass" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_linear_velocity" qualifiers="const"> <return type="Vector3"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> </description> </method> - <method name="get_contact_collider_id" qualifiers="const"> - <return type="int"> + <method name="get_space_state"> + <return type="PhysicsDirectSpaceState"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> </description> </method> - <method name="get_contact_collider_object" qualifiers="const"> - <return type="Object"> + <method name="get_step" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> </description> </method> - <method name="get_contact_collider_shape" qualifiers="const"> - <return type="int"> + <method name="get_total_angular_damp" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> </description> </method> - <method name="get_contact_collider_velocity_at_pos" qualifiers="const"> + <method name="get_total_gravity" qualifiers="const"> <return type="Vector3"> </return> - <argument index="0" name="contact_idx" type="int"> - </argument> <description> </description> </method> - <method name="get_step" qualifiers="const"> + <method name="get_total_linear_damp" qualifiers="const"> <return type="float"> </return> <description> </description> </method> + <method name="get_transform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + </description> + </method> <method name="integrate_forces"> <description> </description> </method> - <method name="get_space_state"> - <return type="PhysicsDirectSpaceState"> + <method name="is_sleeping" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> + <method name="set_angular_velocity"> + <argument index="0" name="velocity" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_linear_velocity"> + <argument index="0" name="velocity" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_sleep_state"> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_transform"> + <argument index="0" name="transform" type="Transform"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -27177,23 +27247,17 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="intersect_ray"> - <return type="Dictionary"> + <method name="cast_motion"> + <return type="Array"> </return> - <argument index="0" name="from" type="Vector3"> - </argument> - <argument index="1" name="to" type="Vector3"> - </argument> - <argument index="2" name="exclude" type="Array" default="Array()"> - </argument> - <argument index="3" name="layer_mask" type="int" default="2147483647"> + <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> </argument> - <argument index="4" name="type_mask" type="int" default="15"> + <argument index="1" name="motion" type="Vector3"> </argument> <description> </description> </method> - <method name="intersect_shape"> + <method name="collide_shape"> <return type="Array"> </return> <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> @@ -27203,31 +27267,37 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="cast_motion"> - <return type="Array"> + <method name="get_rest_info"> + <return type="Dictionary"> </return> <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> </argument> - <argument index="1" name="motion" type="Vector3"> - </argument> <description> </description> </method> - <method name="collide_shape"> - <return type="Array"> + <method name="intersect_ray"> + <return type="Dictionary"> </return> - <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> + <argument index="0" name="from" type="Vector3"> </argument> - <argument index="1" name="max_results" type="int" default="32"> + <argument index="1" name="to" type="Vector3"> + </argument> + <argument index="2" name="exclude" type="Array" default="Array()"> + </argument> + <argument index="3" name="layer_mask" type="int" default="2147483647"> + </argument> + <argument index="4" name="type_mask" type="int" default="15"> </argument> <description> </description> </method> - <method name="get_rest_info"> - <return type="Dictionary"> + <method name="intersect_shape"> + <return type="Array"> </return> <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> </argument> + <argument index="1" name="max_results" type="int" default="32"> + </argument> <description> </description> </method> @@ -27235,16 +27305,16 @@ This method controls whether the position between two cached points is interpola <constants> <constant name="TYPE_MASK_STATIC_BODY" value="1"> </constant> + <constant name="TYPE_MASK_COLLISION" value="15"> + </constant> + <constant name="TYPE_MASK_AREA" value="16"> + </constant> <constant name="TYPE_MASK_KINEMATIC_BODY" value="2"> </constant> <constant name="TYPE_MASK_RIGID_BODY" value="4"> </constant> <constant name="TYPE_MASK_CHARACTER_BODY" value="8"> </constant> - <constant name="TYPE_MASK_AREA" value="16"> - </constant> - <constant name="TYPE_MASK_COLLISION" value="15"> - </constant> </constants> </class> <class name="PhysicsServer" inherits="Object" category="Core"> @@ -27253,117 +27323,63 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="shape_create"> - <return type="RID"> - </return> - <argument index="0" name="type" type="int"> - </argument> - <description> - </description> - </method> - <method name="shape_set_data"> - <argument index="0" name="shape" type="RID"> - </argument> - <argument index="1" name="data" type="Variant"> + <method name="area_add_shape"> + <argument index="0" name="area" type="RID"> </argument> - <description> - </description> - </method> - <method name="shape_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="shape" type="RID"> + <argument index="1" name="shape" type="RID"> </argument> - <description> - </description> - </method> - <method name="shape_get_data" qualifiers="const"> - <argument index="0" name="shape" type="RID"> + <argument index="2" name="transform" type="Transform" default="Transform()"> </argument> <description> </description> </method> - <method name="space_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="space_set_active"> - <argument index="0" name="space" type="RID"> - </argument> - <argument index="1" name="active" type="bool"> + <method name="area_attach_object_instance_ID"> + <argument index="0" name="area" type="RID"> </argument> - <description> - </description> - </method> - <method name="space_is_active" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="space" type="RID"> + <argument index="1" name="id" type="int"> </argument> <description> </description> </method> - <method name="space_set_param"> - <argument index="0" name="space" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="float"> + <method name="area_clear_shapes"> + <argument index="0" name="area" type="RID"> </argument> <description> </description> </method> - <method name="space_get_param" qualifiers="const"> - <return type="float"> + <method name="area_create"> + <return type="RID"> </return> - <argument index="0" name="space" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> <description> </description> </method> - <method name="space_get_direct_state"> - <return type="PhysicsDirectSpaceState"> + <method name="area_get_object_instance_ID" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="space" type="RID"> + <argument index="0" name="area" type="RID"> </argument> <description> </description> </method> - <method name="area_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="area_set_space"> + <method name="area_get_param" qualifiers="const"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="space" type="RID"> + <argument index="1" name="param" type="int"> </argument> <description> </description> </method> - <method name="area_get_space" qualifiers="const"> + <method name="area_get_shape" qualifiers="const"> <return type="RID"> </return> <argument index="0" name="area" type="RID"> </argument> - <description> - </description> - </method> - <method name="area_set_space_override_mode"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="mode" type="int"> + <argument index="1" name="shape_idx" type="int"> </argument> <description> </description> </method> - <method name="area_get_space_override_mode" qualifiers="const"> + <method name="area_get_shape_count" qualifiers="const"> <return type="int"> </return> <argument index="0" name="area" type="RID"> @@ -27371,37 +27387,25 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="area_add_shape"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="shape" type="RID"> - </argument> - <argument index="2" name="transform" type="Transform" default="Transform()"> - </argument> - <description> - </description> - </method> - <method name="area_set_shape"> + <method name="area_get_shape_transform" qualifiers="const"> + <return type="Transform"> + </return> <argument index="0" name="area" type="RID"> </argument> <argument index="1" name="shape_idx" type="int"> </argument> - <argument index="2" name="shape" type="RID"> - </argument> <description> </description> </method> - <method name="area_set_shape_transform"> + <method name="area_get_space" qualifiers="const"> + <return type="RID"> + </return> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <argument index="2" name="transform" type="Transform"> - </argument> <description> </description> </method> - <method name="area_get_shape_count" qualifiers="const"> + <method name="area_get_space_override_mode" qualifiers="const"> <return type="int"> </return> <argument index="0" name="area" type="RID"> @@ -27409,23 +27413,19 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="area_get_shape" qualifiers="const"> - <return type="RID"> + <method name="area_get_transform" qualifiers="const"> + <return type="Transform"> </return> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> <description> </description> </method> - <method name="area_get_shape_transform" qualifiers="const"> - <return type="Transform"> + <method name="area_is_ray_pickable" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> <description> </description> </method> @@ -27437,9 +27437,11 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="area_clear_shapes"> + <method name="area_set_collision_mask"> <argument index="0" name="area" type="RID"> </argument> + <argument index="1" name="mask" type="int"> + </argument> <description> </description> </method> @@ -27451,10 +27453,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="area_set_collision_mask"> + <method name="area_set_monitor_callback"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="mask" type="int"> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> </argument> <description> </description> @@ -27469,141 +27473,129 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="area_set_transform"> + <method name="area_set_ray_pickable"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="transform" type="Transform"> + <argument index="1" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="area_get_param" qualifiers="const"> + <method name="area_set_shape"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="param" type="int"> + <argument index="1" name="shape_idx" type="int"> </argument> - <description> - </description> - </method> - <method name="area_get_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="area" type="RID"> + <argument index="2" name="shape" type="RID"> </argument> <description> </description> </method> - <method name="area_attach_object_instance_ID"> + <method name="area_set_shape_transform"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="shape_idx" type="int"> </argument> - <description> - </description> - </method> - <method name="area_get_object_instance_ID" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="area" type="RID"> + <argument index="2" name="transform" type="Transform"> </argument> <description> </description> </method> - <method name="area_set_monitor_callback"> + <method name="area_set_space"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="receiver" type="Object"> - </argument> - <argument index="2" name="method" type="String"> + <argument index="1" name="space" type="RID"> </argument> <description> </description> </method> - <method name="area_set_ray_pickable"> + <method name="area_set_space_override_mode"> <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="enable" type="bool"> + <argument index="1" name="mode" type="int"> </argument> <description> </description> </method> - <method name="area_is_ray_pickable" qualifiers="const"> - <return type="bool"> - </return> + <method name="area_set_transform"> <argument index="0" name="area" type="RID"> </argument> + <argument index="1" name="transform" type="Transform"> + </argument> <description> </description> </method> - <method name="body_create"> - <return type="RID"> - </return> - <argument index="0" name="mode" type="int" default="2"> + <method name="body_add_collision_exception"> + <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="init_sleeping" type="bool" default="false"> + <argument index="1" name="excepted_body" type="RID"> </argument> <description> </description> </method> - <method name="body_set_space"> + <method name="body_add_shape"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="space" type="RID"> + <argument index="1" name="shape" type="RID"> + </argument> + <argument index="2" name="transform" type="Transform" default="Transform()"> </argument> <description> </description> </method> - <method name="body_get_space" qualifiers="const"> - <return type="RID"> - </return> + <method name="body_apply_impulse"> <argument index="0" name="body" type="RID"> </argument> + <argument index="1" name="pos" type="Vector3"> + </argument> + <argument index="2" name="impulse" type="Vector3"> + </argument> <description> </description> </method> - <method name="body_set_mode"> + <method name="body_attach_object_instance_ID"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="mode" type="int"> + <argument index="1" name="id" type="int"> </argument> <description> </description> </method> - <method name="body_get_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="body_clear_shapes"> <argument index="0" name="body" type="RID"> </argument> <description> </description> </method> - <method name="body_set_layer_mask"> - <argument index="0" name="body" type="RID"> + <method name="body_create"> + <return type="RID"> + </return> + <argument index="0" name="mode" type="int" default="2"> </argument> - <argument index="1" name="mask" type="int"> + <argument index="1" name="init_sleeping" type="bool" default="false"> </argument> <description> </description> </method> - <method name="body_get_layer_mask" qualifiers="const"> + <method name="body_get_axis_lock" qualifiers="const"> <return type="int"> </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> - <method name="body_set_collision_mask"> + <method name="body_get_collision_mask" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="mask" type="int"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="body_get_collision_mask" qualifiers="const"> + <method name="body_get_layer_mask" qualifiers="const"> <return type="int"> </return> <argument index="0" name="body" type="RID"> @@ -27613,41 +27605,37 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="body_add_shape"> + <method name="body_get_max_contacts_reported" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="shape" type="RID"> - </argument> - <argument index="2" name="transform" type="Transform" default="Transform()"> - </argument> <description> </description> </method> - <method name="body_set_shape"> + <method name="body_get_mode" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <argument index="2" name="shape" type="RID"> - </argument> <description> </description> </method> - <method name="body_set_shape_transform"> + <method name="body_get_object_instance_ID" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <argument index="2" name="transform" type="Transform"> - </argument> <description> </description> </method> - <method name="body_get_shape_count" qualifiers="const"> - <return type="int"> + <method name="body_get_param" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="body" type="RID"> </argument> + <argument index="1" name="param" type="int"> + </argument> <description> </description> </method> @@ -27661,17 +27649,17 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="body_get_shape_transform" qualifiers="const"> - <return type="Transform"> + <method name="body_get_shape_count" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> <description> </description> </method> - <method name="body_remove_shape"> + <method name="body_get_shape_transform" qualifiers="const"> + <return type="Transform"> + </return> <argument index="0" name="body" type="RID"> </argument> <argument index="1" name="shape_idx" type="int"> @@ -27679,37 +27667,39 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="body_clear_shapes"> + <method name="body_get_space" qualifiers="const"> + <return type="RID"> + </return> <argument index="0" name="body" type="RID"> </argument> <description> </description> </method> - <method name="body_attach_object_instance_ID"> + <method name="body_get_state" qualifiers="const"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="state" type="int"> </argument> <description> </description> </method> - <method name="body_get_object_instance_ID" qualifiers="const"> - <return type="int"> + <method name="body_is_continuous_collision_detection_enabled" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="body" type="RID"> </argument> <description> </description> </method> - <method name="body_set_enable_continuous_collision_detection"> + <method name="body_is_omitting_force_integration" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="enable" type="bool"> - </argument> <description> </description> </method> - <method name="body_is_continuous_collision_detection_enabled" qualifiers="const"> + <method name="body_is_ray_pickable" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="body" type="RID"> @@ -27717,111 +27707,109 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="body_set_param"> + <method name="body_remove_collision_exception"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="float"> + <argument index="1" name="excepted_body" type="RID"> </argument> <description> </description> </method> - <method name="body_get_param" qualifiers="const"> - <return type="float"> - </return> + <method name="body_remove_shape"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="param" type="int"> + <argument index="1" name="shape_idx" type="int"> </argument> <description> </description> </method> - <method name="body_set_state"> + <method name="body_set_axis_lock"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="state" type="int"> - </argument> - <argument index="2" name="value" type="Variant"> + <argument index="1" name="axis" type="int"> </argument> <description> </description> </method> - <method name="body_get_state" qualifiers="const"> + <method name="body_set_axis_velocity"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="state" type="int"> + <argument index="1" name="axis_velocity" type="Vector3"> </argument> <description> </description> </method> - <method name="body_apply_impulse"> + <method name="body_set_collision_mask"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="pos" type="Vector3"> - </argument> - <argument index="2" name="impulse" type="Vector3"> + <argument index="1" name="mask" type="int"> </argument> <description> </description> </method> - <method name="body_set_axis_velocity"> + <method name="body_set_enable_continuous_collision_detection"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="axis_velocity" type="Vector3"> + <argument index="1" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="body_set_axis_lock"> + <method name="body_set_force_integration_callback"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="axis" type="int"> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <argument index="3" name="userdata" type="Variant" default="NULL"> </argument> <description> </description> </method> - <method name="body_get_axis_lock" qualifiers="const"> - <return type="int"> - </return> + <method name="body_set_layer_mask"> <argument index="0" name="body" type="RID"> </argument> + <argument index="1" name="mask" type="int"> + </argument> <description> </description> </method> - <method name="body_add_collision_exception"> + <method name="body_set_max_contacts_reported"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="excepted_body" type="RID"> + <argument index="1" name="amount" type="int"> </argument> <description> </description> </method> - <method name="body_remove_collision_exception"> + <method name="body_set_mode"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="excepted_body" type="RID"> + <argument index="1" name="mode" type="int"> </argument> <description> </description> </method> - <method name="body_set_max_contacts_reported"> + <method name="body_set_omit_force_integration"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="amount" type="int"> + <argument index="1" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="body_get_max_contacts_reported" qualifiers="const"> - <return type="int"> - </return> + <method name="body_set_param"> <argument index="0" name="body" type="RID"> </argument> + <argument index="1" name="param" type="int"> + </argument> + <argument index="2" name="value" type="float"> + </argument> <description> </description> </method> - <method name="body_set_omit_force_integration"> + <method name="body_set_ray_pickable"> <argument index="0" name="body" type="RID"> </argument> <argument index="1" name="enable" type="bool"> @@ -27829,57 +27817,55 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="body_is_omitting_force_integration" qualifiers="const"> - <return type="bool"> - </return> + <method name="body_set_shape"> <argument index="0" name="body" type="RID"> </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="shape" type="RID"> + </argument> <description> </description> </method> - <method name="body_set_force_integration_callback"> + <method name="body_set_shape_transform"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="receiver" type="Object"> - </argument> - <argument index="2" name="method" type="String"> + <argument index="1" name="shape_idx" type="int"> </argument> - <argument index="3" name="userdata" type="Variant" default="NULL"> + <argument index="2" name="transform" type="Transform"> </argument> <description> </description> </method> - <method name="body_set_ray_pickable"> + <method name="body_set_space"> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="enable" type="bool"> + <argument index="1" name="space" type="RID"> </argument> <description> </description> </method> - <method name="body_is_ray_pickable" qualifiers="const"> - <return type="bool"> - </return> + <method name="body_set_state"> <argument index="0" name="body" type="RID"> </argument> + <argument index="1" name="state" type="int"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> <description> </description> </method> - <method name="joint_create_pin"> - <return type="RID"> + <method name="cone_twist_joint_get_param" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="body_A" type="RID"> - </argument> - <argument index="1" name="local_A" type="Vector3"> - </argument> - <argument index="2" name="body_B" type="RID"> + <argument index="0" name="joint" type="RID"> </argument> - <argument index="3" name="local_B" type="Vector3"> + <argument index="1" name="param" type="int"> </argument> <description> </description> </method> - <method name="pin_joint_set_param"> + <method name="cone_twist_joint_set_param"> <argument index="0" name="joint" type="RID"> </argument> <argument index="1" name="param" type="int"> @@ -27889,68 +27875,74 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="pin_joint_get_param" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="joint" type="RID"> - </argument> - <argument index="1" name="param" type="int"> + <method name="free_rid"> + <argument index="0" name="rid" type="RID"> </argument> <description> </description> </method> - <method name="pin_joint_set_local_A"> + <method name="generic_6dof_joint_get_flag"> + <return type="bool"> + </return> <argument index="0" name="joint" type="RID"> </argument> - <argument index="1" name="local_A" type="Vector3"> + <argument index="1" name="axis" type="int"> + </argument> + <argument index="2" name="flag" type="int"> </argument> <description> </description> </method> - <method name="pin_joint_get_local_A" qualifiers="const"> - <return type="Vector3"> + <method name="generic_6dof_joint_get_param"> + <return type="float"> </return> <argument index="0" name="joint" type="RID"> </argument> + <argument index="1" name="axis" type="int"> + </argument> + <argument index="2" name="param" type="int"> + </argument> <description> </description> </method> - <method name="pin_joint_set_local_B"> + <method name="generic_6dof_joint_set_flag"> <argument index="0" name="joint" type="RID"> </argument> - <argument index="1" name="local_B" type="Vector3"> + <argument index="1" name="axis" type="int"> + </argument> + <argument index="2" name="flag" type="int"> + </argument> + <argument index="3" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="pin_joint_get_local_B" qualifiers="const"> - <return type="Vector3"> - </return> + <method name="generic_6dof_joint_set_param"> <argument index="0" name="joint" type="RID"> </argument> + <argument index="1" name="axis" type="int"> + </argument> + <argument index="2" name="param" type="int"> + </argument> + <argument index="3" name="value" type="float"> + </argument> <description> </description> </method> - <method name="joint_create_hinge"> - <return type="RID"> + <method name="get_process_info"> + <return type="int"> </return> - <argument index="0" name="body_A" type="RID"> - </argument> - <argument index="1" name="hinge_A" type="Transform"> - </argument> - <argument index="2" name="body_B" type="RID"> - </argument> - <argument index="3" name="hinge_B" type="Transform"> + <argument index="0" name="process_info" type="int"> </argument> <description> </description> </method> - <method name="hinge_joint_set_param"> + <method name="hinge_joint_get_flag" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="joint" type="RID"> </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="float"> + <argument index="1" name="flag" type="int"> </argument> <description> </description> @@ -27975,17 +27967,17 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="hinge_joint_get_flag" qualifiers="const"> - <return type="bool"> - </return> + <method name="hinge_joint_set_param"> <argument index="0" name="joint" type="RID"> </argument> - <argument index="1" name="flag" type="int"> + <argument index="1" name="param" type="int"> + </argument> + <argument index="2" name="value" type="float"> </argument> <description> </description> </method> - <method name="joint_create_slider"> + <method name="joint_create_cone_twist"> <return type="RID"> </return> <argument index="0" name="body_A" type="RID"> @@ -27999,57 +27991,67 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="slider_joint_set_param"> - <argument index="0" name="joint" type="RID"> + <method name="joint_create_generic_6dof"> + <return type="RID"> + </return> + <argument index="0" name="body_A" type="RID"> </argument> - <argument index="1" name="param" type="int"> + <argument index="1" name="local_ref_A" type="Transform"> </argument> - <argument index="2" name="value" type="float"> + <argument index="2" name="body_B" type="RID"> + </argument> + <argument index="3" name="local_ref_B" type="Transform"> </argument> <description> </description> </method> - <method name="slider_joint_get_param" qualifiers="const"> - <return type="float"> + <method name="joint_create_hinge"> + <return type="RID"> </return> - <argument index="0" name="joint" type="RID"> + <argument index="0" name="body_A" type="RID"> </argument> - <argument index="1" name="param" type="int"> + <argument index="1" name="hinge_A" type="Transform"> + </argument> + <argument index="2" name="body_B" type="RID"> + </argument> + <argument index="3" name="hinge_B" type="Transform"> </argument> <description> </description> </method> - <method name="joint_create_cone_twist"> + <method name="joint_create_pin"> <return type="RID"> </return> <argument index="0" name="body_A" type="RID"> </argument> - <argument index="1" name="local_ref_A" type="Transform"> + <argument index="1" name="local_A" type="Vector3"> </argument> <argument index="2" name="body_B" type="RID"> </argument> - <argument index="3" name="local_ref_B" type="Transform"> + <argument index="3" name="local_B" type="Vector3"> </argument> <description> </description> </method> - <method name="cone_twist_joint_set_param"> - <argument index="0" name="joint" type="RID"> + <method name="joint_create_slider"> + <return type="RID"> + </return> + <argument index="0" name="body_A" type="RID"> </argument> - <argument index="1" name="param" type="int"> + <argument index="1" name="local_ref_A" type="Transform"> </argument> - <argument index="2" name="value" type="float"> + <argument index="2" name="body_B" type="RID"> + </argument> + <argument index="3" name="local_ref_B" type="Transform"> </argument> <description> </description> </method> - <method name="cone_twist_joint_get_param" qualifiers="const"> - <return type="float"> + <method name="joint_get_solver_priority" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="joint" type="RID"> </argument> - <argument index="1" name="param" type="int"> - </argument> <description> </description> </method> @@ -28069,179 +28071,232 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="joint_get_solver_priority" qualifiers="const"> - <return type="int"> + <method name="pin_joint_get_local_A" qualifiers="const"> + <return type="Vector3"> </return> <argument index="0" name="joint" type="RID"> </argument> <description> </description> </method> - <method name="joint_create_generic_6dof"> - <return type="RID"> + <method name="pin_joint_get_local_B" qualifiers="const"> + <return type="Vector3"> </return> - <argument index="0" name="body_A" type="RID"> - </argument> - <argument index="1" name="local_ref_A" type="Transform"> + <argument index="0" name="joint" type="RID"> </argument> - <argument index="2" name="body_B" type="RID"> + <description> + </description> + </method> + <method name="pin_joint_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="joint" type="RID"> </argument> - <argument index="3" name="local_ref_B" type="Transform"> + <argument index="1" name="param" type="int"> </argument> <description> </description> </method> - <method name="generic_6dof_joint_set_param"> + <method name="pin_joint_set_local_A"> <argument index="0" name="joint" type="RID"> </argument> - <argument index="1" name="axis" type="int"> + <argument index="1" name="local_A" type="Vector3"> </argument> - <argument index="2" name="param" type="int"> + <description> + </description> + </method> + <method name="pin_joint_set_local_B"> + <argument index="0" name="joint" type="RID"> </argument> - <argument index="3" name="value" type="float"> + <argument index="1" name="local_B" type="Vector3"> </argument> <description> </description> </method> - <method name="generic_6dof_joint_get_param"> - <return type="float"> - </return> + <method name="pin_joint_set_param"> <argument index="0" name="joint" type="RID"> </argument> - <argument index="1" name="axis" type="int"> + <argument index="1" name="param" type="int"> </argument> - <argument index="2" name="param" type="int"> + <argument index="2" name="value" type="float"> </argument> <description> </description> </method> - <method name="generic_6dof_joint_set_flag"> - <argument index="0" name="joint" type="RID"> + <method name="set_active"> + <argument index="0" name="active" type="bool"> </argument> - <argument index="1" name="axis" type="int"> + <description> + </description> + </method> + <method name="shape_create"> + <return type="RID"> + </return> + <argument index="0" name="type" type="int"> </argument> - <argument index="2" name="flag" type="int"> + <description> + </description> + </method> + <method name="shape_get_data" qualifiers="const"> + <argument index="0" name="shape" type="RID"> </argument> - <argument index="3" name="enable" type="bool"> + <description> + </description> + </method> + <method name="shape_get_type" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="shape" type="RID"> </argument> <description> </description> </method> - <method name="generic_6dof_joint_get_flag"> - <return type="bool"> + <method name="shape_set_data"> + <argument index="0" name="shape" type="RID"> + </argument> + <argument index="1" name="data" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="slider_joint_get_param" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="joint" type="RID"> </argument> - <argument index="1" name="axis" type="int"> + <argument index="1" name="param" type="int"> </argument> - <argument index="2" name="flag" type="int"> + <description> + </description> + </method> + <method name="slider_joint_set_param"> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int"> + </argument> + <argument index="2" name="value" type="float"> </argument> <description> </description> </method> - <method name="free_rid"> - <argument index="0" name="rid" type="RID"> + <method name="space_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="space_get_direct_state"> + <return type="PhysicsDirectSpaceState"> + </return> + <argument index="0" name="space" type="RID"> </argument> <description> </description> </method> - <method name="set_active"> - <argument index="0" name="active" type="bool"> + <method name="space_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <argument index="1" name="param" type="int"> </argument> <description> </description> </method> - <method name="get_process_info"> - <return type="int"> + <method name="space_is_active" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="process_info" type="int"> + <argument index="0" name="space" type="RID"> + </argument> + <description> + </description> + </method> + <method name="space_set_active"> + <argument index="0" name="space" type="RID"> + </argument> + <argument index="1" name="active" type="bool"> + </argument> + <description> + </description> + </method> + <method name="space_set_param"> + <argument index="0" name="space" type="RID"> + </argument> + <argument index="1" name="param" type="int"> + </argument> + <argument index="2" name="value" type="float"> </argument> <description> </description> </method> </methods> <constants> - <constant name="JOINT_PIN" value="0"> - </constant> - <constant name="JOINT_HINGE" value="1"> - </constant> - <constant name="JOINT_SLIDER" value="2"> - </constant> - <constant name="JOINT_CONE_TWIST" value="3"> - </constant> - <constant name="JOINT_6DOF" value="4"> - </constant> - <constant name="PIN_JOINT_BIAS" value="0"> - </constant> - <constant name="PIN_JOINT_DAMPING" value="1"> - </constant> - <constant name="PIN_JOINT_IMPULSE_CLAMP" value="2"> - </constant> - <constant name="HINGE_JOINT_BIAS" value="0"> - </constant> - <constant name="HINGE_JOINT_LIMIT_UPPER" value="1"> - </constant> - <constant name="HINGE_JOINT_LIMIT_LOWER" value="2"> + <constant name="AREA_BODY_ADDED" value="0"> </constant> - <constant name="HINGE_JOINT_LIMIT_BIAS" value="3"> + <constant name="AREA_PARAM_GRAVITY" value="0"> </constant> - <constant name="HINGE_JOINT_LIMIT_SOFTNESS" value="4"> + <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. </constant> - <constant name="HINGE_JOINT_LIMIT_RELAXATION" value="5"> + <constant name="AREA_BODY_REMOVED" value="1"> </constant> - <constant name="HINGE_JOINT_MOTOR_TARGET_VELOCITY" value="6"> + <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1"> </constant> - <constant name="HINGE_JOINT_MOTOR_MAX_IMPULSE" value="7"> + <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1"> + 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> - <constant name="HINGE_JOINT_FLAG_USE_LIMIT" value="0"> + <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2"> </constant> - <constant name="HINGE_JOINT_FLAG_ENABLE_MOTOR" value="1"> + <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + 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> - <constant name="SLIDER_JOINT_LINEAR_LIMIT_UPPER" value="0"> + <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3"> </constant> - <constant name="SLIDER_JOINT_LINEAR_LIMIT_LOWER" value="1"> + <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> + This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. </constant> - <constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2"> + <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4"> </constant> - <constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3"> + <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. </constant> - <constant name="SLIDER_JOINT_LINEAR_LIMIT_DAMPING" value="4"> + <constant name="AREA_PARAM_LINEAR_DAMP" value="5"> </constant> - <constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5"> + <constant name="AREA_PARAM_ANGULAR_DAMP" value="6"> </constant> - <constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6"> + <constant name="AREA_PARAM_PRIORITY" value="7"> </constant> - <constant name="SLIDER_JOINT_LINEAR_MOTION_DAMPING" value="7"> + <constant name="BODY_MODE_STATIC" value="0"> </constant> - <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8"> + <constant name="BODY_PARAM_BOUNCE" value="0"> </constant> - <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9"> + <constant name="BODY_STATE_TRANSFORM" value="0"> </constant> - <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10"> + <constant name="BODY_MODE_KINEMATIC" value="1"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11"> + <constant name="BODY_PARAM_FRICTION" value="1"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_LIMIT_LOWER" value="12"> + <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS" value="13"> + <constant name="BODY_MODE_RIGID" value="2"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION" value="14"> + <constant name="BODY_PARAM_MASS" value="2"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_LIMIT_DAMPING" value="15"> + <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS" value="16"> + <constant name="BODY_MODE_CHARACTER" value="3"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION" value="17"> + <constant name="BODY_PARAM_GRAVITY_SCALE" value="3"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_MOTION_DAMPING" value="18"> + <constant name="BODY_STATE_SLEEPING" value="3"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS" value="19"> + <constant name="BODY_PARAM_LINEAR_DAMP" value="4"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION" value="20"> + <constant name="BODY_STATE_CAN_SLEEP" value="4"> </constant> - <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING" value="21"> + <constant name="BODY_PARAM_ANGULAR_DAMP" value="5"> </constant> - <constant name="SLIDER_JOINT_MAX" value="22"> + <constant name="BODY_PARAM_MAX" value="6"> </constant> <constant name="CONE_TWIST_JOINT_SWING_SPAN" value="0"> </constant> @@ -28253,10 +28308,24 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="CONE_TWIST_JOINT_RELAXATION" value="4"> </constant> + <constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0"> + </constant> <constant name="G6DOF_JOINT_LINEAR_LOWER_LIMIT" value="0"> </constant> + <constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1"> + </constant> <constant name="G6DOF_JOINT_LINEAR_UPPER_LIMIT" value="1"> </constant> + <constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_ERP" value="11"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="13"> + </constant> + <constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2"> + </constant> <constant name="G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value="2"> </constant> <constant name="G6DOF_JOINT_LINEAR_RESTITUTION" value="3"> @@ -28273,110 +28342,111 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="9"> </constant> - <constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10"> + <constant name="HINGE_JOINT_BIAS" value="0"> </constant> - <constant name="G6DOF_JOINT_ANGULAR_ERP" value="11"> + <constant name="HINGE_JOINT_FLAG_USE_LIMIT" value="0"> </constant> - <constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12"> + <constant name="HINGE_JOINT_FLAG_ENABLE_MOTOR" value="1"> </constant> - <constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="13"> + <constant name="HINGE_JOINT_LIMIT_UPPER" value="1"> </constant> - <constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0"> + <constant name="HINGE_JOINT_LIMIT_LOWER" value="2"> </constant> - <constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1"> + <constant name="HINGE_JOINT_LIMIT_BIAS" value="3"> </constant> - <constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2"> + <constant name="HINGE_JOINT_LIMIT_SOFTNESS" value="4"> </constant> - <constant name="SHAPE_PLANE" value="0"> + <constant name="HINGE_JOINT_LIMIT_RELAXATION" value="5"> </constant> - <constant name="SHAPE_RAY" value="1"> + <constant name="HINGE_JOINT_MOTOR_TARGET_VELOCITY" value="6"> </constant> - <constant name="SHAPE_SPHERE" value="2"> + <constant name="HINGE_JOINT_MOTOR_MAX_IMPULSE" value="7"> </constant> - <constant name="SHAPE_BOX" value="3"> + <constant name="INFO_ACTIVE_OBJECTS" value="0"> </constant> - <constant name="SHAPE_CAPSULE" value="4"> + <constant name="INFO_COLLISION_PAIRS" value="1"> </constant> - <constant name="SHAPE_CONVEX_POLYGON" value="5"> + <constant name="INFO_ISLAND_COUNT" value="2"> </constant> - <constant name="SHAPE_CONCAVE_POLYGON" value="6"> + <constant name="JOINT_PIN" value="0"> </constant> - <constant name="SHAPE_HEIGHTMAP" value="7"> + <constant name="JOINT_HINGE" value="1"> </constant> - <constant name="SHAPE_CUSTOM" value="8"> + <constant name="JOINT_SLIDER" value="2"> </constant> - <constant name="AREA_PARAM_GRAVITY" value="0"> + <constant name="JOINT_CONE_TWIST" value="3"> </constant> - <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1"> + <constant name="JOINT_6DOF" value="4"> </constant> - <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2"> + <constant name="PIN_JOINT_BIAS" value="0"> </constant> - <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3"> + <constant name="PIN_JOINT_DAMPING" value="1"> </constant> - <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4"> + <constant name="PIN_JOINT_IMPULSE_CLAMP" value="2"> </constant> - <constant name="AREA_PARAM_LINEAR_DAMP" value="5"> + <constant name="SHAPE_PLANE" value="0"> </constant> - <constant name="AREA_PARAM_ANGULAR_DAMP" value="6"> + <constant name="SHAPE_RAY" value="1"> </constant> - <constant name="AREA_PARAM_PRIORITY" value="7"> + <constant name="SHAPE_SPHERE" value="2"> </constant> - <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> - This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + <constant name="SHAPE_BOX" value="3"> </constant> - <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1"> - 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 name="SHAPE_CAPSULE" value="4"> </constant> - <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> - 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 name="SHAPE_CONVEX_POLYGON" value="5"> </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> - This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + <constant name="SHAPE_CONCAVE_POLYGON" value="6"> </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> - This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. + <constant name="SHAPE_HEIGHTMAP" value="7"> </constant> - <constant name="BODY_MODE_STATIC" value="0"> + <constant name="SHAPE_CUSTOM" value="8"> </constant> - <constant name="BODY_MODE_KINEMATIC" value="1"> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_UPPER" value="0"> </constant> - <constant name="BODY_MODE_RIGID" value="2"> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_LOWER" value="1"> </constant> - <constant name="BODY_MODE_CHARACTER" value="3"> + <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10"> </constant> - <constant name="BODY_PARAM_BOUNCE" value="0"> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11"> </constant> - <constant name="BODY_PARAM_FRICTION" value="1"> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_LOWER" value="12"> </constant> - <constant name="BODY_PARAM_MASS" value="2"> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS" value="13"> </constant> - <constant name="BODY_PARAM_GRAVITY_SCALE" value="3"> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION" value="14"> </constant> - <constant name="BODY_PARAM_ANGULAR_DAMP" value="5"> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_DAMPING" value="15"> </constant> - <constant name="BODY_PARAM_LINEAR_DAMP" value="4"> + <constant name="SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS" value="16"> </constant> - <constant name="BODY_PARAM_MAX" value="6"> + <constant name="SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION" value="17"> </constant> - <constant name="BODY_STATE_TRANSFORM" value="0"> + <constant name="SLIDER_JOINT_ANGULAR_MOTION_DAMPING" value="18"> </constant> - <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> + <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS" value="19"> </constant> - <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2"> </constant> - <constant name="BODY_STATE_SLEEPING" value="3"> + <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION" value="20"> </constant> - <constant name="BODY_STATE_CAN_SLEEP" value="4"> + <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING" value="21"> </constant> - <constant name="AREA_BODY_ADDED" value="0"> + <constant name="SLIDER_JOINT_MAX" value="22"> </constant> - <constant name="AREA_BODY_REMOVED" value="1"> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3"> </constant> - <constant name="INFO_ACTIVE_OBJECTS" value="0"> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_DAMPING" value="4"> </constant> - <constant name="INFO_COLLISION_PAIRS" value="1"> + <constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5"> </constant> - <constant name="INFO_ISLAND_COUNT" value="2"> + <constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_MOTION_DAMPING" value="7"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9"> </constant> </constants> </class> @@ -28396,45 +28466,45 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_shape"> - <argument index="0" name="shape" type="Shape"> - </argument> + <method name="get_exclude" qualifiers="const"> + <return type="Array"> + </return> <description> </description> </method> - <method name="set_shape_rid"> - <argument index="0" name="shape" type="RID"> - </argument> + <method name="get_layer_mask" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_shape_rid" qualifiers="const"> - <return type="RID"> + <method name="get_margin" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="set_transform"> - <argument index="0" name="transform" type="Transform"> - </argument> + <method name="get_object_type_mask" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform"> + <method name="get_shape_rid" qualifiers="const"> + <return type="RID"> </return> <description> </description> </method> - <method name="set_margin"> - <argument index="0" name="margin" type="float"> - </argument> + <method name="get_transform" qualifiers="const"> + <return type="Transform"> + </return> <description> </description> </method> - <method name="get_margin" qualifiers="const"> - <return type="float"> - </return> + <method name="set_exclude"> + <argument index="0" name="exclude" type="Array"> + </argument> <description> </description> </method> @@ -28444,9 +28514,9 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_margin"> + <argument index="0" name="margin" type="float"> + </argument> <description> </description> </method> @@ -28456,21 +28526,21 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_object_type_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_shape"> + <argument index="0" name="shape" type="Shape"> + </argument> <description> </description> </method> - <method name="set_exclude"> - <argument index="0" name="exclude" type="Array"> + <method name="set_shape_rid"> + <argument index="0" name="shape" type="RID"> </argument> <description> </description> </method> - <method name="get_exclude" qualifiers="const"> - <return type="Array"> - </return> + <method name="set_transform"> + <argument index="0" name="transform" type="Transform"> + </argument> <description> </description> </method> @@ -28491,8 +28561,8 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_result_rid" qualifiers="const"> - <return type="RID"> + <method name="get_result_object" qualifiers="const"> + <return type="Object"> </return> <argument index="0" name="idx" type="int"> </argument> @@ -28507,16 +28577,16 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_result_object" qualifiers="const"> - <return type="Object"> + <method name="get_result_object_shape" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_result_object_shape" qualifiers="const"> - <return type="int"> + <method name="get_result_rid" qualifiers="const"> + <return type="RID"> </return> <argument index="0" name="idx" type="int"> </argument> @@ -28533,19 +28603,19 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_param"> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="param" type="int"> </argument> - <argument index="1" name="value" type="float"> - </argument> <description> </description> </method> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> + <method name="set_param"> <argument index="0" name="param" type="int"> </argument> + <argument index="1" name="value" type="float"> + </argument> <description> </description> </method> @@ -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. </description> <methods> - <method name="set_softness"> - <argument index="0" name="softness" type="float"> - </argument> - <description> - </description> - </method> <method name="get_softness" qualifiers="const"> <return type="float"> </return> <description> </description> </method> + <method name="set_softness"> + <argument index="0" name="softness" type="float"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -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. </description> <methods> + <method name="Plane"> + <return type="Plane"> + </return> + <argument index="0" name="a" type="float"> + </argument> + <argument index="1" name="b" type="float"> + </argument> + <argument index="2" name="c" type="float"> + </argument> + <argument index="3" name="d" type="float"> + </argument> + <description> + Creates a plane from the three parameters "a", "b", "c" and "d". + </description> + </method> + <method name="Plane"> + <return type="Plane"> + </return> + <argument index="0" name="v1" type="Vector3"> + </argument> + <argument index="1" name="v2" type="Vector3"> + </argument> + <argument index="2" name="v3" type="Vector3"> + </argument> + <description> + Creates a plane from three points. + </description> + </method> + <method name="Plane"> + <return type="Plane"> + </return> + <argument index="0" name="normal" type="Vector3"> + </argument> + <argument index="1" name="d" type="float"> + </argument> + <description> + Creates a plane from the normal and the plane's distance to the origin. + </description> + </method> <method name="center"> <return type="Vector3"> </return> @@ -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. </description> </method> - <method name="Plane"> - <return type="Plane"> - </return> - <argument index="0" name="a" type="float"> - </argument> - <argument index="1" name="b" type="float"> - </argument> - <argument index="2" name="c" type="float"> - </argument> - <argument index="3" name="d" type="float"> - </argument> - <description> - Creates a plane from the three parameters "a", "b", "c" and "d". - </description> - </method> - <method name="Plane"> - <return type="Plane"> - </return> - <argument index="0" name="v1" type="Vector3"> - </argument> - <argument index="1" name="v2" type="Vector3"> - </argument> - <argument index="2" name="v3" type="Vector3"> - </argument> - <description> - Creates a plane from three points. - </description> - </method> - <method name="Plane"> - <return type="Plane"> - </return> - <argument index="0" name="normal" type="Vector3"> - </argument> - <argument index="1" name="d" type="float"> - </argument> - <description> - Creates a plane from the normal and the plane's distance to the origin. - </description> - </method> </methods> <members> + <member name="d" type="float"> + </member> <member name="normal" type="Vector3"> </member> <member name="x" type="float"> @@ -28732,8 +28804,6 @@ This method controls whether the position between two cached points is interpola </member> <member name="z" type="float"> </member> - <member name="d" type="float"> - </member> </members> <constants> </constants> @@ -28744,18 +28814,18 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_plane"> - <argument index="0" name="plane" type="Plane"> - </argument> - <description> - </description> - </method> <method name="get_plane" qualifiers="const"> <return type="Plane"> </return> <description> </description> </method> + <method name="set_plane"> + <argument index="0" name="plane" type="Plane"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -28768,159 +28838,159 @@ 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. </description> <methods> - <method name="set_polygon"> - <argument index="0" name="polygon" type="Vector2Array"> - </argument> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> <description> - Define the set of vertices that will represent the polygon. + Return the polygon fill color. </description> </method> - <method name="get_polygon" qualifiers="const"> - <return type="Vector2Array"> + <method name="get_invert" qualifiers="const"> + <return type="bool"> </return> <description> - Return the set of vertices that defines this polygon. + Return whether this polygon is inverted or not. </description> </method> - <method name="set_uv"> - <argument index="0" name="uv" type="Vector2Array"> - </argument> + <method name="get_invert_border" qualifiers="const"> + <return type="float"> + </return> <description> - 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 added padding around the bounding box. </description> </method> - <method name="get_uv" qualifiers="const"> - <return type="Vector2Array"> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> </return> <description> - Return the texture coordinates associated with every vertex of the polygon. + Return the offset for the polygon vertices. </description> </method> - <method name="set_color"> - <argument index="0" name="color" type="Color"> - </argument> + <method name="get_polygon" qualifiers="const"> + <return type="Vector2Array"> + </return> <description> - 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]. + Return the set of vertices that defines this polygon. </description> </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> + <method name="get_texture" qualifiers="const"> + <return type="Object"> </return> <description> - Return the polygon fill color. + Return the polygon texture </description> </method> - <method name="set_vertex_colors"> - <argument index="0" name="vertex_colors" type="ColorArray"> - </argument> + <method name="get_texture_offset" qualifiers="const"> + <return type="Vector2"> + </return> <description> - 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 polygon texture offset. </description> </method> - <method name="get_vertex_colors" qualifiers="const"> - <return type="ColorArray"> + <method name="get_texture_rotation" qualifiers="const"> + <return type="float"> </return> <description> - Return the list of vertex colors. + Return the rotation in radians of the texture polygon. </description> </method> - <method name="set_texture"> - <argument index="0" name="texture" type="Object"> - </argument> + <method name="get_texture_scale" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Set the polygon texture. + Return the uv coordinate multiplier. </description> </method> - <method name="get_texture" qualifiers="const"> - <return type="Object"> + <method name="get_uv" qualifiers="const"> + <return type="Vector2Array"> </return> <description> - Return the polygon texture + Return the texture coordinates associated with every vertex of the polygon. </description> </method> - <method name="set_texture_offset"> - <argument index="0" name="texture_offset" type="Vector2"> - </argument> + <method name="get_vertex_colors" qualifiers="const"> + <return type="ColorArray"> + </return> <description> - 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 list of vertex colors. </description> </method> - <method name="get_texture_offset" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_color"> + <argument index="0" name="color" type="Color"> + </argument> <description> - Return the polygon texture offset. + 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]. </description> </method> - <method name="set_texture_rotation"> - <argument index="0" name="texture_rotation" type="float"> + <method name="set_invert"> + <argument index="0" name="invert" type="bool"> </argument> <description> - Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation. + 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). </description> </method> - <method name="get_texture_rotation" qualifiers="const"> - <return type="float"> - </return> + <method name="set_invert_border"> + <argument index="0" name="invert_border" type="float"> + </argument> <description> - Return the rotation in radians of the texture 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. </description> </method> - <method name="set_texture_scale"> - <argument index="0" name="texture_scale" type="Vector2"> + <method name="set_offset"> + <argument index="0" name="offset" type="Vector2"> </argument> <description> - 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 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. </description> </method> - <method name="get_texture_scale" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_polygon"> + <argument index="0" name="polygon" type="Vector2Array"> + </argument> <description> - Return the uv coordinate multiplier. + Define the set of vertices that will represent the polygon. </description> </method> - <method name="set_invert"> - <argument index="0" name="invert" type="bool"> + <method name="set_texture"> + <argument index="0" name="texture" type="Object"> </argument> <description> - 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). + Set the polygon texture. </description> </method> - <method name="get_invert" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_texture_offset"> + <argument index="0" name="texture_offset" type="Vector2"> + </argument> <description> - Return whether this polygon is inverted or not. + 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. </description> </method> - <method name="set_invert_border"> - <argument index="0" name="invert_border" type="float"> + <method name="set_texture_rotation"> + <argument index="0" name="texture_rotation" type="float"> </argument> <description> - Add extra padding around the bounding box, making it bigger. Too small a value can make the polygon triangulate strangely, due to numerical imprecision. + Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation. </description> </method> - <method name="get_invert_border" qualifiers="const"> - <return type="float"> - </return> + <method name="set_texture_scale"> + <argument index="0" name="texture_scale" type="Vector2"> + </argument> <description> - Return the added padding around the bounding box. + 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. </description> </method> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> + <method name="set_uv"> + <argument index="0" name="uv" type="Vector2Array"> </argument> <description> - 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. + 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. </description> </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_vertex_colors"> + <argument index="0" name="vertex_colors" type="ColorArray"> + </argument> <description> - Return the offset for the polygon vertices. + 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. </description> </method> </methods> @@ -28933,14 +29003,6 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="setup"> - <argument index="0" name="points" type="Vector2Array"> - </argument> - <argument index="1" name="connections" type="IntArray"> - </argument> - <description> - </description> - </method> <method name="find_path"> <return type="Vector2Array"> </return> @@ -28951,6 +29013,20 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="get_bounds" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="get_closest_point" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="get_intersections" qualifiers="const"> <return type="Vector2Array"> </return> @@ -28961,10 +29037,10 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_closest_point" qualifiers="const"> - <return type="Vector2"> + <method name="get_point_penalty" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="point" type="Vector2"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -28985,17 +29061,11 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_point_penalty" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="idx" type="int"> + <method name="setup"> + <argument index="0" name="points" type="Vector2Array"> + </argument> + <argument index="1" name="connections" type="IntArray"> </argument> - <description> - </description> - </method> - <method name="get_bounds" qualifiers="const"> - <return type="Rect2"> - </return> <description> </description> </method> @@ -29011,18 +29081,23 @@ 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. </description> <methods> - <method name="popup_centered"> - <argument index="0" name="size" type="Vector2" default="Vector2(0,0)"> - </argument> + <method name="is_exclusive" qualifiers="const"> + <return type="bool"> + </return> <description> - Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". + Returns whether the popup will hide other popups when shown on the screen. </description> </method> - <method name="popup_centered_ratio"> - <argument index="0" name="ratio" type="float" default="0.75"> + <method name="popup"> + <description> + Popup (show the control in modal form). + </description> + </method> + <method name="popup_centered"> + <argument index="0" name="size" type="Vector2" default="Vector2(0,0)"> </argument> <description> - Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen. + Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". </description> </method> <method name="popup_centered_minsize"> @@ -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]. </description> </method> - <method name="popup"> + <method name="popup_centered_ratio"> + <argument index="0" name="ratio" type="float" default="0.75"> + </argument> <description> - 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. </description> </method> <method name="set_exclusive"> @@ -29044,23 +29121,16 @@ This method controls whether the position between two cached points is interpola Make the popup hide other popups when shown on the screen. </description> </method> - <method name="is_exclusive" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether the popup will hide other popups when shown on the screen. - </description> - </method> </methods> <signals> - <signal name="popup_hide"> + <signal name="about_to_show"> <description> - 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). </description> </signal> - <signal name="about_to_show"> + <signal name="popup_hide"> <description> - 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. </description> </signal> </signals> @@ -29093,28 +29163,23 @@ 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. </description> <methods> - <method name="add_icon_item"> - <argument index="0" name="texture" type="Object"> - </argument> - <argument index="1" name="label" type="String"> + <method name="add_check_item"> + <argument index="0" name="label" type="String"> </argument> - <argument index="2" name="id" type="int" default="-1"> + <argument index="1" name="id" type="int" default="-1"> </argument> - <argument index="3" name="accel" type="int" default="0"> + <argument index="2" name="accel" type="int" default="0"> </argument> <description> - 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. + 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. </description> </method> - <method name="add_item"> - <argument index="0" name="label" type="String"> + <method name="add_check_shortcut"> + <argument index="0" name="shortcut" type="ShortCut"> </argument> <argument index="1" name="id" type="int" default="-1"> </argument> - <argument index="2" name="accel" type="int" default="0"> - </argument> <description> - 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. </description> </method> <method name="add_icon_check_item"> @@ -29130,26 +29195,27 @@ 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. </description> </method> - <method name="add_check_item"> - <argument index="0" name="label" type="String"> + <method name="add_icon_check_shortcut"> + <argument index="0" name="texture" type="Object"> </argument> - <argument index="1" name="id" type="int" default="-1"> + <argument index="1" name="shortcut" type="ShortCut"> </argument> - <argument index="2" name="accel" type="int" default="0"> + <argument index="2" name="id" type="int" default="-1"> </argument> <description> - 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. </description> </method> - <method name="add_submenu_item"> - <argument index="0" name="label" type="String"> + <method name="add_icon_item"> + <argument index="0" name="texture" type="Object"> </argument> - <argument index="1" name="submenu" type="String"> + <argument index="1" name="label" type="String"> </argument> <argument index="2" name="id" type="int" default="-1"> </argument> + <argument index="3" name="accel" type="int" default="0"> + </argument> <description> - 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. + 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. </description> </method> <method name="add_icon_shortcut"> @@ -29162,25 +29228,23 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="add_shortcut"> - <argument index="0" name="shortcut" type="ShortCut"> + <method name="add_item"> + <argument index="0" name="label" type="String"> </argument> <argument index="1" name="id" type="int" default="-1"> </argument> + <argument index="2" name="accel" type="int" default="0"> + </argument> <description> + 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. </description> </method> - <method name="add_icon_check_shortcut"> - <argument index="0" name="texture" type="Object"> - </argument> - <argument index="1" name="shortcut" type="ShortCut"> - </argument> - <argument index="2" name="id" type="int" default="-1"> - </argument> + <method name="add_separator"> <description> + Add a separator between items. Separators also occupy an index. </description> </method> - <method name="add_check_shortcut"> + <method name="add_shortcut"> <argument index="0" name="shortcut" type="ShortCut"> </argument> <argument index="1" name="id" type="int" default="-1"> @@ -29188,102 +29252,87 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_item_text"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="text" type="String"> + <method name="add_submenu_item"> + <argument index="0" name="label" type="String"> </argument> - <description> - Set the text of the item at index "idx". - </description> - </method> - <method name="set_item_icon"> - <argument index="0" name="idx" type="int"> + <argument index="1" name="submenu" type="String"> </argument> - <argument index="1" name="icon" type="Object"> + <argument index="2" name="id" type="int" default="-1"> </argument> <description> - Set the icon of the item at index "idx". + 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. </description> </method> - <method name="set_item_accelerator"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="accel" type="int"> - </argument> + <method name="clear"> <description> - 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. + Clear the popup menu, in effect removing all items. </description> </method> - <method name="set_item_metadata"> + <method name="get_item_ID" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="metadata" type="Variant"> - </argument> <description> - 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. + Return the id of the item at index "idx". </description> </method> - <method name="set_item_checked"> + <method name="get_item_accelerator" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="checked" type="bool"> - </argument> <description> - Set the checkstate status 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. </description> </method> - <method name="set_item_disabled"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="disabled" type="bool"> - </argument> + <method name="get_item_count" qualifiers="const"> + <return type="int"> + </return> <description> - Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked. + Return the amount of items. </description> </method> - <method name="set_item_shortcut"> + <method name="get_item_icon" qualifiers="const"> + <return type="Object"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="shortcut" type="ShortCut"> - </argument> <description> + Return the icon of the item at index "idx". </description> </method> - <method name="set_item_submenu"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="submenu" type="String"> + <method name="get_item_index" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="id" type="int"> </argument> <description> - 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. + Find and return the index of the item containing a given id. </description> </method> - <method name="set_item_as_separator"> + <method name="get_item_metadata" qualifiers="const"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="enable" type="bool"> - </argument> <description> - Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line. + 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. </description> </method> - <method name="set_item_as_checkable"> + <method name="get_item_shortcut" qualifiers="const"> + <return type="ShortCut"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="enable" type="bool"> - </argument> <description> - 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. </description> </method> - <method name="set_item_ID"> + <method name="get_item_submenu" qualifiers="const"> + <return type="String"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="id" type="int"> - </argument> <description> - Set the id of the item at index "idx". + Return the submenu name of the item at index "idx". </description> </method> <method name="get_item_text" qualifiers="const"> @@ -29295,124 +29344,145 @@ This method controls whether the position between two cached points is interpola Return the text of the item at index "idx". </description> </method> - <method name="get_item_icon" qualifiers="const"> - <return type="Object"> + <method name="is_item_checkable" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - Return the icon of the item at index "idx". + Return 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. </description> </method> - <method name="get_item_metadata" qualifiers="const"> + <method name="is_item_checked" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="idx" type="int"> </argument> <description> - 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 checkstate status of the item at index "idx". </description> </method> - <method name="get_item_accelerator" qualifiers="const"> - <return type="int"> + <method name="is_item_disabled" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="idx" type="int"> </argument> <description> - 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 whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. </description> </method> - <method name="get_item_shortcut" qualifiers="const"> - <return type="ShortCut"> + <method name="is_item_separator" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="idx" type="int"> </argument> <description> + Return whether the item is a seperator. If it is, it would be displayed as a line. </description> </method> - <method name="get_item_submenu" qualifiers="const"> - <return type="String"> - </return> + <method name="remove_item"> <argument index="0" name="idx" type="int"> </argument> <description> - Return the submenu name of the item at index "idx". + 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. </description> </method> - <method name="is_item_separator" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_item_ID"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="id" type="int"> + </argument> <description> - Return whether the item is a seperator. If it is, it would be displayed as a line. + Set the id of the item at index "idx". </description> </method> - <method name="is_item_checkable" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_item_accelerator"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="accel" type="int"> + </argument> <description> - Return 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 accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. </description> </method> - <method name="is_item_checked" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_item_as_checkable"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="enable" type="bool"> + </argument> <description> - Return the checkstate status of the item at index "idx". + 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. </description> </method> - <method name="is_item_disabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_item_as_separator"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="enable" type="bool"> + </argument> <description> - Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. + Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line. </description> </method> - <method name="get_item_ID" qualifiers="const"> - <return type="int"> - </return> + <method name="set_item_checked"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="checked" type="bool"> + </argument> <description> - Return the id of the item at index "idx". + Set the checkstate status of the item at index "idx". </description> </method> - <method name="get_item_index" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="id" type="int"> + <method name="set_item_disabled"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> </argument> <description> - Find and return the index of the item containing a given id. + Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked. </description> </method> - <method name="get_item_count" qualifiers="const"> - <return type="int"> - </return> + <method name="set_item_icon"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="icon" type="Object"> + </argument> <description> - Return the amount of items. + Set the icon of the item at index "idx". </description> </method> - <method name="add_separator"> + <method name="set_item_metadata"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="metadata" type="Variant"> + </argument> <description> - Add a separator between items. Separators also occupy an index. + 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. </description> </method> - <method name="remove_item"> + <method name="set_item_shortcut"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="shortcut" type="ShortCut"> + </argument> <description> - 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. </description> </method> - <method name="clear"> + <method name="set_item_submenu"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="submenu" type="String"> + </argument> <description> - Clear the popup menu, in effect removing all 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. + </description> + </method> + <method name="set_item_text"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="text" type="String"> + </argument> + <description> + Set the text of the item at index "idx". </description> </method> </methods> @@ -29428,33 +29498,33 @@ This method controls whether the position between two cached points is interpola <constants> </constants> <theme_items> - <theme_item name="vseparation" type="int"> + <theme_item name="checked" type="Texture"> </theme_item> - <theme_item name="hseparation" type="int"> + <theme_item name="font" type="Font"> </theme_item> - <theme_item name="font_color_disabled" type="Color"> + <theme_item name="font_color" type="Color"> </theme_item> <theme_item name="font_color_accel" type="Color"> </theme_item> - <theme_item name="font_color" type="Color"> + <theme_item name="font_color_disabled" type="Color"> </theme_item> <theme_item name="font_color_hover" type="Color"> </theme_item> - <theme_item name="submenu" type="Texture"> + <theme_item name="hover" type="StyleBox"> </theme_item> - <theme_item name="checked" type="Texture"> + <theme_item name="hseparation" type="int"> </theme_item> - <theme_item name="unchecked" type="Texture"> + <theme_item name="panel" type="StyleBox"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="panel_disabled" type="StyleBox"> </theme_item> - <theme_item name="hover" type="StyleBox"> + <theme_item name="separator" type="StyleBox"> </theme_item> - <theme_item name="panel_disabled" type="StyleBox"> + <theme_item name="submenu" type="Texture"> </theme_item> - <theme_item name="panel" type="StyleBox"> + <theme_item name="unchecked" type="Texture"> </theme_item> - <theme_item name="separator" type="StyleBox"> + <theme_item name="vseparation" type="int"> </theme_item> </theme_items> </class> @@ -29482,25 +29552,32 @@ 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. </description> <methods> - <method name="set_shape"> - <argument index="0" name="points" type="Vector2Array"> - </argument> + <method name="get_connect_range" qualifiers="const"> + <return type="float"> + </return> <description> - Set the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane. + Return the range for auto-connecting two portals from different rooms sharing the same space. </description> </method> - <method name="get_shape" qualifiers="const"> - <return type="Vector2Array"> + <method name="get_disable_distance" qualifiers="const"> + <return type="float"> </return> <description> - Return the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane. + 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]). </description> </method> - <method name="set_enabled"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_disabled_color" qualifiers="const"> + <return type="Color"> + </return> <description> - 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 the color for when the portal goes beyond the disable distance (see [method set_disable_distance]) and becomes disabled. + </description> + </method> + <method name="get_shape" qualifiers="const"> + <return type="Vector2Array"> + </return> + <description> + Return the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane. </description> </method> <method name="is_enabled" qualifiers="const"> @@ -29510,18 +29587,18 @@ This method controls whether the position between two cached points is interpola Return whether the portal is active. When disabled it causes the parent [VisualInstance] to not be visible any longer when looking through the portal. </description> </method> - <method name="set_disable_distance"> - <argument index="0" name="distance" type="float"> + <method name="set_connect_range"> + <argument index="0" name="range" type="float"> </argument> <description> - 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]). + Set the range for auto-connecting two portals from different rooms sharing the same space. </description> </method> - <method name="get_disable_distance" qualifiers="const"> - <return type="float"> - </return> + <method name="set_disable_distance"> + <argument index="0" name="distance" type="float"> + </argument> <description> - 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]). + 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]). </description> </method> <method name="set_disabled_color"> @@ -29531,25 +29608,18 @@ This method controls whether the position between two cached points is interpola When the portal goes beyond the disable distance (see [method set_disable_distance]), it becomes opaque and displayed with color "color". </description> </method> - <method name="get_disabled_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - Return the color for when the portal goes beyond the disable distance (see [method set_disable_distance]) and becomes disabled. - </description> - </method> - <method name="set_connect_range"> - <argument index="0" name="range" type="float"> + <method name="set_enabled"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Set the range for auto-connecting two portals from different rooms sharing the same space. + 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. </description> </method> - <method name="get_connect_range" qualifiers="const"> - <return type="float"> - </return> + <method name="set_shape"> + <argument index="0" name="points" type="Vector2Array"> + </argument> <description> - Return the range for auto-connecting two portals from different rooms sharing the same space. + Set the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane. </description> </method> </methods> @@ -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. </description> <methods> - <method name="set_percent_visible"> - <argument index="0" name="visible" type="bool"> - </argument> - <description> - </description> - </method> <method name="is_percent_visible" qualifiers="const"> <return type="bool"> </return> <description> </description> </method> + <method name="set_percent_visible"> + <argument index="0" name="visible" type="bool"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> <theme_items> - <theme_item name="font_color" type="Color"> + <theme_item name="bg" type="StyleBox"> </theme_item> - <theme_item name="font_color_shadow" type="Color"> + <theme_item name="fg" type="StyleBox"> </theme_item> <theme_item name="font" type="Font"> </theme_item> - <theme_item name="fg" type="StyleBox"> + <theme_item name="font_color" type="Color"> </theme_item> - <theme_item name="bg" type="StyleBox"> + <theme_item name="font_color_shadow" type="Color"> </theme_item> </theme_items> </class> @@ -29624,12 +29694,6 @@ This method controls whether the position between two cached points is interpola General purpose proximity-detection node. </description> <methods> - <method name="set_group_name"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> <method name="broadcast"> <argument index="0" name="name" type="String"> </argument> @@ -29638,6 +29702,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="get_grid_radius" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> <method name="set_dispatch_mode"> <argument index="0" name="mode" type="int"> </argument> @@ -29650,9 +29720,9 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_grid_radius" qualifiers="const"> - <return type="Vector3"> - </return> + <method name="set_group_name"> + <argument index="0" name="name" type="String"> + </argument> <description> </description> </method> @@ -29676,21 +29746,15 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_axis"> - <argument index="0" name="axis" type="int"> - </argument> - <description> - </description> - </method> <method name="get_axis" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="set_size"> - <argument index="0" name="size" type="Vector2"> - </argument> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> <description> </description> </method> @@ -29700,15 +29764,21 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_centered"> - <argument index="0" name="centered" type="bool"> + <method name="is_centered" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_axis"> + <argument index="0" name="axis" type="int"> </argument> <description> </description> </method> - <method name="is_centered" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_centered"> + <argument index="0" name="centered" type="bool"> + </argument> <description> </description> </method> @@ -29718,9 +29788,9 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_size"> + <argument index="0" name="size" type="Vector2"> + </argument> <description> </description> </method> @@ -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. </description> <methods> + <method name="Quat"> + <return type="Quat"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <argument index="2" name="z" type="float"> + </argument> + <argument index="3" name="w" type="float"> + </argument> + <description> + </description> + </method> + <method name="Quat"> + <return type="Quat"> + </return> + <argument index="0" name="axis" type="Vector3"> + </argument> + <argument index="1" name="angle" type="float"> + </argument> + <description> + </description> + </method> + <method name="Quat"> + <return type="Quat"> + </return> + <argument index="0" name="from" type="Matrix3"> + </argument> + <description> + </description> + </method> <method name="cubic_slerp"> <return type="Quat"> </return> @@ -29816,48 +29918,16 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="Quat"> - <return type="Quat"> - </return> - <argument index="0" name="x" type="float"> - </argument> - <argument index="1" name="y" type="float"> - </argument> - <argument index="2" name="z" type="float"> - </argument> - <argument index="3" name="w" type="float"> - </argument> - <description> - </description> - </method> - <method name="Quat"> - <return type="Quat"> - </return> - <argument index="0" name="axis" type="Vector3"> - </argument> - <argument index="1" name="angle" type="float"> - </argument> - <description> - </description> - </method> - <method name="Quat"> - <return type="Quat"> - </return> - <argument index="0" name="from" type="Matrix3"> - </argument> - <description> - </description> - </method> </methods> <members> + <member name="w" type="float"> + </member> <member name="x" type="float"> </member> <member name="y" type="float"> </member> <member name="z" type="float"> </member> - <member name="w" type="float"> - </member> </members> <constants> </constants> @@ -29868,12 +29938,6 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="get_id"> - <return type="int"> - </return> - <description> - </description> - </method> <method name="RID"> <return type="RID"> </return> @@ -29882,6 +29946,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="get_id"> + <return type="int"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -29894,71 +29964,70 @@ 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]. </description> <methods> - <method name="get_val" qualifiers="const"> + <method name="get_max" qualifiers="const"> <return type="float"> </return> <description> - Return the current value. + Return the maximum value. </description> </method> - <method name="get_value" qualifiers="const"> + <method name="get_min" qualifiers="const"> <return type="float"> </return> <description> + Return the minimum value. </description> </method> - <method name="get_min" qualifiers="const"> + <method name="get_page" qualifiers="const"> <return type="float"> </return> <description> - Return the minimum value. + Return the page size, if page is 0, paging is disabled. </description> </method> - <method name="get_max" qualifiers="const"> + <method name="get_step" qualifiers="const"> <return type="float"> </return> <description> - Return the maximum value. + Return the stepping, if step is 0, stepping is disabled. </description> </method> - <method name="get_step" qualifiers="const"> + <method name="get_unit_value" qualifiers="const"> <return type="float"> </return> <description> - Return the stepping, if step is 0, stepping is disabled. + Return value mapped to 0 to 1 (unit) range. </description> </method> - <method name="get_page" qualifiers="const"> + <method name="get_val" qualifiers="const"> <return type="float"> </return> <description> - Return the page size, if page is 0, paging is disabled. + Return the current value. </description> </method> - <method name="get_unit_value" qualifiers="const"> + <method name="get_value" qualifiers="const"> <return type="float"> </return> <description> - Return value mapped to 0 to 1 (unit) range. </description> </method> - <method name="set_val"> - <argument index="0" name="value" type="float"> - </argument> + <method name="is_rounded_values" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="set_value"> - <argument index="0" name="value" type="float"> - </argument> + <method name="is_unit_value_exp" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="set_min"> - <argument index="0" name="minimum" type="float"> + <method name="set_exp_unit_value"> + <argument index="0" name="enabled" type="bool"> </argument> <description> - Set minimum value, clamped range value to it if it's less. </description> </method> <method name="set_max"> @@ -29967,11 +30036,11 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_step"> - <argument index="0" name="step" type="float"> + <method name="set_min"> + <argument index="0" name="minimum" type="float"> </argument> <description> - Set step value. If step is 0, stepping will be disabled. + Set minimum value, clamped range value to it if it's less. </description> </method> <method name="set_page"> @@ -29981,34 +30050,35 @@ This method controls whether the position between two cached points is interpola Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. </description> </method> - <method name="set_unit_value"> - <argument index="0" name="value" type="float"> + <method name="set_rounded_values"> + <argument index="0" name="enabled" type="bool"> </argument> <description> - Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. </description> </method> - <method name="set_rounded_values"> - <argument index="0" name="enabled" type="bool"> + <method name="set_step"> + <argument index="0" name="step" type="float"> </argument> <description> + Set step value. If step is 0, stepping will be disabled. </description> </method> - <method name="is_rounded_values" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_unit_value"> + <argument index="0" name="value" type="float"> + </argument> <description> + Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. </description> </method> - <method name="set_exp_unit_value"> - <argument index="0" name="enabled" type="bool"> + <method name="set_val"> + <argument index="0" name="value" type="float"> </argument> <description> </description> </method> - <method name="is_unit_value_exp" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_value"> + <argument index="0" name="value" type="float"> + </argument> <description> </description> </method> @@ -30024,6 +30094,11 @@ This method controls whether the position between two cached points is interpola </method> </methods> <signals> + <signal name="changed"> + <description> + This signal is emitted when min, max, range or step change. + </description> + </signal> <signal name="value_changed"> <argument index="0" name="value" type="float"> </argument> @@ -30031,11 +30106,6 @@ This method controls whether the position between two cached points is interpola This signal is emitted when value changes. </description> </signal> - <signal name="changed"> - <description> - This signal is emitted when min, max, range or step change. - </description> - </signal> </signals> <constants> </constants> @@ -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. </description> <methods> + <method name="RawArray"> + <return type="RawArray"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Create from a generic array. + </description> + </method> <method name="get_string_from_ascii"> <return type="String"> </return> @@ -30092,15 +30171,6 @@ This method controls whether the position between two cached points is interpola Return the size of the array. </description> </method> - <method name="RawArray"> - <return type="RawArray"> - </return> - <argument index="0" name="from" type="Array"> - </argument> - <description> - Create from a generic array. - </description> - </method> </methods> <constants> </constants> @@ -30111,21 +30181,19 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_enabled"> - <argument index="0" name="enabled" type="bool"> + <method name="add_exception"> + <argument index="0" name="node" type="Object"> </argument> <description> </description> </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="add_exception_rid"> + <argument index="0" name="rid" type="RID"> + </argument> <description> </description> </method> - <method name="set_cast_to"> - <argument index="0" name="local_point" type="Vector3"> - </argument> + <method name="clear_exceptions"> <description> </description> </method> @@ -30135,12 +30203,6 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="is_colliding" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="get_collider" qualifiers="const"> <return type="Object"> </return> @@ -30153,33 +30215,39 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_collision_point" qualifiers="const"> + <method name="get_collision_normal" qualifiers="const"> <return type="Vector3"> </return> <description> </description> </method> - <method name="get_collision_normal" qualifiers="const"> + <method name="get_collision_point" qualifiers="const"> <return type="Vector3"> </return> <description> </description> </method> - <method name="add_exception_rid"> - <argument index="0" name="rid" type="RID"> - </argument> + <method name="get_layer_mask" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="add_exception"> - <argument index="0" name="node" type="Object"> - </argument> + <method name="get_type_mask" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="remove_exception_rid"> - <argument index="0" name="rid" type="RID"> - </argument> + <method name="is_colliding" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> @@ -30189,31 +30257,33 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="clear_exceptions"> + <method name="remove_exception_rid"> + <argument index="0" name="rid" type="RID"> + </argument> <description> </description> </method> - <method name="set_layer_mask"> - <argument index="0" name="mask" type="int"> + <method name="set_cast_to"> + <argument index="0" name="local_point" type="Vector3"> </argument> <description> </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> </description> </method> - <method name="set_type_mask"> + <method name="set_layer_mask"> <argument index="0" name="mask" type="int"> </argument> <description> </description> </method> - <method name="get_type_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_type_mask"> + <argument index="0" name="mask" type="int"> + </argument> <description> </description> </method> @@ -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. </description> <methods> - <method name="set_enabled"> - <argument index="0" name="enabled" type="bool"> + <method name="add_exception"> + <argument index="0" name="node" type="Object"> </argument> <description> - 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]. </description> </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="add_exception_rid"> + <argument index="0" name="rid" type="RID"> + </argument> <description> - Returns whether this raycast is enabled or not </description> </method> - <method name="set_cast_to"> - <argument index="0" name="local_point" type="Vector2"> - </argument> + <method name="clear_exceptions"> <description> - 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. </description> </method> <method name="get_cast_to" qualifiers="const"> @@ -30257,13 +30324,6 @@ This method controls whether the position between two cached points is interpola Return the destination point of this ray object </description> </method> - <method name="is_colliding" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). - </description> - </method> <method name="get_collider" qualifiers="const"> <return type="Object"> </return> @@ -30278,6 +30338,13 @@ 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. </description> </method> + <method name="get_collision_normal" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the normal of the intersecting object shape face containing the collision point. + </description> + </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector2"> </return> @@ -30285,30 +30352,31 @@ This method controls whether the position between two cached points is interpola Returns the collision point in which the ray intersects the closest object. </description> </method> - <method name="get_collision_normal" qualifiers="const"> - <return type="Vector2"> + <method name="get_layer_mask" qualifiers="const"> + <return type="int"> </return> <description> - Returns the normal of the intersecting object shape face containing the collision point. + Returns the layer mask for this ray. </description> </method> - <method name="add_exception_rid"> - <argument index="0" name="rid" type="RID"> - </argument> + <method name="get_type_mask" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="add_exception"> - <argument index="0" name="node" type="Object"> - </argument> + <method name="is_colliding" qualifiers="const"> + <return type="bool"> + </return> <description> - Adds a collision exception so the ray does not report collisions with the specified [code]node[/code]. + Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). </description> </method> - <method name="remove_exception_rid"> - <argument index="0" name="rid" type="RID"> - </argument> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> + Returns whether this raycast is enabled or not </description> </method> <method name="remove_exception"> @@ -30318,33 +30386,35 @@ This method controls whether the position between two cached points is interpola Removes a collision exception so the ray does report collisions with the specified [code]node[/code]. </description> </method> - <method name="clear_exceptions"> + <method name="remove_exception_rid"> + <argument index="0" name="rid" type="RID"> + </argument> <description> - Removes all collision exception for this ray. </description> </method> - <method name="set_layer_mask"> - <argument index="0" name="mask" type="int"> + <method name="set_cast_to"> + <argument index="0" name="local_point" type="Vector2"> </argument> <description> + Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> - Returns the layer mask for this ray. + Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. </description> </method> - <method name="set_type_mask"> + <method name="set_layer_mask"> <argument index="0" name="mask" type="int"> </argument> <description> </description> </method> - <method name="get_type_mask" qualifiers="const"> - <return type="int"> - </return> + <method name="set_type_mask"> + <argument index="0" name="mask" type="int"> + </argument> <description> </description> </method> @@ -30358,18 +30428,18 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_length"> - <argument index="0" name="length" type="float"> - </argument> - <description> - </description> - </method> <method name="get_length" qualifiers="const"> <return type="float"> </return> <description> </description> </method> + <method name="set_length"> + <argument index="0" name="length" type="float"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -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. </description> <methods> - <method name="set_length"> - <argument index="0" name="length" type="float"> - </argument> - <description> - Set the length of the ray. - </description> - </method> <method name="get_length" qualifiers="const"> <return type="float"> </return> @@ -30396,6 +30459,13 @@ This method controls whether the position between two cached points is interpola Return the length of the ray. </description> </method> + <method name="set_length"> + <argument index="0" name="length" type="float"> + </argument> + <description> + Set the length of the ray. + </description> + </method> </methods> <constants> </constants> @@ -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. </description> <methods> + <method name="RealArray"> + <return type="RealArray"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Create from a generic array. + </description> + </method> <method name="push_back"> <argument index="0" name="value" type="float"> </argument> @@ -30438,15 +30517,6 @@ This method controls whether the position between two cached points is interpola Return the size of the array. </description> </method> - <method name="RealArray"> - <return type="RealArray"> - </return> - <argument index="0" name="from" type="Array"> - </argument> - <description> - Create from a generic array. - </description> - </method> </methods> <constants> </constants> @@ -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. </description> <methods> + <method name="Rect2"> + <return type="Rect2"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="size" type="Vector2"> + </argument> + <description> + Construct a [Rect2] by position and size. + </description> + </method> + <method name="Rect2"> + <return type="Rect2"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <argument index="2" name="width" type="float"> + </argument> + <argument index="3" name="height" type="float"> + </argument> + <description> + Construct a [Rect2] by x, y, width and height. + </description> + </method> <method name="clip"> <return type="Rect2"> </return> @@ -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. </description> </method> - <method name="Rect2"> - <return type="Rect2"> - </return> - <argument index="0" name="pos" type="Vector2"> - </argument> - <argument index="1" name="size" type="Vector2"> - </argument> - <description> - Construct a [Rect2] by position and size. - </description> - </method> - <method name="Rect2"> - <return type="Rect2"> - </return> - <argument index="0" name="x" type="float"> - </argument> - <argument index="1" name="y" type="float"> - </argument> - <argument index="2" name="width" type="float"> - </argument> - <argument index="3" name="height" type="float"> - </argument> - <description> - Construct a [Rect2] by x, y, width and height. - </description> - </method> </methods> <members> + <member name="end" type="Vector2"> + Ending corner. + </member> <member name="pos" type="Vector2"> Position (starting corner). </member> <member name="size" type="Vector2"> Size from position to end. </member> - <member name="end" type="Vector2"> - Ending corner. - </member> </members> <constants> </constants> @@ -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. </description> <methods> - <method name="set_extents"> - <argument index="0" name="extents" type="Vector2"> - </argument> - <description> - Set the half extents, the actual width and height of this shape is twice the half extents. - </description> - </method> <method name="get_extents" qualifiers="const"> <return type="Vector2"> </return> @@ -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. </description> </method> + <method name="set_extents"> + <argument index="0" name="extents" type="Vector2"> + </argument> + <description> + Set the half extents, the actual width and height of this shape is twice the half extents. + </description> + </method> </methods> <constants> </constants> @@ -30674,6 +30744,11 @@ This method controls whether the position between two cached points is interpola Word boundaries [code]\b[/code], [code]\B[/code] </description> <methods> + <method name="clear"> + <description> + 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]. + </description> + </method> <method name="compile"> <return type="int"> </return> @@ -30698,16 +30773,13 @@ 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. </description> </method> - <method name="clear"> - <description> - 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]. - </description> - </method> - <method name="is_valid" qualifiers="const"> - <return type="bool"> + <method name="get_capture" qualifiers="const"> + <return type="String"> </return> + <argument index="0" name="capture" type="int"> + </argument> <description> - Returns whether this object has a valid regular expression assigned. + 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]). </description> </method> <method name="get_capture_count" qualifiers="const"> @@ -30717,15 +30789,6 @@ This method controls whether the position between two cached points is interpola 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]). </description> </method> - <method name="get_capture" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="capture" type="int"> - </argument> - <description> - 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]). - </description> - </method> <method name="get_capture_start" qualifiers="const"> <return type="int"> </return> @@ -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. </description> </method> + <method name="is_valid" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this object has a valid regular expression assigned. + </description> + </method> </methods> <constants> </constants> @@ -30751,18 +30821,18 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_remote_node"> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> <method name="get_remote_node" qualifiers="const"> <return type="NodePath"> </return> <description> </description> </method> + <method name="set_remote_node"> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -30785,39 +30855,32 @@ 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. </description> <methods> - <method name="set_path"> - <argument index="0" name="path" type="String"> + <method name="duplicate"> + <return type="Object"> + </return> + <argument index="0" name="subresources" type="bool" default="false"> </argument> <description> - 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". </description> </method> - <method name="take_over_path"> - <argument index="0" name="path" type="String"> - </argument> + <method name="get_import_metadata" qualifiers="const"> + <return type="Object"> + </return> <description> - Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing. </description> </method> - <method name="get_path" qualifiers="const"> + <method name="get_name" qualifiers="const"> <return type="String"> </return> <description> - Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. - </description> - </method> - <method name="set_name"> - <argument index="0" name="name" type="String"> - </argument> - <description> - Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. + Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. </description> </method> - <method name="get_name" qualifiers="const"> + <method name="get_path" qualifiers="const"> <return type="String"> </return> <description> - 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. </description> </method> <method name="get_rid" qualifiers="const"> @@ -30833,18 +30896,25 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_import_metadata" qualifiers="const"> - <return type="Object"> - </return> + <method name="set_name"> + <argument index="0" name="name" type="String"> + </argument> <description> + Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. </description> </method> - <method name="duplicate"> - <return type="Object"> - </return> - <argument index="0" name="subresources" type="bool" default="false"> + <method name="set_path"> + <argument index="0" name="path" type="String"> </argument> <description> + 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". + </description> + </method> + <method name="take_over_path"> + <argument index="0" name="path" type="String"> + </argument> + <description> + Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing. </description> </method> </methods> @@ -30863,8 +30933,10 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_editor"> - <argument index="0" name="name" type="String"> + <method name="add_source"> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="md5" type="String" default=""""> </argument> <description> </description> @@ -30875,19 +30947,21 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="add_source"> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="md5" type="String" default=""""> + <method name="get_option" qualifiers="const"> + <argument index="0" name="key" type="String"> </argument> <description> </description> </method> - <method name="get_source_path" qualifiers="const"> - <return type="String"> + <method name="get_options" qualifiers="const"> + <return type="StringArray"> + </return> + <description> + </description> + </method> + <method name="get_source_count" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> @@ -30899,11 +30973,11 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_source_md5"> + <method name="get_source_path" qualifiers="const"> + <return type="String"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="md5" type="String"> - </argument> <description> </description> </method> @@ -30913,9 +30987,9 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_source_count" qualifiers="const"> - <return type="int"> - </return> + <method name="set_editor"> + <argument index="0" name="name" type="String"> + </argument> <description> </description> </method> @@ -30927,15 +31001,11 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_option" qualifiers="const"> - <argument index="0" name="key" type="String"> + <method name="set_source_md5"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="md5" type="String"> </argument> - <description> - </description> - </method> - <method name="get_options" qualifiers="const"> - <return type="StringArray"> - </return> <description> </description> </method> @@ -30958,31 +31028,31 @@ This method controls whether the position between two cached points is interpola Return the loaded resource (only if loaded). Otherwise, returns null. </description> </method> - <method name="poll"> + <method name="get_stage" qualifiers="const"> <return type="int"> </return> <description> - 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]. + Return the load stage. The total amount of stages can be queried with [method get_stage_count] </description> </method> - <method name="wait"> + <method name="get_stage_count" qualifiers="const"> <return type="int"> </return> <description> + Return the total amount of stages (calls to [method poll]) needed to completely load this resource. </description> </method> - <method name="get_stage" qualifiers="const"> + <method name="poll"> <return type="int"> </return> <description> - Return the load stage. The total amount of stages can be queried with [method get_stage_count] + 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]. </description> </method> - <method name="get_stage_count" qualifiers="const"> + <method name="wait"> <return type="int"> </return> <description> - Return the total amount of stages (calls to [method poll]) needed to completely load this resource. </description> </method> </methods> @@ -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. </description> <methods> - <method name="load_interactive"> - <return type="ResourceInteractiveLoader"> + <method name="get_dependencies"> + <return type="StringArray"> </return> <argument index="0" name="path" type="String"> </argument> - <argument index="1" name="type_hint" type="String" default=""""> + <description> + </description> + </method> + <method name="get_recognized_extensions_for_type"> + <return type="StringArray"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + Return the list of recognized extensions for a resource type. + </description> + </method> + <method name="has"> + <return type="bool"> + </return> + <argument index="0" name="path" type="String"> </argument> <description> - Load a resource interactively, the returned object allows to load with high granularity. </description> </method> <method name="load"> @@ -31028,13 +31112,15 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_recognized_extensions_for_type"> - <return type="StringArray"> + <method name="load_interactive"> + <return type="ResourceInteractiveLoader"> </return> - <argument index="0" name="type" type="String"> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="type_hint" type="String" default=""""> </argument> <description> - Return the list of recognized extensions for a resource type. + Load a resource interactively, the returned object allows to load with high granularity. </description> </method> <method name="set_abort_on_missing_resources"> @@ -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. </description> </method> - <method name="get_dependencies"> - <return type="StringArray"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="has"> - <return type="bool"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> </methods> <constants> </constants> @@ -31081,20 +31151,20 @@ 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). </description> </method> - <method name="remove_resource"> + <method name="get_resource" qualifiers="const"> + <return type="Object"> + </return> <argument index="0" name="name" type="String"> </argument> <description> - Remove a resource from the preloader by text id. + Return the resource given a text-id. </description> </method> - <method name="rename_resource"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="newname" type="String"> - </argument> + <method name="get_resource_list" qualifiers="const"> + <return type="StringArray"> + </return> <description> - Rename a resource inside the preloader, from a text-id to a new text-id. + Return the list of resources inside the preloader. </description> </method> <method name="has_resource" qualifiers="const"> @@ -31106,20 +31176,20 @@ This method controls whether the position between two cached points is interpola Return true if the preloader has a given resource. </description> </method> - <method name="get_resource" qualifiers="const"> - <return type="Object"> - </return> + <method name="remove_resource"> <argument index="0" name="name" type="String"> </argument> <description> - Return the resource given a text-id. + Remove a resource from the preloader by text id. </description> </method> - <method name="get_resource_list" qualifiers="const"> - <return type="StringArray"> - </return> + <method name="rename_resource"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="newname" type="String"> + </argument> <description> - Return the list of resources inside the preloader. + Rename a resource inside the preloader, from a text-id to a new text-id. </description> </method> </methods> @@ -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. </description> <methods> + <method name="get_recognized_extensions"> + <return type="StringArray"> + </return> + <argument index="0" name="type" type="Object"> + </argument> + <description> + Return the list of extensions available for saving a resource of a given type. + </description> + </method> <method name="save"> <return type="int"> </return> @@ -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. </description> </method> - <method name="get_recognized_extensions"> - <return type="StringArray"> - </return> - <argument index="0" name="type" type="Object"> - </argument> - <description> - Return the list of extensions available for saving a resource of a given type. - </description> - </method> </methods> <constants> <constant name="FLAG_RELATIVE_PATHS" value="1"> </constant> + <constant name="FLAG_SAVE_BIG_ENDIAN" value="16"> + </constant> <constant name="FLAG_BUNDLE_RESOURCES" value="2"> </constant> + <constant name="FLAG_COMPRESS" value="32"> + </constant> <constant name="FLAG_CHANGE_PATH" value="4"> </constant> <constant name="FLAG_OMIT_EDITOR_PROPERTIES" value="8"> </constant> - <constant name="FLAG_SAVE_BIG_ENDIAN" value="16"> - </constant> - <constant name="FLAG_COMPRESS" value="32"> - </constant> </constants> </class> <class name="RichTextLabel" inherits="Control" category="Core"> @@ -31180,207 +31250,207 @@ 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. </description> <methods> - <method name="add_text"> - <argument index="0" name="text" type="String"> + <method name="add_image"> + <argument index="0" name="image" type="Texture"> </argument> <description> </description> </method> - <method name="add_image"> - <argument index="0" name="image" type="Texture"> + <method name="add_text"> + <argument index="0" name="text" type="String"> </argument> <description> </description> </method> - <method name="newline"> + <method name="append_bbcode"> + <return type="int"> + </return> + <argument index="0" name="bbcode" type="String"> + </argument> <description> </description> </method> - <method name="push_font"> - <argument index="0" name="font" type="Object"> - </argument> + <method name="clear"> <description> </description> </method> - <method name="push_color"> - <argument index="0" name="color" type="Color"> - </argument> + <method name="get_bbcode" qualifiers="const"> + <return type="String"> + </return> <description> </description> </method> - <method name="push_align"> - <argument index="0" name="align" type="int"> - </argument> + <method name="get_tab_size" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="push_indent"> - <argument index="0" name="level" type="int"> - </argument> + <method name="get_total_character_count" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="push_list"> - <argument index="0" name="type" type="int"> - </argument> + <method name="get_v_scroll"> + <return type="Object"> + </return> <description> </description> </method> - <method name="push_meta"> - <argument index="0" name="data" type="Variant"> - </argument> + <method name="get_visible_characters" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="push_underline"> + <method name="is_meta_underlined" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="push_table"> - <argument index="0" name="columns" type="int"> - </argument> + <method name="is_scroll_active" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="set_table_column_expand"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="expand" type="bool"> - </argument> - <argument index="2" name="ratio" type="int"> - </argument> + <method name="is_scroll_following" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="push_cell"> + <method name="is_selection_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> + Return true if selecting the text inside this richtext is allowed. </description> </method> - <method name="pop"> + <method name="is_using_bbcode" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="clear"> + <method name="newline"> <description> </description> </method> - <method name="set_meta_underline"> - <argument index="0" name="enable" type="bool"> + <method name="parse_bbcode"> + <return type="int"> + </return> + <argument index="0" name="bbcode" type="String"> </argument> <description> </description> </method> - <method name="is_meta_underlined" qualifiers="const"> - <return type="bool"> - </return> + <method name="pop"> <description> </description> </method> - <method name="set_scroll_active"> - <argument index="0" name="active" type="bool"> + <method name="push_align"> + <argument index="0" name="align" type="int"> </argument> <description> </description> </method> - <method name="is_scroll_active" qualifiers="const"> - <return type="bool"> - </return> + <method name="push_cell"> <description> </description> </method> - <method name="set_scroll_follow"> - <argument index="0" name="follow" type="bool"> + <method name="push_color"> + <argument index="0" name="color" type="Color"> </argument> <description> </description> </method> - <method name="is_scroll_following" qualifiers="const"> - <return type="bool"> - </return> + <method name="push_font"> + <argument index="0" name="font" type="Object"> + </argument> <description> </description> </method> - <method name="get_v_scroll"> - <return type="Object"> - </return> + <method name="push_indent"> + <argument index="0" name="level" type="int"> + </argument> <description> </description> </method> - <method name="scroll_to_line"> - <argument index="0" name="line" type="int"> + <method name="push_list"> + <argument index="0" name="type" type="int"> </argument> <description> </description> </method> - <method name="set_tab_size"> - <argument index="0" name="spaces" type="int"> + <method name="push_meta"> + <argument index="0" name="data" type="Variant"> </argument> <description> </description> </method> - <method name="get_tab_size" qualifiers="const"> - <return type="int"> - </return> + <method name="push_table"> + <argument index="0" name="columns" type="int"> + </argument> <description> </description> </method> - <method name="set_selection_enabled"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="push_underline"> <description> - Set to true if selecting the text inside this richtext is allowed. </description> </method> - <method name="is_selection_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="scroll_to_line"> + <argument index="0" name="line" type="int"> + </argument> <description> - Return true if selecting the text inside this richtext is allowed. </description> </method> - <method name="parse_bbcode"> - <return type="int"> - </return> - <argument index="0" name="bbcode" type="String"> + <method name="set_bbcode"> + <argument index="0" name="text" type="String"> </argument> <description> </description> </method> - <method name="append_bbcode"> - <return type="int"> - </return> - <argument index="0" name="bbcode" type="String"> + <method name="set_meta_underline"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="set_bbcode"> - <argument index="0" name="text" type="String"> + <method name="set_scroll_active"> + <argument index="0" name="active" type="bool"> </argument> <description> </description> </method> - <method name="get_bbcode" qualifiers="const"> - <return type="String"> - </return> + <method name="set_scroll_follow"> + <argument index="0" name="follow" type="bool"> + </argument> <description> </description> </method> - <method name="set_visible_characters"> - <argument index="0" name="amount" type="int"> + <method name="set_selection_enabled"> + <argument index="0" name="enabled" type="bool"> </argument> <description> + Set to true if selecting the text inside this richtext is allowed. </description> </method> - <method name="get_visible_characters" qualifiers="const"> - <return type="int"> - </return> + <method name="set_tab_size"> + <argument index="0" name="spaces" type="int"> + </argument> <description> </description> </method> - <method name="get_total_character_count" qualifiers="const"> - <return type="int"> - </return> + <method name="set_table_column_expand"> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="expand" type="bool"> + </argument> + <argument index="2" name="ratio" type="int"> + </argument> <description> </description> </method> @@ -31390,9 +31460,9 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="is_using_bbcode" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_visible_characters"> + <argument index="0" name="amount" type="int"> + </argument> <description> </description> </method> @@ -31414,16 +31484,12 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="ALIGN_FILL" value="3"> </constant> - <constant name="LIST_NUMBERS" value="0"> - </constant> - <constant name="LIST_LETTERS" value="1"> - </constant> - <constant name="LIST_DOTS" value="2"> - </constant> <constant name="ITEM_FRAME" value="0"> </constant> <constant name="ITEM_TEXT" value="1"> </constant> + <constant name="ITEM_META" value="11"> + </constant> <constant name="ITEM_IMAGE" value="2"> </constant> <constant name="ITEM_NEWLINE" value="3"> @@ -31440,33 +31506,37 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="ITEM_LIST" value="9"> </constant> - <constant name="ITEM_META" value="11"> + <constant name="LIST_NUMBERS" value="0"> + </constant> + <constant name="LIST_LETTERS" value="1"> + </constant> + <constant name="LIST_DOTS" value="2"> </constant> </constants> <theme_items> - <theme_item name="table_vseparation" type="int"> - </theme_item> - <theme_item name="table_hseparation" type="int"> + <theme_item name="bold_font" type="Font"> </theme_item> - <theme_item name="line_separation" type="int"> + <theme_item name="bold_italics_font" type="Font"> </theme_item> <theme_item name="default_color" type="Color"> </theme_item> - <theme_item name="selection_color" type="Color"> + <theme_item name="focus" type="StyleBox"> </theme_item> <theme_item name="font_color_selected" type="Color"> </theme_item> - <theme_item name="mono_font" type="Font"> - </theme_item> - <theme_item name="bold_italics_font" type="Font"> - </theme_item> <theme_item name="italics_font" type="Font"> </theme_item> - <theme_item name="bold_font" type="Font"> + <theme_item name="line_separation" type="int"> + </theme_item> + <theme_item name="mono_font" type="Font"> </theme_item> <theme_item name="normal_font" type="Font"> </theme_item> - <theme_item name="focus" type="StyleBox"> + <theme_item name="selection_color" type="Color"> + </theme_item> + <theme_item name="table_hseparation" type="int"> + </theme_item> + <theme_item name="table_vseparation" type="int"> </theme_item> </theme_items> </class> @@ -31485,130 +31555,139 @@ 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. </description> </method> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> + <method name="apply_impulse"> + <argument index="0" name="pos" type="Vector3"> + </argument> + <argument index="1" name="impulse" type="Vector3"> </argument> <description> - Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. + 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. </description> </method> - <method name="get_mode" qualifiers="const"> - <return type="int"> + <method name="get_angular_damp" qualifiers="const"> + <return type="float"> </return> <description> - Return the current body mode, see [method set_mode]. + Return the current body angular damp. Default is -1. </description> </method> - <method name="set_mass"> - <argument index="0" name="mass" type="float"> - </argument> + <method name="get_angular_velocity" qualifiers="const"> + <return type="Vector3"> + </return> <description> - Set the body mass. + Return the current body angular velocity. </description> </method> - <method name="get_mass" qualifiers="const"> + <method name="get_axis_lock" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the current axis lock of the body. One of AXIS_LOCK_* enum. + </description> + </method> + <method name="get_bounce" qualifiers="const"> <return type="float"> </return> <description> - Return the current body mass. + Return the current body bounciness. </description> </method> - <method name="set_weight"> - <argument index="0" name="weight" type="float"> - </argument> + <method name="get_colliding_bodies" qualifiers="const"> + <return type="Array"> + </return> <description> - Set the body weight given standard earth-weight (gravity 9.8). + Return a list of the bodies colliding with this one. </description> </method> - <method name="get_weight" qualifiers="const"> + <method name="get_friction" qualifiers="const"> <return type="float"> </return> <description> - Return the current body weight, given standard earth-weight (gravity 9.8). + Return the current body friction, from 0 (frictionless) to 1 (max friction). </description> </method> - <method name="set_friction"> - <argument index="0" name="friction" type="float"> - </argument> + <method name="get_gravity_scale" qualifiers="const"> + <return type="float"> + </return> <description> - Set the body friction, from 0 (frictionless) to 1 (max friction). + Return the current body gravity scale. </description> </method> - <method name="get_friction" qualifiers="const"> + <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the current body friction, from 0 (frictionless) to 1 (max friction). + Return the current body linear damp. Default is -1. </description> </method> - <method name="set_bounce"> - <argument index="0" name="bounce" type="float"> - </argument> + <method name="get_linear_velocity" qualifiers="const"> + <return type="Vector3"> + </return> <description> - Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness). + Return the current body linear velocity. </description> </method> - <method name="get_bounce" qualifiers="const"> + <method name="get_mass" qualifiers="const"> <return type="float"> </return> <description> - Return the current body bounciness. + Return the current body mass. </description> </method> - <method name="set_linear_velocity"> - <argument index="0" name="linear_velocity" type="Vector3"> - </argument> + <method name="get_max_contacts_reported" qualifiers="const"> + <return type="int"> + </return> <description> - 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 maximum contacts that can be reported. See [method set_max_contacts_reported]. </description> </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector3"> + <method name="get_mode" qualifiers="const"> + <return type="int"> </return> <description> - Return the current body linear velocity. + Return the current body mode, see [method set_mode]. </description> </method> - <method name="set_angular_velocity"> - <argument index="0" name="angular_velocity" type="Vector3"> - </argument> + <method name="get_weight" qualifiers="const"> + <return type="float"> + </return> <description> - 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 weight, given standard earth-weight (gravity 9.8). </description> </method> - <method name="get_angular_velocity" qualifiers="const"> - <return type="Vector3"> + <method name="is_able_to_sleep" qualifiers="const"> + <return type="bool"> </return> <description> - Return the current body angular velocity. + Return whether the body has the ability to fall asleep when not moving. See [method set_can_sleep]. </description> </method> - <method name="set_gravity_scale"> - <argument index="0" name="gravity_scale" type="float"> - </argument> + <method name="is_contact_monitor_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> - Set the gravity factor. This factor multiplies gravity intensity just for this body. + Return whether contact monitoring is enabled. </description> </method> - <method name="get_gravity_scale" qualifiers="const"> - <return type="float"> + <method name="is_sleeping" qualifiers="const"> + <return type="bool"> </return> <description> - Return the current body gravity scale. + Return whether the body is sleeping. </description> </method> - <method name="set_linear_damp"> - <argument index="0" name="linear_damp" type="float"> - </argument> + <method name="is_using_continuous_collision_detection" qualifiers="const"> + <return type="bool"> + </return> <description> - 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 whether this body is using continuous collision detection. </description> </method> - <method name="get_linear_damp" qualifiers="const"> - <return type="float"> + <method name="is_using_custom_integrator"> + <return type="bool"> </return> <description> - Return the current body linear damp. Default is -1. + Return whether the body is using a custom integrator. </description> </method> <method name="set_angular_damp"> @@ -31618,39 +31697,40 @@ This method controls whether the position between two cached points is interpola 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. </description> </method> - <method name="get_angular_damp" qualifiers="const"> - <return type="float"> - </return> + <method name="set_angular_velocity"> + <argument index="0" name="angular_velocity" type="Vector3"> + </argument> <description> - Return the current body angular damp. Default is -1. + 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. </description> </method> - <method name="set_max_contacts_reported"> - <argument index="0" name="amount" type="int"> + <method name="set_axis_lock"> + <argument index="0" name="axis_lock" type="int"> </argument> <description> - 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 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. </description> </method> - <method name="get_max_contacts_reported" qualifiers="const"> - <return type="int"> - </return> + <method name="set_axis_velocity"> + <argument index="0" name="axis_velocity" type="Vector3"> + </argument> <description> - Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. + 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. </description> </method> - <method name="set_use_custom_integrator"> - <argument index="0" name="enable" type="bool"> + <method name="set_bounce"> + <argument index="0" name="bounce" type="float"> </argument> <description> - 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 bounciness, from 0 (no bounciness) to 1 (max bounciness). </description> </method> - <method name="is_using_custom_integrator"> - <return type="bool"> - </return> + <method name="set_can_sleep"> + <argument index="0" name="able_to_sleep" type="bool"> + </argument> <description> - Return whether the body is using a custom integrator. + Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. + 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. </description> </method> <method name="set_contact_monitor"> @@ -31660,92 +31740,82 @@ This method controls whether the position between two cached points is interpola Enable contact monitoring. This allows the body to emit signals when it collides with another. </description> </method> - <method name="is_contact_monitor_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether contact monitoring is enabled. - </description> - </method> - <method name="set_use_continuous_collision_detection"> - <argument index="0" name="enable" type="bool"> + <method name="set_friction"> + <argument index="0" name="friction" type="float"> </argument> <description> - 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 (max friction). </description> </method> - <method name="is_using_continuous_collision_detection" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_gravity_scale"> + <argument index="0" name="gravity_scale" type="float"> + </argument> <description> - Return whether this body is using continuous collision detection. + Set the gravity factor. This factor multiplies gravity intensity just for this body. </description> </method> - <method name="set_axis_velocity"> - <argument index="0" name="axis_velocity" type="Vector3"> + <method name="set_linear_damp"> + <argument index="0" name="linear_damp" type="float"> </argument> <description> - 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 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. </description> </method> - <method name="apply_impulse"> - <argument index="0" name="pos" type="Vector3"> - </argument> - <argument index="1" name="impulse" type="Vector3"> + <method name="set_linear_velocity"> + <argument index="0" name="linear_velocity" type="Vector3"> </argument> <description> - 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 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. </description> </method> - <method name="set_sleeping"> - <argument index="0" name="sleeping" type="bool"> + <method name="set_mass"> + <argument index="0" name="mass" type="float"> </argument> <description> - 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 body mass. </description> </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_max_contacts_reported"> + <argument index="0" name="amount" type="int"> + </argument> <description> - Return whether the body is sleeping. + 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. </description> </method> - <method name="set_can_sleep"> - <argument index="0" name="able_to_sleep" type="bool"> + <method name="set_mode"> + <argument index="0" name="mode" type="int"> </argument> <description> - Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. - 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. + Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. </description> </method> - <method name="is_able_to_sleep" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_sleeping"> + <argument index="0" name="sleeping" type="bool"> + </argument> <description> - Return whether the body has the ability to fall asleep when not moving. See [method set_can_sleep]. + 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. </description> </method> - <method name="set_axis_lock"> - <argument index="0" name="axis_lock" type="int"> + <method name="set_use_continuous_collision_detection"> + <argument index="0" name="enable" type="bool"> </argument> <description> - 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 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. </description> </method> - <method name="get_axis_lock" qualifiers="const"> - <return type="int"> - </return> + <method name="set_use_custom_integrator"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return the current axis lock of the body. One of AXIS_LOCK_* enum. + 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. </description> </method> - <method name="get_colliding_bodies" qualifiers="const"> - <return type="Array"> - </return> + <method name="set_weight"> + <argument index="0" name="weight" type="float"> + </argument> <description> - Return a list of the bodies colliding with this one. + Set the body weight given standard earth-weight (gravity 9.8). </description> </method> </methods> @@ -31799,18 +31869,18 @@ This method controls whether the position between two cached points is interpola </signal> </signals> <constants> - <constant name="MODE_STATIC" value="1"> - Static mode. The body behaves like a [StaticBody], and can only move by user code. - </constant> - <constant name="MODE_KINEMATIC" value="3"> - Kinematic body. The body behaves like a [KinematicBody], and can only move by user code. - </constant> <constant name="MODE_RIGID" value="0"> 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. </constant> + <constant name="MODE_STATIC" value="1"> + Static mode. The body behaves like a [StaticBody], and can only move by user code. + </constant> <constant name="MODE_CHARACTER" value="2"> Character body. This behaves like a rigid body, but can not rotate. </constant> + <constant name="MODE_KINEMATIC" value="3"> + Kinematic body. The body behaves like a [KinematicBody], and can only move by user code. + </constant> </constants> </class> <class name="RigidBody2D" inherits="PhysicsBody2D" category="Core"> @@ -31830,67 +31900,71 @@ 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. </description> </method> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> + <method name="add_force"> + <argument index="0" name="offset" type="Vector2"> + </argument> + <argument index="1" name="force" type="Vector2"> </argument> <description> - Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the current body mode, see [method set_mode]. + 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. </description> </method> - <method name="set_mass"> - <argument index="0" name="mass" type="float"> + <method name="apply_impulse"> + <argument index="0" name="offset" type="Vector2"> + </argument> + <argument index="1" name="impulse" type="Vector2"> </argument> <description> - Set the body mass. + 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. </description> </method> - <method name="get_mass" qualifiers="const"> + <method name="get_angular_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the body mass. + Return the angular damp for this body. </description> </method> - <method name="get_inertia" qualifiers="const"> + <method name="get_angular_velocity" qualifiers="const"> <return type="float"> </return> <description> - 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 body angular velocity. This changes by physics granularity. See [method set_angular_velocity]. </description> </method> - <method name="set_inertia"> - <argument index="0" name="inertia" type="float"> - </argument> + <method name="get_applied_force" qualifiers="const"> + <return type="Vector2"> + </return> <description> - 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. + Return the applied force vector. </description> </method> - <method name="set_weight"> - <argument index="0" name="weight" type="float"> - </argument> + <method name="get_applied_torque" qualifiers="const"> + <return type="float"> + </return> <description> - 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 torque which is being applied to this body. </description> </method> - <method name="get_weight" qualifiers="const"> + <method name="get_bounce" qualifiers="const"> <return type="float"> </return> <description> - Return the body weight given standard earth-weight (gravity 9.8). + Return the body bounciness. </description> </method> - <method name="set_friction"> - <argument index="0" name="friction" type="float"> - </argument> + <method name="get_colliding_bodies" qualifiers="const"> + <return type="Array"> + </return> <description> - Set the body friction, from 0 (frictionless) to 1 (full friction). + Return a list of the bodies colliding with this one. + </description> + </method> + <method name="get_continuous_collision_detection_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + Return whether this body is using continuous collision detection. </description> </method> <method name="get_friction" qualifiers="const"> @@ -31900,74 +31974,95 @@ This method controls whether the position between two cached points is interpola Return the body friction. </description> </method> - <method name="set_bounce"> - <argument index="0" name="bounce" type="float"> - </argument> + <method name="get_gravity_scale" qualifiers="const"> + <return type="float"> + </return> <description> - Set the body bounciness, from 0 (no bounce) to 1 (full bounce). + Return the gravity factor. </description> </method> - <method name="get_bounce" qualifiers="const"> + <method name="get_inertia" qualifiers="const"> <return type="float"> </return> <description> - Return the body bounciness. + 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. </description> </method> - <method name="set_gravity_scale"> - <argument index="0" name="gravity_scale" type="float"> - </argument> + <method name="get_linear_damp" qualifiers="const"> + <return type="float"> + </return> <description> - Set the gravity factor. This factor multiplies gravity intensity just for this body. + Return the linear damp for this body. </description> </method> - <method name="get_gravity_scale" qualifiers="const"> + <method name="get_linear_velocity" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity]. + </description> + </method> + <method name="get_mass" qualifiers="const"> <return type="float"> </return> <description> - Return the gravity factor. + Return the body mass. </description> </method> - <method name="set_linear_damp"> - <argument index="0" name="linear_damp" type="float"> - </argument> + <method name="get_max_contacts_reported" qualifiers="const"> + <return type="int"> + </return> <description> - 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 maximum contacts that can be reported. See [method set_max_contacts_reported]. </description> </method> - <method name="get_linear_damp" qualifiers="const"> + <method name="get_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the current body mode, see [method set_mode]. + </description> + </method> + <method name="get_weight" qualifiers="const"> <return type="float"> </return> <description> - Return the linear damp for this body. + Return the body weight given standard earth-weight (gravity 9.8). </description> </method> - <method name="set_angular_damp"> - <argument index="0" name="angular_damp" type="float"> - </argument> + <method name="is_able_to_sleep" qualifiers="const"> + <return type="bool"> + </return> <description> - 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 true if the body has the ability to fall asleep when not moving. See [method set_can_sleep]. </description> </method> - <method name="get_angular_damp" qualifiers="const"> - <return type="float"> + <method name="is_contact_monitor_enabled" qualifiers="const"> + <return type="bool"> </return> <description> - Return the angular damp for this body. + Return whether contact monitoring is enabled. </description> </method> - <method name="set_linear_velocity"> - <argument index="0" name="linear_velocity" type="Vector2"> - </argument> + <method name="is_sleeping" qualifiers="const"> + <return type="bool"> + </return> <description> - 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 whether the body is sleeping. </description> </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector2"> + <method name="is_using_custom_integrator"> + <return type="bool"> </return> <description> - Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity]. + Return true if the body is not doing any built-in force integration. + </description> + </method> + <method name="set_angular_damp"> + <argument index="0" name="angular_damp" type="float"> + </argument> + <description> + 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. </description> </method> <method name="set_angular_velocity"> @@ -31977,39 +32072,40 @@ This method controls whether the position between two cached points is interpola 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. </description> </method> - <method name="get_angular_velocity" qualifiers="const"> - <return type="float"> - </return> + <method name="set_applied_force"> + <argument index="0" name="force" type="Vector2"> + </argument> <description> - Return the body angular velocity. This changes by physics granularity. See [method set_angular_velocity]. + Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly. </description> </method> - <method name="set_max_contacts_reported"> - <argument index="0" name="amount" type="int"> + <method name="set_applied_torque"> + <argument index="0" name="torque" type="float"> </argument> <description> - 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 a constant torque which will be applied to this body. </description> </method> - <method name="get_max_contacts_reported" qualifiers="const"> - <return type="int"> - </return> + <method name="set_axis_velocity"> + <argument index="0" name="axis_velocity" type="Vector2"> + </argument> <description> - Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. + 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. </description> </method> - <method name="set_use_custom_integrator"> - <argument index="0" name="enable" type="bool"> + <method name="set_bounce"> + <argument index="0" name="bounce" type="float"> </argument> <description> - 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 bounciness, from 0 (no bounce) to 1 (full bounce). </description> </method> - <method name="is_using_custom_integrator"> - <return type="bool"> - </return> + <method name="set_can_sleep"> + <argument index="0" name="able_to_sleep" type="bool"> + </argument> <description> - Return true if the body is not doing any built-in force integration. + Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. + 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. </description> </method> <method name="set_contact_monitor"> @@ -32019,13 +32115,6 @@ This method controls whether the position between two cached points is interpola Enable contact monitoring. This allows the body to emit signals when it collides with another. </description> </method> - <method name="is_contact_monitor_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether contact monitoring is enabled. - </description> - </method> <method name="set_continuous_collision_detection_mode"> <argument index="0" name="mode" type="int"> </argument> @@ -32034,64 +32123,60 @@ This method controls whether the position between two cached points is interpola 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. </description> </method> - <method name="get_continuous_collision_detection_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_friction"> + <argument index="0" name="friction" type="float"> + </argument> <description> - Return whether this body is using continuous collision detection. + Set the body friction, from 0 (frictionless) to 1 (full friction). </description> </method> - <method name="set_axis_velocity"> - <argument index="0" name="axis_velocity" type="Vector2"> + <method name="set_gravity_scale"> + <argument index="0" name="gravity_scale" type="float"> </argument> <description> - 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 gravity factor. This factor multiplies gravity intensity just for this body. </description> </method> - <method name="apply_impulse"> - <argument index="0" name="offset" type="Vector2"> - </argument> - <argument index="1" name="impulse" type="Vector2"> + <method name="set_inertia"> + <argument index="0" name="inertia" type="float"> </argument> <description> - 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 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. </description> </method> - <method name="set_applied_force"> - <argument index="0" name="force" type="Vector2"> + <method name="set_linear_damp"> + <argument index="0" name="linear_damp" type="float"> </argument> <description> - Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly. + 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. </description> </method> - <method name="get_applied_force" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_linear_velocity"> + <argument index="0" name="linear_velocity" type="Vector2"> + </argument> <description> - Return the applied force vector. + 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. </description> </method> - <method name="set_applied_torque"> - <argument index="0" name="torque" type="float"> + <method name="set_mass"> + <argument index="0" name="mass" type="float"> </argument> <description> - Set a constant torque which will be applied to this body. + Set the body mass. </description> </method> - <method name="get_applied_torque" qualifiers="const"> - <return type="float"> - </return> + <method name="set_max_contacts_reported"> + <argument index="0" name="amount" type="int"> + </argument> <description> - Return the torque which is being applied to this 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. </description> </method> - <method name="add_force"> - <argument index="0" name="offset" type="Vector2"> - </argument> - <argument index="1" name="force" type="Vector2"> + <method name="set_mode"> + <argument index="0" name="mode" type="int"> </argument> <description> - 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. + Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. </description> </method> <method name="set_sleeping"> @@ -32101,26 +32186,18 @@ This method controls whether the position between two cached points is interpola 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. </description> </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the body is sleeping. - </description> - </method> - <method name="set_can_sleep"> - <argument index="0" name="able_to_sleep" type="bool"> + <method name="set_use_custom_integrator"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. - 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. </description> </method> - <method name="is_able_to_sleep" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_weight"> + <argument index="0" name="weight" type="float"> + </argument> <description> - Return true if the body has the ability to fall asleep when not moving. See [method set_can_sleep]. + 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. </description> </method> <method name="test_motion"> @@ -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). </description> </method> - <method name="get_colliding_bodies" qualifiers="const"> - <return type="Array"> - </return> - <description> - Return a list of the bodies colliding with this one. - </description> - </method> </methods> <signals> <signal name="body_enter"> @@ -32194,18 +32264,6 @@ This method controls whether the position between two cached points is interpola </signal> </signals> <constants> - <constant name="MODE_STATIC" value="1"> - Static mode. The body behaves like a [StaticBody2D], and can only move by user code. - </constant> - <constant name="MODE_KINEMATIC" value="3"> - Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code. - </constant> - <constant name="MODE_RIGID" value="0"> - 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. - </constant> - <constant name="MODE_CHARACTER" value="2"> - Character body. This behaves like a rigid body, but can not rotate. - </constant> <constant name="CCD_MODE_DISABLED" value="0"> Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. </constant> @@ -32215,6 +32273,18 @@ This method controls whether the position between two cached points is interpola <constant name="CCD_MODE_CAST_SHAPE" value="2"> Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. </constant> + <constant name="MODE_RIGID" value="0"> + 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. + </constant> + <constant name="MODE_STATIC" value="1"> + Static mode. The body behaves like a [StaticBody2D], and can only move by user code. + </constant> + <constant name="MODE_CHARACTER" value="2"> + Character body. This behaves like a rigid body, but can not rotate. + </constant> + <constant name="MODE_KINEMATIC" value="3"> + Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code. + </constant> </constants> </class> <class name="Room" inherits="VisualInstance" category="Core"> @@ -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. </description> <methods> - <method name="set_room"> - <argument index="0" name="room" type="Room"> - </argument> + <method name="compute_room_from_subtree"> <description> </description> </method> @@ -32237,19 +32305,21 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="compute_room_from_subtree"> + <method name="is_simulating_acoustics" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="set_simulate_acoustics"> - <argument index="0" name="enable" type="bool"> + <method name="set_room"> + <argument index="0" name="room" type="Room"> </argument> <description> </description> </method> - <method name="is_simulating_acoustics" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_simulate_acoustics"> + <argument index="0" name="enable" type="bool"> + </argument> <description> </description> </method> @@ -32263,24 +32333,12 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_bounds"> - <argument index="0" name="bsp_tree" type="Dictionary"> - </argument> - <description> - </description> - </method> <method name="get_bounds" qualifiers="const"> <return type="Dictionary"> </return> <description> </description> </method> - <method name="set_geometry_hint"> - <argument index="0" name="triangles" type="Vector3Array"> - </argument> - <description> - </description> - </method> <method name="get_geometry_hint" qualifiers="const"> <return type="Vector3Array"> </return> @@ -32295,6 +32353,18 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="set_bounds"> + <argument index="0" name="bsp_tree" type="Dictionary"> + </argument> + <description> + </description> + </method> + <method name="set_geometry_hint"> + <argument index="0" name="triangles" type="Vector3Array"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -32319,18 +32389,18 @@ 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. </description> </method> - <method name="get_format" qualifiers="const"> - <return type="int"> + <method name="get_data" qualifiers="const"> + <return type="RawArray"> </return> <description> - Return the sample format. + Return sample data as little endian. </description> </method> - <method name="is_stereo" qualifiers="const"> - <return type="bool"> + <method name="get_format" qualifiers="const"> + <return type="int"> </return> <description> - Return whether the current sample was created as stereo. + Return the sample format. </description> </method> <method name="get_length" qualifiers="const"> @@ -32340,29 +32410,25 @@ 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. </description> </method> - <method name="set_data"> - <argument index="0" name="data" type="RawArray"> - </argument> + <method name="get_loop_begin" qualifiers="const"> + <return type="int"> + </return> <description> - Set sample data. Data must be little endian, no matter the host platform, and exactly as long as to fit all samples. The length of this array can be calculated as follows: - Get the sample length ([method get_length]). - If the sample format is FORMAT_PCM16, multiply it by 2. - If the sample format is FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. - If the sample is stereo ([method is_stereo]), multiply it by 2. + Return the loop begin position. </description> </method> - <method name="get_data" qualifiers="const"> - <return type="RawArray"> + <method name="get_loop_end" qualifiers="const"> + <return type="int"> </return> <description> - Return sample data as little endian. + Return the loop end position. </description> </method> - <method name="set_mix_rate"> - <argument index="0" name="hz" type="int"> - </argument> + <method name="get_loop_format" qualifiers="const"> + <return type="int"> + </return> <description> - Set the mix rate for the sample (expected playback frequency). + Return the loop format. </description> </method> <method name="get_mix_rate" qualifiers="const"> @@ -32372,18 +32438,22 @@ This method controls whether the position between two cached points is interpola Return the mix rate for the sample. </description> </method> - <method name="set_loop_format"> - <argument index="0" name="format" type="int"> - </argument> + <method name="is_stereo" qualifiers="const"> + <return type="bool"> + </return> <description> - Set the loop format (use LOOP_* constants as argument). + Return whether the current sample was created as stereo. </description> </method> - <method name="get_loop_format" qualifiers="const"> - <return type="int"> - </return> + <method name="set_data"> + <argument index="0" name="data" type="RawArray"> + </argument> <description> - Return the loop format. + Set sample data. Data must be little endian, no matter the host platform, and exactly as long as to fit all samples. The length of this array can be calculated as follows: + Get the sample length ([method get_length]). + If the sample format is FORMAT_PCM16, multiply it by 2. + If the sample format is FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. + If the sample is stereo ([method is_stereo]), multiply it by 2. </description> </method> <method name="set_loop_begin"> @@ -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. </description> </method> - <method name="get_loop_begin" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the loop begin position. - </description> - </method> <method name="set_loop_end"> <argument index="0" name="pos" type="int"> </argument> @@ -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. </description> </method> - <method name="get_loop_end" qualifiers="const"> - <return type="int"> - </return> + <method name="set_loop_format"> + <argument index="0" name="format" type="int"> + </argument> <description> - Return the loop end position. + Set the loop format (use LOOP_* constants as argument). + </description> + </method> + <method name="set_mix_rate"> + <argument index="0" name="hz" type="int"> + </argument> + <description> + Set the mix rate for the sample (expected playback frequency). </description> </method> </methods> @@ -32478,13 +32548,13 @@ This method controls whether the position between two cached points is interpola Remove the sample matching the given text ID. </description> </method> - <method name="sample_set_volume_db"> + <method name="sample_get_pitch_scale" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="db" type="float"> - </argument> <description> - Set the volume (in dB) for the given sample. + Return the pitch scale for the given sample. </description> </method> <method name="sample_get_volume_db" qualifiers="const"> @@ -32505,13 +32575,13 @@ This method controls whether the position between two cached points is interpola Set the pitch scale for the given sample. </description> </method> - <method name="sample_get_pitch_scale" qualifiers="const"> - <return type="float"> - </return> + <method name="sample_set_volume_db"> <argument index="0" name="name" type="String"> </argument> + <argument index="1" name="db" type="float"> + </argument> <description> - Return the pitch scale for the given sample. + Set the volume (in dB) for the given sample. </description> </method> </methods> @@ -32526,181 +32596,149 @@ 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. </description> <methods> - <method name="set_sample_library"> - <argument index="0" name="library" type="SampleLibrary"> + <method name="get_chorus" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="voice" type="int"> </argument> <description> - Set the sample library for the player. + Return the current chorus send level for a given voice. </description> </method> - <method name="get_sample_library" qualifiers="const"> - <return type="SampleLibrary"> + <method name="get_default_chorus" qualifiers="const"> + <return type="float"> </return> <description> - Return the sample library used by the player. + Return the default chorus send level of the player. </description> </method> - <method name="set_polyphony"> - <argument index="0" name="max_voices" type="int"> - </argument> + <method name="get_default_filter_cutoff" qualifiers="const"> + <return type="float"> + </return> <description> - Set the polyphony of the player (maximum amount of simultaneous voices). + Return the default filter cutoff frequency of the player. </description> </method> - <method name="get_polyphony" qualifiers="const"> - <return type="int"> + <method name="get_default_filter_gain" qualifiers="const"> + <return type="float"> </return> <description> - Return the polyphony of the player. + Return the default filter gain of the player. </description> </method> - <method name="play"> - <return type="int"> + <method name="get_default_filter_resonance" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="unique" type="bool" default="false"> - </argument> <description> - 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 filter resonance of the player. </description> </method> - <method name="stop"> - <argument index="0" name="voice" type="int"> - </argument> + <method name="get_default_filter_type" qualifiers="const"> + <return type="int"> + </return> <description> - Stop a given voice. + Return the default filter type in use (see FILTER_* constants) for the player. </description> </method> - <method name="stop_all"> + <method name="get_default_pan" qualifiers="const"> + <return type="float"> + </return> <description> - Stop all playing voices. + Return the default panning of the player. </description> </method> - <method name="set_mix_rate"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="hz" type="int"> - </argument> + <method name="get_default_pan_depth" qualifiers="const"> + <return type="float"> + </return> <description> - Set the mix rate (in Hz) of a given voice. + Return the default pan depth of the player. </description> </method> - <method name="set_pitch_scale"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="ratio" type="float"> - </argument> + <method name="get_default_pan_height" qualifiers="const"> + <return type="float"> + </return> <description> - Set the pitch scale of a given voice. A ratio of 1.0 is the normal scale. + Return the default pan height of the player. </description> </method> - <method name="set_volume"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="volume" type="float"> - </argument> + <method name="get_default_pitch_scale" qualifiers="const"> + <return type="float"> + </return> <description> - 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 pitch scale of the player. </description> </method> - <method name="set_volume_db"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="db" type="float"> - </argument> + <method name="get_default_reverb" qualifiers="const"> + <return type="float"> + </return> <description> - 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 reverberation send level of the player. </description> </method> - <method name="set_pan"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="pan" type="float"> - </argument> - <argument index="2" name="depth" type="float" default="0"> - </argument> - <argument index="3" name="height" type="float" default="0"> - </argument> + <method name="get_default_reverb_room" qualifiers="const"> + <return type="int"> + </return> <description> - 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 reverberation room type of the player (see REVERB_* enum). </description> </method> - <method name="set_filter"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="type" type="int"> - </argument> - <argument index="2" name="cutoff_hz" type="float"> - </argument> - <argument index="3" name="resonance" type="float"> - </argument> - <argument index="4" name="gain" type="float" default="0"> - </argument> + <method name="get_default_volume" qualifiers="const"> + <return type="float"> + </return> <description> - 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). + Return the default volume (on a linear scale) of the player. </description> </method> - <method name="set_chorus"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="send" type="float"> - </argument> + <method name="get_default_volume_db" qualifiers="const"> + <return type="float"> + </return> <description> - Set the chorus send level of a voice (from 0 to 1.0). For setting chorus parameters, see [AudioServer]. + Return the default volume (in dB) of the player. </description> </method> - <method name="set_reverb"> + <method name="get_filter_cutoff" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="voice" type="int"> </argument> - <argument index="1" name="room_type" type="int"> - </argument> - <argument index="2" name="send" type="float"> - </argument> <description> - Set the reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of a voice. + Return the current filter cutoff frequency for a given voice. </description> </method> - <method name="get_mix_rate" qualifiers="const"> - <return type="int"> + <method name="get_filter_gain" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="voice" type="int"> </argument> <description> - Return the current mix rate for a given voice. + Return the current filter gain for a given voice. </description> </method> - <method name="get_pitch_scale" qualifiers="const"> + <method name="get_filter_resonance" qualifiers="const"> <return type="float"> </return> <argument index="0" name="voice" type="int"> </argument> <description> - Return the current pitch scale for a given voice. + Return the current filter resonance for a given voice. </description> </method> - <method name="get_volume" qualifiers="const"> - <return type="float"> + <method name="get_filter_type" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="voice" type="int"> </argument> <description> - Return the current volume (on a linear scale) for a given voice. + Return the current filter type in use (see FILTER_* constants) for a given voice. </description> </method> - <method name="get_volume_db" qualifiers="const"> - <return type="float"> + <method name="get_mix_rate" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="voice" type="int"> </argument> <description> - Return the current volume (in dB) for a given voice. + Return the current mix rate for a given voice. </description> </method> <method name="get_pan" qualifiers="const"> @@ -32730,103 +32768,107 @@ This method controls whether the position between two cached points is interpola Return the current pan height for a given voice. </description> </method> - <method name="get_filter_type" qualifiers="const"> - <return type="int"> + <method name="get_pitch_scale" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="voice" type="int"> </argument> <description> - Return the current filter type in use (see FILTER_* constants) for a given voice. + Return the current pitch scale for a given voice. </description> </method> - <method name="get_filter_cutoff" qualifiers="const"> - <return type="float"> + <method name="get_polyphony" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="voice" type="int"> - </argument> <description> - Return the current filter cutoff frequency for a given voice. + Return the polyphony of the player. </description> </method> - <method name="get_filter_resonance" qualifiers="const"> + <method name="get_reverb" qualifiers="const"> <return type="float"> </return> <argument index="0" name="voice" type="int"> </argument> <description> - Return the current filter resonance for a given voice. + Return the current reverberation send level for a given voice. </description> </method> - <method name="get_filter_gain" qualifiers="const"> - <return type="float"> + <method name="get_reverb_room" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="voice" type="int"> </argument> <description> - Return the current filter gain for a given voice. + Return the current reverberation room type for a given voice (see REVERB_* enum). </description> </method> - <method name="get_chorus" qualifiers="const"> - <return type="float"> + <method name="get_sample_library" qualifiers="const"> + <return type="SampleLibrary"> </return> - <argument index="0" name="voice" type="int"> - </argument> <description> - Return the current chorus send level for a given voice. + Return the sample library used by the player. </description> </method> - <method name="get_reverb_room" qualifiers="const"> - <return type="int"> + <method name="get_volume" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="voice" type="int"> </argument> <description> - Return the current reverberation room type for a given voice (see REVERB_* enum). + Return the current volume (on a linear scale) for a given voice. </description> </method> - <method name="get_reverb" qualifiers="const"> + <method name="get_volume_db" qualifiers="const"> <return type="float"> </return> <argument index="0" name="voice" type="int"> </argument> <description> - Return the current reverberation send level for a given voice. + Return the current volume (in dB) for a given voice. </description> </method> - <method name="set_default_pitch_scale"> - <argument index="0" name="ratio" type="float"> - </argument> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> <description> - Set the default pitch scale of the player. A ratio of 1.0 is the normal scale. + Return whether the player is currently active. </description> </method> - <method name="set_default_volume"> - <argument index="0" name="volume" type="float"> + <method name="is_voice_active" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="voice" type="int"> </argument> <description> - Set the default volume of the player using a linear scale. - The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB). - A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output. + Return whether the given voice is currently active. </description> </method> - <method name="set_default_volume_db"> - <argument index="0" name="db" type="float"> + <method name="play"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="unique" type="bool" default="false"> </argument> <description> - Set the default volume of the player in dB. - The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half. + 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. </description> </method> - <method name="set_default_pan"> - <argument index="0" name="pan" type="float"> + <method name="set_chorus"> + <argument index="0" name="voice" type="int"> </argument> - <argument index="1" name="depth" type="float" default="0"> + <argument index="1" name="send" type="float"> </argument> - <argument index="2" name="height" type="float" default="0"> + <description> + Set the chorus send level of a voice (from 0 to 1.0). For setting chorus parameters, see [AudioServer]. + </description> + </method> + <method name="set_default_chorus"> + <argument index="0" name="send" type="float"> </argument> <description> - 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 chorus send level of the player (from 0 to 1.0). For setting chorus parameters, see [AudioServer]. </description> </method> <method name="set_default_filter"> @@ -32843,11 +32885,23 @@ This method controls whether the position between two cached points is interpola Optionally, a gain can also be given (from 0 to 2.0). </description> </method> - <method name="set_default_chorus"> - <argument index="0" name="send" type="float"> + <method name="set_default_pan"> + <argument index="0" name="pan" type="float"> + </argument> + <argument index="1" name="depth" type="float" default="0"> + </argument> + <argument index="2" name="height" type="float" default="0"> </argument> <description> - Set the default chorus send level of the player (from 0 to 1.0). For setting chorus parameters, see [AudioServer]. + 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). + </description> + </method> + <method name="set_default_pitch_scale"> + <argument index="0" name="ratio" type="float"> + </argument> + <description> + Set the default pitch scale of the player. A ratio of 1.0 is the normal scale. </description> </method> <method name="set_default_reverb"> @@ -32859,111 +32913,127 @@ This method controls whether the position between two cached points is interpola Set the default reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of the player. </description> </method> - <method name="get_default_pitch_scale" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the default pitch scale of the player. - </description> - </method> - <method name="get_default_volume" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the default volume (on a linear scale) of the player. - </description> - </method> - <method name="get_default_volume_db" qualifiers="const"> - <return type="float"> - </return> + <method name="set_default_volume"> + <argument index="0" name="volume" type="float"> + </argument> <description> - Return the default volume (in dB) of the player. + Set the default volume of the player using a linear scale. + The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB). + A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output. </description> </method> - <method name="get_default_pan" qualifiers="const"> - <return type="float"> - </return> + <method name="set_default_volume_db"> + <argument index="0" name="db" type="float"> + </argument> <description> - Return the default panning of the player. + Set the default volume of the player in dB. + The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half. </description> </method> - <method name="get_default_pan_depth" qualifiers="const"> - <return type="float"> - </return> + <method name="set_filter"> + <argument index="0" name="voice" type="int"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="cutoff_hz" type="float"> + </argument> + <argument index="3" name="resonance" type="float"> + </argument> + <argument index="4" name="gain" type="float" default="0"> + </argument> <description> - Return the default pan depth of the player. + 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). </description> </method> - <method name="get_default_pan_height" qualifiers="const"> - <return type="float"> - </return> + <method name="set_mix_rate"> + <argument index="0" name="voice" type="int"> + </argument> + <argument index="1" name="hz" type="int"> + </argument> <description> - Return the default pan height of the player. + Set the mix rate (in Hz) of a given voice. </description> </method> - <method name="get_default_filter_type" qualifiers="const"> - <return type="int"> - </return> + <method name="set_pan"> + <argument index="0" name="voice" type="int"> + </argument> + <argument index="1" name="pan" type="float"> + </argument> + <argument index="2" name="depth" type="float" default="0"> + </argument> + <argument index="3" name="height" type="float" default="0"> + </argument> <description> - Return the default filter type in use (see FILTER_* constants) for 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). </description> </method> - <method name="get_default_filter_cutoff" qualifiers="const"> - <return type="float"> - </return> + <method name="set_pitch_scale"> + <argument index="0" name="voice" type="int"> + </argument> + <argument index="1" name="ratio" type="float"> + </argument> <description> - Return the default filter cutoff frequency of the player. + Set the pitch scale of a given voice. A ratio of 1.0 is the normal scale. </description> </method> - <method name="get_default_filter_resonance" qualifiers="const"> - <return type="float"> - </return> + <method name="set_polyphony"> + <argument index="0" name="max_voices" type="int"> + </argument> <description> - Return the default filter resonance of the player. + Set the polyphony of the player (maximum amount of simultaneous voices). </description> </method> - <method name="get_default_filter_gain" qualifiers="const"> - <return type="float"> - </return> + <method name="set_reverb"> + <argument index="0" name="voice" type="int"> + </argument> + <argument index="1" name="room_type" type="int"> + </argument> + <argument index="2" name="send" type="float"> + </argument> <description> - Return the default filter gain of the player. + Set the reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of a voice. </description> </method> - <method name="get_default_chorus" qualifiers="const"> - <return type="float"> - </return> + <method name="set_sample_library"> + <argument index="0" name="library" type="SampleLibrary"> + </argument> <description> - Return the default chorus send level of the player. + Set the sample library for the player. </description> </method> - <method name="get_default_reverb_room" qualifiers="const"> - <return type="int"> - </return> + <method name="set_volume"> + <argument index="0" name="voice" type="int"> + </argument> + <argument index="1" name="volume" type="float"> + </argument> <description> - Return the default reverberation room type of the player (see REVERB_* enum). + 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. </description> </method> - <method name="get_default_reverb" qualifiers="const"> - <return type="float"> - </return> + <method name="set_volume_db"> + <argument index="0" name="voice" type="int"> + </argument> + <argument index="1" name="db" type="float"> + </argument> <description> - Return the default reverberation send level 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. </description> </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> + <method name="stop"> + <argument index="0" name="voice" type="int"> + </argument> <description> - Return whether the player is currently active. + Stop a given voice. </description> </method> - <method name="is_voice_active" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="voice" type="int"> - </argument> + <method name="stop_all"> <description> - Return whether the given voice is currently active. + Stop all playing voices. </description> </method> </methods> @@ -32995,6 +33065,9 @@ This method controls whether the position between two cached points is interpola <constant name="FILTER_HIGH_SHELF" value="8"> High-shelf filter is used for voice. </constant> + <constant name="INVALID_VOICE_ID" value="-1"> + Value returned if the voice ID is invalid. + </constant> <constant name="REVERB_SMALL" value="0"> Small reverberation room (house room). </constant> @@ -33007,9 +33080,6 @@ This method controls whether the position between two cached points is interpola <constant name="REVERB_HALL" value="3"> Huge reverberation room (cathedral, warehouse). </constant> - <constant name="INVALID_VOICE_ID" value="-1"> - Value returned if the voice ID is invalid. - </constant> </constants> </class> <class name="SamplePlayer2D" inherits="SoundPlayer2D" category="Core"> @@ -33020,32 +33090,34 @@ 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. </description> <methods> - <method name="set_sample_library"> - <argument index="0" name="library" type="SampleLibrary"> - </argument> + <method name="get_polyphony" qualifiers="const"> + <return type="int"> + </return> <description> - Set the sample library for the player. + Return the polyphony of the player. </description> </method> - <method name="get_sample_library" qualifiers="const"> - <return type="SampleLibrary"> + <method name="get_random_pitch_scale" qualifiers="const"> + <return type="float"> </return> <description> - Return the sample library used by the player. + Return the amplitude used for random pitch scale variations. </description> </method> - <method name="set_polyphony"> - <argument index="0" name="max_voices" type="int"> - </argument> + <method name="get_sample_library" qualifiers="const"> + <return type="SampleLibrary"> + </return> <description> - Set the polyphony of the player (maximum amount of simultaneous voices). + Return the sample library used by the player. </description> </method> - <method name="get_polyphony" qualifiers="const"> - <return type="int"> + <method name="is_voice_active" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="voice" type="int"> + </argument> <description> - Return the polyphony of the player. + Return whether a voice is still active or has stopped playing. </description> </method> <method name="play"> @@ -33060,31 +33132,33 @@ 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. </description> </method> - <method name="voice_set_pitch_scale"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="ratio" type="float"> + <method name="set_polyphony"> + <argument index="0" name="max_voices" type="int"> </argument> <description> - Change the pitch scale of a currently playing voice. + Set the polyphony of the player (maximum amount of simultaneous voices). </description> </method> - <method name="voice_set_volume_scale_db"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="db" type="float"> + <method name="set_random_pitch_scale"> + <argument index="0" name="val" type="float"> </argument> <description> - Change the volume scale (in dB) of a currently playing voice. + 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) </description> </method> - <method name="is_voice_active" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="voice" type="int"> + <method name="set_sample_library"> + <argument index="0" name="library" type="SampleLibrary"> </argument> <description> - Return whether a voice is still active or has stopped playing. + Set the sample library for the player. + </description> + </method> + <method name="stop_all"> + <description> + Stop all playing voices. </description> </method> <method name="stop_voice"> @@ -33094,26 +33168,22 @@ This method controls whether the position between two cached points is interpola Stop a given voice. </description> </method> - <method name="stop_all"> - <description> - Stop all playing voices. - </description> - </method> - <method name="set_random_pitch_scale"> - <argument index="0" name="val" type="float"> + <method name="voice_set_pitch_scale"> + <argument index="0" name="voice" type="int"> + </argument> + <argument index="1" name="ratio" type="float"> </argument> <description> - 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) + Change the pitch scale of a currently playing voice. </description> </method> - <method name="get_random_pitch_scale" qualifiers="const"> - <return type="float"> - </return> + <method name="voice_set_volume_scale_db"> + <argument index="0" name="voice" type="int"> + </argument> + <argument index="1" name="db" type="float"> + </argument> <description> - Return the amplitude used for random pitch scale variations. + Change the volume scale (in dB) of a currently playing voice. </description> </method> </methods> @@ -33132,67 +33202,63 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="get_node_count" qualifiers="const"> - <return type="int"> + <method name="get_connection_binds" qualifiers="const"> + <return type="Array"> </return> + <argument index="0" name="idx" type="int"> + </argument> <description> </description> </method> - <method name="get_node_type" qualifiers="const"> - <return type="String"> + <method name="get_connection_count" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="get_node_name" qualifiers="const"> - <return type="String"> + <method name="get_connection_flags" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_node_path" qualifiers="const"> - <return type="NodePath"> + <method name="get_connection_method" qualifiers="const"> + <return type="String"> </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="for_parent" type="bool" default="false"> - </argument> <description> </description> </method> - <method name="get_node_owner_path" qualifiers="const"> - <return type="NodePath"> + <method name="get_connection_signal" qualifiers="const"> + <return type="String"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="is_node_instance_placeholder" qualifiers="const"> - <return type="bool"> + <method name="get_connection_source" qualifiers="const"> + <return type="NodePath"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_node_instance_placeholder" qualifiers="const"> - <return type="String"> + <method name="get_connection_target" qualifiers="const"> + <return type="NodePath"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_node_instance" qualifiers="const"> - <return type="PackedScene"> + <method name="get_node_count" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> @@ -33204,80 +33270,84 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_node_property_count" qualifiers="const"> - <return type="int"> + <method name="get_node_instance" qualifiers="const"> + <return type="PackedScene"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_node_property_name" qualifiers="const"> + <method name="get_node_instance_placeholder" qualifiers="const"> <return type="String"> </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="prop_idx" type="int"> - </argument> <description> </description> </method> - <method name="get_node_property_value" qualifiers="const"> + <method name="get_node_name" qualifiers="const"> + <return type="String"> + </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="prop_idx" type="int"> - </argument> <description> </description> </method> - <method name="get_connection_count" qualifiers="const"> - <return type="int"> + <method name="get_node_owner_path" qualifiers="const"> + <return type="NodePath"> </return> + <argument index="0" name="idx" type="int"> + </argument> <description> </description> </method> - <method name="get_connection_source" qualifiers="const"> + <method name="get_node_path" qualifiers="const"> <return type="NodePath"> </return> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="for_parent" type="bool" default="false"> + </argument> <description> </description> </method> - <method name="get_connection_signal" qualifiers="const"> - <return type="String"> + <method name="get_node_property_count" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_connection_target" qualifiers="const"> - <return type="NodePath"> + <method name="get_node_property_name" qualifiers="const"> + <return type="String"> </return> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="prop_idx" type="int"> + </argument> <description> </description> </method> - <method name="get_connection_method" qualifiers="const"> - <return type="String"> - </return> + <method name="get_node_property_value" qualifiers="const"> <argument index="0" name="idx" type="int"> </argument> + <argument index="1" name="prop_idx" type="int"> + </argument> <description> </description> </method> - <method name="get_connection_flags" qualifiers="const"> - <return type="int"> + <method name="get_node_type" qualifiers="const"> + <return type="String"> </return> <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_connection_binds" qualifiers="const"> - <return type="Array"> + <method name="is_node_instance_placeholder" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="idx" type="int"> </argument> @@ -33294,241 +33364,241 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="notify_group"> - <argument index="0" name="call_flags" type="int"> + <method name="call_group"> + <argument index="0" name="flags" type="int"> </argument> <argument index="1" name="group" type="String"> </argument> - <argument index="2" name="notification" type="int"> + <argument index="2" name="method" type="String"> </argument> - <description> - </description> - </method> - <method name="set_group"> - <argument index="0" name="call_flags" type="int"> + <argument index="3" name="arg0" type="Variant" default="NULL"> </argument> - <argument index="1" name="group" type="String"> + <argument index="4" name="arg1" type="Variant" default="NULL"> </argument> - <argument index="2" name="property" type="String"> + <argument index="5" name="arg2" type="Variant" default="NULL"> </argument> - <argument index="3" name="value" type="Variant"> + <argument index="6" name="arg3" type="Variant" default="NULL"> + </argument> + <argument index="7" name="arg4" type="Variant" default="NULL"> </argument> <description> </description> </method> - <method name="get_nodes_in_group"> - <return type="Array"> + <method name="change_scene"> + <return type="int"> </return> - <argument index="0" name="group" type="String"> + <argument index="0" name="path" type="String"> </argument> <description> </description> </method> - <method name="get_root" qualifiers="const"> - <return type="Viewport"> + <method name="change_scene_to"> + <return type="int"> </return> + <argument index="0" name="packed_scene" type="PackedScene"> + </argument> <description> </description> </method> - <method name="has_group" qualifiers="const"> - <return type="bool"> + <method name="get_current_scene" qualifiers="const"> + <return type="Node"> </return> - <argument index="0" name="name" type="String"> - </argument> <description> </description> </method> - <method name="set_auto_accept_quit"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_edited_scene_root" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> - <method name="set_editor_hint"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_frame" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="is_editor_hint" qualifiers="const"> - <return type="bool"> + <method name="get_node_count" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="set_debug_collisions_hint"> - <argument index="0" name="enable" type="bool"> + <method name="get_nodes_in_group"> + <return type="Array"> + </return> + <argument index="0" name="group" type="String"> </argument> <description> </description> </method> - <method name="is_debugging_collisions_hint" qualifiers="const"> - <return type="bool"> + <method name="get_root" qualifiers="const"> + <return type="Viewport"> </return> <description> </description> </method> - <method name="set_debug_navigation_hint"> - <argument index="0" name="enable" type="bool"> + <method name="has_group" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> </argument> <description> </description> </method> + <method name="is_debugging_collisions_hint" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_debugging_navigation_hint" qualifiers="const"> <return type="bool"> </return> <description> </description> </method> - <method name="set_edited_scene_root"> - <argument index="0" name="scene" type="Object"> - </argument> + <method name="is_editor_hint" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_edited_scene_root" qualifiers="const"> - <return type="Object"> + <method name="is_paused" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_pause"> - <argument index="0" name="enable" type="bool"> + <method name="notify_group"> + <argument index="0" name="call_flags" type="int"> + </argument> + <argument index="1" name="group" type="String"> + </argument> + <argument index="2" name="notification" type="int"> </argument> <description> </description> </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> - </return> + <method name="queue_delete"> + <argument index="0" name="obj" type="Object"> + </argument> <description> </description> </method> - <method name="set_input_as_handled"> + <method name="quit"> <description> </description> </method> - <method name="get_node_count" qualifiers="const"> + <method name="reload_current_scene"> <return type="int"> </return> <description> </description> </method> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> + <method name="set_auto_accept_quit"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> </description> </method> - <method name="quit"> + <method name="set_current_scene"> + <argument index="0" name="child_node" type="Node"> + </argument> <description> </description> </method> - <method name="set_screen_stretch"> - <argument index="0" name="mode" type="int"> - </argument> - <argument index="1" name="aspect" type="int"> - </argument> - <argument index="2" name="minsize" type="Vector2"> + <method name="set_debug_collisions_hint"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="queue_delete"> - <argument index="0" name="obj" type="Object"> + <method name="set_debug_navigation_hint"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="call_group"> - <argument index="0" name="flags" type="int"> - </argument> - <argument index="1" name="group" type="String"> - </argument> - <argument index="2" name="method" type="String"> - </argument> - <argument index="3" name="arg0" type="Variant" default="NULL"> - </argument> - <argument index="4" name="arg1" type="Variant" default="NULL"> - </argument> - <argument index="5" name="arg2" type="Variant" default="NULL"> - </argument> - <argument index="6" name="arg3" type="Variant" default="NULL"> - </argument> - <argument index="7" name="arg4" type="Variant" default="NULL"> + <method name="set_edited_scene_root"> + <argument index="0" name="scene" type="Object"> </argument> <description> </description> </method> - <method name="set_current_scene"> - <argument index="0" name="child_node" type="Node"> + <method name="set_editor_hint"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="get_current_scene" qualifiers="const"> - <return type="Node"> - </return> + <method name="set_group"> + <argument index="0" name="call_flags" type="int"> + </argument> + <argument index="1" name="group" type="String"> + </argument> + <argument index="2" name="property" type="String"> + </argument> + <argument index="3" name="value" type="Variant"> + </argument> <description> </description> </method> - <method name="change_scene"> - <return type="int"> - </return> - <argument index="0" name="path" type="String"> - </argument> + <method name="set_input_as_handled"> <description> </description> </method> - <method name="change_scene_to"> - <return type="int"> - </return> - <argument index="0" name="packed_scene" type="PackedScene"> + <method name="set_pause"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="reload_current_scene"> - <return type="int"> - </return> + <method name="set_screen_stretch"> + <argument index="0" name="mode" type="int"> + </argument> + <argument index="1" name="aspect" type="int"> + </argument> + <argument index="2" name="minsize" type="Vector2"> + </argument> <description> </description> </method> </methods> <signals> - <signal name="node_configuration_warning_changed"> - <argument index="0" name="node" type="Object"> + <signal name="files_dropped"> + <argument index="0" name="files" type="StringArray"> + </argument> + <argument index="1" name="screen" type="int"> </argument> <description> </description> </signal> - <signal name="screen_resized"> + <signal name="fixed_frame"> <description> </description> </signal> - <signal name="node_removed"> - <argument index="0" name="node" type="Object"> - </argument> + <signal name="idle_frame"> <description> </description> </signal> - <signal name="files_dropped"> - <argument index="0" name="files" type="StringArray"> - </argument> - <argument index="1" name="screen" type="int"> + <signal name="node_configuration_warning_changed"> + <argument index="0" name="node" type="Object"> </argument> <description> </description> </signal> - <signal name="idle_frame"> + <signal name="node_removed"> + <argument index="0" name="node" type="Object"> + </argument> <description> </description> </signal> - <signal name="tree_changed"> + <signal name="screen_resized"> <description> </description> </signal> - <signal name="fixed_frame"> + <signal name="tree_changed"> <description> </description> </signal> @@ -33542,18 +33612,18 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="GROUP_CALL_UNIQUE" value="4"> </constant> - <constant name="STRETCH_MODE_DISABLED" value="0"> - </constant> - <constant name="STRETCH_MODE_2D" value="1"> - </constant> - <constant name="STRETCH_MODE_VIEWPORT" value="2"> - </constant> <constant name="STRETCH_ASPECT_IGNORE" value="0"> </constant> + <constant name="STRETCH_MODE_DISABLED" value="0"> + </constant> <constant name="STRETCH_ASPECT_KEEP" value="1"> </constant> + <constant name="STRETCH_MODE_2D" value="1"> + </constant> <constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2"> </constant> + <constant name="STRETCH_MODE_VIEWPORT" value="2"> + </constant> <constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3"> </constant> </constants> @@ -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). </description> </method> - <method name="instance_has" qualifiers="const"> - <return type="bool"> + <method name="get_source_code" qualifiers="const"> + <return type="String"> </return> - <argument index="0" name="base_object" type="Object"> - </argument> <description> - Return true if a given object uses an instance of this script. + Return the script source code (if available). </description> </method> <method name="has_source_code" qualifiers="const"> @@ -33589,18 +33657,13 @@ This method controls whether the position between two cached points is interpola Return true if the script contains source code. </description> </method> - <method name="get_source_code" qualifiers="const"> - <return type="String"> + <method name="instance_has" qualifiers="const"> + <return type="bool"> </return> - <description> - Return the script source code (if available). - </description> - </method> - <method name="set_source_code"> - <argument index="0" name="source" type="String"> + <argument index="0" name="base_object" type="Object"> </argument> <description> - Set the script source code. + Return true if a given object uses an instance of this script. </description> </method> <method name="reload"> @@ -33611,6 +33674,13 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="set_source_code"> + <argument index="0" name="source" type="String"> + </argument> + <description> + Set the script source code. + </description> + </method> </methods> <constants> </constants> @@ -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. </description> <methods> - <method name="set_custom_step"> - <argument index="0" name="step" type="float"> - </argument> - <description> - </description> - </method> <method name="get_custom_step" qualifiers="const"> <return type="float"> </return> <description> </description> </method> + <method name="set_custom_step"> + <argument index="0" name="step" type="float"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -33647,25 +33717,25 @@ 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. </description> <methods> - <method name="set_enable_h_scroll"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_h_scroll" qualifiers="const"> + <return type="int"> + </return> <description> - Set allows horizontal scrool. + Return current horizontal scroll value. </description> </method> - <method name="is_h_scroll_enabled" qualifiers="const"> - <return type="bool"> + <method name="get_v_scroll" qualifiers="const"> + <return type="int"> </return> <description> - Return true if horizontal scrool is allowed. + Return current vertical scroll value. </description> </method> - <method name="set_enable_v_scroll"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="is_h_scroll_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> - Set allows vertical scrool. + Return true if horizontal scrool is allowed. </description> </method> <method name="is_v_scroll_enabled" qualifiers="const"> @@ -33675,32 +33745,32 @@ This method controls whether the position between two cached points is interpola Return true if vertical scrool is allowed. </description> </method> - <method name="set_h_scroll"> - <argument index="0" name="val" type="int"> + <method name="set_enable_h_scroll"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Set horizontal scroll value. + Set allows horizontal scrool. </description> </method> - <method name="get_h_scroll" qualifiers="const"> - <return type="int"> - </return> + <method name="set_enable_v_scroll"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return current horizontal scroll value. + Set allows vertical scrool. </description> </method> - <method name="set_v_scroll"> + <method name="set_h_scroll"> <argument index="0" name="val" type="int"> </argument> <description> - Set vertical scroll value. + Set horizontal scroll value. </description> </method> - <method name="get_v_scroll" qualifiers="const"> - <return type="int"> - </return> + <method name="set_v_scroll"> + <argument index="0" name="val" type="int"> + </argument> <description> - Return current vertical scroll value. + Set vertical scroll value. </description> </method> </methods> @@ -33715,32 +33785,32 @@ 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'. </description> <methods> - <method name="set_a"> - <argument index="0" name="a" type="Vector2"> - </argument> + <method name="get_a" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Set the first point's position. + Return the first point's position. </description> </method> - <method name="get_a" qualifiers="const"> + <method name="get_b" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the first point's position. + Return the second point's position. </description> </method> - <method name="set_b"> - <argument index="0" name="b" type="Vector2"> + <method name="set_a"> + <argument index="0" name="a" type="Vector2"> </argument> <description> - Set the second point's position. + Set the first point's position. </description> </method> - <method name="get_b" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_b"> + <argument index="0" name="b" type="Vector2"> + </argument> <description> - Return the second point's position. + Set the second point's position. </description> </method> </methods> @@ -33755,18 +33825,18 @@ 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. </description> <methods> - <method name="wait"> + <method name="post"> <return type="Error"> </return> <description> - Tries to wait for the [Semaphore], if it's value is zero, blocks until non-zero. + Lowers the [Semaphore], allowing one more thread in. </description> </method> - <method name="post"> + <method name="wait"> <return type="Error"> </return> <description> - Lowers the [Semaphore], allowing one more thread in. + Tries to wait for the [Semaphore], if it's value is zero, blocks until non-zero. </description> </method> </methods> @@ -33793,64 +33863,64 @@ This method controls whether the position between two cached points is interpola To be changed, ignore. </description> <methods> - <method name="get_mode" qualifiers="const"> - <return type="int"> + <method name="get_default_texture_param" qualifiers="const"> + <return type="Texture"> </return> + <argument index="0" name="param" type="String"> + </argument> <description> </description> </method> - <method name="set_code"> - <argument index="0" name="vcode" type="String"> - </argument> - <argument index="1" name="fcode" type="String"> - </argument> - <argument index="2" name="lcode" type="String"> - </argument> - <argument index="3" name="fofs" type="int" default="0"> - </argument> - <argument index="4" name="lofs" type="int" default="0"> - </argument> + <method name="get_fragment_code" qualifiers="const"> + <return type="String"> + </return> <description> </description> </method> - <method name="get_vertex_code" qualifiers="const"> + <method name="get_light_code" qualifiers="const"> <return type="String"> </return> <description> </description> </method> - <method name="get_fragment_code" qualifiers="const"> - <return type="String"> + <method name="get_mode" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="get_light_code" qualifiers="const"> + <method name="get_vertex_code" qualifiers="const"> <return type="String"> </return> <description> </description> </method> - <method name="set_default_texture_param"> - <argument index="0" name="param" type="String"> - </argument> - <argument index="1" name="texture" type="Texture"> + <method name="has_param" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> </argument> <description> </description> </method> - <method name="get_default_texture_param" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="param" type="String"> + <method name="set_code"> + <argument index="0" name="vcode" type="String"> + </argument> + <argument index="1" name="fcode" type="String"> + </argument> + <argument index="2" name="lcode" type="String"> + </argument> + <argument index="3" name="fofs" type="int" default="0"> + </argument> + <argument index="4" name="lofs" type="int" default="0"> </argument> <description> </description> </method> - <method name="has_param" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> + <method name="set_default_texture_param"> + <argument index="0" name="param" type="String"> + </argument> + <argument index="1" name="texture" type="Texture"> </argument> <description> </description> @@ -33871,17 +33941,15 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="node_add"> + <method name="clear"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="node_type" type="int"> - </argument> - <argument index="2" name="id" type="int"> - </argument> <description> </description> </method> - <method name="node_remove"> + <method name="color_ramp_node_get_colors" qualifiers="const"> + <return type="ColorArray"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> @@ -33889,28 +33957,30 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="node_set_pos"> + <method name="color_ramp_node_get_offsets" qualifiers="const"> + <return type="RealArray"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="pos" type="Vector2"> - </argument> <description> </description> </method> - <method name="node_get_pos" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="color_ramp_node_set_ramp"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> + <argument index="2" name="colors" type="ColorArray"> + </argument> + <argument index="3" name="offsets" type="RealArray"> + </argument> <description> </description> </method> - <method name="node_get_type" qualifiers="const"> - <return type="int"> + <method name="comment_node_get_text" qualifiers="const"> + <return type="String"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -33919,48 +33989,54 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_node_list" qualifiers="const"> - <return type="Array"> - </return> + <method name="comment_node_set_text"> <argument index="0" name="shader_type" type="int"> </argument> + <argument index="1" name="id" type="int"> + </argument> + <argument index="2" name="text" type="String"> + </argument> <description> </description> </method> - <method name="default_set_value"> + <method name="connect_node"> + <return type="Error"> + </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="src_id" type="int"> </argument> - <argument index="2" name="param_id" type="int"> + <argument index="2" name="src_slot" type="int"> </argument> - <argument index="3" name="value" type="Variant"> + <argument index="3" name="dst_id" type="int"> + </argument> + <argument index="4" name="dst_slot" type="int"> </argument> <description> </description> </method> - <method name="default_get_value"> + <method name="cubemap_input_node_get_value" qualifiers="const"> + <return type="CubeMap"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="param_id" type="int"> - </argument> <description> </description> </method> - <method name="scalar_const_node_set_value"> + <method name="cubemap_input_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="value" type="float"> + <argument index="2" name="value" type="CubeMap"> </argument> <description> </description> </method> - <method name="scalar_const_node_get_value" qualifiers="const"> - <return type="float"> + <method name="curve_map_node_get_points" qualifiers="const"> + <return type="Vector2Array"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -33969,78 +34045,70 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="vec_const_node_set_value"> + <method name="curve_map_node_set_points"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="value" type="Vector3"> + <argument index="2" name="points" type="Vector2Array"> </argument> <description> </description> </method> - <method name="vec_const_node_get_value" qualifiers="const"> - <return type="Vector3"> - </return> + <method name="default_get_value"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> + <argument index="2" name="param_id" type="int"> + </argument> <description> </description> </method> - <method name="rgb_const_node_set_value"> + <method name="default_set_value"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="value" type="Color"> + <argument index="2" name="param_id" type="int"> + </argument> + <argument index="3" name="value" type="Variant"> </argument> <description> </description> </method> - <method name="rgb_const_node_get_value" qualifiers="const"> - <return type="Color"> - </return> + <method name="disconnect_node"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="src_id" type="int"> </argument> - <description> - </description> - </method> - <method name="xform_const_node_set_value"> - <argument index="0" name="shader_type" type="int"> + <argument index="2" name="src_slot" type="int"> </argument> - <argument index="1" name="id" type="int"> + <argument index="3" name="dst_id" type="int"> </argument> - <argument index="2" name="value" type="Transform"> + <argument index="4" name="dst_slot" type="int"> </argument> <description> </description> </method> - <method name="xform_const_node_get_value" qualifiers="const"> - <return type="Transform"> + <method name="get_node_connections" qualifiers="const"> + <return type="Array"> </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> - </argument> <description> </description> </method> - <method name="texture_node_set_filter_size"> + <method name="get_node_list" qualifiers="const"> + <return type="Array"> + </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> - </argument> - <argument index="2" name="filter_size" type="int"> - </argument> <description> </description> </method> - <method name="texture_node_get_filter_size" qualifiers="const"> - <return type="int"> + <method name="input_node_get_name"> + <return type="String"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -34049,118 +34117,122 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="texture_node_set_filter_strength"> + <method name="input_node_set_name"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="float"> + <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="filter_strength" type="float"> + <argument index="2" name="name" type="String"> </argument> <description> </description> </method> - <method name="texture_node_get_filter_strength" qualifiers="const"> - <return type="float"> + <method name="is_node_connected" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="float"> + <argument index="1" name="src_id" type="int"> + </argument> + <argument index="2" name="src_slot" type="int"> + </argument> + <argument index="3" name="dst_id" type="int"> + </argument> + <argument index="4" name="dst_slot" type="int"> </argument> <description> </description> </method> - <method name="scalar_op_node_set_op"> + <method name="node_add"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="float"> + <argument index="1" name="node_type" type="int"> </argument> - <argument index="2" name="op" type="int"> + <argument index="2" name="id" type="int"> </argument> <description> </description> </method> - <method name="scalar_op_node_get_op" qualifiers="const"> - <return type="int"> + <method name="node_get_pos" qualifiers="const"> + <return type="Vector2"> </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="float"> + <argument index="1" name="id" type="int"> </argument> <description> </description> </method> - <method name="vec_op_node_set_op"> + <method name="node_get_state" qualifiers="const"> + <return type="Variant"> + </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="float"> - </argument> - <argument index="2" name="op" type="int"> + <argument index="1" name="id" type="int"> </argument> <description> </description> </method> - <method name="vec_op_node_get_op" qualifiers="const"> + <method name="node_get_type" qualifiers="const"> <return type="int"> </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="float"> + <argument index="1" name="id" type="int"> </argument> <description> </description> </method> - <method name="vec_scalar_op_node_set_op"> + <method name="node_remove"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="float"> - </argument> - <argument index="2" name="op" type="int"> + <argument index="1" name="id" type="int"> </argument> <description> </description> </method> - <method name="vec_scalar_op_node_get_op" qualifiers="const"> - <return type="int"> - </return> + <method name="node_set_pos"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="float"> + <argument index="1" name="id" type="int"> + </argument> + <argument index="2" name="pos" type="Vector2"> </argument> <description> </description> </method> - <method name="rgb_op_node_set_op"> + <method name="node_set_state"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="float"> + <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="op" type="int"> + <argument index="2" name="state" type="Variant"> </argument> <description> </description> </method> - <method name="rgb_op_node_get_op" qualifiers="const"> - <return type="int"> + <method name="rgb_const_node_get_value" qualifiers="const"> + <return type="Color"> </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="float"> + <argument index="1" name="id" type="int"> </argument> <description> </description> </method> - <method name="xform_vec_mult_node_set_no_translation"> + <method name="rgb_const_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="disable" type="bool"> + <argument index="2" name="value" type="Color"> </argument> <description> </description> </method> - <method name="xform_vec_mult_node_get_no_translation" qualifiers="const"> - <return type="bool"> + <method name="rgb_input_node_get_value" qualifiers="const"> + <return type="Color"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -34169,38 +34241,38 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="scalar_func_node_set_function"> + <method name="rgb_input_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="func" type="int"> + <argument index="2" name="value" type="Color"> </argument> <description> </description> </method> - <method name="scalar_func_node_get_function" qualifiers="const"> + <method name="rgb_op_node_get_op" qualifiers="const"> <return type="int"> </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="id" type="float"> </argument> <description> </description> </method> - <method name="vec_func_node_set_function"> + <method name="rgb_op_node_set_op"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="id" type="float"> </argument> - <argument index="2" name="func" type="int"> + <argument index="2" name="op" type="int"> </argument> <description> </description> </method> - <method name="vec_func_node_get_function" qualifiers="const"> - <return type="int"> + <method name="scalar_const_node_get_value" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -34209,18 +34281,18 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="input_node_set_name"> + <method name="scalar_const_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="name" type="String"> + <argument index="2" name="value" type="float"> </argument> <description> </description> </method> - <method name="input_node_get_name"> - <return type="String"> + <method name="scalar_func_node_get_function" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -34229,12 +34301,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="scalar_input_node_set_value"> + <method name="scalar_func_node_set_function"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="value" type="float"> + <argument index="2" name="func" type="int"> </argument> <description> </description> @@ -34249,38 +34321,38 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="vec_input_node_set_value"> + <method name="scalar_input_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="value" type="Vector3"> + <argument index="2" name="value" type="float"> </argument> <description> </description> </method> - <method name="vec_input_node_get_value" qualifiers="const"> - <return type="Vector3"> + <method name="scalar_op_node_get_op" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="id" type="float"> </argument> <description> </description> </method> - <method name="rgb_input_node_set_value"> + <method name="scalar_op_node_set_op"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="id" type="float"> </argument> - <argument index="2" name="value" type="Color"> + <argument index="2" name="op" type="int"> </argument> <description> </description> </method> - <method name="rgb_input_node_get_value" qualifiers="const"> - <return type="Color"> + <method name="texture_input_node_get_value" qualifiers="const"> + <return type="Texture"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -34289,18 +34361,18 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="xform_input_node_set_value"> + <method name="texture_input_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="value" type="Transform"> + <argument index="2" name="value" type="Texture"> </argument> <description> </description> </method> - <method name="xform_input_node_get_value" qualifiers="const"> - <return type="Transform"> + <method name="texture_node_get_filter_size" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -34309,38 +34381,38 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="texture_input_node_set_value"> + <method name="texture_node_get_filter_strength" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> - </argument> - <argument index="2" name="value" type="Texture"> + <argument index="1" name="id" type="float"> </argument> <description> </description> </method> - <method name="texture_input_node_get_value" qualifiers="const"> - <return type="Texture"> - </return> + <method name="texture_node_set_filter_size"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> + <argument index="2" name="filter_size" type="int"> + </argument> <description> </description> </method> - <method name="cubemap_input_node_set_value"> + <method name="texture_node_set_filter_strength"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="id" type="float"> </argument> - <argument index="2" name="value" type="CubeMap"> + <argument index="2" name="filter_strength" type="float"> </argument> <description> </description> </method> - <method name="cubemap_input_node_get_value" qualifiers="const"> - <return type="CubeMap"> + <method name="vec_const_node_get_value" qualifiers="const"> + <return type="Vector3"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -34349,18 +34421,18 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="comment_node_set_text"> + <method name="vec_const_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="text" type="String"> + <argument index="2" name="value" type="Vector3"> </argument> <description> </description> </method> - <method name="comment_node_get_text" qualifiers="const"> - <return type="String"> + <method name="vec_func_node_get_function" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -34369,20 +34441,18 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="color_ramp_node_set_ramp"> + <method name="vec_func_node_set_function"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="colors" type="ColorArray"> - </argument> - <argument index="3" name="offsets" type="RealArray"> + <argument index="2" name="func" type="int"> </argument> <description> </description> </method> - <method name="color_ramp_node_get_colors" qualifiers="const"> - <return type="ColorArray"> + <method name="vec_input_node_get_value" qualifiers="const"> + <return type="Vector3"> </return> <argument index="0" name="shader_type" type="int"> </argument> @@ -34391,113 +34461,113 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="color_ramp_node_get_offsets" qualifiers="const"> - <return type="RealArray"> - </return> + <method name="vec_input_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> + <argument index="2" name="value" type="Vector3"> + </argument> <description> </description> </method> - <method name="curve_map_node_set_points"> + <method name="vec_op_node_get_op" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> - </argument> - <argument index="2" name="points" type="Vector2Array"> + <argument index="1" name="id" type="float"> </argument> <description> </description> </method> - <method name="curve_map_node_get_points" qualifiers="const"> - <return type="Vector2Array"> - </return> + <method name="vec_op_node_set_op"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="id" type="int"> + <argument index="1" name="id" type="float"> + </argument> + <argument index="2" name="op" type="int"> </argument> <description> </description> </method> - <method name="connect_node"> - <return type="Error"> + <method name="vec_scalar_op_node_get_op" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="src_id" type="int"> + <argument index="1" name="id" type="float"> </argument> - <argument index="2" name="src_slot" type="int"> + <description> + </description> + </method> + <method name="vec_scalar_op_node_set_op"> + <argument index="0" name="shader_type" type="int"> </argument> - <argument index="3" name="dst_id" type="int"> + <argument index="1" name="id" type="float"> </argument> - <argument index="4" name="dst_slot" type="int"> + <argument index="2" name="op" type="int"> </argument> <description> </description> </method> - <method name="is_node_connected" qualifiers="const"> - <return type="bool"> + <method name="xform_const_node_get_value" qualifiers="const"> + <return type="Transform"> </return> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="src_id" type="int"> - </argument> - <argument index="2" name="src_slot" type="int"> - </argument> - <argument index="3" name="dst_id" type="int"> - </argument> - <argument index="4" name="dst_slot" type="int"> + <argument index="1" name="id" type="int"> </argument> <description> </description> </method> - <method name="disconnect_node"> + <method name="xform_const_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> - <argument index="1" name="src_id" type="int"> - </argument> - <argument index="2" name="src_slot" type="int"> - </argument> - <argument index="3" name="dst_id" type="int"> + <argument index="1" name="id" type="int"> </argument> - <argument index="4" name="dst_slot" type="int"> + <argument index="2" name="value" type="Transform"> </argument> <description> </description> </method> - <method name="get_node_connections" qualifiers="const"> - <return type="Array"> + <method name="xform_input_node_get_value" qualifiers="const"> + <return type="Transform"> </return> <argument index="0" name="shader_type" type="int"> </argument> + <argument index="1" name="id" type="int"> + </argument> <description> </description> </method> - <method name="clear"> + <method name="xform_input_node_set_value"> <argument index="0" name="shader_type" type="int"> </argument> + <argument index="1" name="id" type="int"> + </argument> + <argument index="2" name="value" type="Transform"> + </argument> <description> </description> </method> - <method name="node_set_state"> + <method name="xform_vec_mult_node_get_no_translation" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="state" type="Variant"> - </argument> <description> </description> </method> - <method name="node_get_state" qualifiers="const"> - <return type="Variant"> - </return> + <method name="xform_vec_mult_node_set_no_translation"> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> + <argument index="2" name="disable" type="bool"> + </argument> <description> </description> </method> @@ -34509,25 +34579,15 @@ This method controls whether the position between two cached points is interpola </signal> </signals> <constants> - <constant name="NODE_INPUT" value="0"> - </constant> - <constant name="NODE_SCALAR_CONST" value="1"> - </constant> - <constant name="NODE_VEC_CONST" value="2"> - </constant> - <constant name="NODE_RGB_CONST" value="3"> - </constant> - <constant name="NODE_XFORM_CONST" value="4"> - </constant> - <constant name="NODE_TIME" value="5"> + <constant name="GRAPH_OK" value="0"> </constant> - <constant name="NODE_SCREEN_TEX" value="6"> + <constant name="GRAPH_ERROR_CYCLIC" value="1"> </constant> - <constant name="NODE_SCALAR_OP" value="7"> + <constant name="GRAPH_ERROR_MISSING_CONNECTIONS" value="2"> </constant> - <constant name="NODE_VEC_OP" value="8"> + <constant name="NODE_INPUT" value="0"> </constant> - <constant name="NODE_VEC_SCALAR_OP" value="9"> + <constant name="NODE_SCALAR_CONST" value="1"> </constant> <constant name="NODE_RGB_OP" value="10"> </constant> @@ -34549,10 +34609,12 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="NODE_SCALAR_TO_VEC" value="19"> </constant> - <constant name="NODE_VEC_TO_XFORM" value="21"> + <constant name="NODE_VEC_CONST" value="2"> </constant> <constant name="NODE_XFORM_TO_VEC" value="20"> </constant> + <constant name="NODE_VEC_TO_XFORM" value="21"> + </constant> <constant name="NODE_SCALAR_INTERP" value="22"> </constant> <constant name="NODE_VEC_INTERP" value="23"> @@ -34569,6 +34631,8 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="NODE_XFORM_INPUT" value="29"> </constant> + <constant name="NODE_RGB_CONST" value="3"> + </constant> <constant name="NODE_TEXTURE_INPUT" value="30"> </constant> <constant name="NODE_CUBEMAP_INPUT" value="31"> @@ -34581,157 +34645,163 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="NODE_TYPE_MAX" value="35"> </constant> - <constant name="SLOT_TYPE_SCALAR" value="0"> + <constant name="NODE_XFORM_CONST" value="4"> </constant> - <constant name="SLOT_TYPE_VEC" value="1"> + <constant name="NODE_TIME" value="5"> </constant> - <constant name="SLOT_TYPE_XFORM" value="2"> + <constant name="NODE_SCREEN_TEX" value="6"> </constant> - <constant name="SLOT_TYPE_TEXTURE" value="3"> + <constant name="NODE_SCALAR_OP" value="7"> </constant> - <constant name="SLOT_MAX" value="4"> + <constant name="NODE_VEC_OP" value="8"> </constant> - <constant name="SHADER_TYPE_VERTEX" value="0"> + <constant name="NODE_VEC_SCALAR_OP" value="9"> </constant> - <constant name="SHADER_TYPE_FRAGMENT" value="1"> + <constant name="RGB_OP_SCREEN" value="0"> </constant> - <constant name="SHADER_TYPE_LIGHT" value="2"> + <constant name="RGB_OP_DIFFERENCE" value="1"> </constant> - <constant name="SHADER_TYPE_MAX" value="3"> + <constant name="RGB_OP_DARKEN" value="2"> </constant> - <constant name="SLOT_IN" value="0"> + <constant name="RGB_OP_LIGHTEN" value="3"> </constant> - <constant name="SLOT_OUT" value="1"> + <constant name="RGB_OP_OVERLAY" value="4"> </constant> - <constant name="GRAPH_OK" value="0"> + <constant name="RGB_OP_DODGE" value="5"> </constant> - <constant name="GRAPH_ERROR_CYCLIC" value="1"> + <constant name="RGB_OP_BURN" value="6"> </constant> - <constant name="GRAPH_ERROR_MISSING_CONNECTIONS" value="2"> + <constant name="RGB_OP_SOFT_LIGHT" value="7"> + </constant> + <constant name="RGB_OP_HARD_LIGHT" value="8"> + </constant> + <constant name="RGB_MAX_OP" value="9"> + </constant> + <constant name="SCALAR_FUNC_SIN" value="0"> </constant> <constant name="SCALAR_OP_ADD" value="0"> </constant> - <constant name="SCALAR_OP_SUB" value="1"> + <constant name="SCALAR_FUNC_COS" value="1"> </constant> - <constant name="SCALAR_OP_MUL" value="2"> + <constant name="SCALAR_OP_SUB" value="1"> </constant> - <constant name="SCALAR_OP_DIV" value="3"> + <constant name="SCALAR_FUNC_EXP" value="10"> </constant> - <constant name="SCALAR_OP_MOD" value="4"> + <constant name="SCALAR_FUNC_SQRT" value="11"> </constant> - <constant name="SCALAR_OP_POW" value="5"> + <constant name="SCALAR_FUNC_ABS" value="12"> </constant> - <constant name="SCALAR_OP_MAX" value="6"> + <constant name="SCALAR_FUNC_SIGN" value="13"> </constant> - <constant name="SCALAR_OP_MIN" value="7"> + <constant name="SCALAR_FUNC_FLOOR" value="14"> </constant> - <constant name="SCALAR_OP_ATAN2" value="8"> + <constant name="SCALAR_FUNC_ROUND" value="15"> </constant> - <constant name="SCALAR_MAX_OP" value="9"> + <constant name="SCALAR_FUNC_CEIL" value="16"> </constant> - <constant name="VEC_OP_ADD" value="0"> + <constant name="SCALAR_FUNC_FRAC" value="17"> </constant> - <constant name="VEC_OP_SUB" value="1"> + <constant name="SCALAR_FUNC_SATURATE" value="18"> </constant> - <constant name="VEC_OP_MUL" value="2"> + <constant name="SCALAR_FUNC_NEGATE" value="19"> </constant> - <constant name="VEC_OP_DIV" value="3"> + <constant name="SCALAR_FUNC_TAN" value="2"> </constant> - <constant name="VEC_OP_MOD" value="4"> + <constant name="SCALAR_OP_MUL" value="2"> </constant> - <constant name="VEC_OP_POW" value="5"> + <constant name="SCALAR_MAX_FUNC" value="20"> </constant> - <constant name="VEC_OP_MAX" value="6"> + <constant name="SCALAR_FUNC_ASIN" value="3"> </constant> - <constant name="VEC_OP_MIN" value="7"> + <constant name="SCALAR_OP_DIV" value="3"> </constant> - <constant name="VEC_OP_CROSS" value="8"> + <constant name="SCALAR_FUNC_ACOS" value="4"> </constant> - <constant name="VEC_MAX_OP" value="9"> + <constant name="SCALAR_OP_MOD" value="4"> </constant> - <constant name="VEC_SCALAR_OP_MUL" value="0"> + <constant name="SCALAR_FUNC_ATAN" value="5"> </constant> - <constant name="VEC_SCALAR_OP_DIV" value="1"> + <constant name="SCALAR_OP_POW" value="5"> </constant> - <constant name="VEC_SCALAR_OP_POW" value="2"> + <constant name="SCALAR_FUNC_SINH" value="6"> </constant> - <constant name="VEC_SCALAR_MAX_OP" value="3"> + <constant name="SCALAR_OP_MAX" value="6"> </constant> - <constant name="RGB_OP_SCREEN" value="0"> + <constant name="SCALAR_FUNC_COSH" value="7"> </constant> - <constant name="RGB_OP_DIFFERENCE" value="1"> + <constant name="SCALAR_OP_MIN" value="7"> </constant> - <constant name="RGB_OP_DARKEN" value="2"> + <constant name="SCALAR_FUNC_TANH" value="8"> </constant> - <constant name="RGB_OP_LIGHTEN" value="3"> + <constant name="SCALAR_OP_ATAN2" value="8"> </constant> - <constant name="RGB_OP_OVERLAY" value="4"> + <constant name="SCALAR_FUNC_LOG" value="9"> </constant> - <constant name="RGB_OP_DODGE" value="5"> + <constant name="SCALAR_MAX_OP" value="9"> </constant> - <constant name="RGB_OP_BURN" value="6"> + <constant name="SHADER_TYPE_VERTEX" value="0"> </constant> - <constant name="RGB_OP_SOFT_LIGHT" value="7"> + <constant name="SHADER_TYPE_FRAGMENT" value="1"> </constant> - <constant name="RGB_OP_HARD_LIGHT" value="8"> + <constant name="SHADER_TYPE_LIGHT" value="2"> </constant> - <constant name="RGB_MAX_OP" value="9"> + <constant name="SHADER_TYPE_MAX" value="3"> </constant> - <constant name="SCALAR_FUNC_SIN" value="0"> + <constant name="SLOT_IN" value="0"> </constant> - <constant name="SCALAR_FUNC_COS" value="1"> + <constant name="SLOT_TYPE_SCALAR" value="0"> </constant> - <constant name="SCALAR_FUNC_TAN" value="2"> + <constant name="SLOT_OUT" value="1"> </constant> - <constant name="SCALAR_FUNC_ASIN" value="3"> + <constant name="SLOT_TYPE_VEC" value="1"> </constant> - <constant name="SCALAR_FUNC_ACOS" value="4"> + <constant name="SLOT_TYPE_XFORM" value="2"> </constant> - <constant name="SCALAR_FUNC_ATAN" value="5"> + <constant name="SLOT_TYPE_TEXTURE" value="3"> </constant> - <constant name="SCALAR_FUNC_SINH" value="6"> + <constant name="SLOT_MAX" value="4"> </constant> - <constant name="SCALAR_FUNC_COSH" value="7"> + <constant name="VEC_FUNC_NORMALIZE" value="0"> </constant> - <constant name="SCALAR_FUNC_TANH" value="8"> + <constant name="VEC_OP_ADD" value="0"> </constant> - <constant name="SCALAR_FUNC_LOG" value="9"> + <constant name="VEC_SCALAR_OP_MUL" value="0"> </constant> - <constant name="SCALAR_FUNC_EXP" value="10"> + <constant name="VEC_FUNC_SATURATE" value="1"> </constant> - <constant name="SCALAR_FUNC_SQRT" value="11"> + <constant name="VEC_OP_SUB" value="1"> </constant> - <constant name="SCALAR_FUNC_ABS" value="12"> + <constant name="VEC_SCALAR_OP_DIV" value="1"> </constant> - <constant name="SCALAR_FUNC_SIGN" value="13"> + <constant name="VEC_FUNC_NEGATE" value="2"> </constant> - <constant name="SCALAR_FUNC_FLOOR" value="14"> + <constant name="VEC_OP_MUL" value="2"> </constant> - <constant name="SCALAR_FUNC_ROUND" value="15"> + <constant name="VEC_SCALAR_OP_POW" value="2"> </constant> - <constant name="SCALAR_FUNC_CEIL" value="16"> + <constant name="VEC_FUNC_RECIPROCAL" value="3"> </constant> - <constant name="SCALAR_FUNC_FRAC" value="17"> + <constant name="VEC_OP_DIV" value="3"> </constant> - <constant name="SCALAR_FUNC_SATURATE" value="18"> + <constant name="VEC_SCALAR_MAX_OP" value="3"> </constant> - <constant name="SCALAR_FUNC_NEGATE" value="19"> + <constant name="VEC_FUNC_RGB2HSV" value="4"> </constant> - <constant name="SCALAR_MAX_FUNC" value="20"> + <constant name="VEC_OP_MOD" value="4"> </constant> - <constant name="VEC_FUNC_NORMALIZE" value="0"> + <constant name="VEC_FUNC_HSV2RGB" value="5"> </constant> - <constant name="VEC_FUNC_SATURATE" value="1"> + <constant name="VEC_OP_POW" value="5"> </constant> - <constant name="VEC_FUNC_NEGATE" value="2"> + <constant name="VEC_MAX_FUNC" value="6"> </constant> - <constant name="VEC_FUNC_RECIPROCAL" value="3"> + <constant name="VEC_OP_MAX" value="6"> </constant> - <constant name="VEC_FUNC_RGB2HSV" value="4"> + <constant name="VEC_OP_MIN" value="7"> </constant> - <constant name="VEC_FUNC_HSV2RGB" value="5"> + <constant name="VEC_OP_CROSS" value="8"> </constant> - <constant name="VEC_MAX_FUNC" value="6"> + <constant name="VEC_MAX_OP" value="9"> </constant> </constants> </class> @@ -34741,31 +34811,31 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_shader"> - <argument index="0" name="shader" type="Shader"> - </argument> - <description> - </description> - </method> <method name="get_shader" qualifiers="const"> <return type="Shader"> </return> <description> </description> </method> - <method name="set_shader_param"> + <method name="get_shader_param" qualifiers="const"> + <return type="Variant"> + </return> <argument index="0" name="param" type="String"> </argument> - <argument index="1" name="value" type="Variant"> + <description> + </description> + </method> + <method name="set_shader"> + <argument index="0" name="shader" type="Shader"> </argument> <description> </description> </method> - <method name="get_shader_param" qualifiers="const"> - <return type="Variant"> - </return> + <method name="set_shader_param"> <argument index="0" name="param" type="String"> </argument> + <argument index="1" name="value" type="Variant"> + </argument> <description> </description> </method> @@ -34791,23 +34861,22 @@ 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. </description> <methods> - <method name="set_custom_solver_bias"> - <argument index="0" name="bias" type="float"> - </argument> - <description> - 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. - </description> - </method> - <method name="get_custom_solver_bias" qualifiers="const"> - <return type="float"> + <method name="collide"> + <return type="bool"> </return> + <argument index="0" name="local_xform" type="Matrix32"> + </argument> + <argument index="1" name="with_shape" type="Shape2D"> + </argument> + <argument index="2" name="shape_xform" type="Matrix32"> + </argument> <description> - Return the custom solver bias. + Return whether this shape is colliding with another. + 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]). </description> </method> - <method name="collide"> - <return type="bool"> + <method name="collide_and_get_contacts"> + <return type="Variant"> </return> <argument index="0" name="local_xform" type="Matrix32"> </argument> @@ -34816,7 +34885,7 @@ This method controls whether the position between two cached points is interpola <argument index="2" name="shape_xform" type="Matrix32"> </argument> <description> - Return whether this shape is colliding with another. + 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]). </description> </method> @@ -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]). </description> </method> - <method name="collide_and_get_contacts"> - <return type="Variant"> - </return> - <argument index="0" name="local_xform" type="Matrix32"> - </argument> - <argument index="1" name="with_shape" type="Shape2D"> - </argument> - <argument index="2" name="shape_xform" type="Matrix32"> - </argument> - <description> - 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]). - </description> - </method> <method name="collide_with_motion_and_get_contacts"> <return type="Variant"> </return> @@ -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]). </description> </method> + <method name="get_custom_solver_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the custom solver bias. + </description> + </method> + <method name="set_custom_solver_bias"> + <argument index="0" name="bias" type="float"> + </argument> + <description> + 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. + </description> + </method> </methods> <constants> </constants> @@ -34880,9 +34950,9 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_shortcut"> - <argument index="0" name="event" type="InputEvent"> - </argument> + <method name="get_as_text" qualifiers="const"> + <return type="String"> + </return> <description> </description> </method> @@ -34892,23 +34962,23 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="is_valid" qualifiers="const"> + <method name="is_shortcut" qualifiers="const"> <return type="bool"> </return> + <argument index="0" name="event" type="InputEvent"> + </argument> <description> </description> </method> - <method name="is_shortcut" qualifiers="const"> + <method name="is_valid" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="event" type="InputEvent"> - </argument> <description> </description> </method> - <method name="get_as_text" qualifiers="const"> - <return type="String"> - </return> + <method name="set_shortcut"> + <argument index="0" name="event" type="InputEvent"> + </argument> <description> </description> </method> @@ -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. </description> </method> + <method name="bind_child_node_to_bone"> + <argument index="0" name="bone_idx" type="int"> + </argument> + <argument index="1" name="node" type="Node"> + </argument> + <description> + Deprecated soon. + </description> + </method> + <method name="clear_bones"> + <description> + Clear all the bones in this skeleton. + </description> + </method> <method name="find_bone" qualifiers="const"> <return type="int"> </return> @@ -34940,44 +35024,54 @@ This method controls whether the position between two cached points is interpola Return the bone index that matches "name" as its name. </description> </method> - <method name="get_bone_name" qualifiers="const"> - <return type="String"> + <method name="get_bone_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of bones in the skeleton. + </description> + </method> + <method name="get_bone_custom_pose" qualifiers="const"> + <return type="Transform"> </return> <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the name of the bone at index "index" </description> </method> - <method name="get_bone_parent" qualifiers="const"> - <return type="int"> + <method name="get_bone_global_pose" qualifiers="const"> + <return type="Transform"> </return> <argument index="0" name="bone_idx" type="int"> </argument> <description> - 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". </description> </method> - <method name="set_bone_parent"> + <method name="get_bone_name" qualifiers="const"> + <return type="String"> + </return> <argument index="0" name="bone_idx" type="int"> </argument> - <argument index="1" name="parent_idx" type="int"> - </argument> <description> - 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 name of the bone at index "index" </description> </method> - <method name="get_bone_count" qualifiers="const"> + <method name="get_bone_parent" qualifiers="const"> <return type="int"> </return> + <argument index="0" name="bone_idx" type="int"> + </argument> <description> - Return the amount of bones in the skeleton. + 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". </description> </method> - <method name="unparent_bone_and_rest"> + <method name="get_bone_pose" qualifiers="const"> + <return type="Transform"> + </return> <argument index="0" name="bone_idx" type="int"> </argument> <description> + Return the pose transform for bone "bone_idx". </description> </method> <method name="get_bone_rest" qualifiers="const"> @@ -34989,21 +35083,21 @@ This method controls whether the position between two cached points is interpola Return the rest transform for a bone "bone_idx". </description> </method> - <method name="set_bone_rest"> + <method name="get_bone_transform" qualifiers="const"> + <return type="Transform"> + </return> <argument index="0" name="bone_idx" type="int"> </argument> - <argument index="1" name="rest" type="Transform"> - </argument> <description> - Set the rest transform for bone "bone_idx" </description> </method> - <method name="set_bone_disable_rest"> + <method name="get_bound_child_nodes_to_bone" qualifiers="const"> + <return type="Array"> + </return> <argument index="0" name="bone_idx" type="int"> </argument> - <argument index="1" name="disable" type="bool"> - </argument> <description> + Deprecated soon. </description> </method> <method name="is_bone_rest_disabled" qualifiers="const"> @@ -35014,91 +35108,67 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="bind_child_node_to_bone"> + <method name="set_bone_custom_pose"> <argument index="0" name="bone_idx" type="int"> </argument> - <argument index="1" name="node" type="Node"> + <argument index="1" name="custom_pose" type="Transform"> </argument> <description> - Deprecated soon. </description> </method> - <method name="unbind_child_node_from_bone"> + <method name="set_bone_disable_rest"> <argument index="0" name="bone_idx" type="int"> </argument> - <argument index="1" name="node" type="Node"> + <argument index="1" name="disable" type="bool"> </argument> <description> - Deprecated soon. </description> </method> - <method name="get_bound_child_nodes_to_bone" qualifiers="const"> - <return type="Array"> - </return> + <method name="set_bone_global_pose"> <argument index="0" name="bone_idx" type="int"> </argument> - <description> - Deprecated soon. - </description> - </method> - <method name="clear_bones"> - <description> - Clear all the bones in this skeleton. - </description> - </method> - <method name="get_bone_pose" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="bone_idx" type="int"> + <argument index="1" name="pose" type="Transform"> </argument> <description> - Return the pose transform for bone "bone_idx". </description> </method> - <method name="set_bone_pose"> + <method name="set_bone_parent"> <argument index="0" name="bone_idx" type="int"> </argument> - <argument index="1" name="pose" type="Transform"> + <argument index="1" name="parent_idx" type="int"> </argument> <description> - Return the pose transform for bone "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". </description> </method> - <method name="set_bone_global_pose"> + <method name="set_bone_pose"> <argument index="0" name="bone_idx" type="int"> </argument> <argument index="1" name="pose" type="Transform"> </argument> <description> + Return the pose transform for bone "bone_idx". </description> </method> - <method name="get_bone_global_pose" qualifiers="const"> - <return type="Transform"> - </return> + <method name="set_bone_rest"> <argument index="0" name="bone_idx" type="int"> </argument> - <description> - </description> - </method> - <method name="get_bone_custom_pose" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="bone_idx" type="int"> + <argument index="1" name="rest" type="Transform"> </argument> <description> + Set the rest transform for bone "bone_idx" </description> </method> - <method name="set_bone_custom_pose"> + <method name="unbind_child_node_from_bone"> <argument index="0" name="bone_idx" type="int"> </argument> - <argument index="1" name="custom_pose" type="Transform"> + <argument index="1" name="node" type="Node"> </argument> <description> + Deprecated soon. </description> </method> - <method name="get_bone_transform" qualifiers="const"> - <return type="Transform"> - </return> + <method name="unparent_bone_and_rest"> <argument index="0" name="bone_idx" type="int"> </argument> <description> @@ -35118,13 +35188,6 @@ This method controls whether the position between two cached points is interpola Base class for GUI Sliders. </description> <methods> - <method name="set_ticks"> - <argument index="0" name="count" type="int"> - </argument> - <description> - Set amount of ticks to display in slider. - </description> - </method> <method name="get_ticks" qualifiers="const"> <return type="int"> </return> @@ -35139,6 +35202,13 @@ This method controls whether the position between two cached points is interpola Return true if ticks are visible on borders. </description> </method> + <method name="set_ticks"> + <argument index="0" name="count" type="int"> + </argument> + <description> + Set amount of ticks to display in slider. + </description> + </method> <method name="set_ticks_on_borders"> <argument index="0" name="ticks_on_border" type="bool"> </argument> @@ -35156,19 +35226,19 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_param"> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="param" type="int"> </argument> - <argument index="1" name="value" type="float"> - </argument> <description> </description> </method> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> + <method name="set_param"> <argument index="0" name="param" type="int"> </argument> + <argument index="1" name="value" type="float"> + </argument> <description> </description> </method> @@ -35178,22 +35248,6 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="PARAM_LINEAR_LIMIT_LOWER" value="1"> </constant> - <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2"> - </constant> - <constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3"> - </constant> - <constant name="PARAM_LINEAR_LIMIT_DAMPING" value="4"> - </constant> - <constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5"> - </constant> - <constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6"> - </constant> - <constant name="PARAM_LINEAR_MOTION_DAMPING" value="7"> - </constant> - <constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8"> - </constant> - <constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9"> - </constant> <constant name="PARAM_LINEAR_ORTHOGONAL_DAMPING" value="10"> </constant> <constant name="PARAM_ANGULAR_LIMIT_UPPER" value="11"> @@ -35214,12 +35268,28 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="PARAM_ANGULAR_ORTHOGONAL_SOFTNESS" value="19"> </constant> + <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2"> + </constant> <constant name="PARAM_ANGULAR_ORTHOGONAL_RESTITUTION" value="20"> </constant> <constant name="PARAM_ANGULAR_ORTHOGONAL_DAMPING" value="21"> </constant> <constant name="PARAM_MAX" value="22"> </constant> + <constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3"> + </constant> + <constant name="PARAM_LINEAR_LIMIT_DAMPING" value="4"> + </constant> + <constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5"> + </constant> + <constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6"> + </constant> + <constant name="PARAM_LINEAR_MOTION_DAMPING" value="7"> + </constant> + <constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8"> + </constant> + <constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9"> + </constant> </constants> </class> <class name="SoundPlayer2D" inherits="Node2D" category="Core"> @@ -35230,19 +35300,19 @@ This method controls whether the position between two cached points is interpola Base class for playing spatial 2D sound. </description> <methods> - <method name="set_param"> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="param" type="int"> </argument> - <argument index="1" name="value" type="float"> - </argument> <description> </description> </method> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> + <method name="set_param"> <argument index="0" name="param" type="int"> </argument> + <argument index="1" name="value" type="float"> + </argument> <description> </description> </method> @@ -35268,14 +35338,6 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_param"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="float"> - </argument> - <description> - </description> - </method> <method name="get_param" qualifiers="const"> <return type="float"> </return> @@ -35284,14 +35346,14 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_reverb_mode"> - <argument index="0" name="reverb_mode" type="int"> - </argument> + <method name="get_reverb_mode" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_reverb_mode" qualifiers="const"> - <return type="int"> + <method name="is_forcing_params_to_all_sources"> + <return type="bool"> </return> <description> </description> @@ -35302,9 +35364,17 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="is_forcing_params_to_all_sources"> - <return type="bool"> - </return> + <method name="set_param"> + <argument index="0" name="param" type="int"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_reverb_mode"> + <argument index="0" name="reverb_mode" type="int"> + </argument> <description> </description> </method> @@ -35320,98 +35390,90 @@ 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. </description> <methods> - <method name="set_transform"> - <argument index="0" name="local" type="Transform"> - </argument> + <method name="get_gizmo" qualifiers="const"> + <return type="SpatialGizmo"> + </return> <description> - Set the transform locally, relative to the parent spatial node. </description> </method> - <method name="get_transform" qualifiers="const"> + <method name="get_global_transform" qualifiers="const"> <return type="Transform"> </return> <description> - Return the local transform, relative to the bone parent. + Return the global transform, relative to worldspace. </description> </method> - <method name="set_translation"> - <argument index="0" name="translation" type="Vector3"> - </argument> + <method name="get_parent_spatial" qualifiers="const"> + <return type="Object"> + </return> <description> + Return the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial]. </description> </method> - <method name="get_translation" qualifiers="const"> + <method name="get_rotation" qualifiers="const"> <return type="Vector3"> </return> <description> </description> </method> - <method name="set_rotation"> - <argument index="0" name="rotation_rad" type="Vector3"> - </argument> + <method name="get_rotation_deg" qualifiers="const"> + <return type="Vector3"> + </return> <description> </description> </method> - <method name="get_rotation" qualifiers="const"> + <method name="get_scale" qualifiers="const"> <return type="Vector3"> </return> <description> </description> </method> - <method name="set_rotation_deg"> - <argument index="0" name="rotation_deg" type="Vector3"> - </argument> + <method name="get_transform" qualifiers="const"> + <return type="Transform"> + </return> <description> + Return the local transform, relative to the bone parent. </description> </method> - <method name="get_rotation_deg" qualifiers="const"> + <method name="get_translation" qualifiers="const"> <return type="Vector3"> </return> <description> </description> </method> - <method name="set_scale"> - <argument index="0" name="scale" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_scale" qualifiers="const"> - <return type="Vector3"> + <method name="get_world" qualifiers="const"> + <return type="World"> </return> <description> </description> </method> - <method name="set_global_transform"> - <argument index="0" name="global" type="Transform"> + <method name="global_rotate"> + <argument index="0" name="normal" type="Vector3"> + </argument> + <argument index="1" name="radians" type="float"> </argument> <description> - Set the transform globally, relative to worldspace. </description> </method> - <method name="get_global_transform" qualifiers="const"> - <return type="Transform"> - </return> + <method name="global_translate"> + <argument index="0" name="offset" type="Vector3"> + </argument> <description> - Return the global transform, relative to worldspace. </description> </method> - <method name="get_parent_spatial" qualifiers="const"> - <return type="Object"> - </return> + <method name="hide"> <description> - Return the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial]. </description> </method> - <method name="set_ignore_transform_notification"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="is_hidden" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="set_as_toplevel"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="is_local_transform_notification_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> @@ -35421,135 +35483,143 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_world" qualifiers="const"> - <return type="World"> + <method name="is_visible" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="update_gizmo"> + <method name="look_at"> + <argument index="0" name="target" type="Vector3"> + </argument> + <argument index="1" name="up" type="Vector3"> + </argument> <description> </description> </method> - <method name="set_gizmo"> - <argument index="0" name="gizmo" type="SpatialGizmo"> + <method name="look_at_from_pos"> + <argument index="0" name="pos" type="Vector3"> + </argument> + <argument index="1" name="target" type="Vector3"> + </argument> + <argument index="2" name="up" type="Vector3"> </argument> <description> </description> </method> - <method name="get_gizmo" qualifiers="const"> - <return type="SpatialGizmo"> - </return> + <method name="orthonormalize"> <description> </description> </method> - <method name="show"> + <method name="rotate"> + <argument index="0" name="normal" type="Vector3"> + </argument> + <argument index="1" name="radians" type="float"> + </argument> <description> </description> </method> - <method name="hide"> + <method name="rotate_x"> + <argument index="0" name="radians" type="float"> + </argument> <description> </description> </method> - <method name="is_visible" qualifiers="const"> - <return type="bool"> - </return> + <method name="rotate_y"> + <argument index="0" name="radians" type="float"> + </argument> <description> </description> </method> - <method name="is_hidden" qualifiers="const"> - <return type="bool"> - </return> + <method name="rotate_z"> + <argument index="0" name="radians" type="float"> + </argument> <description> </description> </method> - <method name="set_hidden"> - <argument index="0" name="hidden" type="bool"> + <method name="set_as_toplevel"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="set_notify_local_transform"> - <argument index="0" name="enable" type="bool"> + <method name="set_gizmo"> + <argument index="0" name="gizmo" type="SpatialGizmo"> </argument> <description> </description> </method> - <method name="is_local_transform_notification_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_global_transform"> + <argument index="0" name="global" type="Transform"> + </argument> <description> + Set the transform globally, relative to worldspace. </description> </method> - <method name="rotate"> - <argument index="0" name="normal" type="Vector3"> - </argument> - <argument index="1" name="radians" type="float"> + <method name="set_hidden"> + <argument index="0" name="hidden" type="bool"> </argument> <description> </description> </method> - <method name="global_rotate"> - <argument index="0" name="normal" type="Vector3"> - </argument> - <argument index="1" name="radians" type="float"> + <method name="set_identity"> + <description> + </description> + </method> + <method name="set_ignore_transform_notification"> + <argument index="0" name="enabled" type="bool"> </argument> <description> </description> </method> - <method name="rotate_x"> - <argument index="0" name="radians" type="float"> + <method name="set_notify_local_transform"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="rotate_y"> - <argument index="0" name="radians" type="float"> + <method name="set_rotation"> + <argument index="0" name="rotation_rad" type="Vector3"> </argument> <description> </description> </method> - <method name="rotate_z"> - <argument index="0" name="radians" type="float"> + <method name="set_rotation_deg"> + <argument index="0" name="rotation_deg" type="Vector3"> </argument> <description> </description> </method> - <method name="translate"> - <argument index="0" name="offset" type="Vector3"> + <method name="set_scale"> + <argument index="0" name="scale" type="Vector3"> </argument> <description> </description> </method> - <method name="global_translate"> - <argument index="0" name="offset" type="Vector3"> + <method name="set_transform"> + <argument index="0" name="local" type="Transform"> </argument> <description> + Set the transform locally, relative to the parent spatial node. </description> </method> - <method name="orthonormalize"> + <method name="set_translation"> + <argument index="0" name="translation" type="Vector3"> + </argument> <description> </description> </method> - <method name="set_identity"> + <method name="show"> <description> </description> </method> - <method name="look_at"> - <argument index="0" name="target" type="Vector3"> - </argument> - <argument index="1" name="up" type="Vector3"> + <method name="translate"> + <argument index="0" name="offset" type="Vector3"> </argument> <description> </description> </method> - <method name="look_at_from_pos"> - <argument index="0" name="pos" type="Vector3"> - </argument> - <argument index="1" name="target" type="Vector3"> - </argument> - <argument index="2" name="up" type="Vector3"> - </argument> + <method name="update_gizmo"> <description> </description> </method> @@ -35588,19 +35658,19 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_param"> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="param" type="int"> </argument> - <argument index="1" name="value" type="float"> - </argument> <description> </description> </method> - <method name="get_param" qualifiers="const"> - <return type="float"> - </return> + <method name="set_param"> <argument index="0" name="param" type="int"> </argument> + <argument index="1" name="value" type="float"> + </argument> <description> </description> </method> @@ -35630,9 +35700,9 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_sample_library"> - <argument index="0" name="library" type="SampleLibrary"> - </argument> + <method name="get_polyphony" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> @@ -35642,15 +35712,11 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_polyphony"> - <argument index="0" name="voices" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_polyphony" qualifiers="const"> - <return type="int"> + <method name="is_voice_active" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="voice" type="int"> + </argument> <description> </description> </method> @@ -35664,37 +35730,41 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="voice_set_pitch_scale"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="ratio" type="float"> + <method name="set_polyphony"> + <argument index="0" name="voices" type="int"> </argument> <description> </description> </method> - <method name="voice_set_volume_scale_db"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="db" type="float"> + <method name="set_sample_library"> + <argument index="0" name="library" type="SampleLibrary"> </argument> <description> </description> </method> - <method name="is_voice_active" qualifiers="const"> - <return type="bool"> - </return> + <method name="stop_all"> + <description> + </description> + </method> + <method name="stop_voice"> <argument index="0" name="voice" type="int"> </argument> <description> </description> </method> - <method name="stop_voice"> + <method name="voice_set_pitch_scale"> <argument index="0" name="voice" type="int"> </argument> + <argument index="1" name="ratio" type="float"> + </argument> <description> </description> </method> - <method name="stop_all"> + <method name="voice_set_volume_scale_db"> + <argument index="0" name="voice" type="int"> + </argument> + <argument index="1" name="db" type="float"> + </argument> <description> </description> </method> @@ -35754,145 +35824,145 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_stream"> - <argument index="0" name="stream" type="AudioStream"> - </argument> + <method name="get_buffering_msec" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_stream" qualifiers="const"> - <return type="AudioStream"> + <method name="get_length" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="play"> - <argument index="0" name="offset" type="float" default="0"> - </argument> + <method name="get_loop_count" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="stop"> + <method name="get_loop_restart_time" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> + <method name="get_pos" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="set_paused"> - <argument index="0" name="paused" type="bool"> - </argument> + <method name="get_stream" qualifiers="const"> + <return type="AudioStream"> + </return> <description> </description> </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> + <method name="get_stream_name" qualifiers="const"> + <return type="String"> </return> <description> </description> </method> - <method name="set_loop"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_volume" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> + <method name="get_volume_db" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="set_volume"> - <argument index="0" name="volume" type="float"> - </argument> + <method name="has_autoplay" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_volume" qualifiers="const"> - <return type="float"> + <method name="has_loop" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_volume_db"> - <argument index="0" name="db" type="float"> - </argument> + <method name="is_paused" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_volume_db" qualifiers="const"> - <return type="float"> + <method name="is_playing" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_buffering_msec"> - <argument index="0" name="msec" type="int"> + <method name="play"> + <argument index="0" name="offset" type="float" default="0"> </argument> <description> </description> </method> - <method name="get_buffering_msec" qualifiers="const"> - <return type="int"> - </return> + <method name="seek_pos"> + <argument index="0" name="time" type="float"> + </argument> <description> </description> </method> - <method name="set_loop_restart_time"> - <argument index="0" name="secs" type="float"> + <method name="set_autoplay"> + <argument index="0" name="enabled" type="bool"> </argument> <description> </description> </method> - <method name="get_loop_restart_time" qualifiers="const"> - <return type="float"> - </return> + <method name="set_buffering_msec"> + <argument index="0" name="msec" type="int"> + </argument> <description> </description> </method> - <method name="get_stream_name" qualifiers="const"> - <return type="String"> - </return> + <method name="set_loop"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> </description> </method> - <method name="get_loop_count" qualifiers="const"> - <return type="int"> - </return> + <method name="set_loop_restart_time"> + <argument index="0" name="secs" type="float"> + </argument> <description> </description> </method> - <method name="get_pos" qualifiers="const"> - <return type="float"> - </return> + <method name="set_paused"> + <argument index="0" name="paused" type="bool"> + </argument> <description> </description> </method> - <method name="seek_pos"> - <argument index="0" name="time" type="float"> + <method name="set_stream"> + <argument index="0" name="stream" type="AudioStream"> </argument> <description> </description> </method> - <method name="set_autoplay"> - <argument index="0" name="enabled" type="bool"> + <method name="set_volume"> + <argument index="0" name="volume" type="float"> </argument> <description> </description> </method> - <method name="has_autoplay" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_volume_db"> + <argument index="0" name="db" type="float"> + </argument> <description> </description> </method> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> + <method name="stop"> <description> </description> </method> @@ -35906,18 +35976,18 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_radius"> - <argument index="0" name="radius" type="float"> - </argument> - <description> - </description> - </method> <method name="get_radius" qualifiers="const"> <return type="float"> </return> <description> </description> </method> + <method name="set_radius"> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -35930,31 +36000,30 @@ 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. </description> <methods> - <method name="set_suffix"> - <argument index="0" name="suffix" type="String"> - </argument> + <method name="get_line_edit"> + <return type="Object"> + </return> <description> - Set a specific suffix. </description> </method> - <method name="get_suffix" qualifiers="const"> + <method name="get_prefix" qualifiers="const"> <return type="String"> </return> <description> - Return the specific suffix. </description> </method> - <method name="set_prefix"> - <argument index="0" name="prefix" type="String"> - </argument> + <method name="get_suffix" qualifiers="const"> + <return type="String"> + </return> <description> - Set a prefix. + Return the specific suffix. </description> </method> - <method name="get_prefix" qualifiers="const"> - <return type="String"> + <method name="is_editable" qualifiers="const"> + <return type="bool"> </return> <description> + Return if the spinbox is editable. </description> </method> <method name="set_editable"> @@ -35964,17 +36033,18 @@ This method controls whether the position between two cached points is interpola Set whether the spinbox is editable. </description> </method> - <method name="is_editable" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_prefix"> + <argument index="0" name="prefix" type="String"> + </argument> <description> - Return if the spinbox is editable. + Set a prefix. </description> </method> - <method name="get_line_edit"> - <return type="Object"> - </return> + <method name="set_suffix"> + <argument index="0" name="suffix" type="String"> + </argument> <description> + Set a specific suffix. </description> </method> </methods> @@ -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. </description> <methods> - <method name="set_split_offset"> - <argument index="0" name="offset" type="int"> - </argument> + <method name="get_dragger_visibility" qualifiers="const"> + <return type="int"> + </return> <description> - Set the split offset. + Return visibility of the split dragger(One of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). </description> </method> <method name="get_split_offset" qualifiers="const"> @@ -36007,13 +36077,6 @@ This method controls whether the position between two cached points is interpola Return the split offset. </description> </method> - <method name="set_collapsed"> - <argument index="0" name="collapsed" type="bool"> - </argument> - <description> - Set if the split must be collapsed. - </description> - </method> <method name="is_collapsed" qualifiers="const"> <return type="bool"> </return> @@ -36021,6 +36084,13 @@ This method controls whether the position between two cached points is interpola Return true if the split is collapsed. </description> </method> + <method name="set_collapsed"> + <argument index="0" name="collapsed" type="bool"> + </argument> + <description> + Set if the split must be collapsed. + </description> + </method> <method name="set_dragger_visibility"> <argument index="0" name="mode" type="int"> </argument> @@ -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]). </description> </method> - <method name="get_dragger_visibility" qualifiers="const"> - <return type="int"> - </return> + <method name="set_split_offset"> + <argument index="0" name="offset" type="int"> + </argument> <description> - Return visibility of the split dragger(One of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). + Set the split offset. </description> </method> </methods> @@ -36077,67 +36147,67 @@ 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. </description> <methods> - <method name="set_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> + <method name="get_frame" qualifiers="const"> + <return type="int"> + </return> <description> - Set the base texture for the sprite. + Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. </description> </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> + <method name="get_hframes" qualifiers="const"> + <return type="int"> </return> <description> - Return the base texture for the sprite. + Return the amount of horizontal frames. See [method set_hframes]. </description> </method> - <method name="set_centered"> - <argument index="0" name="centered" type="bool"> - </argument> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> + </return> <description> - Set whether the sprite should be centered on the origin. + Return color modulation for the sprite. All sprite pixels are multiplied by this color. </description> </method> - <method name="is_centered" qualifiers="const"> - <return type="bool"> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> </return> <description> - Return if the sprite is centered at the local origin. + Return sprite draw offset. </description> </method> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> - </argument> + <method name="get_region_rect" qualifiers="const"> + <return type="Rect2"> + </return> <description> - Set the sprite draw offset, useful for setting rotation pivots. + Return the region rect to read from. </description> </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> </return> <description> - Return sprite draw offset. + Return the base texture for the sprite. </description> </method> - <method name="set_flip_h"> - <argument index="0" name="flip_h" type="bool"> - </argument> + <method name="get_vframes" qualifiers="const"> + <return type="int"> + </return> <description> - Set true to flip the sprite horizontally. + Return the amount of vertical frames. See [method set_vframes]. </description> </method> - <method name="is_flipped_h" qualifiers="const"> + <method name="is_centered" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the sprite is flipped horizontally. + Return if the sprite is centered at the local origin. </description> </method> - <method name="set_flip_v"> - <argument index="0" name="flip_v" type="bool"> - </argument> + <method name="is_flipped_h" qualifiers="const"> + <return type="bool"> + </return> <description> - Set true to flip the sprite vertically. + Return true if the sprite is flipped horizontally. </description> </method> <method name="is_flipped_v" qualifiers="const"> @@ -36147,13 +36217,6 @@ This method controls whether the position between two cached points is interpola Return true if the sprite is flipped vertically. </description> </method> - <method name="set_region"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. - </description> - </method> <method name="is_region" qualifiers="const"> <return type="bool"> </return> @@ -36161,18 +36224,25 @@ This method controls whether the position between two cached points is interpola Return if the sprite reads from a region. </description> </method> - <method name="set_region_rect"> - <argument index="0" name="rect" type="Rect2"> + <method name="set_centered"> + <argument index="0" name="centered" type="bool"> </argument> <description> - Set the region rect to read from. + Set whether the sprite should be centered on the origin. </description> </method> - <method name="get_region_rect" qualifiers="const"> - <return type="Rect2"> - </return> + <method name="set_flip_h"> + <argument index="0" name="flip_h" type="bool"> + </argument> <description> - Return the region rect to read from. + Set true to flip the sprite horizontally. + </description> + </method> + <method name="set_flip_v"> + <argument index="0" name="flip_v" type="bool"> + </argument> + <description> + Set true to flip the sprite vertically. </description> </method> <method name="set_frame"> @@ -36182,53 +36252,53 @@ This method controls whether the position between two cached points is interpola Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. </description> </method> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> + <method name="set_hframes"> + <argument index="0" name="hframes" type="int"> + </argument> <description> - Return 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. </description> </method> - <method name="set_vframes"> - <argument index="0" name="vframes" type="int"> + <method name="set_modulate"> + <argument index="0" name="modulate" type="Color"> </argument> <description> - Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation. + 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. </description> </method> - <method name="get_vframes" qualifiers="const"> - <return type="int"> - </return> + <method name="set_offset"> + <argument index="0" name="offset" type="Vector2"> + </argument> <description> - Return the amount of vertical frames. See [method set_vframes]. + Set the sprite draw offset, useful for setting rotation pivots. </description> </method> - <method name="set_hframes"> - <argument index="0" name="hframes" type="int"> + <method name="set_region"> + <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. + Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. </description> </method> - <method name="get_hframes" qualifiers="const"> - <return type="int"> - </return> + <method name="set_region_rect"> + <argument index="0" name="rect" type="Rect2"> + </argument> <description> - Return the amount of horizontal frames. See [method set_hframes]. + Set the region rect to read from. </description> </method> - <method name="set_modulate"> - <argument index="0" name="modulate" type="Color"> + <method name="set_texture"> + <argument index="0" name="texture" type="Texture"> </argument> <description> - 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. + Set the base texture for the sprite. </description> </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> - </return> + <method name="set_vframes"> + <argument index="0" name="vframes" type="int"> + </argument> <description> - Return color modulation for the sprite. All sprite pixels are multiplied by this color. + Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation. </description> </method> </methods> @@ -36247,38 +36317,38 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> + <method name="get_frame" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> + <method name="get_hframes" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="set_region"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_region_rect" qualifiers="const"> + <return type="Rect2"> + </return> <description> </description> </method> - <method name="is_region" qualifiers="const"> - <return type="bool"> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> </return> <description> </description> </method> - <method name="set_region_rect"> - <argument index="0" name="rect" type="Rect2"> - </argument> + <method name="get_vframes" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_region_rect" qualifiers="const"> - <return type="Rect2"> + <method name="is_region" qualifiers="const"> + <return type="bool"> </return> <description> </description> @@ -36289,33 +36359,33 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> + <method name="set_hframes"> + <argument index="0" name="hframes" type="int"> + </argument> <description> </description> </method> - <method name="set_vframes"> - <argument index="0" name="vframes" type="int"> + <method name="set_region"> + <argument index="0" name="enabled" type="bool"> </argument> <description> </description> </method> - <method name="get_vframes" qualifiers="const"> - <return type="int"> - </return> + <method name="set_region_rect"> + <argument index="0" name="rect" type="Rect2"> + </argument> <description> </description> </method> - <method name="set_hframes"> - <argument index="0" name="hframes" type="int"> + <method name="set_texture"> + <argument index="0" name="texture" type="Texture"> </argument> <description> </description> </method> - <method name="get_hframes" qualifiers="const"> - <return type="int"> - </return> + <method name="set_vframes"> + <argument index="0" name="vframes" type="int"> + </argument> <description> </description> </method> @@ -36335,99 +36405,89 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_centered"> - <argument index="0" name="centered" type="bool"> - </argument> + <method name="get_alpha_cut_mode" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="is_centered" qualifiers="const"> - <return type="bool"> + <method name="get_axis" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> + <method name="get_draw_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int"> </argument> <description> </description> </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> + <method name="get_item_rect" qualifiers="const"> + <return type="Rect2"> </return> <description> </description> </method> - <method name="set_flip_h"> - <argument index="0" name="flip_h" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_flipped_h" qualifiers="const"> - <return type="bool"> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> </return> <description> </description> </method> - <method name="set_flip_v"> - <argument index="0" name="flip_v" type="bool"> - </argument> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> <description> </description> </method> - <method name="is_flipped_v" qualifiers="const"> - <return type="bool"> + <method name="get_opacity" qualifiers="const"> + <return type="float"> </return> <description> </description> </method> - <method name="set_modulate"> - <argument index="0" name="modulate" type="Color"> - </argument> + <method name="get_pixel_size" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> + <method name="is_centered" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_opacity"> - <argument index="0" name="opacity" type="float"> - </argument> + <method name="is_flipped_h" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_opacity" qualifiers="const"> - <return type="float"> + <method name="is_flipped_v" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_pixel_size"> - <argument index="0" name="pixel_size" type="float"> + <method name="set_alpha_cut_mode"> + <argument index="0" name="mode" type="int"> </argument> <description> </description> </method> - <method name="get_pixel_size" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="set_axis"> <argument index="0" name="axis" type="int"> </argument> <description> </description> </method> - <method name="get_axis" qualifiers="const"> - <return type="int"> - </return> + <method name="set_centered"> + <argument index="0" name="centered" type="bool"> + </argument> <description> </description> </method> @@ -36439,46 +36499,56 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_draw_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int"> + <method name="set_flip_h"> + <argument index="0" name="flip_h" type="bool"> </argument> <description> </description> </method> - <method name="set_alpha_cut_mode"> - <argument index="0" name="mode" type="int"> + <method name="set_flip_v"> + <argument index="0" name="flip_v" type="bool"> </argument> <description> </description> </method> - <method name="get_alpha_cut_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_modulate"> + <argument index="0" name="modulate" type="Color"> + </argument> <description> </description> </method> - <method name="get_item_rect" qualifiers="const"> - <return type="Rect2"> - </return> + <method name="set_offset"> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_opacity"> + <argument index="0" name="opacity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_pixel_size"> + <argument index="0" name="pixel_size" type="float"> + </argument> <description> </description> </method> </methods> <constants> - <constant name="FLAG_TRANSPARENT" value="0"> - </constant> - <constant name="FLAG_SHADED" value="1"> - </constant> - <constant name="FLAG_MAX" value="2"> - </constant> <constant name="ALPHA_CUT_DISABLED" value="0"> </constant> <constant name="ALPHA_CUT_DISCARD" value="1"> </constant> <constant name="ALPHA_CUT_OPAQUE_PREPASS" value="2"> </constant> + <constant name="FLAG_TRANSPARENT" value="0"> + </constant> + <constant name="FLAG_SHADED" value="1"> + </constant> + <constant name="FLAG_MAX" value="2"> + </constant> </constants> </class> <class name="SpriteFrames" inherits="Resource" category="Core"> @@ -36495,33 +36565,31 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="has_animation" qualifiers="const"> - <return type="bool"> - </return> + <method name="add_frame"> <argument index="0" name="anim" type="String"> </argument> + <argument index="1" name="frame" type="Object"> + </argument> + <argument index="2" name="atpos" type="int" default="-1"> + </argument> <description> </description> </method> - <method name="remove_animation"> + <method name="clear"> <argument index="0" name="anim" type="String"> </argument> <description> </description> </method> - <method name="rename_animation"> - <argument index="0" name="anim" type="String"> - </argument> - <argument index="1" name="newname" type="String"> - </argument> + <method name="clear_all"> <description> </description> </method> - <method name="set_animation_speed"> + <method name="get_animation_loop" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="anim" type="String"> </argument> - <argument index="1" name="speed" type="float"> - </argument> <description> </description> </method> @@ -36533,43 +36601,39 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_animation_loop"> + <method name="get_frame" qualifiers="const"> + <return type="Object"> + </return> <argument index="0" name="anim" type="String"> </argument> - <argument index="1" name="loop" type="bool"> + <argument index="1" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_animation_loop" qualifiers="const"> - <return type="bool"> + <method name="get_frame_count" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="anim" type="String"> </argument> <description> </description> </method> - <method name="add_frame"> + <method name="has_animation" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="anim" type="String"> </argument> - <argument index="1" name="frame" type="Object"> - </argument> - <argument index="2" name="atpos" type="int" default="-1"> - </argument> <description> </description> </method> - <method name="get_frame_count" qualifiers="const"> - <return type="int"> - </return> + <method name="remove_animation"> <argument index="0" name="anim" type="String"> </argument> <description> </description> </method> - <method name="get_frame" qualifiers="const"> - <return type="Object"> - </return> + <method name="remove_frame"> <argument index="0" name="anim" type="String"> </argument> <argument index="1" name="idx" type="int"> @@ -36577,31 +36641,37 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_frame"> + <method name="rename_animation"> <argument index="0" name="anim" type="String"> </argument> - <argument index="1" name="idx" type="int"> - </argument> - <argument index="2" name="txt" type="Object"> + <argument index="1" name="newname" type="String"> </argument> <description> </description> </method> - <method name="remove_frame"> + <method name="set_animation_loop"> <argument index="0" name="anim" type="String"> </argument> - <argument index="1" name="idx" type="int"> + <argument index="1" name="loop" type="bool"> </argument> <description> </description> </method> - <method name="clear"> + <method name="set_animation_speed"> <argument index="0" name="anim" type="String"> </argument> + <argument index="1" name="speed" type="float"> + </argument> <description> </description> </method> - <method name="clear_all"> + <method name="set_frame"> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="idx" type="int"> + </argument> + <argument index="2" name="txt" type="Object"> + </argument> <description> </description> </method> @@ -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). </description> <methods> - <method name="set_constant_linear_velocity"> - <argument index="0" name="vel" type="Vector3"> - </argument> - <description> - 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. - </description> - </method> - <method name="set_constant_angular_velocity"> - <argument index="0" name="vel" type="Vector3"> - </argument> - <description> - 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. - </description> - </method> - <method name="get_constant_linear_velocity" qualifiers="const"> - <return type="Vector3"> + <method name="get_bounce" qualifiers="const"> + <return type="float"> </return> <description> - Return the constant linear velocity for the body. + Return the body bounciness. </description> </method> <method name="get_constant_angular_velocity" qualifiers="const"> @@ -36647,11 +36703,11 @@ This method controls whether the position between two cached points is interpola Return the constant angular velocity for the body. </description> </method> - <method name="set_friction"> - <argument index="0" name="friction" type="float"> - </argument> + <method name="get_constant_linear_velocity" qualifiers="const"> + <return type="Vector3"> + </return> <description> - Set the body friction, from 0 (frictionless) to 1 (full friction). + Return the constant linear velocity for the body. </description> </method> <method name="get_friction" qualifiers="const"> @@ -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). </description> </method> - <method name="get_bounce" qualifiers="const"> - <return type="float"> - </return> + <method name="set_constant_angular_velocity"> + <argument index="0" name="vel" type="Vector3"> + </argument> <description> - 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. + </description> + </method> + <method name="set_constant_linear_velocity"> + <argument index="0" name="vel" type="Vector3"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_friction"> + <argument index="0" name="friction" type="float"> + </argument> + <description> + Set the body friction, from 0 (frictionless) to 1 (full friction). </description> </method> </methods> @@ -36689,18 +36759,18 @@ 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). </description> <methods> - <method name="set_constant_linear_velocity"> - <argument index="0" name="vel" type="Vector2"> - </argument> + <method name="get_bounce" qualifiers="const"> + <return type="float"> + </return> <description> - 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. + Return the body bounciness. </description> </method> - <method name="set_constant_angular_velocity"> - <argument index="0" name="vel" type="float"> - </argument> + <method name="get_constant_angular_velocity" qualifiers="const"> + <return type="float"> + </return> <description> - 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 angular velocity for the body. </description> </method> <method name="get_constant_linear_velocity" qualifiers="const"> @@ -36710,39 +36780,39 @@ This method controls whether the position between two cached points is interpola Return the constant linear velocity for the body. </description> </method> - <method name="get_constant_angular_velocity" qualifiers="const"> + <method name="get_friction" qualifiers="const"> <return type="float"> </return> <description> - Return the constant angular velocity for the body. + Return the body friction. </description> </method> - <method name="set_friction"> - <argument index="0" name="friction" type="float"> + <method name="set_bounce"> + <argument index="0" name="bounce" type="float"> </argument> <description> - Set the body friction, from 0 (frictionless) to 1 (full friction). + Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). </description> </method> - <method name="get_friction" qualifiers="const"> - <return type="float"> - </return> + <method name="set_constant_angular_velocity"> + <argument index="0" name="vel" type="float"> + </argument> <description> - Return the body friction. + 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. </description> </method> - <method name="set_bounce"> - <argument index="0" name="bounce" type="float"> + <method name="set_constant_linear_velocity"> + <argument index="0" name="vel" type="Vector2"> </argument> <description> - Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). + 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. </description> </method> - <method name="get_bounce" qualifiers="const"> - <return type="float"> - </return> + <method name="set_friction"> + <argument index="0" name="friction" type="float"> + </argument> <description> - Return the body bounciness. + Set the body friction, from 0 (frictionless) to 1 (full friction). </description> </method> </methods> @@ -36757,40 +36827,32 @@ 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. </description> <methods> - <method name="put_data"> + <method name="get_16"> <return type="int"> </return> - <argument index="0" name="data" type="RawArray"> - </argument> <description> - 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. </description> </method> - <method name="put_partial_data"> - <return type="Array"> + <method name="get_32"> + <return type="int"> </return> - <argument index="0" name="data" type="RawArray"> - </argument> <description> - 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. </description> </method> - <method name="get_data"> - <return type="Array"> + <method name="get_64"> + <return type="int"> </return> - <argument index="0" name="bytes" type="int"> - </argument> <description> - 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. + Get a signed 64 bit value from the stream. </description> </method> - <method name="get_partial_data"> - <return type="Array"> + <method name="get_8"> + <return type="int"> </return> - <argument index="0" name="bytes" type="int"> - </argument> <description> - 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. + Get a signed byte from the stream. </description> </method> <method name="get_available_bytes" qualifiers="const"> @@ -36800,197 +36862,205 @@ This method controls whether the position between two cached points is interpola Return the amount of bytes this [StreamPeer] has available. </description> </method> - <method name="set_big_endian"> - <argument index="0" name="enable" type="bool"> + <method name="get_data"> + <return type="Array"> + </return> + <argument index="0" name="bytes" type="int"> </argument> <description> - Set this [StreamPeer] to use big-endian format. Default is false. + 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. </description> </method> - <method name="is_big_endian_enabled" qualifiers="const"> - <return type="bool"> + <method name="get_double"> + <return type="float"> </return> <description> - Return whether this [StreamPeer] is using big-endian format. + Get a double-precision float from the stream. </description> </method> - <method name="put_8"> - <argument index="0" name="val" type="int"> - </argument> + <method name="get_float"> + <return type="float"> + </return> <description> - Put a signed byte into the stream. + Get a single-precision float from the stream. </description> </method> - <method name="put_u8"> - <argument index="0" name="val" type="int"> + <method name="get_partial_data"> + <return type="Array"> + </return> + <argument index="0" name="bytes" type="int"> </argument> <description> - Put an unsigned byte into 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. </description> </method> - <method name="put_16"> - <argument index="0" name="val" type="int"> + <method name="get_string"> + <return type="String"> + </return> + <argument index="0" name="bytes" type="int"> </argument> <description> - Put a signed 16 bit value into the stream. + Get a string with byte-length "bytes" from the stream. </description> </method> - <method name="put_u16"> - <argument index="0" name="val" type="int"> - </argument> + <method name="get_u16"> + <return type="int"> + </return> <description> - Put an unsigned 16 bit value into the stream. + Get an unsigned 16 bit value from the stream. </description> </method> - <method name="put_32"> - <argument index="0" name="val" type="int"> - </argument> + <method name="get_u32"> + <return type="int"> + </return> <description> - Put a signed 32 bit value into the stream. + Get an unsigned 32 bit value from the stream. </description> </method> - <method name="put_u32"> - <argument index="0" name="val" type="int"> - </argument> + <method name="get_u64"> + <return type="int"> + </return> <description> - Put an unsigned 32 bit value into the stream. + Get an unsigned 16 bit value from the stream. </description> </method> - <method name="put_64"> - <argument index="0" name="val" type="int"> - </argument> + <method name="get_u8"> + <return type="int"> + </return> <description> - Put a signed 64 bit value into the stream. + Get an unsigned byte from the stream. </description> </method> - <method name="put_u64"> - <argument index="0" name="val" type="int"> + <method name="get_utf8_string"> + <return type="String"> + </return> + <argument index="0" name="bytes" type="int"> </argument> <description> - Put an unsigned 64 bit value into the stream. + Get an utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8). </description> </method> - <method name="put_float"> - <argument index="0" name="val" type="float"> - </argument> + <method name="get_var"> + <return type="Variant"> + </return> <description> - Put a single-precision float into the stream. + Get a Variant from the stream. </description> </method> - <method name="put_double"> - <argument index="0" name="val" type="float"> - </argument> + <method name="is_big_endian_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> - Put a double-precision float into the stream. + Return whether this [StreamPeer] is using big-endian format. </description> </method> - <method name="put_utf8_string"> - <argument index="0" name="val" type="String"> + <method name="put_16"> + <argument index="0" name="val" type="int"> </argument> <description> - Put a zero-terminated utf8 string into the stream. + Put a signed 16 bit value into the stream. </description> </method> - <method name="put_var"> - <argument index="0" name="val" type="Variant"> + <method name="put_32"> + <argument index="0" name="val" type="int"> </argument> <description> - Put a Variant into the stream. + Put a signed 32 bit value into the stream. </description> </method> - <method name="get_8"> - <return type="int"> - </return> + <method name="put_64"> + <argument index="0" name="val" type="int"> + </argument> <description> - Get a signed byte from the stream. + Put a signed 64 bit value into the stream. </description> </method> - <method name="get_u8"> - <return type="int"> - </return> + <method name="put_8"> + <argument index="0" name="val" type="int"> + </argument> <description> - Get an unsigned byte from the stream. + Put a signed byte into the stream. </description> </method> - <method name="get_16"> + <method name="put_data"> <return type="int"> </return> + <argument index="0" name="data" type="RawArray"> + </argument> <description> - Get a signed 16 bit value from 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. </description> </method> - <method name="get_u16"> - <return type="int"> - </return> + <method name="put_double"> + <argument index="0" name="val" type="float"> + </argument> <description> - Get an unsigned 16 bit value from the stream. + Put a double-precision float into the stream. </description> </method> - <method name="get_32"> - <return type="int"> - </return> + <method name="put_float"> + <argument index="0" name="val" type="float"> + </argument> <description> - Get a signed 32 bit value from the stream. + Put a single-precision float into the stream. </description> </method> - <method name="get_u32"> - <return type="int"> + <method name="put_partial_data"> + <return type="Array"> </return> + <argument index="0" name="data" type="RawArray"> + </argument> <description> - Get an unsigned 32 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. </description> </method> - <method name="get_64"> - <return type="int"> - </return> + <method name="put_u16"> + <argument index="0" name="val" type="int"> + </argument> <description> - Get a signed 64 bit value from the stream. + Put an unsigned 16 bit value into the stream. </description> </method> - <method name="get_u64"> - <return type="int"> - </return> + <method name="put_u32"> + <argument index="0" name="val" type="int"> + </argument> <description> - Get an unsigned 16 bit value from the stream. + Put an unsigned 32 bit value into the stream. </description> </method> - <method name="get_float"> - <return type="float"> - </return> + <method name="put_u64"> + <argument index="0" name="val" type="int"> + </argument> <description> - Get a single-precision float from the stream. + Put an unsigned 64 bit value into the stream. </description> </method> - <method name="get_double"> - <return type="float"> - </return> + <method name="put_u8"> + <argument index="0" name="val" type="int"> + </argument> <description> - Get a double-precision float from the stream. + Put an unsigned byte into the stream. </description> </method> - <method name="get_string"> - <return type="String"> - </return> - <argument index="0" name="bytes" type="int"> + <method name="put_utf8_string"> + <argument index="0" name="val" type="String"> </argument> <description> - Get a string with byte-length "bytes" from the stream. + Put a zero-terminated utf8 string into the stream. </description> </method> - <method name="get_utf8_string"> - <return type="String"> - </return> - <argument index="0" name="bytes" type="int"> + <method name="put_var"> + <argument index="0" name="val" type="Variant"> </argument> <description> - Get an utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8). + Put a Variant into the stream. </description> </method> - <method name="get_var"> - <return type="Variant"> - </return> + <method name="set_big_endian"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Get a Variant from the stream. + Set this [StreamPeer] to use big-endian format. Default is false. </description> </method> </methods> @@ -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". </description> </method> + <method name="disconnect"> + <description> + Disconnect from host. + </description> + </method> <method name="get_status" qualifiers="const"> <return type="int"> </return> @@ -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. </description> </method> - <method name="disconnect"> - <description> - Disconnect from host. - </description> - </method> </methods> <constants> <constant name="STATUS_DISCONNECTED" value="0"> @@ -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. </description> </method> - <method name="is_connected" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether this peer is connected. Returns true while connecting and connected. - </description> - </method> - <method name="get_status" qualifiers="const"> - <return type="int"> - </return> + <method name="disconnect"> <description> - Return the status of the connection, one of STATUS_* enum. + Disconnect from host. </description> </method> <method name="get_connected_host" qualifiers="const"> @@ -37101,9 +37162,18 @@ This method controls whether the position between two cached points is interpola Return the port of this peer. </description> </method> - <method name="disconnect"> + <method name="get_status" qualifiers="const"> + <return type="int"> + </return> <description> - Disconnect from host. + Return the status of the connection, one of STATUS_* enum. + </description> + </method> + <method name="is_connected" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this peer is connected. Returns true while connecting and connected. </description> </method> </methods> @@ -37130,58 +37200,74 @@ This method controls whether the position between two cached points is interpola Base class for audio stream playback. Audio stream players inherit from it. </description> <methods> - <method name="set_stream"> - <argument index="0" name="stream" type="AudioStream"> - </argument> + <method name="get_buffering_msec" qualifiers="const"> + <return type="int"> + </return> <description> - Set the [EventStream] this player will play. + Return the size of the audio buffer. </description> </method> - <method name="get_stream" qualifiers="const"> - <return type="AudioStream"> + <method name="get_length" qualifiers="const"> + <return type="float"> </return> <description> - Return the currently assigned stream. + Return the length of the stream, in seconds. </description> </method> - <method name="play"> - <argument index="0" name="offset" type="float" default="0"> - </argument> + <method name="get_loop_count" qualifiers="const"> + <return type="int"> + </return> <description> - Play the currently assigned stream, starting from a given position (in seconds). + Return the number of times the playback has looped. </description> </method> - <method name="stop"> + <method name="get_loop_restart_time" qualifiers="const"> + <return type="float"> + </return> <description> - Stop the playback. + Return the point in time the stream will rewind to, when looping. </description> </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> + <method name="get_pos" qualifiers="const"> + <return type="float"> </return> <description> - Return whether this player is playing. + Return the playback position, in seconds. </description> </method> - <method name="set_paused"> - <argument index="0" name="paused" type="bool"> - </argument> + <method name="get_stream" qualifiers="const"> + <return type="AudioStream"> + </return> <description> - Pause stream playback. + Return the currently assigned stream. </description> </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> + <method name="get_stream_name" qualifiers="const"> + <return type="String"> </return> <description> - Return whether the playback is currently paused. + 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>". </description> </method> - <method name="set_loop"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_volume" qualifiers="const"> + <return type="float"> + </return> <description> - Set whether the stream will be restarted at the end. + Return the playback volume for this player. + </description> + </method> + <method name="get_volume_db" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the playback volume for this player, in decibels. + </description> + </method> + <method name="has_autoplay" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this player will start playing as soon as it enters the scene tree. </description> </method> <method name="has_loop" qualifiers="const"> @@ -37191,32 +37277,39 @@ This method controls whether the position between two cached points is interpola Return whether the stream will be restarted at the end. </description> </method> - <method name="set_volume"> - <argument index="0" name="volume" type="float"> - </argument> + <method name="is_paused" qualifiers="const"> + <return type="bool"> + </return> <description> - 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 whether the playback is currently paused. </description> </method> - <method name="get_volume" qualifiers="const"> - <return type="float"> + <method name="is_playing" qualifiers="const"> + <return type="bool"> </return> <description> - Return the playback volume for this player. + Return whether this player is playing. </description> </method> - <method name="set_volume_db"> - <argument index="0" name="db" type="float"> + <method name="play"> + <argument index="0" name="offset" type="float" default="0"> </argument> <description> - 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. + Play the currently assigned stream, starting from a given position (in seconds). </description> </method> - <method name="get_volume_db" qualifiers="const"> - <return type="float"> - </return> + <method name="seek_pos"> + <argument index="0" name="time" type="float"> + </argument> <description> - Return the playback volume for this player, in decibels. + Set the playback position, in seconds. + </description> + </method> + <method name="set_autoplay"> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set whether this player will start playing as soon as it enters the scene tree. </description> </method> <method name="set_buffering_msec"> @@ -37227,11 +37320,11 @@ This method controls whether the position between two cached points is interpola Default is 500 milliseconds. </description> </method> - <method name="get_buffering_msec" qualifiers="const"> - <return type="int"> - </return> + <method name="set_loop"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> - Return the size of the audio buffer. + Set whether the stream will be restarted at the end. </description> </method> <method name="set_loop_restart_time"> @@ -37241,60 +37334,37 @@ This method controls whether the position between two cached points is interpola Set the point in time the stream will rewind to, when looping. </description> </method> - <method name="get_loop_restart_time" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the point in time the stream will rewind to, when looping. - </description> - </method> - <method name="get_stream_name" qualifiers="const"> - <return type="String"> - </return> - <description> - 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>". - </description> - </method> - <method name="get_loop_count" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the number of times the playback has looped. - </description> - </method> - <method name="get_pos" qualifiers="const"> - <return type="float"> - </return> + <method name="set_paused"> + <argument index="0" name="paused" type="bool"> + </argument> <description> - Return the playback position, in seconds. + Pause stream playback. </description> </method> - <method name="seek_pos"> - <argument index="0" name="time" type="float"> + <method name="set_stream"> + <argument index="0" name="stream" type="AudioStream"> </argument> <description> - Set the playback position, in seconds. + Set the [EventStream] this player will play. </description> </method> - <method name="set_autoplay"> - <argument index="0" name="enabled" type="bool"> + <method name="set_volume"> + <argument index="0" name="volume" type="float"> </argument> <description> - Set whether this player will start playing as soon as it enters the scene tree. + 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. </description> </method> - <method name="has_autoplay" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_volume_db"> + <argument index="0" name="db" type="float"> + </argument> <description> - Return whether this player will start playing as soon as it enters the scene tree. + 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. </description> </method> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> + <method name="stop"> <description> - Return the length of the stream, in seconds. + Stop the playback. </description> </method> </methods> @@ -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. </description> <methods> + <method name="StringArray"> + <return type="StringArray"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Create from a generic array. + </description> + </method> <method name="push_back"> <argument index="0" name="string" type="String"> </argument> @@ -37849,15 +37928,6 @@ This method controls whether the position between two cached points is interpola Return the size of the array. </description> </method> - <method name="StringArray"> - <return type="StringArray"> - </return> - <argument index="0" name="from" type="Array"> - </argument> - <description> - Create from a generic array. - </description> - </method> </methods> <constants> </constants> @@ -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. </description> <methods> - <method name="test_mask" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="point" type="Vector2"> + <method name="draw" qualifiers="const"> + <argument index="0" name="canvas_item" type="RID"> </argument> <argument index="1" name="rect" type="Rect2"> </argument> <description> - Test a position in a rectangle, return whether it passes the mask test. </description> </method> - <method name="set_default_margin"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="offset" type="float"> - </argument> + <method name="get_center_size" qualifiers="const"> + <return type="Vector2"> + </return> <description> - 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. </description> </method> <method name="get_default_margin" qualifiers="const"> @@ -37915,25 +37979,31 @@ This method controls whether the position between two cached points is interpola Return the minimum size that this stylebox can be shrunk to. </description> </method> - <method name="get_center_size" qualifiers="const"> + <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> + 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]. </description> </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_default_margin"> + <argument index="0" name="margin" type="int"> + </argument> + <argument index="1" name="offset" type="float"> + </argument> <description> - 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. </description> </method> - <method name="draw" qualifiers="const"> - <argument index="0" name="canvas_item" type="RID"> + <method name="test_mask" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector2"> </argument> <argument index="1" name="rect" type="Rect2"> </argument> <description> + Test a position in a rectangle, return whether it passes the mask test. </description> </method> </methods> @@ -37960,63 +38030,63 @@ 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. </description> <methods> - <method name="set_bg_color"> - <argument index="0" name="color" type="Color"> - </argument> + <method name="get_bg_color" qualifiers="const"> + <return type="Color"> + </return> <description> </description> </method> - <method name="get_bg_color" qualifiers="const"> - <return type="Color"> + <method name="get_border_blend" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_light_color"> - <argument index="0" name="color" type="Color"> - </argument> + <method name="get_border_size" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_light_color" qualifiers="const"> + <method name="get_dark_color" qualifiers="const"> <return type="Color"> </return> <description> </description> </method> - <method name="set_dark_color"> - <argument index="0" name="color" type="Color"> - </argument> + <method name="get_draw_center" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_dark_color" qualifiers="const"> + <method name="get_light_color" qualifiers="const"> <return type="Color"> </return> <description> </description> </method> - <method name="set_border_size"> - <argument index="0" name="size" type="int"> + <method name="set_bg_color"> + <argument index="0" name="color" type="Color"> </argument> <description> </description> </method> - <method name="get_border_size" qualifiers="const"> - <return type="int"> - </return> + <method name="set_border_blend"> + <argument index="0" name="blend" type="bool"> + </argument> <description> </description> </method> - <method name="set_border_blend"> - <argument index="0" name="blend" type="bool"> + <method name="set_border_size"> + <argument index="0" name="size" type="int"> </argument> <description> </description> </method> - <method name="get_border_blend" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_dark_color"> + <argument index="0" name="color" type="Color"> + </argument> <description> </description> </method> @@ -38026,9 +38096,9 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_draw_center" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_light_color"> + <argument index="0" name="color" type="Color"> + </argument> <description> </description> </method> @@ -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. </description> <methods> - <method name="set_image"> - <argument index="0" name="image" type="Image"> + <method name="get_expand" qualifiers="const"> + <return type="bool"> + </return> + <description> + 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. + </description> + </method> + <method name="get_expand_margin_size" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int"> </argument> <description> - 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. </description> </method> <method name="get_image" qualifiers="const"> @@ -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. </description> </method> - <method name="get_expand" qualifiers="const"> - <return type="bool"> - </return> - <description> - 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. - </description> - </method> <method name="set_expand_margin_size"> <argument index="0" name="margin" type="int"> </argument> @@ -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. </description> </method> - <method name="get_expand_margin_size" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int"> + <method name="set_image"> + <argument index="0" name="image" type="Image"> </argument> <description> - 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. </description> </method> </methods> @@ -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. </description> <methods> - <method name="set_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> + <method name="get_draw_center" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_margin_size"> + <method name="get_expand_margin_size" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="margin" type="int"> </argument> - <argument index="1" name="size" type="float"> - </argument> <description> </description> </method> @@ -38130,6 +38194,24 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="get_region_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="set_draw_center"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_expand_margin_size"> <argument index="0" name="margin" type="int"> </argument> @@ -38138,11 +38220,11 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_expand_margin_size" qualifiers="const"> - <return type="float"> - </return> + <method name="set_margin_size"> <argument index="0" name="margin" type="int"> </argument> + <argument index="1" name="size" type="float"> + </argument> <description> </description> </method> @@ -38152,24 +38234,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_region_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="set_draw_center"> - <argument index="0" name="enable" type="bool"> + <method name="set_texture"> + <argument index="0" name="texture" type="Texture"> </argument> <description> </description> </method> - <method name="get_draw_center" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> </methods> <constants> </constants> @@ -38182,14 +38252,8 @@ This method controls whether the position between two cached points is interpola Helper tool to create geometry. </description> <methods> - <method name="begin"> - <argument index="0" name="primitive" type="int"> - </argument> - <description> - </description> - </method> - <method name="add_vertex"> - <argument index="0" name="vertex" type="Vector3"> + <method name="add_bones"> + <argument index="0" name="bones" type="IntArray"> </argument> <description> </description> @@ -38206,12 +38270,34 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="add_smooth_group"> + <argument index="0" name="smooth" type="bool"> + </argument> + <description> + </description> + </method> <method name="add_tangent"> <argument index="0" name="tangent" type="Plane"> </argument> <description> </description> </method> + <method name="add_triangle_fan"> + <argument index="0" name="vertexes" type="Vector3Array"> + </argument> + <argument index="1" name="uvs" type="Vector2Array" default="Vector2Array()"> + </argument> + <argument index="2" name="colors" type="ColorArray" default="ColorArray([ColorArray])"> + </argument> + <argument index="3" name="uv2s" type="Vector2Array" default="Vector2Array()"> + </argument> + <argument index="4" name="normals" type="Vector3Array" default="Vector3Array()"> + </argument> + <argument index="5" name="tangents" type="Array" default="Array()"> + </argument> + <description> + </description> + </method> <method name="add_uv"> <argument index="0" name="uv" type="Vector2"> </argument> @@ -38224,8 +38310,8 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="add_bones"> - <argument index="0" name="bones" type="IntArray"> + <method name="add_vertex"> + <argument index="0" name="vertex" type="Vector3"> </argument> <description> </description> @@ -38236,38 +38322,24 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="add_smooth_group"> - <argument index="0" name="smooth" type="bool"> + <method name="begin"> + <argument index="0" name="primitive" type="int"> </argument> <description> </description> </method> - <method name="add_triangle_fan"> - <argument index="0" name="vertexes" type="Vector3Array"> - </argument> - <argument index="1" name="uvs" type="Vector2Array" default="Vector2Array()"> - </argument> - <argument index="2" name="colors" type="ColorArray" default="ColorArray([ColorArray])"> - </argument> - <argument index="3" name="uv2s" type="Vector2Array" default="Vector2Array()"> - </argument> - <argument index="4" name="normals" type="Vector3Array" default="Vector3Array()"> - </argument> - <argument index="5" name="tangents" type="Array" default="Array()"> - </argument> + <method name="clear"> <description> </description> </method> - <method name="set_material"> - <argument index="0" name="material" type="Material"> + <method name="commit"> + <return type="Mesh"> + </return> + <argument index="0" name="existing" type="Mesh" default="NULL"> </argument> <description> </description> </method> - <method name="index"> - <description> - </description> - </method> <method name="deindex"> <description> </description> @@ -38276,15 +38348,13 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="commit"> - <return type="Mesh"> - </return> - <argument index="0" name="existing" type="Mesh" default="NULL"> - </argument> + <method name="index"> <description> </description> </method> - <method name="clear"> + <method name="set_material"> + <argument index="0" name="material" type="Material"> + </argument> <description> </description> </method> @@ -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. </description> <methods> + <method name="is_connection_available" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if a connection is available for taking. + </description> + </method> <method name="listen"> <return type="int"> </return> @@ -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. </description> </method> - <method name="is_connection_available" qualifiers="const"> - <return type="bool"> - </return> + <method name="stop"> <description> - Return true if a connection is available for taking. + Stop listening. </description> </method> <method name="take_connection"> @@ -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/ </description> </method> - <method name="stop"> - <description> - Stop listening. - </description> - </method> </methods> <constants> </constants> @@ -38343,18 +38413,11 @@ This method controls whether the position between two cached points is interpola Children controls of this one automatically. </description> <methods> - <method name="get_tab_count" qualifiers="const"> - <return type="int"> + <method name="are_tabs_visible" qualifiers="const"> + <return type="bool"> </return> <description> - Return the amount of tabs. - </description> - </method> - <method name="set_current_tab"> - <argument index="0" name="tab_idx" type="int"> - </argument> - <description> - Bring a tab (and the Control it represents) to the front, and hide the rest. + Return whether the tabs should be visible or hidden. </description> </method> <method name="get_current_tab" qualifiers="const"> @@ -38370,21 +38433,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_tab_control" qualifiers="const"> - <return type="Control"> + <method name="get_popup" qualifiers="const"> + <return type="Popup"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="set_tab_align"> - <argument index="0" name="align" type="int"> - </argument> - <description> - Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center. - </description> - </method> <method name="get_tab_align" qualifiers="const"> <return type="int"> </return> @@ -38392,27 +38446,27 @@ This method controls whether the position between two cached points is interpola Return tab alignment, from the ALIGN_* enum. </description> </method> - <method name="set_tabs_visible"> - <argument index="0" name="visible" type="bool"> + <method name="get_tab_control" qualifiers="const"> + <return type="Control"> + </return> + <argument index="0" name="idx" type="int"> </argument> <description> - Set whether the tabs should be visible or hidden. </description> </method> - <method name="are_tabs_visible" qualifiers="const"> - <return type="bool"> + <method name="get_tab_count" qualifiers="const"> + <return type="int"> </return> <description> - Return whether the tabs should be visible or hidden. + Return the amount of tabs. </description> </method> - <method name="set_tab_title"> + <method name="get_tab_icon" qualifiers="const"> + <return type="Texture"> + </return> <argument index="0" name="tab_idx" type="int"> </argument> - <argument index="1" name="title" type="String"> - </argument> <description> - Set a title for the tab. Tab titles are by default the children node name, but this can be overridden. </description> </method> <method name="get_tab_title" qualifiers="const"> @@ -38424,33 +38478,49 @@ 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. </description> </method> - <method name="set_tab_icon"> + <method name="set_current_tab"> <argument index="0" name="tab_idx" type="int"> </argument> - <argument index="1" name="icon" type="Texture"> + <description> + Bring a tab (and the Control it represents) to the front, and hide the rest. + </description> + </method> + <method name="set_popup"> + <argument index="0" name="popup" type="Popup"> </argument> <description> - Set an icon for a tab. </description> </method> - <method name="get_tab_icon" qualifiers="const"> - <return type="Texture"> - </return> + <method name="set_tab_align"> + <argument index="0" name="align" type="int"> + </argument> + <description> + Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center. + </description> + </method> + <method name="set_tab_icon"> <argument index="0" name="tab_idx" type="int"> </argument> + <argument index="1" name="icon" type="Texture"> + </argument> <description> + Set an icon for a tab. </description> </method> - <method name="set_popup"> - <argument index="0" name="popup" type="Popup"> + <method name="set_tab_title"> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="title" type="String"> </argument> <description> + Set a title for the tab. Tab titles are by default the children node name, but this can be overridden. </description> </method> - <method name="get_popup" qualifiers="const"> - <return type="Popup"> - </return> + <method name="set_tabs_visible"> + <argument index="0" name="visible" type="bool"> + </argument> <description> + Set whether the tabs should be visible or hidden. </description> </method> </methods> @@ -38470,39 +38540,39 @@ This method controls whether the position between two cached points is interpola <constants> </constants> <theme_items> - <theme_item name="label_valign_fg" type="int"> - </theme_item> - <theme_item name="hseparation" type="int"> - </theme_item> - <theme_item name="label_valign_bg" type="int"> + <theme_item name="decrement" type="Texture"> </theme_item> - <theme_item name="top_margin" type="int"> + <theme_item name="decrement_hilite" type="Texture"> </theme_item> - <theme_item name="side_margin" type="int"> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color_bg" type="Color"> </theme_item> <theme_item name="font_color_fg" type="Color"> </theme_item> - <theme_item name="menu_hilite" type="Texture"> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="increment" type="Texture"> </theme_item> <theme_item name="increment_hilite" type="Texture"> </theme_item> - <theme_item name="menu" type="Texture"> + <theme_item name="label_valign_bg" type="int"> </theme_item> - <theme_item name="decrement_hilite" type="Texture"> + <theme_item name="label_valign_fg" type="int"> </theme_item> - <theme_item name="increment" type="Texture"> + <theme_item name="menu" type="Texture"> </theme_item> - <theme_item name="decrement" type="Texture"> + <theme_item name="menu_hilite" type="Texture"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="panel" type="StyleBox"> </theme_item> - <theme_item name="tab_fg" type="StyleBox"> + <theme_item name="side_margin" type="int"> </theme_item> <theme_item name="tab_bg" type="StyleBox"> </theme_item> - <theme_item name="panel" type="StyleBox"> + <theme_item name="tab_fg" type="StyleBox"> + </theme_item> + <theme_item name="top_margin" type="int"> </theme_item> </theme_items> </class> @@ -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. </description> <methods> - <method name="get_tab_count" qualifiers="const"> - <return type="int"> - </return> + <method name="add_tab"> + <argument index="0" name="title" type="String"> + </argument> + <argument index="1" name="icon" type="Texture"> + </argument> <description> </description> </method> - <method name="set_current_tab"> - <argument index="0" name="tab_idx" type="int"> + <method name="ensure_tab_visible"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -38532,32 +38604,28 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_tab_title"> - <argument index="0" name="tab_idx" type="int"> - </argument> - <argument index="1" name="title" type="String"> - </argument> + <method name="get_tab_align" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_tab_title" qualifiers="const"> - <return type="String"> + <method name="get_tab_count" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="tab_idx" type="int"> - </argument> <description> </description> </method> - <method name="set_tab_icon"> + <method name="get_tab_icon" qualifiers="const"> + <return type="Texture"> + </return> <argument index="0" name="tab_idx" type="int"> </argument> - <argument index="1" name="icon" type="Texture"> - </argument> <description> </description> </method> - <method name="get_tab_icon" qualifiers="const"> - <return type="Texture"> + <method name="get_tab_title" qualifiers="const"> + <return type="String"> </return> <argument index="0" name="tab_idx" type="int"> </argument> @@ -38570,10 +38638,8 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="add_tab"> - <argument index="0" name="title" type="String"> - </argument> - <argument index="1" name="icon" type="Texture"> + <method name="set_current_tab"> + <argument index="0" name="tab_idx" type="int"> </argument> <description> </description> @@ -38584,33 +38650,37 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_tab_align" qualifiers="const"> - <return type="int"> - </return> + <method name="set_tab_icon"> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="icon" type="Texture"> + </argument> <description> </description> </method> - <method name="ensure_tab_visible"> - <argument index="0" name="idx" type="int"> + <method name="set_tab_title"> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="title" type="String"> </argument> <description> </description> </method> </methods> <signals> - <signal name="tab_close"> + <signal name="right_button_pressed"> <argument index="0" name="tab" type="int"> </argument> <description> </description> </signal> - <signal name="right_button_pressed"> + <signal name="tab_changed"> <argument index="0" name="tab" type="int"> </argument> <description> </description> </signal> - <signal name="tab_changed"> + <signal name="tab_close"> <argument index="0" name="tab" type="int"> </argument> <description> @@ -38624,47 +38694,47 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="ALIGN_RIGHT" value="2"> </constant> + <constant name="CLOSE_BUTTON_SHOW_NEVER" value="0"> + </constant> <constant name="CLOSE_BUTTON_SHOW_ACTIVE_ONLY" value="1"> </constant> <constant name="CLOSE_BUTTON_SHOW_ALWAYS" value="2"> </constant> - <constant name="CLOSE_BUTTON_SHOW_NEVER" value="0"> - </constant> </constants> <theme_items> - <theme_item name="label_valign_fg" type="int"> + <theme_item name="button" type="StyleBox"> </theme_item> - <theme_item name="hseparation" type="int"> + <theme_item name="button_pressed" type="StyleBox"> </theme_item> - <theme_item name="label_valign_bg" type="int"> + <theme_item name="close" type="Texture"> </theme_item> - <theme_item name="top_margin" type="int"> + <theme_item name="decrement" type="Texture"> + </theme_item> + <theme_item name="decrement_hilite" type="Texture"> + </theme_item> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color_bg" type="Color"> </theme_item> <theme_item name="font_color_fg" type="Color"> </theme_item> - <theme_item name="increment_hilite" type="Texture"> - </theme_item> - <theme_item name="decrement_hilite" type="Texture"> + <theme_item name="hseparation" type="int"> </theme_item> <theme_item name="increment" type="Texture"> </theme_item> - <theme_item name="close" type="Texture"> - </theme_item> - <theme_item name="decrement" type="Texture"> + <theme_item name="increment_hilite" type="Texture"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="label_valign_bg" type="int"> </theme_item> - <theme_item name="tab_fg" type="StyleBox"> + <theme_item name="label_valign_fg" type="int"> </theme_item> - <theme_item name="button" type="StyleBox"> + <theme_item name="panel" type="StyleBox"> </theme_item> <theme_item name="tab_bg" type="StyleBox"> </theme_item> - <theme_item name="panel" type="StyleBox"> + <theme_item name="tab_fg" type="StyleBox"> </theme_item> - <theme_item name="button_pressed" type="StyleBox"> + <theme_item name="top_margin" type="int"> </theme_item> </theme_items> </class> @@ -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. </description> <methods> - <method name="set_text"> - <argument index="0" name="text" type="String"> + <method name="add_color_region"> + <argument index="0" name="begin_key" type="String"> + </argument> + <argument index="1" name="end_key" type="String"> + </argument> + <argument index="2" name="color" type="Color"> + </argument> + <argument index="3" name="line_only" type="bool" default="false"> </argument> <description> - Set the entire text. + Add color region (given the delimiters) and its colors. </description> </method> - <method name="insert_text_at_cursor"> - <argument index="0" name="text" type="String"> + <method name="add_keyword_color"> + <argument index="0" name="keyword" type="String"> + </argument> + <argument index="1" name="color" type="Color"> </argument> <description> - Insert a given text at the cursor position. + Add a keyword and its color. </description> </method> - <method name="get_line_count" qualifiers="const"> - <return type="int"> - </return> + <method name="clear_colors"> <description> - Return the amount of total lines in the text. + Clear all the syntax coloring information. </description> </method> - <method name="get_text"> - <return type="String"> - </return> + <method name="clear_undo_history"> <description> - Return the whole text. + Clear the undo history. </description> </method> - <method name="get_line" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="line" type="int"> - </argument> + <method name="copy"> <description> - Return the text of a specific line. + Copy the current selection. </description> </method> - <method name="cursor_set_column"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="adjust_viewport" type="bool" default="false"> - </argument> + <method name="cursor_get_blink_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> + Gets whether the text editor caret is blinking. </description> </method> - <method name="cursor_set_line"> - <argument index="0" name="line" type="int"> - </argument> - <argument index="1" name="adjust_viewport" type="bool" default="false"> - </argument> + <method name="cursor_get_blink_speed" qualifiers="const"> + <return type="float"> + </return> <description> + Gets the text editor caret blink speed. </description> </method> <method name="cursor_get_column" qualifiers="const"> @@ -38762,13 +38830,6 @@ This method controls whether the position between two cached points is interpola Set the text editor caret to blink. </description> </method> - <method name="cursor_get_blink_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Gets whether the text editor caret is blinking. - </description> - </method> <method name="cursor_set_blink_speed"> <argument index="0" name="blink_speed" type="float"> </argument> @@ -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. </description> </method> - <method name="cursor_get_blink_speed" qualifiers="const"> - <return type="float"> - </return> - <description> - Gets the text editor caret blink speed. - </description> - </method> - <method name="set_readonly"> - <argument index="0" name="enable" type="bool"> + <method name="cursor_set_column"> + <argument index="0" name="column" type="int"> </argument> - <description> - Set the text editor as read-only. Text can be displayed but not edited. - </description> - </method> - <method name="set_wrap"> - <argument index="0" name="enable" type="bool"> + <argument index="1" name="adjust_viewport" type="bool" default="false"> </argument> <description> - Enable text wrapping when it goes beyond he edge of what is visible. </description> </method> - <method name="set_max_chars"> - <argument index="0" name="amount" type="int"> + <method name="cursor_set_line"> + <argument index="0" name="line" type="int"> + </argument> + <argument index="1" name="adjust_viewport" type="bool" default="false"> </argument> <description> - Set the maximum amount of characters editable. </description> </method> <method name="cut"> @@ -38809,39 +38858,33 @@ This method controls whether the position between two cached points is interpola Cut the current selection. </description> </method> - <method name="copy"> - <description> - Copy the current selection. - </description> - </method> - <method name="paste"> + <method name="get_line" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="line" type="int"> + </argument> <description> - Paste the current selection. + Return the text of a specific line. </description> </method> - <method name="select_all"> + <method name="get_line_count" qualifiers="const"> + <return type="int"> + </return> <description> - Select all the text. + Return the amount of total lines in the text. </description> </method> - <method name="select"> - <argument index="0" name="from_line" type="int"> - </argument> - <argument index="1" name="from_column" type="int"> - </argument> - <argument index="2" name="to_line" type="int"> - </argument> - <argument index="3" name="to_column" type="int"> - </argument> + <method name="get_menu" qualifiers="const"> + <return type="PopupMenu"> + </return> <description> - Perform selection, from line/column to line/column. </description> </method> - <method name="is_selection_active" qualifiers="const"> - <return type="bool"> + <method name="get_selection_from_column" qualifiers="const"> + <return type="int"> </return> <description> - Return true if the selection is active. + Return the selection begin column. </description> </method> <method name="get_selection_from_line" qualifiers="const"> @@ -38851,32 +38894,32 @@ This method controls whether the position between two cached points is interpola Return the selection begin line. </description> </method> - <method name="get_selection_from_column" qualifiers="const"> - <return type="int"> + <method name="get_selection_text" qualifiers="const"> + <return type="String"> </return> <description> - Return the selection begin column. + Return the text inside the selection. </description> </method> - <method name="get_selection_to_line" qualifiers="const"> + <method name="get_selection_to_column" qualifiers="const"> <return type="int"> </return> <description> - Return the selection end line. + Return the selection end column. </description> </method> - <method name="get_selection_to_column" qualifiers="const"> + <method name="get_selection_to_line" qualifiers="const"> <return type="int"> </return> <description> - Return the selection end column. + Return the selection end line. </description> </method> - <method name="get_selection_text" qualifiers="const"> + <method name="get_text"> <return type="String"> </return> <description> - Return the text inside the selection. + Return the whole text. </description> </method> <method name="get_word_under_cursor" qualifiers="const"> @@ -38885,6 +38928,43 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="insert_text_at_cursor"> + <argument index="0" name="text" type="String"> + </argument> + <description> + Insert a given text at the cursor position. + </description> + </method> + <method name="is_selection_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the selection is active. + </description> + </method> + <method name="is_syntax_coloring_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the syntax coloring is enabled. + </description> + </method> + <method name="menu_option"> + <argument index="0" name="arg0" type="int"> + </argument> + <description> + </description> + </method> + <method name="paste"> + <description> + Paste the current selection. + </description> + </method> + <method name="redo"> + <description> + Perform redo operation. + </description> + </method> <method name="search" qualifiers="const"> <return type="IntArray"> </return> @@ -38900,55 +38980,43 @@ 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. </description> </method> - <method name="undo"> - <description> - Perform undo operation. - </description> - </method> - <method name="redo"> + <method name="select"> + <argument index="0" name="from_line" type="int"> + </argument> + <argument index="1" name="from_column" type="int"> + </argument> + <argument index="2" name="to_line" type="int"> + </argument> + <argument index="3" name="to_column" type="int"> + </argument> <description> - Perform redo operation. + Perform selection, from line/column to line/column. </description> </method> - <method name="clear_undo_history"> + <method name="select_all"> <description> - Clear the undo history. + Select all the text. </description> </method> - <method name="set_syntax_coloring"> - <argument index="0" name="enable" type="bool"> + <method name="set_custom_bg_color"> + <argument index="0" name="color" type="Color"> </argument> <description> - Set to enable the syntax coloring. - </description> - </method> - <method name="is_syntax_coloring_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if the syntax coloring is enabled. + Set a custom background color. A background color with alpha==0 disables this. </description> </method> - <method name="add_keyword_color"> - <argument index="0" name="keyword" type="String"> - </argument> - <argument index="1" name="color" type="Color"> + <method name="set_max_chars"> + <argument index="0" name="amount" type="int"> </argument> <description> - Add a keyword and its color. + Set the maximum amount of characters editable. </description> </method> - <method name="add_color_region"> - <argument index="0" name="begin_key" type="String"> - </argument> - <argument index="1" name="end_key" type="String"> - </argument> - <argument index="2" name="color" type="Color"> - </argument> - <argument index="3" name="line_only" type="bool" default="false"> + <method name="set_readonly"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Add color region (given the delimiters) and its colors. + Set the text editor as read-only. Text can be displayed but not edited. </description> </method> <method name="set_symbol_color"> @@ -38958,37 +39026,34 @@ This method controls whether the position between two cached points is interpola Set the color for symbols. </description> </method> - <method name="set_custom_bg_color"> - <argument index="0" name="color" type="Color"> + <method name="set_syntax_coloring"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Set a custom background color. A background color with alpha==0 disables this. + Set to enable the syntax coloring. </description> </method> - <method name="clear_colors"> + <method name="set_text"> + <argument index="0" name="text" type="String"> + </argument> <description> - Clear all the syntax coloring information. + Set the entire text. </description> </method> - <method name="menu_option"> - <argument index="0" name="arg0" type="int"> + <method name="set_wrap"> + <argument index="0" name="enable" type="bool"> </argument> <description> + Enable text wrapping when it goes beyond he edge of what is visible. </description> </method> - <method name="get_menu" qualifiers="const"> - <return type="PopupMenu"> - </return> + <method name="undo"> <description> + Perform undo operation. </description> </method> </methods> <signals> - <signal name="text_changed"> - <description> - Emitted when the text changes. - </description> - </signal> <signal name="cursor_changed"> <description> Emitted when the cursor changes. @@ -38998,17 +39063,13 @@ This method controls whether the position between two cached points is interpola <description> </description> </signal> + <signal name="text_changed"> + <description> + Emitted when the text changes. + </description> + </signal> </signals> <constants> - <constant name="SEARCH_MATCH_CASE" value="1"> - Match case when searching. - </constant> - <constant name="SEARCH_WHOLE_WORDS" value="2"> - Match whole words when searching. - </constant> - <constant name="SEARCH_BACKWARDS" value="4"> - Search from end to beginning. - </constant> <constant name="MENU_CUT" value="0"> </constant> <constant name="MENU_COPY" value="1"> @@ -39023,49 +39084,58 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="MENU_MAX" value="6"> </constant> + <constant name="SEARCH_MATCH_CASE" value="1"> + Match case when searching. + </constant> + <constant name="SEARCH_WHOLE_WORDS" value="2"> + Match whole words when searching. + </constant> + <constant name="SEARCH_BACKWARDS" value="4"> + Search from end to beginning. + </constant> </constants> <theme_items> - <theme_item name="line_spacing" type="int"> - </theme_item> - <theme_item name="completion_lines" type="int"> - </theme_item> - <theme_item name="completion_max_width" type="int"> + <theme_item name="brace_mismatch_color" type="Color"> </theme_item> - <theme_item name="completion_scroll_width" type="int"> + <theme_item name="breakpoint_color" type="Color"> </theme_item> - <theme_item name="symbol_color" type="Color"> + <theme_item name="caret_color" type="Color"> </theme_item> - <theme_item name="selection_color" type="Color"> + <theme_item name="completion" type="StyleBox"> </theme_item> <theme_item name="completion_existing" type="Color"> </theme_item> - <theme_item name="caret_color" type="Color"> - </theme_item> - <theme_item name="breakpoint_color" type="Color"> - </theme_item> - <theme_item name="font_color_selected" type="Color"> + <theme_item name="completion_lines" type="int"> </theme_item> - <theme_item name="font_color" type="Color"> + <theme_item name="completion_max_width" type="int"> </theme_item> <theme_item name="completion_scroll_color" type="Color"> </theme_item> - <theme_item name="brace_mismatch_color" type="Color"> + <theme_item name="completion_scroll_width" type="int"> </theme_item> - <theme_item name="current_line_color" type="Color"> + <theme_item name="completion_selected" type="StyleBox"> </theme_item> - <theme_item name="mark_color" type="Color"> + <theme_item name="current_line_color" type="Color"> </theme_item> - <theme_item name="tab" type="Texture"> + <theme_item name="focus" type="StyleBox"> </theme_item> <theme_item name="font" type="Font"> </theme_item> - <theme_item name="focus" type="StyleBox"> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_selected" type="Color"> + </theme_item> + <theme_item name="line_spacing" type="int"> + </theme_item> + <theme_item name="mark_color" type="Color"> </theme_item> <theme_item name="normal" type="StyleBox"> </theme_item> - <theme_item name="completion_selected" type="StyleBox"> + <theme_item name="selection_color" type="Color"> </theme_item> - <theme_item name="completion" type="StyleBox"> + <theme_item name="symbol_color" type="Color"> + </theme_item> + <theme_item name="tab" type="Texture"> </theme_item> </theme_items> </class> @@ -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]. </description> <methods> - <method name="get_width" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the texture width. - </description> - </method> - <method name="get_height" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the texture height. - </description> - </method> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the texture size. - </description> - </method> - <method name="get_rid" qualifiers="const"> - <return type="RID"> - </return> - <description> - Return the texture RID as used in the [VisualServer]. - </description> - </method> - <method name="has_alpha" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_flags"> - <argument index="0" name="flags" type="int"> - </argument> - <description> - Change the texture flags. - </description> - </method> - <method name="get_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the current texture flags. - </description> - </method> <method name="draw" qualifiers="const"> <argument index="0" name="canvas_item" type="RID"> </argument> @@ -39165,28 +39187,76 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="get_flags" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the current texture flags. + </description> + </method> + <method name="get_height" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the texture height. + </description> + </method> + <method name="get_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + Return the texture RID as used in the [VisualServer]. + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the texture size. + </description> + </method> + <method name="get_width" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the texture width. + </description> + </method> + <method name="has_alpha" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_flags"> + <argument index="0" name="flags" type="int"> + </argument> + <description> + Change the texture flags. + </description> + </method> </methods> <constants> <constant name="FLAG_MIPMAPS" value="1"> Generate mipmaps, to enable smooth zooming out of the texture. </constant> + <constant name="FLAG_CONVERT_TO_LINEAR" value="16"> + </constant> <constant name="FLAG_REPEAT" value="2"> Repeat (instead of clamp to edge). </constant> + <constant name="FLAG_MIRRORED_REPEAT" value="32"> + </constant> <constant name="FLAG_FILTER" value="4"> Turn on magnifying filter, to enable smooth zooming in of the texture. </constant> <constant name="FLAG_VIDEO_SURFACE" value="4096"> Texture is a video surface. </constant> - <constant name="FLAGS_DEFAULT" value="7"> - Default flags. Generate mipmaps, repeat, and filter are enabled. - </constant> <constant name="FLAG_ANISOTROPIC_FILTER" value="8"> </constant> - <constant name="FLAG_CONVERT_TO_LINEAR" value="16"> - </constant> - <constant name="FLAG_MIRRORED_REPEAT" value="32"> + <constant name="FLAGS_DEFAULT" value="7"> + Default flags. Generate mipmaps, repeat, and filter are enabled. </constant> </constants> </class> @@ -39199,99 +39269,99 @@ This method controls whether the position between two cached points is interpola Only the normal texture is required, the others are optional. </description> <methods> - <method name="set_normal_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> + <method name="get_click_mask" qualifiers="const"> + <return type="BitMap"> + </return> <description> </description> </method> - <method name="set_pressed_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> + <method name="get_disabled_texture" qualifiers="const"> + <return type="Texture"> + </return> <description> </description> </method> - <method name="set_hover_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> + <method name="get_focused_texture" qualifiers="const"> + <return type="Texture"> + </return> <description> </description> </method> - <method name="set_disabled_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> + <method name="get_hover_texture" qualifiers="const"> + <return type="Texture"> + </return> <description> </description> </method> - <method name="set_focused_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> + </return> <description> </description> </method> - <method name="set_click_mask"> - <argument index="0" name="mask" type="BitMap"> - </argument> + <method name="get_normal_texture" qualifiers="const"> + <return type="Texture"> + </return> <description> </description> </method> - <method name="set_texture_scale"> - <argument index="0" name="scale" type="Vector2"> - </argument> + <method name="get_pressed_texture" qualifiers="const"> + <return type="Texture"> + </return> <description> </description> </method> - <method name="set_modulate"> - <argument index="0" name="color" type="Color"> - </argument> + <method name="get_texture_scale" qualifiers="const"> + <return type="Vector2"> + </return> <description> </description> </method> - <method name="get_normal_texture" qualifiers="const"> - <return type="Texture"> - </return> + <method name="set_click_mask"> + <argument index="0" name="mask" type="BitMap"> + </argument> <description> </description> </method> - <method name="get_pressed_texture" qualifiers="const"> - <return type="Texture"> - </return> + <method name="set_disabled_texture"> + <argument index="0" name="texture" type="Texture"> + </argument> <description> </description> </method> - <method name="get_hover_texture" qualifiers="const"> - <return type="Texture"> - </return> + <method name="set_focused_texture"> + <argument index="0" name="texture" type="Texture"> + </argument> <description> </description> </method> - <method name="get_disabled_texture" qualifiers="const"> - <return type="Texture"> - </return> + <method name="set_hover_texture"> + <argument index="0" name="texture" type="Texture"> + </argument> <description> </description> </method> - <method name="get_focused_texture" qualifiers="const"> - <return type="Texture"> - </return> + <method name="set_modulate"> + <argument index="0" name="color" type="Color"> + </argument> <description> </description> </method> - <method name="get_click_mask" qualifiers="const"> - <return type="BitMap"> - </return> + <method name="set_normal_texture"> + <argument index="0" name="texture" type="Texture"> + </argument> <description> </description> </method> - <method name="get_texture_scale" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_pressed_texture"> + <argument index="0" name="texture" type="Texture"> + </argument> <description> </description> </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> - </return> + <method name="set_texture_scale"> + <argument index="0" name="scale" type="Vector2"> + </argument> <description> </description> </method> @@ -39307,26 +39377,26 @@ 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. </description> <methods> - <method name="set_texture"> - <argument index="0" name="texture" type="Object"> - </argument> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> + </return> <description> </description> </method> - <method name="get_texture" qualifiers="const"> - <return type="Object"> + <method name="get_stretch_mode" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="set_modulate"> - <argument index="0" name="modulate" type="Color"> - </argument> + <method name="get_texture" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> + <method name="has_expand" qualifiers="const"> + <return type="bool"> </return> <description> </description> @@ -39337,9 +39407,9 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="has_expand" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_modulate"> + <argument index="0" name="modulate" type="Color"> + </argument> <description> </description> </method> @@ -39349,9 +39419,9 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_stretch_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_texture"> + <argument index="0" name="texture" type="Object"> + </argument> <description> </description> </method> @@ -39381,21 +39451,21 @@ 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). </description> <methods> - <method name="set_under_texture"> - <argument index="0" name="tex" type="Object"> - </argument> + <method name="get_fill_degrees"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_under_texture" qualifiers="const"> - <return type="Object"> + <method name="get_fill_mode"> + <return type="int"> </return> <description> </description> </method> - <method name="set_progress_texture"> - <argument index="0" name="tex" type="Object"> - </argument> + <method name="get_over_texture" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> @@ -39405,39 +39475,45 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_over_texture"> - <argument index="0" name="tex" type="Object"> - </argument> + <method name="get_radial_center_offset"> + <return type="Vector2"> + </return> <description> </description> </method> - <method name="get_over_texture" qualifiers="const"> + <method name="get_radial_initial_angle"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_under_texture" qualifiers="const"> <return type="Object"> </return> <description> </description> </method> - <method name="set_fill_mode"> - <argument index="0" name="mode" type="int"> + <method name="set_fill_degrees"> + <argument index="0" name="mode" type="float"> </argument> <description> </description> </method> - <method name="get_fill_mode"> - <return type="int"> - </return> + <method name="set_fill_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> </description> </method> - <method name="set_radial_initial_angle"> - <argument index="0" name="mode" type="float"> + <method name="set_over_texture"> + <argument index="0" name="tex" type="Object"> </argument> <description> </description> </method> - <method name="get_radial_initial_angle"> - <return type="float"> - </return> + <method name="set_progress_texture"> + <argument index="0" name="tex" type="Object"> + </argument> <description> </description> </method> @@ -39447,21 +39523,15 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_radial_center_offset"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_fill_degrees"> + <method name="set_radial_initial_angle"> <argument index="0" name="mode" type="float"> </argument> <description> </description> </method> - <method name="get_fill_degrees"> - <return type="float"> - </return> + <method name="set_under_texture"> + <argument index="0" name="tex" type="Object"> + </argument> <description> </description> </method> @@ -39490,19 +39560,15 @@ 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. </description> <methods> - <method name="set_icon"> + <method name="clear_color"> <argument index="0" name="name" type="String"> </argument> <argument index="1" name="type" type="String"> </argument> - <argument index="2" name="texture" type="Texture"> - </argument> <description> </description> </method> - <method name="get_icon" qualifiers="const"> - <return type="Texture"> - </return> + <method name="clear_constant"> <argument index="0" name="name" type="String"> </argument> <argument index="1" name="type" type="String"> @@ -39510,9 +39576,7 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="has_icon" qualifiers="const"> - <return type="bool"> - </return> + <method name="clear_font"> <argument index="0" name="name" type="String"> </argument> <argument index="1" name="type" type="String"> @@ -39528,26 +39592,20 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_icon_list" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_stylebox"> + <method name="clear_stylebox"> <argument index="0" name="name" type="String"> </argument> <argument index="1" name="type" type="String"> </argument> - <argument index="2" name="texture" type="StyleBox"> - </argument> <description> </description> </method> - <method name="get_stylebox" qualifiers="const"> - <return type="StyleBox"> + <method name="copy_default_theme"> + <description> + </description> + </method> + <method name="get_color" qualifiers="const"> + <return type="Color"> </return> <argument index="0" name="name" type="String"> </argument> @@ -39556,17 +39614,17 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="has_stylebox" qualifiers="const"> - <return type="bool"> + <method name="get_color_list" qualifiers="const"> + <return type="StringArray"> </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> </method> - <method name="clear_stylebox"> + <method name="get_constant" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="name" type="String"> </argument> <argument index="1" name="type" type="String"> @@ -39574,7 +39632,7 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_stylebox_list" qualifiers="const"> + <method name="get_constant_list" qualifiers="const"> <return type="StringArray"> </return> <argument index="0" name="type" type="String"> @@ -39582,24 +39640,32 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_stylebox_types" qualifiers="const"> - <return type="StringArray"> + <method name="get_default_font" qualifiers="const"> + <return type="Object"> </return> <description> </description> </method> - <method name="set_font"> + <method name="get_font" qualifiers="const"> + <return type="Font"> + </return> <argument index="0" name="name" type="String"> </argument> <argument index="1" name="type" type="String"> </argument> - <argument index="2" name="font" type="Font"> + <description> + </description> + </method> + <method name="get_font_list" qualifiers="const"> + <return type="StringArray"> + </return> + <argument index="0" name="type" type="String"> </argument> <description> </description> </method> - <method name="get_font" qualifiers="const"> - <return type="Font"> + <method name="get_icon" qualifiers="const"> + <return type="Texture"> </return> <argument index="0" name="name" type="String"> </argument> @@ -39608,17 +39674,17 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="has_font" qualifiers="const"> - <return type="bool"> + <method name="get_icon_list" qualifiers="const"> + <return type="StringArray"> </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> </method> - <method name="clear_font"> + <method name="get_stylebox" qualifiers="const"> + <return type="StyleBox"> + </return> <argument index="0" name="name" type="String"> </argument> <argument index="1" name="type" type="String"> @@ -39626,7 +39692,7 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_font_list" qualifiers="const"> + <method name="get_stylebox_list" qualifiers="const"> <return type="StringArray"> </return> <argument index="0" name="type" type="String"> @@ -39634,22 +39700,16 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_color"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <argument index="2" name="color" type="Color"> - </argument> + <method name="get_stylebox_types" qualifiers="const"> + <return type="StringArray"> + </return> <description> </description> </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> + <method name="get_type_list" qualifiers="const"> + <return type="StringArray"> </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -39664,7 +39724,9 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="clear_color"> + <method name="has_constant" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="name" type="String"> </argument> <argument index="1" name="type" type="String"> @@ -39672,26 +39734,18 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_color_list" qualifiers="const"> - <return type="StringArray"> + <method name="has_font" qualifiers="const"> + <return type="bool"> </return> - <argument index="0" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_constant"> <argument index="0" name="name" type="String"> </argument> <argument index="1" name="type" type="String"> </argument> - <argument index="2" name="constant" type="int"> - </argument> <description> </description> </method> - <method name="get_constant" qualifiers="const"> - <return type="int"> + <method name="has_icon" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="name" type="String"> </argument> @@ -39700,7 +39754,7 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="has_constant" qualifiers="const"> + <method name="has_stylebox" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="name" type="String"> @@ -39710,18 +39764,22 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="clear_constant"> + <method name="set_color"> <argument index="0" name="name" type="String"> </argument> <argument index="1" name="type" type="String"> </argument> + <argument index="2" name="color" type="Color"> + </argument> <description> </description> </method> - <method name="get_constant_list" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="type" type="String"> + <method name="set_constant"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <argument index="2" name="constant" type="int"> </argument> <description> </description> @@ -39732,21 +39790,33 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_default_font" qualifiers="const"> - <return type="Object"> - </return> + <method name="set_font"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <argument index="2" name="font" type="Font"> + </argument> <description> </description> </method> - <method name="get_type_list" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="type" type="String"> + <method name="set_icon"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <argument index="2" name="texture" type="Texture"> </argument> <description> </description> </method> - <method name="copy_default_theme"> + <method name="set_stylebox"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <argument index="2" name="texture" type="StyleBox"> + </argument> <description> </description> </method> @@ -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. </description> <methods> + <method name="get_id" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the id of the thread, uniquely identifying it among all threads. + </description> + </method> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + 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]. + </description> + </method> <method name="start"> <return type="Error"> </return> @@ -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. </description> </method> - <method name="get_id" qualifiers="const"> - <return type="String"> - </return> - <description> - Return the id of the thread, uniquely identifying it among all threads. - </description> - </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - 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]. - </description> - </method> <method name="wait_to_finish"> <return type="Variant"> </return> @@ -39818,233 +39888,192 @@ 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. </description> <methods> - <method name="set_tileset"> - <argument index="0" name="tileset" type="TileSet"> - </argument> + <method name="clear"> <description> - Set the current tileset. + Clear all cells. </description> </method> - <method name="get_tileset" qualifiers="const"> - <return type="TileSet"> + <method name="get_cell" qualifiers="const"> + <return type="int"> </return> - <description> - Return the current tileset. - </description> - </method> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> </argument> <description> - Set the orientation mode as square, isometric or custom (use MODE_* constants as argument). + Return the tile index of the referenced cell. </description> </method> - <method name="get_mode" qualifiers="const"> - <return type="int"> + <method name="get_cell_size" qualifiers="const"> + <return type="Vector2"> </return> <description> - Return the orientation mode. - </description> - </method> - <method name="set_half_offset"> - <argument index="0" name="half_offset" type="int"> - </argument> - <description> - 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 cell size. </description> </method> - <method name="get_half_offset" qualifiers="const"> + <method name="get_cellv" qualifiers="const"> <return type="int"> </return> - <description> - Return the current half offset configuration. - </description> - </method> - <method name="set_custom_transform"> - <argument index="0" name="custom_transform" type="Matrix32"> + <argument index="0" name="pos" type="Vector2"> </argument> <description> - Set custom transform matrix, to use in combination with the custom orientation mode. + Return the tile index of the cell referenced by a Vector2. </description> </method> - <method name="get_custom_transform" qualifiers="const"> - <return type="Matrix32"> + <method name="get_center_x" qualifiers="const"> + <return type="bool"> </return> <description> - Return the custom transform matrix. + 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). </description> </method> - <method name="set_cell_size"> - <argument index="0" name="size" type="Vector2"> - </argument> + <method name="get_center_y" qualifiers="const"> + <return type="bool"> + </return> <description> - Set the cell size. + 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). </description> </method> - <method name="get_cell_size" qualifiers="const"> - <return type="Vector2"> + <method name="get_collision_bounce" qualifiers="const"> + <return type="float"> </return> <description> - Return the cell size. + Return the collision bounce parameter. </description> </method> - <method name="set_quadrant_size"> - <argument index="0" name="size" type="int"> - </argument> + <method name="get_collision_friction" qualifiers="const"> + <return type="float"> + </return> <description> - 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 collision friction parameter. </description> </method> - <method name="get_quadrant_size" qualifiers="const"> + <method name="get_collision_layer" qualifiers="const"> <return type="int"> </return> <description> - Return the quadrant size. - </description> - </method> - <method name="set_tile_origin"> - <argument index="0" name="origin" type="int"> - </argument> - <description> - Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument). + Return the collision layer. </description> </method> - <method name="get_tile_origin" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the tile origin configuration. - </description> - </method> - <method name="set_center_x"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner). + Return the collision mask. </description> </method> - <method name="get_center_x" qualifiers="const"> + <method name="get_collision_use_kinematic" qualifiers="const"> <return type="bool"> </return> <description> - 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). - </description> - </method> - <method name="set_center_y"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). + Return whether the tilemap handles collisions as a kinematic body. </description> </method> - <method name="get_center_y" qualifiers="const"> - <return type="bool"> + <method name="get_custom_transform" qualifiers="const"> + <return type="Matrix32"> </return> <description> - 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). - </description> - </method> - <method name="set_y_sort_mode"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - 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 custom transform matrix. </description> </method> - <method name="is_y_sort_mode_enabled" qualifiers="const"> - <return type="bool"> + <method name="get_half_offset" qualifiers="const"> + <return type="int"> </return> <description> - Return the Y sort mode. + Return the current half offset configuration. </description> </method> - <method name="set_collision_use_kinematic"> - <argument index="0" name="use_kinematic" type="bool"> - </argument> + <method name="get_mode" qualifiers="const"> + <return type="int"> + </return> <description> - Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled). + Return the orientation mode. </description> </method> - <method name="get_collision_use_kinematic" qualifiers="const"> - <return type="bool"> + <method name="get_occluder_light_mask" qualifiers="const"> + <return type="int"> </return> <description> - Return whether the tilemap handles collisions as a kinematic body. </description> </method> - <method name="set_collision_layer"> - <argument index="0" name="mask" type="int"> - </argument> + <method name="get_quadrant_size" qualifiers="const"> + <return type="int"> + </return> <description> - 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 quadrant size. </description> </method> - <method name="get_collision_layer" qualifiers="const"> + <method name="get_tile_origin" qualifiers="const"> <return type="int"> </return> <description> - Return the collision layer. + Return the tile origin configuration. </description> </method> - <method name="set_collision_mask"> - <argument index="0" name="mask" type="int"> - </argument> + <method name="get_tileset" qualifiers="const"> + <return type="TileSet"> + </return> <description> - 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 current tileset. </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> + <method name="get_used_cells" qualifiers="const"> + <return type="Array"> </return> <description> - Return the collision mask. + Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). </description> </method> - <method name="set_collision_friction"> - <argument index="0" name="value" type="float"> + <method name="is_cell_transposed" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> </argument> <description> - Set the collision friction parameter. - Allowable values range from 0 to 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). </description> </method> - <method name="get_collision_friction" qualifiers="const"> - <return type="float"> + <method name="is_cell_x_flipped" qualifiers="const"> + <return type="bool"> </return> - <description> - Return the collision friction parameter. - </description> - </method> - <method name="set_collision_bounce"> - <argument index="0" name="value" type="float"> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> </argument> <description> - Set the collision bounce parameter. - Allowable values range from 0 to 1. + Return whether the referenced cell is flipped over the X axis. </description> </method> - <method name="get_collision_bounce" qualifiers="const"> - <return type="float"> + <method name="is_cell_y_flipped" qualifiers="const"> + <return type="bool"> </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> <description> - Return the collision bounce parameter. + Return whether the referenced cell is flipped over the Y axis. </description> </method> - <method name="set_occluder_light_mask"> - <argument index="0" name="mask" type="int"> - </argument> + <method name="is_y_sort_mode_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> + Return the Y sort mode. </description> </method> - <method name="get_occluder_light_mask" qualifiers="const"> - <return type="int"> + <method name="map_to_world" qualifiers="const"> + <return type="Vector2"> </return> + <argument index="0" name="mappos" type="Vector2"> + </argument> + <argument index="1" name="ignore_half_ofs" type="bool" default="false"> + </argument> <description> + Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. + Optionally, the tilemap's potential half offset can be ignored. </description> </method> <method name="set_cell"> @@ -40066,6 +40095,13 @@ This method controls whether the position between two cached points is interpola Optionally, the tile can also be flipped over the X and Y coordinates or transposed. </description> </method> + <method name="set_cell_size"> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Set the cell size. + </description> + </method> <method name="set_cellv"> <argument index="0" name="pos" type="Vector2"> </argument> @@ -40083,81 +40119,115 @@ This method controls whether the position between two cached points is interpola Optionally, the tile can also be flipped over the X and Y axes or transposed. </description> </method> - <method name="get_cell" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="x" type="int"> + <method name="set_center_x"> + <argument index="0" name="enable" type="bool"> </argument> - <argument index="1" name="y" type="int"> + <description> + Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner). + </description> + </method> + <method name="set_center_y"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Return the tile index of the referenced cell. + Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). </description> </method> - <method name="get_cellv" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="pos" type="Vector2"> + <method name="set_collision_bounce"> + <argument index="0" name="value" type="float"> </argument> <description> - Return the tile index of the cell referenced by a Vector2. + Set the collision bounce parameter. + Allowable values range from 0 to 1. </description> </method> - <method name="is_cell_x_flipped" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="x" type="int"> + <method name="set_collision_friction"> + <argument index="0" name="value" type="float"> </argument> - <argument index="1" name="y" type="int"> + <description> + Set the collision friction parameter. + Allowable values range from 0 to 1. + </description> + </method> + <method name="set_collision_layer"> + <argument index="0" name="mask" type="int"> </argument> <description> - Return whether the referenced cell is flipped over the X axis. + 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. </description> </method> - <method name="is_cell_y_flipped" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="x" type="int"> + <method name="set_collision_mask"> + <argument index="0" name="mask" type="int"> </argument> - <argument index="1" name="y" type="int"> + <description> + 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. + </description> + </method> + <method name="set_collision_use_kinematic"> + <argument index="0" name="use_kinematic" type="bool"> </argument> <description> - Return whether the referenced cell is flipped over the Y axis. + Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled). </description> </method> - <method name="is_cell_transposed" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="x" type="int"> + <method name="set_custom_transform"> + <argument index="0" name="custom_transform" type="Matrix32"> </argument> - <argument index="1" name="y" type="int"> + <description> + Set custom transform matrix, to use in combination with the custom orientation mode. + </description> + </method> + <method name="set_half_offset"> + <argument index="0" name="half_offset" type="int"> </argument> <description> - Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector). + 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. </description> </method> - <method name="clear"> + <method name="set_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> - Clear all cells. + Set the orientation mode as square, isometric or custom (use MODE_* constants as argument). </description> </method> - <method name="get_used_cells" qualifiers="const"> - <return type="Array"> - </return> + <method name="set_occluder_light_mask"> + <argument index="0" name="mask" type="int"> + </argument> <description> - Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). </description> </method> - <method name="map_to_world" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="mappos" type="Vector2"> + <method name="set_quadrant_size"> + <argument index="0" name="size" type="int"> </argument> - <argument index="1" name="ignore_half_ofs" type="bool" default="false"> + <description> + 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. + </description> + </method> + <method name="set_tile_origin"> + <argument index="0" name="origin" type="int"> </argument> <description> - Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. - Optionally, the tilemap's potential half offset can be ignored. + Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument). + </description> + </method> + <method name="set_tileset"> + <argument index="0" name="tileset" type="TileSet"> + </argument> + <description> + Set the current tileset. + </description> + </method> + <method name="set_y_sort_mode"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + 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. </description> </method> <method name="world_to_map" qualifiers="const"> @@ -40178,6 +40248,15 @@ This method controls whether the position between two cached points is interpola </signal> </signals> <constants> + <constant name="HALF_OFFSET_X" value="0"> + Half offset on the X coordinate. + </constant> + <constant name="HALF_OFFSET_Y" value="1"> + Half offset on the Y coordinate. + </constant> + <constant name="HALF_OFFSET_DISABLED" value="2"> + Half offset disabled. + </constant> <constant name="INVALID_CELL" value="-1"> Returned when a cell doesn't exist. </constant> @@ -40190,15 +40269,6 @@ This method controls whether the position between two cached points is interpola <constant name="MODE_CUSTOM" value="2"> Custom orientation mode. </constant> - <constant name="HALF_OFFSET_X" value="0"> - Half offset on the X coordinate. - </constant> - <constant name="HALF_OFFSET_Y" value="1"> - Half offset on the Y coordinate. - </constant> - <constant name="HALF_OFFSET_DISABLED" value="2"> - Half offset disabled. - </constant> <constant name="TILE_ORIGIN_TOP_LEFT" value="0"> Tile origin at its top-left corner. </constant> @@ -40216,6 +40286,11 @@ This method controls whether the position between two cached points is interpola Tiles are referenced by a unique integer ID. </description> <methods> + <method name="clear"> + <description> + Clear all tiles. + </description> + </method> <method name="create_tile"> <argument index="0" name="id" type="int"> </argument> @@ -40223,49 +40298,43 @@ This method controls whether the position between two cached points is interpola Create a new tile which will be referenced by the given ID. </description> </method> - <method name="tile_set_name"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="name" type="String"> + <method name="find_tile_by_name" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> </argument> <description> - Set the name of the tile, for descriptive purposes. + Find the first tile matching the given name. </description> </method> - <method name="tile_get_name" qualifiers="const"> - <return type="String"> + <method name="get_last_unused_tile_id" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="id" type="int"> - </argument> <description> - Return the name of the tile. + Return the ID following the last currently used ID, useful when creating a new tile. </description> </method> - <method name="tile_set_texture"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> + <method name="get_tiles_ids" qualifiers="const"> + <return type="Array"> + </return> <description> - Set the texture of the tile. + Return an array of all currently used tile IDs. </description> </method> - <method name="tile_get_texture" qualifiers="const"> - <return type="Texture"> - </return> + <method name="remove_tile"> <argument index="0" name="id" type="int"> </argument> <description> - Return the texture of the tile. + Remove the tile referenced by the given ID. </description> </method> - <method name="tile_set_material"> + <method name="tile_get_light_occluder" qualifiers="const"> + <return type="OccluderPolygon2D"> + </return> <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="material" type="CanvasItemMaterial"> - </argument> <description> - Set the material of the tile. + Return the light occluder of the tile. </description> </method> <method name="tile_get_material" qualifiers="const"> @@ -40277,49 +40346,40 @@ This method controls whether the position between two cached points is interpola Return the material of the tile. </description> </method> - <method name="tile_set_texture_offset"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="texture_offset" type="Vector2"> - </argument> - <description> - Set the texture offset of the tile. - </description> - </method> - <method name="tile_get_texture_offset" qualifiers="const"> - <return type="Vector2"> + <method name="tile_get_name" qualifiers="const"> + <return type="String"> </return> <argument index="0" name="id" type="int"> </argument> <description> - Return the texture offset of the tile. + Return the name of the tile. </description> </method> - <method name="tile_set_shape_offset"> + <method name="tile_get_navigation_polygon" qualifiers="const"> + <return type="NavigationPolygon"> + </return> <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="shape_offset" type="Vector2"> - </argument> <description> - Set the shape offset of the tile. + Return the navigation polygon of the tile. </description> </method> - <method name="tile_get_shape_offset" qualifiers="const"> + <method name="tile_get_navigation_polygon_offset" qualifiers="const"> <return type="Vector2"> </return> <argument index="0" name="id" type="int"> </argument> <description> - Return the shape offset of the tile. + Return the offset of the tile's navigation polygon. </description> </method> - <method name="tile_set_region"> + <method name="tile_get_occluder_offset" qualifiers="const"> + <return type="Vector2"> + </return> <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="region" type="Rect2"> - </argument> <description> - Set the tile sub-region in the texture. This is common in texture atlases. + Return the offset of the tile's light occluder. </description> </method> <method name="tile_get_region" qualifiers="const"> @@ -40331,15 +40391,6 @@ This method controls whether the position between two cached points is interpola Return the tile sub-region in the texture. </description> </method> - <method name="tile_set_shape"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="shape" type="Shape2D"> - </argument> - <description> - Set a shape for the tile, enabling physics to collide with it. - </description> - </method> <method name="tile_get_shape" qualifiers="const"> <return type="Shape2D"> </return> @@ -40349,13 +40400,13 @@ This method controls whether the position between two cached points is interpola Return the shape of the tile. </description> </method> - <method name="tile_set_shapes"> + <method name="tile_get_shape_offset" qualifiers="const"> + <return type="Vector2"> + </return> <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="shapes" type="Array"> - </argument> <description> - Set an array of shapes for the tile, enabling physics to collide with it. + Return the shape offset of the tile. </description> </method> <method name="tile_get_shapes" qualifiers="const"> @@ -40367,58 +40418,67 @@ This method controls whether the position between two cached points is interpola Return the array of shapes of the tile. </description> </method> - <method name="tile_set_navigation_polygon"> + <method name="tile_get_texture" qualifiers="const"> + <return type="Texture"> + </return> <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="navigation_polygon" type="NavigationPolygon"> - </argument> <description> - Set a navigation polygon for the tile. + Return the texture of the tile. </description> </method> - <method name="tile_get_navigation_polygon" qualifiers="const"> - <return type="NavigationPolygon"> + <method name="tile_get_texture_offset" qualifiers="const"> + <return type="Vector2"> </return> <argument index="0" name="id" type="int"> </argument> <description> - Return the navigation polygon of the tile. + Return the texture offset of the tile. </description> </method> - <method name="tile_set_navigation_polygon_offset"> + <method name="tile_set_light_occluder"> <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="navigation_polygon_offset" type="Vector2"> + <argument index="1" name="light_occluder" type="OccluderPolygon2D"> </argument> <description> - Set an offset for the tile's navigation polygon. + Set a light occluder for the tile. </description> </method> - <method name="tile_get_navigation_polygon_offset" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="tile_set_material"> <argument index="0" name="id" type="int"> </argument> + <argument index="1" name="material" type="CanvasItemMaterial"> + </argument> <description> - Return the offset of the tile's navigation polygon. + Set the material of the tile. </description> </method> - <method name="tile_set_light_occluder"> + <method name="tile_set_name"> <argument index="0" name="id" type="int"> </argument> - <argument index="1" name="light_occluder" type="OccluderPolygon2D"> + <argument index="1" name="name" type="String"> </argument> <description> - Set a light occluder for the tile. + Set the name of the tile, for descriptive purposes. </description> </method> - <method name="tile_get_light_occluder" qualifiers="const"> - <return type="OccluderPolygon2D"> - </return> + <method name="tile_set_navigation_polygon"> <argument index="0" name="id" type="int"> </argument> + <argument index="1" name="navigation_polygon" type="NavigationPolygon"> + </argument> <description> - Return the light occluder of the tile. + Set a navigation polygon for the tile. + </description> + </method> + <method name="tile_set_navigation_polygon_offset"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="navigation_polygon_offset" type="Vector2"> + </argument> + <description> + Set an offset for the tile's navigation polygon. </description> </method> <method name="tile_set_occluder_offset"> @@ -40430,48 +40490,58 @@ This method controls whether the position between two cached points is interpola Set an offset for the tile's light occluder. </description> </method> - <method name="tile_get_occluder_offset" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="tile_set_region"> <argument index="0" name="id" type="int"> </argument> + <argument index="1" name="region" type="Rect2"> + </argument> <description> - Return the offset of the tile's light occluder. + Set the tile sub-region in the texture. This is common in texture atlases. </description> </method> - <method name="remove_tile"> + <method name="tile_set_shape"> <argument index="0" name="id" type="int"> </argument> + <argument index="1" name="shape" type="Shape2D"> + </argument> <description> - Remove the tile referenced by the given ID. + Set a shape for the tile, enabling physics to collide with it. </description> </method> - <method name="clear"> + <method name="tile_set_shape_offset"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shape_offset" type="Vector2"> + </argument> <description> - Clear all tiles. + Set the shape offset of the tile. </description> </method> - <method name="get_last_unused_tile_id" qualifiers="const"> - <return type="int"> - </return> + <method name="tile_set_shapes"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shapes" type="Array"> + </argument> <description> - Return the ID following the last currently used ID, useful when creating a new tile. + Set an array of shapes for the tile, enabling physics to collide with it. </description> </method> - <method name="find_tile_by_name" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> + <method name="tile_set_texture"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="texture" type="Texture"> </argument> <description> - Find the first tile matching the given name. + Set the texture of the tile. </description> </method> - <method name="get_tiles_ids" qualifiers="const"> - <return type="Array"> - </return> + <method name="tile_set_texture_offset"> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="texture_offset" type="Vector2"> + </argument> <description> - Return an array of all currently used tile IDs. + Set the texture offset of the tile. </description> </method> </methods> @@ -40486,39 +40556,25 @@ 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. </description> <methods> - <method name="set_wait_time"> - <argument index="0" name="time_sec" type="float"> - </argument> - <description> - Set wait time in seconds. When the time is over, it will emit the timeout signal. - </description> - </method> - <method name="get_wait_time" qualifiers="const"> + <method name="get_time_left" qualifiers="const"> <return type="float"> </return> <description> - Return the wait time in seconds. - </description> - </method> - <method name="set_one_shot"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart. + Return the time left for timeout in seconds if the timer is active, 0 otherwise. </description> </method> - <method name="is_one_shot" qualifiers="const"> - <return type="bool"> + <method name="get_timer_process_mode" qualifiers="const"> + <return type="int"> </return> <description> - Return true if configured as one-shot. + Return the timer's processing mode. </description> </method> - <method name="set_autostart"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_wait_time" qualifiers="const"> + <return type="float"> + </return> <description> - Set to automatically start when entering the scene. + Return the wait time in seconds. </description> </method> <method name="has_autostart" qualifiers="const"> @@ -40528,14 +40584,18 @@ This method controls whether the position between two cached points is interpola Return true if set to automatically start when entering the scene. </description> </method> - <method name="start"> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> <description> - Start the timer. + Return if the timer is active or not. </description> </method> - <method name="stop"> + <method name="is_one_shot" qualifiers="const"> + <return type="bool"> + </return> <description> - Stop (cancel) the timer. + Return true if configured as one-shot. </description> </method> <method name="set_active"> @@ -40545,18 +40605,18 @@ This method controls whether the position between two cached points is interpola Set whether the timer is active or not. An inactive timer will be paused until it is activated again. </description> </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_autostart"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return if the timer is active or not. + Set to automatically start when entering the scene. </description> </method> - <method name="get_time_left" qualifiers="const"> - <return type="float"> - </return> + <method name="set_one_shot"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return the time left for timeout in seconds if the timer is active, 0 otherwise. + Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart. </description> </method> <method name="set_timer_process_mode"> @@ -40566,11 +40626,21 @@ This method controls whether the position between two cached points is interpola Set the timer's processing mode (fixed or idle, use TIMER_PROCESS_* constants as argument). </description> </method> - <method name="get_timer_process_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_wait_time"> + <argument index="0" name="time_sec" type="float"> + </argument> <description> - Return the timer's processing mode. + Set wait time in seconds. When the time is over, it will emit the timeout signal. + </description> + </method> + <method name="start"> + <description> + Start the timer. + </description> + </method> + <method name="stop"> + <description> + Stop (cancel) the timer. </description> </method> </methods> @@ -40600,28 +40670,28 @@ This method controls whether the position between two cached points is interpola <constants> </constants> <theme_items> - <theme_item name="hseparation" type="int"> + <theme_item name="disabled" type="StyleBox"> </theme_item> - <theme_item name="font_color_disabled" type="Color"> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> <theme_item name="font_color_hover" type="Color"> </theme_item> <theme_item name="font_color_pressed" type="Color"> </theme_item> - <theme_item name="font" type="Font"> - </theme_item> <theme_item name="hover" type="StyleBox"> </theme_item> - <theme_item name="pressed" type="StyleBox"> - </theme_item> - <theme_item name="focus" type="StyleBox"> - </theme_item> - <theme_item name="disabled" type="StyleBox"> + <theme_item name="hseparation" type="int"> </theme_item> <theme_item name="normal" type="StyleBox"> </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> </theme_items> </class> <class name="TouchScreenButton" inherits="Node2D" category="Core"> @@ -40630,21 +40700,21 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_texture"> - <argument index="0" name="texture" type="Object"> - </argument> + <method name="get_action" qualifiers="const"> + <return type="String"> + </return> <description> </description> </method> - <method name="get_texture" qualifiers="const"> + <method name="get_bitmask" qualifiers="const"> <return type="Object"> </return> <description> </description> </method> - <method name="set_texture_pressed"> - <argument index="0" name="texture_pressed" type="Object"> - </argument> + <method name="get_texture" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> @@ -40654,39 +40724,33 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_bitmask"> - <argument index="0" name="bitmask" type="Object"> - </argument> - <description> - </description> - </method> - <method name="get_bitmask" qualifiers="const"> - <return type="Object"> + <method name="get_visibility_mode" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="set_action"> - <argument index="0" name="action" type="String"> - </argument> + <method name="is_passby_press_enabled" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_action" qualifiers="const"> - <return type="String"> + <method name="is_pressed" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_visibility_mode"> - <argument index="0" name="mode" type="int"> + <method name="set_action"> + <argument index="0" name="action" type="String"> </argument> <description> </description> </method> - <method name="get_visibility_mode" qualifiers="const"> - <return type="int"> - </return> + <method name="set_bitmask"> + <argument index="0" name="bitmask" type="Object"> + </argument> <description> </description> </method> @@ -40696,25 +40760,31 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="is_passby_press_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_texture"> + <argument index="0" name="texture" type="Object"> + </argument> <description> </description> </method> - <method name="is_pressed" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_texture_pressed"> + <argument index="0" name="texture_pressed" type="Object"> + </argument> + <description> + </description> + </method> + <method name="set_visibility_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> </description> </method> </methods> <signals> - <signal name="released"> + <signal name="pressed"> <description> </description> </signal> - <signal name="pressed"> + <signal name="released"> <description> </description> </signal> @@ -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. </description> <methods> + <method name="Transform"> + <return type="Transform"> + </return> + <argument index="0" name="x_axis" type="Vector3"> + </argument> + <argument index="1" name="y_axis" type="Vector3"> + </argument> + <argument index="2" name="z_axis" type="Vector3"> + </argument> + <argument index="3" name="origin" type="Vector3"> + </argument> + <description> + Construct the Transform from four Vector3. Each axis creates the basis. + </description> + </method> + <method name="Transform"> + <return type="Transform"> + </return> + <argument index="0" name="basis" type="Matrix3"> + </argument> + <argument index="1" name="origin" type="Vector3"> + </argument> + <description> + Construct the Transform from a Matrix3 and Vector3. + </description> + </method> + <method name="Transform"> + <return type="Transform"> + </return> + <argument index="0" name="from" type="Matrix32"> + </argument> + <description> + Construct the Transform from a Matrix32. + </description> + </method> + <method name="Transform"> + <return type="Transform"> + </return> + <argument index="0" name="from" type="Quat"> + </argument> + <description> + Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0) + </description> + </method> + <method name="Transform"> + <return type="Transform"> + </return> + <argument index="0" name="from" type="Matrix3"> + </argument> + <description> + Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0) + </description> + </method> <method name="affine_inverse"> <return type="Transform"> </return> @@ -40809,59 +40932,6 @@ This method controls whether the position between two cached points is interpola Inverse-transforms vector "v" by this transform. </description> </method> - <method name="Transform"> - <return type="Transform"> - </return> - <argument index="0" name="x_axis" type="Vector3"> - </argument> - <argument index="1" name="y_axis" type="Vector3"> - </argument> - <argument index="2" name="z_axis" type="Vector3"> - </argument> - <argument index="3" name="origin" type="Vector3"> - </argument> - <description> - Construct the Transform from four Vector3. Each axis creates the basis. - </description> - </method> - <method name="Transform"> - <return type="Transform"> - </return> - <argument index="0" name="basis" type="Matrix3"> - </argument> - <argument index="1" name="origin" type="Vector3"> - </argument> - <description> - Construct the Transform from a Matrix3 and Vector3. - </description> - </method> - <method name="Transform"> - <return type="Transform"> - </return> - <argument index="0" name="from" type="Matrix32"> - </argument> - <description> - Construct the Transform from a Matrix32. - </description> - </method> - <method name="Transform"> - <return type="Transform"> - </return> - <argument index="0" name="from" type="Quat"> - </argument> - <description> - Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0) - </description> - </method> - <method name="Transform"> - <return type="Transform"> - </return> - <argument index="0" name="from" type="Matrix3"> - </argument> - <description> - Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0) - </description> - </method> </methods> <members> <member name="basis" type="Matrix3"> @@ -40882,11 +40952,20 @@ 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. </description> <methods> - <method name="set_locale"> - <argument index="0" name="locale" type="String"> + <method name="add_message"> + <argument index="0" name="src_message" type="String"> + </argument> + <argument index="1" name="xlated_message" type="String"> </argument> <description> - Set the locale of the translation. + Add a message for translation. + </description> + </method> + <method name="erase_message"> + <argument index="0" name="src_message" type="String"> + </argument> + <description> + Erase a message. </description> </method> <method name="get_locale" qualifiers="const"> @@ -40896,15 +40975,6 @@ This method controls whether the position between two cached points is interpola Return the locale of the translation. </description> </method> - <method name="add_message"> - <argument index="0" name="src_message" type="String"> - </argument> - <argument index="1" name="xlated_message" type="String"> - </argument> - <description> - Add a message for translation. - </description> - </method> <method name="get_message" qualifiers="const"> <return type="String"> </return> @@ -40914,11 +40984,10 @@ This method controls whether the position between two cached points is interpola Return a message for translation. </description> </method> - <method name="erase_message"> - <argument index="0" name="src_message" type="String"> - </argument> + <method name="get_message_count" qualifiers="const"> + <return type="int"> + </return> <description> - Erase a message. </description> </method> <method name="get_message_list" qualifiers="const"> @@ -40928,10 +40997,11 @@ This method controls whether the position between two cached points is interpola Return all the messages (keys). </description> </method> - <method name="get_message_count" qualifiers="const"> - <return type="int"> - </return> + <method name="set_locale"> + <argument index="0" name="locale" type="String"> + </argument> <description> + Set the locale of the translation. </description> </method> </methods> @@ -40945,39 +41015,39 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_locale"> - <argument index="0" name="locale" type="String"> + <method name="add_translation"> + <argument index="0" name="translation" type="Translation"> </argument> <description> </description> </method> - <method name="get_locale" qualifiers="const"> - <return type="String"> - </return> + <method name="clear"> <description> </description> </method> - <method name="translate" qualifiers="const"> + <method name="get_locale" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="message" type="String"> - </argument> <description> </description> </method> - <method name="add_translation"> + <method name="remove_translation"> <argument index="0" name="translation" type="Translation"> </argument> <description> </description> </method> - <method name="remove_translation"> - <argument index="0" name="translation" type="Translation"> + <method name="set_locale"> + <argument index="0" name="locale" type="String"> </argument> <description> </description> </method> - <method name="clear"> + <method name="translate" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="message" type="String"> + </argument> <description> </description> </method> @@ -40991,6 +41061,12 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> + <method name="are_column_titles_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="clear"> <description> </description> @@ -41003,25 +41079,29 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_root"> - <return type="TreeItem"> + <method name="ensure_cursor_is_visible"> + <description> + </description> + </method> + <method name="get_allow_rmb_select" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_column_min_width"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="min_width" type="int"> + <method name="get_column_at_pos" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="pos" type="Vector2"> </argument> <description> </description> </method> - <method name="set_column_expand"> + <method name="get_column_title" qualifiers="const"> + <return type="String"> + </return> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="expand" type="bool"> - </argument> <description> </description> </method> @@ -41033,147 +41113,143 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_hide_root"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_columns" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="get_next_selected"> - <return type="TreeItem"> + <method name="get_custom_popup_rect" qualifiers="const"> + <return type="Rect2"> </return> - <argument index="0" name="from" type="TreeItem"> - </argument> <description> </description> </method> - <method name="get_selected" qualifiers="const"> - <return type="TreeItem"> + <method name="get_drop_mode_flags" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="get_selected_column" qualifiers="const"> - <return type="int"> + <method name="get_edited" qualifiers="const"> + <return type="TreeItem"> </return> <description> </description> </method> - <method name="get_pressed_button" qualifiers="const"> + <method name="get_edited_column" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="set_select_mode"> - <argument index="0" name="mode" type="int"> + <method name="get_item_area_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <argument index="0" name="item" type="TreeItem"> </argument> - <description> - </description> - </method> - <method name="set_columns"> - <argument index="0" name="amount" type="int"> + <argument index="1" name="column" type="int" default="-1"> </argument> <description> </description> </method> - <method name="get_columns" qualifiers="const"> - <return type="int"> + <method name="get_item_at_pos" qualifiers="const"> + <return type="TreeItem"> </return> + <argument index="0" name="pos" type="Vector2"> + </argument> <description> </description> </method> - <method name="get_edited" qualifiers="const"> + <method name="get_next_selected"> <return type="TreeItem"> </return> + <argument index="0" name="from" type="TreeItem"> + </argument> <description> </description> </method> - <method name="get_edited_column" qualifiers="const"> + <method name="get_pressed_button" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="get_custom_popup_rect" qualifiers="const"> - <return type="Rect2"> + <method name="get_root"> + <return type="TreeItem"> </return> <description> </description> </method> - <method name="get_item_area_rect" qualifiers="const"> - <return type="Rect2"> + <method name="get_scroll" qualifiers="const"> + <return type="Vector2"> </return> - <argument index="0" name="item" type="TreeItem"> - </argument> - <argument index="1" name="column" type="int" default="-1"> - </argument> <description> </description> </method> - <method name="get_item_at_pos" qualifiers="const"> + <method name="get_selected" qualifiers="const"> <return type="TreeItem"> </return> - <argument index="0" name="pos" type="Vector2"> - </argument> <description> </description> </method> - <method name="get_column_at_pos" qualifiers="const"> + <method name="get_selected_column" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="pos" type="Vector2"> - </argument> <description> </description> </method> - <method name="ensure_cursor_is_visible"> + <method name="get_single_select_cell_editing_only_when_already_selected" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="set_column_titles_visible"> - <argument index="0" name="visible" type="bool"> - </argument> + <method name="is_folding_hidden" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="are_column_titles_visible" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_allow_rmb_select"> + <argument index="0" name="allow" type="bool"> + </argument> <description> </description> </method> - <method name="set_column_title"> + <method name="set_column_expand"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="title" type="String"> + <argument index="1" name="expand" type="bool"> </argument> <description> </description> </method> - <method name="get_column_title" qualifiers="const"> - <return type="String"> - </return> + <method name="set_column_min_width"> <argument index="0" name="column" type="int"> </argument> + <argument index="1" name="min_width" type="int"> + </argument> <description> </description> </method> - <method name="get_scroll" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_column_title"> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="title" type="String"> + </argument> <description> </description> </method> - <method name="set_hide_folding"> - <argument index="0" name="hide" type="bool"> + <method name="set_column_titles_visible"> + <argument index="0" name="visible" type="bool"> </argument> <description> </description> </method> - <method name="is_folding_hidden" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_columns"> + <argument index="0" name="amount" type="int"> + </argument> <description> </description> </method> @@ -41183,21 +41259,21 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_drop_mode_flags" qualifiers="const"> - <return type="int"> - </return> + <method name="set_hide_folding"> + <argument index="0" name="hide" type="bool"> + </argument> <description> </description> </method> - <method name="set_allow_rmb_select"> - <argument index="0" name="allow" type="bool"> + <method name="set_hide_root"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="get_allow_rmb_select" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_select_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> </description> </method> @@ -41207,50 +41283,48 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_single_select_cell_editing_only_when_already_selected" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> </methods> <signals> - <signal name="item_activated"> - <description> - </description> - </signal> - <signal name="multi_selected"> + <signal name="button_pressed"> <argument index="0" name="item" type="Object"> </argument> <argument index="1" name="column" type="int"> </argument> - <argument index="2" name="selected" type="bool"> + <argument index="2" name="id" type="int"> </argument> <description> </description> </signal> + <signal name="cell_selected"> + <description> + </description> + </signal> <signal name="custom_popup_edited"> <argument index="0" name="arrow_clicked" type="bool"> </argument> <description> </description> </signal> - <signal name="item_collapsed"> - <argument index="0" name="item" type="Object"> + <signal name="empty_tree_rmb_selected"> + <argument index="0" name="pos" type="Vector2"> </argument> <description> </description> </signal> - <signal name="item_edited"> + <signal name="item_activated"> <description> </description> </signal> - <signal name="empty_tree_rmb_selected"> - <argument index="0" name="pos" type="Vector2"> + <signal name="item_collapsed"> + <argument index="0" name="item" type="Object"> </argument> <description> </description> </signal> + <signal name="item_edited"> + <description> + </description> + </signal> <signal name="item_rmb_selected"> <argument index="0" name="pos" type="Vector2"> </argument> @@ -41261,99 +41335,95 @@ This method controls whether the position between two cached points is interpola <description> </description> </signal> - <signal name="cell_selected"> - <description> - </description> - </signal> - <signal name="button_pressed"> + <signal name="multi_selected"> <argument index="0" name="item" type="Object"> </argument> <argument index="1" name="column" type="int"> </argument> - <argument index="2" name="id" type="int"> + <argument index="2" name="selected" type="bool"> </argument> <description> </description> </signal> </signals> <constants> - <constant name="SELECT_SINGLE" value="0"> - </constant> - <constant name="SELECT_ROW" value="1"> - </constant> - <constant name="SELECT_MULTI" value="2"> - </constant> <constant name="DROP_MODE_DISABLED" value="0"> </constant> <constant name="DROP_MODE_ON_ITEM" value="1"> </constant> <constant name="DROP_MODE_INBETWEEN" value="2"> </constant> + <constant name="SELECT_SINGLE" value="0"> + </constant> + <constant name="SELECT_ROW" value="1"> + </constant> + <constant name="SELECT_MULTI" value="2"> + </constant> </constants> <theme_items> - <theme_item name="item_margin" type="int"> - </theme_item> - <theme_item name="vseparation" type="int"> + <theme_item name="arrow" type="Texture"> </theme_item> - <theme_item name="guide_width" type="int"> + <theme_item name="arrow_collapsed" type="Texture"> </theme_item> - <theme_item name="hseparation" type="int"> + <theme_item name="bg" type="StyleBox"> </theme_item> - <theme_item name="draw_relationship_lines" type="int"> + <theme_item name="bg_focus" type="StyleBox"> </theme_item> <theme_item name="button_margin" type="int"> </theme_item> - <theme_item name="title_button_color" type="Color"> + <theme_item name="button_pressed" type="StyleBox"> </theme_item> - <theme_item name="guide_color" type="Color"> + <theme_item name="checked" type="Texture"> + </theme_item> + <theme_item name="cursor" type="StyleBox"> </theme_item> <theme_item name="cursor_color" type="Color"> </theme_item> - <theme_item name="selection_color" type="Color"> + <theme_item name="cursor_unfocused" type="StyleBox"> </theme_item> - <theme_item name="font_color_selected" type="Color"> + <theme_item name="draw_relationship_lines" type="int"> + </theme_item> + <theme_item name="drop_position_color" type="Color"> + </theme_item> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> - <theme_item name="relationship_line_color" type="Color"> + <theme_item name="font_color_selected" type="Color"> </theme_item> - <theme_item name="drop_position_color" type="Color"> + <theme_item name="guide_color" type="Color"> </theme_item> - <theme_item name="arrow" type="Texture"> + <theme_item name="guide_width" type="int"> </theme_item> - <theme_item name="updown" type="Texture"> + <theme_item name="hseparation" type="int"> </theme_item> - <theme_item name="checked" type="Texture"> + <theme_item name="item_margin" type="int"> </theme_item> - <theme_item name="arrow_collapsed" type="Texture"> + <theme_item name="relationship_line_color" type="Color"> </theme_item> <theme_item name="select_arrow" type="Texture"> </theme_item> - <theme_item name="unchecked" type="Texture"> + <theme_item name="selected" type="StyleBox"> </theme_item> - <theme_item name="title_button_font" type="Font"> + <theme_item name="selected_focus" type="StyleBox"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="selection_color" type="Color"> </theme_item> - <theme_item name="title_button_normal" type="StyleBox"> + <theme_item name="title_button_color" type="Color"> </theme_item> - <theme_item name="cursor" type="StyleBox"> + <theme_item name="title_button_font" type="Font"> </theme_item> <theme_item name="title_button_hover" type="StyleBox"> </theme_item> - <theme_item name="selected_focus" type="StyleBox"> - </theme_item> - <theme_item name="bg_focus" type="StyleBox"> - </theme_item> - <theme_item name="button_pressed" type="StyleBox"> + <theme_item name="title_button_normal" type="StyleBox"> </theme_item> - <theme_item name="cursor_unfocused" type="StyleBox"> + <theme_item name="title_button_pressed" type="StyleBox"> </theme_item> - <theme_item name="selected" type="StyleBox"> + <theme_item name="unchecked" type="Texture"> </theme_item> - <theme_item name="bg" type="StyleBox"> + <theme_item name="updown" type="Texture"> </theme_item> - <theme_item name="title_button_pressed" type="StyleBox"> + <theme_item name="vseparation" type="int"> </theme_item> </theme_items> </class> @@ -41363,95 +41433,63 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_cell_mode"> + <method name="add_button"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_cell_mode" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="column" type="int"> + <argument index="1" name="button" type="Texture"> </argument> - <description> - </description> - </method> - <method name="set_checked"> - <argument index="0" name="column" type="int"> + <argument index="2" name="button_idx" type="int" default="-1"> </argument> - <argument index="1" name="checked" type="bool"> + <argument index="3" name="disabled" type="bool" default="false"> </argument> <description> </description> </method> - <method name="is_checked" qualifiers="const"> - <return type="bool"> - </return> + <method name="clear_custom_bg_color"> <argument index="0" name="column" type="int"> </argument> <description> </description> </method> - <method name="set_text"> + <method name="clear_custom_color"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="text" type="String"> - </argument> <description> </description> </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> + <method name="deselect"> <argument index="0" name="column" type="int"> </argument> <description> </description> </method> - <method name="set_icon"> + <method name="erase_button"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="texture" type="Texture"> + <argument index="1" name="button_idx" type="int"> </argument> <description> </description> </method> - <method name="get_icon" qualifiers="const"> + <method name="get_button" qualifiers="const"> <return type="Texture"> </return> <argument index="0" name="column" type="int"> </argument> - <description> - </description> - </method> - <method name="set_icon_region"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="region" type="Rect2"> + <argument index="1" name="button_idx" type="int"> </argument> <description> </description> </method> - <method name="get_icon_region" qualifiers="const"> - <return type="Rect2"> + <method name="get_button_count" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="column" type="int"> </argument> <description> </description> </method> - <method name="set_icon_max_width"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="width" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_icon_max_width" qualifiers="const"> + <method name="get_cell_mode" qualifiers="const"> <return type="int"> </return> <argument index="0" name="column" type="int"> @@ -41459,49 +41497,41 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_range"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="value" type="float"> - </argument> + <method name="get_children"> + <return type="TreeItem"> + </return> <description> </description> </method> - <method name="get_range" qualifiers="const"> - <return type="float"> + <method name="get_custom_bg_color" qualifiers="const"> + <return type="Color"> </return> <argument index="0" name="column" type="int"> </argument> <description> </description> </method> - <method name="set_range_config"> + <method name="get_icon" qualifiers="const"> + <return type="Texture"> + </return> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="min" type="float"> - </argument> - <argument index="2" name="max" type="float"> - </argument> - <argument index="3" name="step" type="float"> - </argument> - <argument index="4" name="expr" type="bool" default="false"> - </argument> <description> </description> </method> - <method name="get_range_config"> - <return type="Dictionary"> + <method name="get_icon_max_width" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="column" type="int"> </argument> <description> </description> </method> - <method name="set_metadata"> + <method name="get_icon_region" qualifiers="const"> + <return type="Rect2"> + </return> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="meta" type="Variant"> - </argument> <description> </description> </method> @@ -41511,29 +41541,19 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_custom_draw"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="object" type="Object"> - </argument> - <argument index="2" name="callback" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_collapsed"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_next"> + <return type="TreeItem"> + </return> <description> </description> </method> - <method name="is_collapsed"> - <return type="bool"> + <method name="get_next_visible"> + <return type="TreeItem"> </return> <description> </description> </method> - <method name="get_next"> + <method name="get_parent"> <return type="TreeItem"> </return> <description> @@ -41545,47 +41565,55 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_parent"> + <method name="get_prev_visible"> <return type="TreeItem"> </return> <description> </description> </method> - <method name="get_children"> - <return type="TreeItem"> + <method name="get_range" qualifiers="const"> + <return type="float"> </return> + <argument index="0" name="column" type="int"> + </argument> <description> </description> </method> - <method name="get_next_visible"> - <return type="TreeItem"> + <method name="get_range_config"> + <return type="Dictionary"> </return> + <argument index="0" name="column" type="int"> + </argument> <description> </description> </method> - <method name="get_prev_visible"> - <return type="TreeItem"> + <method name="get_text" qualifiers="const"> + <return type="String"> </return> + <argument index="0" name="column" type="int"> + </argument> <description> </description> </method> - <method name="remove_child"> - <return type="TreeItem"> + <method name="get_tooltip" qualifiers="const"> + <return type="String"> </return> - <argument index="0" name="child" type="Object"> + <argument index="0" name="column" type="int"> </argument> <description> </description> </method> - <method name="set_selectable"> + <method name="is_button_disabled" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="selectable" type="bool"> + <argument index="1" name="button_idx" type="int"> </argument> <description> </description> </method> - <method name="is_selectable" qualifiers="const"> + <method name="is_checked" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="column" type="int"> @@ -41593,53 +41621,77 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="is_selected"> + <method name="is_collapsed"> <return type="bool"> </return> - <argument index="0" name="column" type="int"> - </argument> <description> </description> </method> - <method name="select"> + <method name="is_editable"> + <return type="bool"> + </return> <argument index="0" name="column" type="int"> </argument> <description> </description> </method> - <method name="deselect"> + <method name="is_selectable" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="column" type="int"> </argument> <description> </description> </method> - <method name="set_editable"> + <method name="is_selected"> + <return type="bool"> + </return> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="enabled" type="bool"> - </argument> <description> </description> </method> - <method name="is_editable"> - <return type="bool"> + <method name="move_to_bottom"> + <description> + </description> + </method> + <method name="move_to_top"> + <description> + </description> + </method> + <method name="remove_child"> + <return type="TreeItem"> </return> + <argument index="0" name="child" type="Object"> + </argument> + <description> + </description> + </method> + <method name="select"> <argument index="0" name="column" type="int"> </argument> <description> </description> </method> - <method name="set_custom_color"> + <method name="set_cell_mode"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="color" type="Color"> + <argument index="1" name="mode" type="int"> </argument> <description> </description> </method> - <method name="clear_custom_color"> + <method name="set_checked"> <argument index="0" name="column" type="int"> </argument> + <argument index="1" name="checked" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_collapsed"> + <argument index="0" name="enable" type="bool"> + </argument> <description> </description> </method> @@ -41653,89 +41705,107 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="clear_custom_bg_color"> + <method name="set_custom_color"> <argument index="0" name="column" type="int"> </argument> + <argument index="1" name="color" type="Color"> + </argument> <description> </description> </method> - <method name="get_custom_bg_color" qualifiers="const"> - <return type="Color"> - </return> + <method name="set_custom_draw"> <argument index="0" name="column" type="int"> </argument> + <argument index="1" name="object" type="Object"> + </argument> + <argument index="2" name="callback" type="String"> + </argument> <description> </description> </method> - <method name="add_button"> + <method name="set_editable"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="button" type="Texture"> + <argument index="1" name="enabled" type="bool"> </argument> - <argument index="2" name="button_idx" type="int" default="-1"> + <description> + </description> + </method> + <method name="set_icon"> + <argument index="0" name="column" type="int"> </argument> - <argument index="3" name="disabled" type="bool" default="false"> + <argument index="1" name="texture" type="Texture"> </argument> <description> </description> </method> - <method name="get_button_count" qualifiers="const"> - <return type="int"> - </return> + <method name="set_icon_max_width"> <argument index="0" name="column" type="int"> </argument> + <argument index="1" name="width" type="int"> + </argument> <description> </description> </method> - <method name="get_button" qualifiers="const"> - <return type="Texture"> - </return> + <method name="set_icon_region"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="button_idx" type="int"> + <argument index="1" name="region" type="Rect2"> </argument> <description> </description> </method> - <method name="erase_button"> + <method name="set_metadata"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="button_idx" type="int"> + <argument index="1" name="meta" type="Variant"> </argument> <description> </description> </method> - <method name="is_button_disabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_range"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="button_idx" type="int"> + <argument index="1" name="value" type="float"> </argument> <description> </description> </method> - <method name="set_tooltip"> + <method name="set_range_config"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="tooltip" type="String"> + <argument index="1" name="min" type="float"> + </argument> + <argument index="2" name="max" type="float"> + </argument> + <argument index="3" name="step" type="float"> + </argument> + <argument index="4" name="expr" type="bool" default="false"> </argument> <description> </description> </method> - <method name="get_tooltip" qualifiers="const"> - <return type="String"> - </return> + <method name="set_selectable"> <argument index="0" name="column" type="int"> </argument> + <argument index="1" name="selectable" type="bool"> + </argument> <description> </description> </method> - <method name="move_to_top"> + <method name="set_text"> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="text" type="String"> + </argument> <description> </description> </method> - <method name="move_to_bottom"> + <method name="set_tooltip"> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="tooltip" type="String"> + </argument> <description> </description> </method> @@ -41771,39 +41841,63 @@ 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. </description> <methods> - <method name="is_active" qualifiers="const"> + <method name="follow_method"> <return type="bool"> </return> - <description> - Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended. - </description> - </method> - <method name="set_active"> - <argument index="0" name="active" type="bool"> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <argument index="2" name="initial_val" type="Variant"> + </argument> + <argument index="3" name="target" type="Object"> + </argument> + <argument index="4" name="target_method" type="String"> + </argument> + <argument index="5" name="times_in_sec" type="float"> + </argument> + <argument index="6" name="trans_type" type="int"> + </argument> + <argument index="7" name="ease_type" type="int"> + </argument> + <argument index="8" name="delay" type="float" default="0"> </argument> <description> - 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. + 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. </description> </method> - <method name="is_repeat" qualifiers="const"> + <method name="follow_property"> <return type="bool"> </return> - <description> - Returns true if repeat has been set from editor GUI or [method set_repeat]. - </description> - </method> - <method name="set_repeat"> - <argument index="0" name="repeat" type="bool"> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="initial_val" type="Variant"> + </argument> + <argument index="3" name="target" type="Object"> + </argument> + <argument index="4" name="target_property" type="String"> + </argument> + <argument index="5" name="times_in_sec" type="float"> + </argument> + <argument index="6" name="trans_type" type="int"> + </argument> + <argument index="7" name="ease_type" type="int"> + </argument> + <argument index="8" name="delay" type="float" default="0"> </argument> <description> - Make the tween repeat after all tweens have finished. + 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. </description> </method> - <method name="set_speed"> - <argument index="0" name="speed" type="float"> - </argument> + <method name="get_runtime" qualifiers="const"> + <return type="float"> + </return> <description> - 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 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. </description> </method> <method name="get_speed" qualifiers="const"> @@ -41813,46 +41907,122 @@ This method controls whether the position between two cached points is interpola Returns the speed that has been set from editor GUI or [method set_repeat]. </description> </method> - <method name="set_tween_process_mode"> - <argument index="0" name="mode" type="int"> + <method name="get_tween_process_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the process mode that has been set from editor GUI or [method set_tween_process_mode] + </description> + </method> + <method name="interpolate_callback"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="times_in_sec" type="float"> + </argument> + <argument index="2" name="callback" type="String"> + </argument> + <argument index="3" name="arg1" type="Variant" default="NULL"> + </argument> + <argument index="4" name="arg2" type="Variant" default="NULL"> + </argument> + <argument index="5" name="arg3" type="Variant" default="NULL"> + </argument> + <argument index="6" name="arg4" type="Variant" default="NULL"> + </argument> + <argument index="7" name="arg5" type="Variant" default="NULL"> </argument> <description> - Set whether the Tween uses [code]_process[/code] or [code]_fixed_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_FIXED constants, respectively). + Call [code]callback[/code] of [code]object[/code] after [code]times_in_sec[/code]. [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. </description> </method> - <method name="get_tween_process_mode" qualifiers="const"> - <return type="int"> + <method name="interpolate_deferred_callback"> + <return type="bool"> </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="times_in_sec" type="float"> + </argument> + <argument index="2" name="callback" type="String"> + </argument> + <argument index="3" name="arg1" type="Variant" default="NULL"> + </argument> + <argument index="4" name="arg2" type="Variant" default="NULL"> + </argument> + <argument index="5" name="arg3" type="Variant" default="NULL"> + </argument> + <argument index="6" name="arg4" type="Variant" default="NULL"> + </argument> + <argument index="7" name="arg5" type="Variant" default="NULL"> + </argument> <description> - Returns the process mode that has been set from editor GUI or [method set_tween_process_mode] + 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. </description> </method> - <method name="start"> + <method name="interpolate_method"> <return type="bool"> </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <argument index="2" name="initial_val" type="Variant"> + </argument> + <argument index="3" name="final_val" type="Variant"> + </argument> + <argument index="4" name="times_in_sec" type="float"> + </argument> + <argument index="5" name="trans_type" type="int"> + </argument> + <argument index="6" name="ease_type" type="int"> + </argument> + <argument index="7" name="delay" type="float" default="0"> + </argument> <description> - Start the tween node. You can define tweens both before and after this. + 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. </description> </method> - <method name="reset"> + <method name="interpolate_property"> <return type="bool"> </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String"> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="initial_val" type="Variant"> + </argument> + <argument index="3" name="final_val" type="Variant"> + </argument> + <argument index="4" name="times_in_sec" type="float"> + </argument> + <argument index="5" name="trans_type" type="int"> + </argument> + <argument index="6" name="ease_type" type="int"> + </argument> + <argument index="7" name="delay" type="float" default="0"> </argument> <description> - Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. + 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. </description> </method> - <method name="reset_all"> + <method name="is_active" qualifiers="const"> <return type="bool"> </return> <description> - Resets all tweens to their initial values (the ones given, not those before the tween). + Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended. </description> </method> - <method name="stop"> + <method name="is_repeat" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if repeat has been set from editor GUI or [method set_repeat]. + </description> + </method> + <method name="remove"> <return type="bool"> </return> <argument index="0" name="object" type="Object"> @@ -41860,17 +42030,17 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="key" type="String"> </argument> <description> - Stop animating a tween, given its object and property/method pair. + Stop animating and completely remove a tween, given its object and property/method pair. </description> </method> - <method name="stop_all"> + <method name="remove_all"> <return type="bool"> </return> <description> - Stop animating all tweens. + Stop animating and completely remove all tweens. </description> </method> - <method name="resume"> + <method name="reset"> <return type="bool"> </return> <argument index="0" name="object" type="Object"> @@ -41878,17 +42048,17 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="key" type="String"> </argument> <description> - Continue animating a stopped tween, given its object and property/method pair. + Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. </description> </method> - <method name="resume_all"> + <method name="reset_all"> <return type="bool"> </return> <description> - Continue animating all stopped tweens. + Resets all tweens to their initial values (the ones given, not those before the tween). </description> </method> - <method name="remove"> + <method name="resume"> <return type="bool"> </return> <argument index="0" name="object" type="Object"> @@ -41896,14 +42066,14 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="key" type="String"> </argument> <description> - Stop animating and completely remove a tween, given its object and property/method pair. + Continue animating a stopped tween, given its object and property/method pair. </description> </method> - <method name="remove_all"> + <method name="resume_all"> <return type="bool"> </return> <description> - Stop animating and completely remove all tweens. + Continue animating all stopped tweens. </description> </method> <method name="seek"> @@ -41915,152 +42085,71 @@ This method controls whether the position between two cached points is interpola Seek the animation to the given [code]time[/code] in seconds. </description> </method> - <method name="tell" qualifiers="const"> - <return type="float"> - </return> + <method name="set_active"> + <argument index="0" name="active" type="bool"> + </argument> <description> - Returns the current time of the tween. + 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. </description> </method> - <method name="get_runtime" qualifiers="const"> - <return type="float"> - </return> + <method name="set_repeat"> + <argument index="0" name="repeat" type="bool"> + </argument> <description> - 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. + Make the tween repeat after all tweens have finished. </description> </method> - <method name="interpolate_property"> - <return type="bool"> - </return> - <argument index="0" name="object" type="Object"> - </argument> - <argument index="1" name="property" type="String"> - </argument> - <argument index="2" name="initial_val" type="Variant"> - </argument> - <argument index="3" name="final_val" type="Variant"> - </argument> - <argument index="4" name="times_in_sec" type="float"> - </argument> - <argument index="5" name="trans_type" type="int"> - </argument> - <argument index="6" name="ease_type" type="int"> - </argument> - <argument index="7" name="delay" type="float" default="0"> + <method name="set_speed"> + <argument index="0" name="speed" type="float"> </argument> <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. + 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. </description> </method> - <method name="interpolate_method"> - <return type="bool"> - </return> - <argument index="0" name="object" type="Object"> - </argument> - <argument index="1" name="method" type="String"> - </argument> - <argument index="2" name="initial_val" type="Variant"> - </argument> - <argument index="3" name="final_val" type="Variant"> - </argument> - <argument index="4" name="times_in_sec" type="float"> - </argument> - <argument index="5" name="trans_type" type="int"> - </argument> - <argument index="6" name="ease_type" type="int"> - </argument> - <argument index="7" name="delay" type="float" default="0"> + <method name="set_tween_process_mode"> + <argument index="0" name="mode" type="int"> </argument> <description> - 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. + Set whether the Tween uses [code]_process[/code] or [code]_fixed_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_FIXED constants, respectively). </description> </method> - <method name="interpolate_callback"> + <method name="start"> <return type="bool"> </return> - <argument index="0" name="object" type="Object"> - </argument> - <argument index="1" name="times_in_sec" type="float"> - </argument> - <argument index="2" name="callback" type="String"> - </argument> - <argument index="3" name="arg1" type="Variant" default="NULL"> - </argument> - <argument index="4" name="arg2" type="Variant" default="NULL"> - </argument> - <argument index="5" name="arg3" type="Variant" default="NULL"> - </argument> - <argument index="6" name="arg4" type="Variant" default="NULL"> - </argument> - <argument index="7" name="arg5" type="Variant" default="NULL"> - </argument> <description> - Call [code]callback[/code] of [code]object[/code] after [code]times_in_sec[/code]. [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. + Start the tween node. You can define tweens both before and after this. </description> </method> - <method name="interpolate_deferred_callback"> + <method name="stop"> <return type="bool"> </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="times_in_sec" type="float"> - </argument> - <argument index="2" name="callback" type="String"> - </argument> - <argument index="3" name="arg1" type="Variant" default="NULL"> - </argument> - <argument index="4" name="arg2" type="Variant" default="NULL"> - </argument> - <argument index="5" name="arg3" type="Variant" default="NULL"> - </argument> - <argument index="6" name="arg4" type="Variant" default="NULL"> - </argument> - <argument index="7" name="arg5" type="Variant" default="NULL"> + <argument index="1" name="key" type="String"> </argument> <description> - 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. + Stop animating a tween, given its object and property/method pair. </description> </method> - <method name="follow_property"> + <method name="stop_all"> <return type="bool"> </return> - <argument index="0" name="object" type="Object"> - </argument> - <argument index="1" name="property" type="String"> - </argument> - <argument index="2" name="initial_val" type="Variant"> - </argument> - <argument index="3" name="target" type="Object"> - </argument> - <argument index="4" name="target_property" type="String"> - </argument> - <argument index="5" name="times_in_sec" type="float"> - </argument> - <argument index="6" name="trans_type" type="int"> - </argument> - <argument index="7" name="ease_type" type="int"> - </argument> - <argument index="8" name="delay" type="float" default="0"> - </argument> <description> - 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. + Stop animating all tweens. </description> </method> - <method name="follow_method"> + <method name="targeting_method"> <return type="bool"> </return> <argument index="0" name="object" type="Object"> </argument> <argument index="1" name="method" type="String"> </argument> - <argument index="2" name="initial_val" type="Variant"> + <argument index="2" name="initial" type="Object"> </argument> - <argument index="3" name="target" type="Object"> + <argument index="3" name="initial_method" type="String"> </argument> - <argument index="4" name="target_method" type="String"> + <argument index="4" name="final_val" type="Variant"> </argument> <argument index="5" name="times_in_sec" type="float"> </argument> @@ -42071,7 +42160,7 @@ This method controls whether the position between two cached points is interpola <argument index="8" name="delay" type="float" default="0"> </argument> <description> - 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. </description> </method> @@ -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. </description> </method> - <method name="targeting_method"> - <return type="bool"> + <method name="tell" qualifiers="const"> + <return type="float"> </return> - <argument index="0" name="object" type="Object"> - </argument> - <argument index="1" name="method" type="String"> - </argument> - <argument index="2" name="initial" type="Object"> - </argument> - <argument index="3" name="initial_method" type="String"> - </argument> - <argument index="4" name="final_val" type="Variant"> - </argument> - <argument index="5" name="times_in_sec" type="float"> - </argument> - <argument index="6" name="trans_type" type="int"> - </argument> - <argument index="7" name="ease_type" type="int"> - </argument> - <argument index="8" name="delay" type="float" default="0"> - </argument> <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. </description> </method> </methods> @@ -42138,35 +42208,41 @@ This method controls whether the position between two cached points is interpola This signal is emitted when a tween ends. </description> </signal> - <signal name="tween_step"> + <signal name="tween_start"> <argument index="0" name="object" type="Object"> </argument> <argument index="1" name="key" type="String"> </argument> - <argument index="2" name="elapsed" type="float"> - </argument> - <argument index="3" name="value" type="Object"> - </argument> <description> - This signal is emitted each step of the tweening. + This signal is emitted when a tween starts. </description> </signal> - <signal name="tween_start"> + <signal name="tween_step"> <argument index="0" name="object" type="Object"> </argument> <argument index="1" name="key" type="String"> </argument> + <argument index="2" name="elapsed" type="float"> + </argument> + <argument index="3" name="value" type="Object"> + </argument> <description> - This signal is emitted when a tween starts. + This signal is emitted each step of the tweening. </description> </signal> </signals> <constants> - <constant name="TWEEN_PROCESS_FIXED" value="0"> - The [Tween] should use [code]_fixed_process[/code] for timekeeping when this is enabled. + <constant name="EASE_IN" value="0"> + Signifies that the interpolation should be focused in the beginning. </constant> - <constant name="TWEEN_PROCESS_IDLE" value="1"> - The [Tween] should use [code]_process[/code] for timekeeping when this is enabled (default). + <constant name="EASE_OUT" value="1"> + Signifies that the interpolation should be focused in the end. + </constant> + <constant name="EASE_IN_OUT" value="2"> + Signifies that the interpolation should be focused in both ends. + </constant> + <constant name="EASE_OUT_IN" value="3"> + 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). </constant> <constant name="TRANS_LINEAR" value="0"> Means that the animation is interpolated linearly. @@ -42174,6 +42250,9 @@ This method controls whether the position between two cached points is interpola <constant name="TRANS_SINE" value="1"> Means that the animation is interpolated using a sine wave. </constant> + <constant name="TRANS_BACK" value="10"> + Means that the animation is interpolated backing out at edges. + </constant> <constant name="TRANS_QUINT" value="2"> Means that the animation is interpolated with a quinary (to the power of 5) function. </constant> @@ -42198,20 +42277,11 @@ This method controls whether the position between two cached points is interpola <constant name="TRANS_BOUNCE" value="9"> Means that the animation is interpolated by bouncing at, but never surpassing, the end. </constant> - <constant name="TRANS_BACK" value="10"> - Means that the animation is interpolated backing out at edges. - </constant> - <constant name="EASE_IN" value="0"> - Signifies that the interpolation should be focused in the beginning. - </constant> - <constant name="EASE_OUT" value="1"> - Signifies that the interpolation should be focused in the end. - </constant> - <constant name="EASE_IN_OUT" value="2"> - Signifies that the interpolation should be focused in both ends. + <constant name="TWEEN_PROCESS_FIXED" value="0"> + The [Tween] should use [code]_fixed_process[/code] for timekeeping when this is enabled. </constant> - <constant name="EASE_OUT_IN" value="3"> - 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). + <constant name="TWEEN_PROCESS_IDLE" value="1"> + The [Tween] should use [code]_process[/code] for timekeeping when this is enabled (default). </constant> </constants> </class> @@ -42227,24 +42297,6 @@ This method controls whether the position between two cached points is interpola functions or property changes, then commiting the action. </description> <methods> - <method name="create_action"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="mergeable" type="bool" default="false"> - </argument> - <description> - 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]. - </description> - </method> - <method name="commit_action"> - <description> - Commit the action. All 'do' methods/properties are - called/set when this function is called. - </description> - </method> <method name="add_do_method"> <argument index="0" name="object" type="Object"> </argument> @@ -42265,6 +42317,26 @@ This method controls whether the position between two cached points is interpola arguments. </description> </method> + <method name="add_do_property"> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + Set a property with a custom value. + </description> + </method> + <method name="add_do_reference"> + <argument index="0" name="object" type="Object"> + </argument> + <description> + 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. + </description> + </method> <method name="add_undo_method"> <argument index="0" name="object" type="Object"> </argument> @@ -42286,17 +42358,6 @@ This method controls whether the position between two cached points is interpola calls. </description> </method> - <method name="add_do_property"> - <argument index="0" name="object" type="Object"> - </argument> - <argument index="1" name="property" type="String"> - </argument> - <argument index="2" name="value" type="Variant"> - </argument> - <description> - Set a property with a custom value. - </description> - </method> <method name="add_undo_property"> <argument index="0" name="object" type="Object"> </argument> @@ -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. </description> </method> - <method name="add_do_reference"> - <argument index="0" name="object" type="Object"> - </argument> - <description> - 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. - </description> - </method> <method name="add_undo_reference"> <argument index="0" name="object" type="Object"> </argument> @@ -42333,6 +42385,24 @@ This method controls whether the position between two cached points is interpola references. </description> </method> + <method name="commit_action"> + <description> + Commit the action. All 'do' methods/properties are + called/set when this function is called. + </description> + </method> + <method name="create_action"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="mergeable" type="bool" default="false"> + </argument> + <description> + 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]. + </description> + </method> <method name="get_current_action_name" qualifiers="const"> <return type="String"> </return> @@ -42386,24 +42456,24 @@ This method controls whether the position between two cached points is interpola <theme_items> <theme_item name="button_separator" type="int"> </theme_item> - <theme_item name="icon_separator" type="int"> + <theme_item name="focus" type="StyleBox"> </theme_item> - <theme_item name="font_color_selected" type="Color"> + <theme_item name="font" type="Font"> </theme_item> <theme_item name="font_color" type="Color"> </theme_item> - <theme_item name="font_selected" type="Font"> + <theme_item name="font_color_selected" type="Color"> </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="font_selected" type="Font"> </theme_item> <theme_item name="hover" type="StyleBox"> </theme_item> - <theme_item name="focus" type="StyleBox"> - </theme_item> - <theme_item name="selected" type="StyleBox"> + <theme_item name="icon_separator" type="int"> </theme_item> <theme_item name="normal" type="StyleBox"> </theme_item> + <theme_item name="selected" type="StyleBox"> + </theme_item> </theme_items> </class> <class name="VScrollBar" inherits="ScrollBar" category="Core"> @@ -42417,22 +42487,22 @@ This method controls whether the position between two cached points is interpola <constants> </constants> <theme_items> - <theme_item name="increment_hilite" type="Texture"> + <theme_item name="decrement" type="Texture"> </theme_item> <theme_item name="decrement_hilite" type="Texture"> </theme_item> - <theme_item name="increment" type="Texture"> - </theme_item> - <theme_item name="decrement" type="Texture"> + <theme_item name="grabber" type="StyleBox"> </theme_item> <theme_item name="grabber_hilite" type="StyleBox"> </theme_item> - <theme_item name="grabber" type="StyleBox"> + <theme_item name="increment" type="Texture"> </theme_item> - <theme_item name="scroll_focus" type="StyleBox"> + <theme_item name="increment_hilite" type="Texture"> </theme_item> <theme_item name="scroll" type="StyleBox"> </theme_item> + <theme_item name="scroll_focus" type="StyleBox"> + </theme_item> </theme_items> </class> <class name="VSeparator" inherits="Separator" category="Core"> @@ -42465,16 +42535,16 @@ This method controls whether the position between two cached points is interpola <constants> </constants> <theme_items> - <theme_item name="tick" type="Texture"> + <theme_item name="grabber" type="Texture"> </theme_item> <theme_item name="grabber_hilite" type="Texture"> </theme_item> - <theme_item name="grabber" type="Texture"> - </theme_item> <theme_item name="grabber_hilite" type="StyleBox"> </theme_item> <theme_item name="slider" type="StyleBox"> </theme_item> + <theme_item name="tick" type="Texture"> + </theme_item> </theme_items> </class> <class name="VSplitContainer" inherits="SplitContainer" category="Core"> @@ -42491,11 +42561,11 @@ This method controls whether the position between two cached points is interpola <theme_items> <theme_item name="autohide" type="int"> </theme_item> - <theme_item name="separation" type="int"> + <theme_item name="bg" type="StyleBox"> </theme_item> <theme_item name="grabber" type="Texture"> </theme_item> - <theme_item name="bg" type="StyleBox"> + <theme_item name="separation" type="int"> </theme_item> </theme_items> </class> @@ -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. </description> <methods> + <method name="Vector2"> + <return type="Vector2"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <description> + Constructs a new Vector2 from the given x and y. + </description> + </method> <method name="abs"> <return type="Vector2"> </return> @@ -42677,31 +42758,20 @@ This method controls whether the position between two cached points is interpola Returns a perpendicular vector. </description> </method> - <method name="Vector2"> - <return type="Vector2"> - </return> - <argument index="0" name="x" type="float"> - </argument> - <argument index="1" name="y" type="float"> - </argument> - <description> - Constructs a new Vector2 from the given x and y. - </description> - </method> </methods> <members> + <member name="height" type="float"> + Height of the vector (Same as Y). + </member> + <member name="width" type="float"> + Width of the vector (Same as X). + </member> <member name="x" type="float"> X component of the vector. </member> <member name="y" type="float"> Y component of the vector. </member> - <member name="width" type="float"> - Width of the vector (Same as X). - </member> - <member name="height" type="float"> - Height of the vector (Same as Y). - </member> </members> <constants> </constants> @@ -42714,6 +42784,15 @@ This method controls whether the position between two cached points is interpola An Array specifically designed to hold Vector2. </description> <methods> + <method name="Vector2Array"> + <return type="Vector2Array"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Construct a new [Vector2Array]. Optionally, you can pass in an Array that will be converted. + </description> + </method> <method name="push_back"> <argument index="0" name="vector2" type="Vector2"> </argument> @@ -42744,15 +42823,6 @@ This method controls whether the position between two cached points is interpola Return the size of the array. </description> </method> - <method name="Vector2Array"> - <return type="Vector2Array"> - </return> - <argument index="0" name="from" type="Array"> - </argument> - <description> - Construct a new [Vector2Array]. Optionally, you can pass in an Array that will be converted. - </description> - </method> </methods> <constants> </constants> @@ -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. </description> <methods> + <method name="Vector3"> + <return type="Vector3"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <argument index="2" name="z" type="float"> + </argument> + <description> + Returns a Vector3 with the given components. + </description> + </method> <method name="abs"> <return type="Vector3"> </return> @@ -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. </description> </method> - <method name="Vector3"> - <return type="Vector3"> - </return> - <argument index="0" name="x" type="float"> - </argument> - <argument index="1" name="y" type="float"> - </argument> - <argument index="2" name="z" type="float"> - </argument> - <description> - Returns a Vector3 with the given components. - </description> - </method> </methods> <members> <member name="x" type="float"> @@ -42973,6 +43043,15 @@ This method controls whether the position between two cached points is interpola An Array specifically designed to hold Vector3. </description> <methods> + <method name="Vector3Array"> + <return type="Vector3Array"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted. + </description> + </method> <method name="push_back"> <argument index="0" name="vector3" type="Vector3"> </argument> @@ -43003,15 +43082,6 @@ This method controls whether the position between two cached points is interpola Return the size of the array. </description> </method> - <method name="Vector3Array"> - <return type="Vector3Array"> - </return> - <argument index="0" name="from" type="Array"> - </argument> - <description> - Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted. - </description> - </method> </methods> <constants> </constants> @@ -43022,37 +43092,42 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_mass"> - <argument index="0" name="mass" type="float"> - </argument> + <method name="get_brake" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_mass" qualifiers="const"> + <method name="get_engine_force" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="set_friction"> - <argument index="0" name="friction" type="float"> - </argument> + <method name="get_friction" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_friction" qualifiers="const"> - <return type="float"> + <method name="get_linear_velocity" qualifiers="const"> + <return type="Vector3"> </return> <description> + Returns the VehicleBody's velocity vector. To get the absolute speed in scalar value, get the length of the return vector in pixels/second. Example: + [codeblock] + # vehicle is an instance of VehicleBody + var speed = vehicle.get_linear_velocity().length() + [/codeblock] </description> </method> - <method name="set_engine_force"> - <argument index="0" name="engine_force" type="float"> - </argument> + <method name="get_mass" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_engine_force" qualifiers="const"> + <method name="get_steering" qualifiers="const"> <return type="float"> </return> <description> @@ -43064,33 +43139,28 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_brake" qualifiers="const"> - <return type="float"> - </return> + <method name="set_engine_force"> + <argument index="0" name="engine_force" type="float"> + </argument> <description> </description> </method> - <method name="set_steering"> - <argument index="0" name="steering" type="float"> + <method name="set_friction"> + <argument index="0" name="friction" type="float"> </argument> <description> </description> </method> - <method name="get_steering" qualifiers="const"> - <return type="float"> - </return> + <method name="set_mass"> + <argument index="0" name="mass" type="float"> + </argument> <description> </description> </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector3"> - </return> + <method name="set_steering"> + <argument index="0" name="steering" type="float"> + </argument> <description> - Returns the VehicleBody's velocity vector. To get the absolute speed in scalar value, get the length of the return vector in pixels/second. Example: - [codeblock] - # vehicle is an instance of VehicleBody - var speed = vehicle.get_linear_velocity().length() - [/codeblock] </description> </method> </methods> @@ -43103,62 +43173,62 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_radius"> - <argument index="0" name="length" type="float"> - </argument> + <method name="get_damping_compression" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_radius" qualifiers="const"> + <method name="get_damping_relaxation" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="set_suspension_rest_length"> - <argument index="0" name="length" type="float"> - </argument> + <method name="get_friction_slip" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_suspension_rest_length" qualifiers="const"> + <method name="get_radius" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="set_suspension_travel"> - <argument index="0" name="length" type="float"> - </argument> + <method name="get_suspension_max_force" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_suspension_travel" qualifiers="const"> + <method name="get_suspension_rest_length" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="set_suspension_stiffness"> - <argument index="0" name="length" type="float"> - </argument> + <method name="get_suspension_stiffness" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_suspension_stiffness" qualifiers="const"> + <method name="get_suspension_travel" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="set_suspension_max_force"> - <argument index="0" name="length" type="float"> - </argument> + <method name="is_used_as_steering" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_suspension_max_force" qualifiers="const"> - <return type="float"> + <method name="is_used_as_traction" qualifiers="const"> + <return type="bool"> </return> <description> </description> @@ -43169,57 +43239,57 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_damping_compression" qualifiers="const"> - <return type="float"> - </return> + <method name="set_damping_relaxation"> + <argument index="0" name="length" type="float"> + </argument> <description> </description> </method> - <method name="set_damping_relaxation"> + <method name="set_friction_slip"> <argument index="0" name="length" type="float"> </argument> <description> </description> </method> - <method name="get_damping_relaxation" qualifiers="const"> - <return type="float"> - </return> + <method name="set_radius"> + <argument index="0" name="length" type="float"> + </argument> <description> </description> </method> - <method name="set_use_as_traction"> - <argument index="0" name="enable" type="bool"> + <method name="set_suspension_max_force"> + <argument index="0" name="length" type="float"> </argument> <description> </description> </method> - <method name="is_used_as_traction" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_suspension_rest_length"> + <argument index="0" name="length" type="float"> + </argument> <description> </description> </method> - <method name="set_use_as_steering"> - <argument index="0" name="enable" type="bool"> + <method name="set_suspension_stiffness"> + <argument index="0" name="length" type="float"> </argument> <description> </description> </method> - <method name="is_used_as_steering" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_suspension_travel"> + <argument index="0" name="length" type="float"> + </argument> <description> </description> </method> - <method name="set_friction_slip"> - <argument index="0" name="length" type="float"> + <method name="set_use_as_steering"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> </method> - <method name="get_friction_slip" qualifiers="const"> - <return type="float"> - </return> + <method name="set_use_as_traction"> + <argument index="0" name="enable" type="bool"> + </argument> <description> </description> </method> @@ -43233,89 +43303,85 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_stream"> - <argument index="0" name="stream" type="VideoStream"> - </argument> - <description> - </description> - </method> - <method name="get_stream" qualifiers="const"> - <return type="VideoStream"> + <method name="get_audio_track" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="play"> + <method name="get_buffering_msec" qualifiers="const"> + <return type="int"> + </return> <description> </description> </method> - <method name="stop"> + <method name="get_stream" qualifiers="const"> + <return type="VideoStream"> + </return> <description> </description> </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> + <method name="get_stream_name" qualifiers="const"> + <return type="String"> </return> <description> </description> </method> - <method name="set_paused"> - <argument index="0" name="paused" type="bool"> - </argument> + <method name="get_stream_pos" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> + <method name="get_video_texture"> + <return type="Texture"> </return> <description> </description> </method> - <method name="set_volume"> - <argument index="0" name="volume" type="float"> - </argument> + <method name="get_volume" qualifiers="const"> + <return type="float"> + </return> <description> </description> </method> - <method name="get_volume" qualifiers="const"> + <method name="get_volume_db" qualifiers="const"> <return type="float"> </return> <description> </description> </method> - <method name="set_volume_db"> - <argument index="0" name="db" type="float"> - </argument> + <method name="has_autoplay" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_volume_db" qualifiers="const"> - <return type="float"> + <method name="has_expand" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="set_audio_track"> - <argument index="0" name="track" type="int"> - </argument> + <method name="is_paused" qualifiers="const"> + <return type="bool"> + </return> <description> </description> </method> - <method name="get_audio_track" qualifiers="const"> - <return type="int"> + <method name="is_playing" qualifiers="const"> + <return type="bool"> </return> <description> </description> </method> - <method name="get_stream_name" qualifiers="const"> - <return type="String"> - </return> + <method name="play"> <description> </description> </method> - <method name="get_stream_pos" qualifiers="const"> - <return type="float"> - </return> + <method name="set_audio_track"> + <argument index="0" name="track" type="int"> + </argument> <description> </description> </method> @@ -43325,9 +43391,9 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="has_autoplay" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_buffering_msec"> + <argument index="0" name="msec" type="int"> + </argument> <description> </description> </method> @@ -43337,27 +43403,31 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="has_expand" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_paused"> + <argument index="0" name="paused" type="bool"> + </argument> <description> </description> </method> - <method name="set_buffering_msec"> - <argument index="0" name="msec" type="int"> + <method name="set_stream"> + <argument index="0" name="stream" type="VideoStream"> </argument> <description> </description> </method> - <method name="get_buffering_msec" qualifiers="const"> - <return type="int"> - </return> + <method name="set_volume"> + <argument index="0" name="volume" type="float"> + </argument> <description> </description> </method> - <method name="get_video_texture"> - <return type="Texture"> - </return> + <method name="set_volume_db"> + <argument index="0" name="db" type="float"> + </argument> + <description> + </description> + </method> + <method name="stop"> <description> </description> </method> @@ -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. </description> <methods> - <method name="set_rect"> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - Set the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. - </description> - </method> - <method name="get_rect" qualifiers="const"> - <return type="Rect2"> + <method name="find_world" qualifiers="const"> + <return type="World"> </return> <description> - 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. </description> </method> <method name="find_world_2d" qualifiers="const"> @@ -43419,32 +43482,11 @@ This method controls whether the position between two cached points is interpola Return the 2D world of the viewport. </description> </method> - <method name="set_world"> - <argument index="0" name="world" type="World"> - </argument> - <description> - Change the 3D world of the viewport. - </description> - </method> - <method name="get_world" qualifiers="const"> - <return type="World"> - </return> - <description> - Return the 3D world of the viewport. - </description> - </method> - <method name="find_world" qualifiers="const"> - <return type="World"> + <method name="get_camera" qualifiers="const"> + <return type="Camera"> </return> <description> - Return the 3D world of the viewport, or if no such present, the one of the parent viewport. - </description> - </method> - <method name="set_canvas_transform"> - <argument index="0" name="xform" type="Matrix32"> - </argument> - <description> - 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. </description> </method> <method name="get_canvas_transform" qualifiers="const"> @@ -43454,11 +43496,11 @@ This method controls whether the position between two cached points is interpola Get the canvas transform of the viewport. </description> </method> - <method name="set_global_canvas_transform"> - <argument index="0" name="xform" type="Matrix32"> - </argument> + <method name="get_final_transform" qualifiers="const"> + <return type="Matrix32"> + </return> <description> - Set the global canvas transform of the viewport. The canvas transform is relative to this. + Get the total transform of the viewport. </description> </method> <method name="get_global_canvas_transform" qualifiers="const"> @@ -43468,76 +43510,67 @@ This method controls whether the position between two cached points is interpola Get the global canvas transform of the viewport. </description> </method> - <method name="get_final_transform" qualifiers="const"> - <return type="Matrix32"> + <method name="get_mouse_pos" qualifiers="const"> + <return type="Vector2"> </return> <description> - Get the total transform of the viewport. + Get the mouse position, relative to the viewport. </description> </method> - <method name="get_visible_rect" qualifiers="const"> - <return type="Rect2"> + <method name="get_physics_object_picking"> + <return type="bool"> </return> <description> - Return the final, visible rect in global screen coordinates. + Get whether picking for all physics objects inside the viewport is enabled. </description> </method> - <method name="set_transparent_background"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_rect" qualifiers="const"> + <return type="Rect2"> + </return> <description> - If this viewport is a child of another viewport, keep the previously drawn background visible. + 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. </description> </method> - <method name="has_transparent_background" qualifiers="const"> + <method name="get_render_target_clear_on_new_frame" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the viewport lets whatever is behind it to show. - </description> - </method> - <method name="set_size_override"> - <argument index="0" name="enable" type="bool"> - </argument> - <argument index="1" name="size" type="Vector2" default="Vector2(-1,-1)"> - </argument> - <argument index="2" name="margin" type="Vector2" default="Vector2(0,0)"> - </argument> - <description> - 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. + Return whether automatic clearing of the render target on each frame is enabled. </description> </method> - <method name="get_size_override" qualifiers="const"> - <return type="Vector2"> + <method name="get_render_target_filter" qualifiers="const"> + <return type="bool"> </return> <description> - Get the size override set with [method set_size_override]. + Get whether the rendered texture has filters enabled. </description> </method> - <method name="is_size_override_enabled" qualifiers="const"> + <method name="get_render_target_gen_mipmaps" qualifiers="const"> <return type="bool"> </return> <description> - Get the enabled status of the size override set with [method set_size_override]. + Get whether the rendered texture will have mipmaps generated. </description> </method> - <method name="set_size_override_stretch"> - <argument index="0" name="enabled" type="bool"> - </argument> + <method name="get_render_target_texture" qualifiers="const"> + <return type="RenderTargetTexture"> + </return> <description> - Set whether the size override affects stretch as well. + Get the render target's texture, for use with various objects that you want to texture with the viewport. </description> </method> - <method name="is_size_override_stretch_enabled" qualifiers="const"> - <return type="bool"> + <method name="get_render_target_update_mode" qualifiers="const"> + <return type="int"> </return> <description> - Get the enabled status of the size strech override set with [method set_size_override_stretch]. + Get when the render target would be updated, will be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. </description> </method> - <method name="queue_screen_capture"> + <method name="get_render_target_vflip" qualifiers="const"> + <return type="bool"> + </return> <description> - Queue a multithreaded screenshot, you can retrive it at a later frame via [method get_screen_capture]. + Set whether the render target is flipped on the Y axis. </description> </method> <method name="get_screen_capture" qualifiers="const"> @@ -43547,187 +43580,195 @@ This method controls whether the position between two cached points is interpola Return the captured screenshot after [method queue_screen_capture]. You might need to check more than one frame untill the right image is returned. </description> </method> - <method name="set_as_render_target"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_size_override" qualifiers="const"> + <return type="Vector2"> + </return> <description> - Set the viewport's render target mode. + Get the size override set with [method set_size_override]. </description> </method> - <method name="is_set_as_render_target" qualifiers="const"> - <return type="bool"> + <method name="get_viewport" qualifiers="const"> + <return type="RID"> </return> <description> - Return whether the viewport is set as a render target by [method set_as_render_target]. + Get the viewport RID from the visual server. </description> </method> - <method name="set_render_target_vflip"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="get_visible_rect" qualifiers="const"> + <return type="Rect2"> + </return> <description> - Set whether the render target should be flipped on the Y axis. + Return the final, visible rect in global screen coordinates. </description> </method> - <method name="get_render_target_vflip" qualifiers="const"> - <return type="bool"> + <method name="get_world" qualifiers="const"> + <return type="World"> </return> <description> - Set whether the render target is flipped on the Y axis. + Return the 3D world of the viewport. </description> </method> - <method name="set_render_target_clear_on_new_frame"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="gui_get_drag_data" qualifiers="const"> + <return type="Variant"> + </return> <description> - 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] + Returs the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. </description> </method> - <method name="get_render_target_clear_on_new_frame" qualifiers="const"> + <method name="gui_has_modal_stack" qualifiers="const"> <return type="bool"> </return> <description> - Return whether automatic clearing of the render target on each frame is enabled. + Returs whether there are shown modals on-screen. </description> </method> - <method name="render_target_clear"> + <method name="has_transparent_background" qualifiers="const"> + <return type="bool"> + </return> <description> - Clear the render target manually. + Return whether the viewport lets whatever is behind it to show. </description> </method> - <method name="set_render_target_filter"> - <argument index="0" name="enable" type="bool"> + <method name="input"> + <argument index="0" name="local_event" type="InputEvent"> </argument> <description> - Set whether the rendered texture should have filters enabled. Disable if you want the texture's pixels be visible. </description> </method> - <method name="get_render_target_filter" qualifiers="const"> + <method name="is_audio_listener" qualifiers="const"> <return type="bool"> </return> <description> - Get whether the rendered texture has filters enabled. + Returns whether the viewport sends sounds to the speakers. </description> </method> - <method name="set_render_target_gen_mipmaps"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="is_audio_listener_2d" qualifiers="const"> + <return type="bool"> + </return> <description> - Set whether the rendered texture should have mipmaps generated. Mipmaps allow the texture to have better antialiasing from far away. + Returns whether the viewport sends soundsfrom 2D emitters to the speakers. </description> </method> - <method name="get_render_target_gen_mipmaps" qualifiers="const"> + <method name="is_input_disabled" qualifiers="const"> <return type="bool"> </return> <description> - Get whether the rendered texture will have mipmaps generated. + Return whether input to the viewport is disabled. </description> </method> - <method name="set_render_target_update_mode"> - <argument index="0" name="mode" type="int"> - </argument> + <method name="is_set_as_render_target" qualifiers="const"> + <return type="bool"> + </return> <description> - Set when the render target should be updated, has to be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. + Return whether the viewport is set as a render target by [method set_as_render_target]. </description> </method> - <method name="get_render_target_update_mode" qualifiers="const"> - <return type="int"> + <method name="is_size_override_enabled" qualifiers="const"> + <return type="bool"> </return> <description> - Get when the render target would be updated, will be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. + Get the enabled status of the size override set with [method set_size_override]. </description> </method> - <method name="get_render_target_texture" qualifiers="const"> - <return type="RenderTargetTexture"> + <method name="is_size_override_stretch_enabled" qualifiers="const"> + <return type="bool"> </return> <description> - Get the render target's texture, for use with various objects that you want to texture with the viewport. + Get the enabled status of the size strech override set with [method set_size_override_stretch]. </description> </method> - <method name="set_physics_object_picking"> - <argument index="0" name="enable" type="bool"> - </argument> + <method name="is_using_own_world" qualifiers="const"> + <return type="bool"> + </return> <description> - Enable/disable picking for all physics objects inside the viewport. + Return whether the viewport is using a world separate from the parent viewport's world. </description> </method> - <method name="get_physics_object_picking"> - <return type="bool"> - </return> + <method name="queue_screen_capture"> <description> - Get whether picking for all physics objects inside the viewport is enabled. + Queue a multithreaded screenshot, you can retrive it at a later frame via [method get_screen_capture]. </description> </method> - <method name="get_viewport" qualifiers="const"> - <return type="RID"> - </return> + <method name="render_target_clear"> <description> - Get the viewport RID from the visual server. + Clear the render target manually. </description> </method> - <method name="input"> - <argument index="0" name="local_event" type="InputEvent"> + <method name="set_as_audio_listener"> + <argument index="0" name="enable" type="bool"> </argument> <description> + Makes the viewport send sounds to the speakers. </description> </method> - <method name="unhandled_input"> - <argument index="0" name="local_event" type="InputEvent"> + <method name="set_as_audio_listener_2d"> + <argument index="0" name="enable" type="bool"> </argument> <description> + Makes the viewport send sounds from 2D emitters to the speakers. </description> </method> - <method name="update_worlds"> + <method name="set_as_render_target"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Force update of the 2D and 3D worlds. + Set the viewport's render target mode. </description> </method> - <method name="set_use_own_world"> - <argument index="0" name="enable" type="bool"> + <method name="set_canvas_transform"> + <argument index="0" name="xform" type="Matrix32"> </argument> <description> - Make the viewport use a world separate from the parent viewport's world. + 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. </description> </method> - <method name="is_using_own_world" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_disable_input"> + <argument index="0" name="disable" type="bool"> + </argument> <description> - Return whether the viewport is using a world separate from the parent viewport's world. + Set whether input to the viewport is disabled. </description> </method> - <method name="get_camera" qualifiers="const"> - <return type="Camera"> - </return> + <method name="set_global_canvas_transform"> + <argument index="0" name="xform" type="Matrix32"> + </argument> <description> - Return the active 3D camera. + Set the global canvas transform of the viewport. The canvas transform is relative to this. </description> </method> - <method name="set_as_audio_listener"> + <method name="set_physics_object_picking"> <argument index="0" name="enable" type="bool"> </argument> <description> - Makes the viewport send sounds to the speakers. + Enable/disable picking for all physics objects inside the viewport. </description> </method> - <method name="is_audio_listener" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_rect"> + <argument index="0" name="rect" type="Rect2"> + </argument> <description> - Returns whether the viewport sends sounds to the speakers. + Set the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. </description> </method> - <method name="set_as_audio_listener_2d"> + <method name="set_render_target_clear_on_new_frame"> <argument index="0" name="enable" type="bool"> </argument> <description> - Makes the viewport send sounds from 2D emitters to the speakers. + 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] </description> </method> - <method name="is_audio_listener_2d" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_render_target_filter"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Returns whether the viewport sends soundsfrom 2D emitters to the speakers. + Set whether the rendered texture should have filters enabled. Disable if you want the texture's pixels be visible. + </description> + </method> + <method name="set_render_target_gen_mipmaps"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether the rendered texture should have mipmaps generated. Mipmaps allow the texture to have better antialiasing from far away. </description> </method> <method name="set_render_target_to_screen_rect"> @@ -43737,46 +43778,75 @@ This method controls whether the position between two cached points is interpola Map a part of the screen to the render target directly. </description> </method> - <method name="get_mouse_pos" qualifiers="const"> - <return type="Vector2"> - </return> + <method name="set_render_target_update_mode"> + <argument index="0" name="mode" type="int"> + </argument> <description> - Get the mouse position, relative to the viewport. + Set when the render target should be updated, has to be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. </description> </method> - <method name="warp_mouse"> - <argument index="0" name="to_pos" type="Vector2"> + <method name="set_render_target_vflip"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Wrap the mouse to a position, relative to the viewport. + Set whether the render target should be flipped on the Y axis. </description> </method> - <method name="gui_has_modal_stack" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_size_override"> + <argument index="0" name="enable" type="bool"> + </argument> + <argument index="1" name="size" type="Vector2" default="Vector2(-1,-1)"> + </argument> + <argument index="2" name="margin" type="Vector2" default="Vector2(0,0)"> + </argument> <description> - Returs whether there are shown modals on-screen. + 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. </description> </method> - <method name="gui_get_drag_data" qualifiers="const"> - <return type="Variant"> - </return> + <method name="set_size_override_stretch"> + <argument index="0" name="enabled" type="bool"> + </argument> <description> - Returs the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. + Set whether the size override affects stretch as well. </description> </method> - <method name="set_disable_input"> - <argument index="0" name="disable" type="bool"> + <method name="set_transparent_background"> + <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether input to the viewport is disabled. + If this viewport is a child of another viewport, keep the previously drawn background visible. </description> </method> - <method name="is_input_disabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_use_own_world"> + <argument index="0" name="enable" type="bool"> + </argument> <description> - Return whether input to the viewport is disabled. + Make the viewport use a world separate from the parent viewport's world. + </description> + </method> + <method name="set_world"> + <argument index="0" name="world" type="World"> + </argument> + <description> + Change the 3D world of the viewport. + </description> + </method> + <method name="unhandled_input"> + <argument index="0" name="local_event" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="update_worlds"> + <description> + Force update of the 2D and 3D worlds. + </description> + </method> + <method name="warp_mouse"> + <argument index="0" name="to_pos" type="Vector2"> + </argument> + <description> + Wrap the mouse to a position, relative to the viewport. </description> </method> </methods> @@ -43810,25 +43880,25 @@ 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. </description> <methods> - <method name="set_viewport_path"> - <argument index="0" name="path" type="NodePath"> - </argument> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> + </return> <description> - Set the path to the shown [Viewport] node. + Get color modulation for the texture. All texture pixels are multiplied by this color. </description> </method> - <method name="get_viewport_path" qualifiers="const"> - <return type="NodePath"> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> </return> <description> - Return the path to the shown [Viewport] node. + get the offset to the origin of the texture. </description> </method> - <method name="set_centered"> - <argument index="0" name="centered" type="bool"> - </argument> + <method name="get_viewport_path" qualifiers="const"> + <return type="NodePath"> + </return> <description> - Set whether the viewport's texture should be centered on the origin. + Return the path to the shown [Viewport] node. </description> </method> <method name="is_centered" qualifiers="const"> @@ -43838,18 +43908,11 @@ This method controls whether the position between two cached points is interpola Return whether the viewport's texture is centered on the origin. </description> </method> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> + <method name="set_centered"> + <argument index="0" name="centered" type="bool"> </argument> <description> - Set the offset to the origin of the texture. - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - get the offset to the origin of the texture. + Set whether the viewport's texture should be centered on the origin. </description> </method> <method name="set_modulate"> @@ -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. </description> </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> - </return> + <method name="set_offset"> + <argument index="0" name="offset" type="Vector2"> + </argument> <description> - Get color modulation for the texture. All texture pixels are multiplied by this color. + Set the offset to the origin of the texture. + </description> + </method> + <method name="set_viewport_path"> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + Set the path to the shown [Viewport] node. </description> </method> </methods> @@ -43878,32 +43948,32 @@ 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. </description> <methods> - <method name="set_enabler"> + <method name="is_enabler_enabled" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="enabler" type="int"> </argument> - <argument index="1" name="enabled" type="bool"> - </argument> <description> - 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. + Returns whether the specified enabler was set to true or not. </description> </method> - <method name="is_enabler_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_enabler"> <argument index="0" name="enabler" type="int"> </argument> + <argument index="1" name="enabled" type="bool"> + </argument> <description> - 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. </description> </method> </methods> <constants> - <constant name="ENABLER_FREEZE_BODIES" value="1"> - This enabler will freeze [RigidBody] nodes. - </constant> <constant name="ENABLER_PAUSE_ANIMATIONS" value="0"> This enabler will pause [AnimationPlayer] nodes. </constant> + <constant name="ENABLER_FREEZE_BODIES" value="1"> + This enabler will freeze [RigidBody] nodes. + </constant> <constant name="ENABLER_MAX" value="2"> </constant> </constants> @@ -43916,43 +43986,43 @@ 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. </description> <methods> - <method name="set_enabler"> + <method name="is_enabler_enabled" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="enabler" type="int"> </argument> - <argument index="1" name="enabled" type="bool"> - </argument> <description> - 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. + Returns whether the specified enabler was set to true or not. </description> </method> - <method name="is_enabler_enabled" qualifiers="const"> - <return type="bool"> - </return> + <method name="set_enabler"> <argument index="0" name="enabler" type="int"> </argument> + <argument index="1" name="enabled" type="bool"> + </argument> <description> - 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. </description> </method> </methods> <constants> - <constant name="ENABLER_FREEZE_BODIES" value="1"> - This enabler will freeze [RigidBody2D] nodes. - </constant> <constant name="ENABLER_PAUSE_ANIMATIONS" value="0"> This enabler will pause [AnimationPlayer] nodes. </constant> + <constant name="ENABLER_FREEZE_BODIES" value="1"> + This enabler will freeze [RigidBody2D] nodes. + </constant> <constant name="ENABLER_PAUSE_PARTICLES" value="2"> This enabler will stop [Particles2D] nodes. </constant> - <constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5"> - </constant> <constant name="ENABLER_PARENT_PROCESS" value="3"> This enabler will stop the parent's _process function. </constant> <constant name="ENABLER_PARENT_FIXED_PROCESS" value="4"> This enabler will stop the parent's _fixed_process function. </constant> + <constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5"> + </constant> <constant name="ENABLER_MAX" value="6"> </constant> </constants> @@ -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. </description> <methods> - <method name="set_aabb"> - <argument index="0" name="rect" type="AABB"> - </argument> - <description> - Set the visibility bounding box of the VisibilityNotifier. - </description> - </method> <method name="get_aabb" qualifiers="const"> <return type="AABB"> </return> @@ -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. </description> </method> - </methods> - <signals> - <signal name="enter_screen"> + <method name="set_aabb"> + <argument index="0" name="rect" type="AABB"> + </argument> <description> - Emitted when the VisibilityNotifier enters the screen. + Set the visibility bounding box of the VisibilityNotifier. </description> - </signal> + </method> + </methods> + <signals> <signal name="enter_camera"> <argument index="0" name="camera" type="Object"> </argument> @@ -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. </description> </signal> - <signal name="exit_screen"> + <signal name="enter_screen"> <description> - Emitted when the VisibilityNotifier exits the screen. + Emitted when the VisibilityNotifier enters the screen. </description> </signal> <signal name="exit_camera"> @@ -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. </description> </signal> + <signal name="exit_screen"> + <description> + Emitted when the VisibilityNotifier exits the screen. + </description> + </signal> </signals> <constants> </constants> @@ -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. </description> <methods> - <method name="set_rect"> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - Set the visibility bounding rectangle of the VisibilityNotifier2D. - </description> - </method> <method name="get_rect" qualifiers="const"> <return type="Rect2"> </return> @@ -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. </description> </method> + <method name="set_rect"> + <argument index="0" name="rect" type="Rect2"> + </argument> + <description> + Set the visibility bounding rectangle of the VisibilityNotifier2D. + </description> + </method> </methods> <signals> <signal name="enter_screen"> @@ -44081,6 +44151,12 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> + <method name="get_layer_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="set_base"> <argument index="0" name="base" type="RID"> </argument> @@ -44093,12 +44169,6 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> </methods> <constants> </constants> @@ -44112,153 +44182,173 @@ 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. </description> <methods> - <method name="texture_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="texture_create_from_image"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="Image"> + <method name="black_bars_set_images"> + <argument index="0" name="left" type="RID"> </argument> - <argument index="1" name="arg1" type="int" default="7"> + <argument index="1" name="top" type="RID"> + </argument> + <argument index="2" name="right" type="RID"> + </argument> + <argument index="3" name="bottom" type="RID"> </argument> <description> </description> </method> - <method name="texture_set_flags"> - <argument index="0" name="arg0" type="RID"> + <method name="black_bars_set_margins"> + <argument index="0" name="left" type="int"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="top" type="int"> + </argument> + <argument index="2" name="right" type="int"> + </argument> + <argument index="3" name="bottom" type="int"> </argument> <description> </description> </method> - <method name="texture_get_flags" qualifiers="const"> - <return type="int"> + <method name="camera_create"> + <return type="RID"> </return> - <argument index="0" name="arg0" type="RID"> - </argument> <description> </description> </method> - <method name="texture_get_width" qualifiers="const"> - <return type="int"> - </return> + <method name="camera_set_orthogonal"> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="float"> + </argument> + <argument index="2" name="arg2" type="float"> + </argument> + <argument index="3" name="arg3" type="float"> + </argument> <description> </description> </method> - <method name="texture_get_height" qualifiers="const"> - <return type="int"> - </return> + <method name="camera_set_perspective"> <argument index="0" name="arg0" type="RID"> </argument> - <description> - </description> - </method> - <method name="texture_set_shrink_all_x2_on_set_data"> - <argument index="0" name="shrink" type="bool"> + <argument index="1" name="arg1" type="float"> </argument> - <description> - </description> - </method> - <method name="shader_create"> - <return type="RID"> - </return> - <argument index="0" name="mode" type="int" default="0"> + <argument index="2" name="arg2" type="float"> + </argument> + <argument index="3" name="arg3" type="float"> </argument> <description> </description> </method> - <method name="shader_set_mode"> - <argument index="0" name="shader" type="RID"> + <method name="camera_set_transform"> + <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="mode" type="int"> + <argument index="1" name="arg1" type="Transform"> </argument> <description> </description> </method> - <method name="material_create"> + <method name="canvas_create"> <return type="RID"> </return> <description> </description> </method> - <method name="material_set_shader"> - <argument index="0" name="shader" type="RID"> + <method name="canvas_item_add_circle"> + <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID"> + <argument index="1" name="arg1" type="Vector2"> + </argument> + <argument index="2" name="arg2" type="float"> + </argument> + <argument index="3" name="arg3" type="Color"> </argument> <description> </description> </method> - <method name="material_get_shader" qualifiers="const"> - <return type="RID"> - </return> + <method name="canvas_item_add_line"> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="Vector2"> + </argument> + <argument index="2" name="arg2" type="Vector2"> + </argument> + <argument index="3" name="arg3" type="Color"> + </argument> + <argument index="4" name="arg4" type="float" default="1"> + </argument> <description> </description> </method> - <method name="material_set_param"> + <method name="canvas_item_add_rect"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="String"> + <argument index="1" name="arg1" type="Rect2"> </argument> - <argument index="2" name="arg2" type="Variant"> + <argument index="2" name="arg2" type="Color"> </argument> <description> </description> </method> - <method name="material_get_param" qualifiers="const"> + <method name="canvas_item_add_style_box"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="String"> + <argument index="1" name="arg1" type="Rect2"> + </argument> + <argument index="2" name="arg2" type="Rect2"> + </argument> + <argument index="3" name="arg3" type="RID"> + </argument> + <argument index="4" name="arg4" type="RealArray"> + </argument> + <argument index="5" name="arg5" type="Color" default="Color(1,1,1,1)"> </argument> <description> </description> </method> - <method name="material_set_flag"> + <method name="canvas_item_add_texture_rect"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="Rect2"> </argument> - <argument index="2" name="arg2" type="bool"> + <argument index="2" name="arg2" type="RID"> + </argument> + <argument index="3" name="arg3" type="bool"> + </argument> + <argument index="4" name="arg4" type="Color" default="Color(1,1,1,1)"> + </argument> + <argument index="5" name="arg5" type="bool" default="false"> </argument> <description> </description> </method> - <method name="material_get_flag" qualifiers="const"> - <return type="bool"> - </return> + <method name="canvas_item_add_texture_rect_region"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="Rect2"> + </argument> + <argument index="2" name="arg2" type="RID"> + </argument> + <argument index="3" name="arg3" type="Rect2"> + </argument> + <argument index="4" name="arg4" type="Color" default="Color(1,1,1,1)"> + </argument> + <argument index="5" name="arg5" type="bool" default="false"> </argument> <description> </description> </method> - <method name="material_set_blend_mode"> + <method name="canvas_item_clear"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> - <method name="material_get_blend_mode" qualifiers="const"> - <return type="int"> + <method name="canvas_item_create"> + <return type="RID"> </return> - <argument index="0" name="arg0" type="RID"> - </argument> <description> </description> </method> - <method name="material_set_line_width"> + <method name="canvas_item_get_opacity" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="float"> @@ -44266,69 +44356,81 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="material_get_line_width" qualifiers="const"> - <return type="float"> + <method name="canvas_item_get_parent" qualifiers="const"> + <return type="RID"> </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="mesh_create"> - <return type="RID"> + <method name="canvas_item_get_self_opacity" qualifiers="const"> + <return type="float"> </return> + <argument index="0" name="arg0" type="RID"> + </argument> + <argument index="1" name="arg1" type="float"> + </argument> <description> </description> </method> - <method name="mesh_add_surface"> + <method name="canvas_item_raise"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <description> + </description> + </method> + <method name="canvas_item_set_clip"> + <argument index="0" name="arg0" type="RID"> </argument> - <argument index="2" name="arg2" type="Array"> + <argument index="1" name="arg1" type="bool"> </argument> - <argument index="3" name="arg3" type="Array"> + <description> + </description> + </method> + <method name="canvas_item_set_custom_rect"> + <argument index="0" name="arg0" type="RID"> </argument> - <argument index="4" name="arg4" type="bool" default="-1"> + <argument index="1" name="arg1" type="bool"> + </argument> + <argument index="2" name="arg2" type="Rect2"> </argument> <description> </description> </method> - <method name="mesh_surface_set_material"> + <method name="canvas_item_set_opacity"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="float"> </argument> - <argument index="2" name="arg2" type="RID"> + <description> + </description> + </method> + <method name="canvas_item_set_parent"> + <argument index="0" name="arg0" type="RID"> </argument> - <argument index="3" name="arg3" type="bool" default="false"> + <argument index="1" name="arg1" type="RID"> </argument> <description> </description> </method> - <method name="mesh_surface_get_material" qualifiers="const"> - <return type="RID"> - </return> + <method name="canvas_item_set_self_opacity"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="float"> </argument> <description> </description> </method> - <method name="mesh_surface_get_array_len" qualifiers="const"> - <return type="int"> - </return> + <method name="canvas_item_set_transform"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="Matrix32"> </argument> <description> </description> </method> - <method name="mesh_surface_get_array_index_len" qualifiers="const"> - <return type="int"> - </return> + <method name="canvas_item_set_z"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="int"> @@ -44336,137 +44438,119 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="mesh_surface_get_format" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> + <method name="cursor_set_pos"> + <argument index="0" name="arg0" type="Vector2"> </argument> <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="mesh_surface_get_primitive_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> + <method name="cursor_set_rotation"> + <argument index="0" name="arg0" type="float"> </argument> <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="mesh_remove_surface"> + <method name="cursor_set_texture"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="Vector2"> + </argument> + <argument index="2" name="arg2" type="int"> </argument> <description> </description> </method> - <method name="mesh_get_surface_count" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> + <method name="cursor_set_visible"> + <argument index="0" name="arg0" type="bool"> + </argument> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="multimesh_create"> - <return type="RID"> - </return> + <method name="draw"> <description> </description> </method> - <method name="multimesh_set_mesh"> + <method name="free_rid"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID"> - </argument> <description> </description> </method> - <method name="multimesh_set_aabb"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="AABB"> + <method name="get_render_info"> + <return type="int"> + </return> + <argument index="0" name="arg0" type="int"> </argument> <description> </description> </method> - <method name="multimesh_instance_set_transform"> + <method name="get_test_cube"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="instance_attach_object_instance_ID"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="int"> </argument> - <argument index="2" name="arg2" type="Transform"> - </argument> <description> </description> </method> - <method name="multimesh_instance_set_color"> + <method name="instance_attach_skeleton"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="Color"> + <argument index="1" name="arg1" type="RID"> </argument> <description> </description> </method> - <method name="multimesh_get_mesh" qualifiers="const"> + <method name="instance_create"> <return type="RID"> </return> - <argument index="0" name="arg0" type="RID"> - </argument> <description> </description> </method> - <method name="multimesh_get_aabb" qualifiers="const"> - <return type="AABB"> + <method name="instance_geometry_get_material_param" qualifiers="const"> + <return type="RID"> </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="AABB"> - </argument> <description> </description> </method> - <method name="multimesh_instance_get_transform" qualifiers="const"> - <return type="Transform"> + <method name="instance_geometry_override_material_param" qualifiers="const"> + <return type="RID"> </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> - <method name="multimesh_instance_get_color" qualifiers="const"> - <return type="Color"> + <method name="instance_get_base" qualifiers="const"> + <return type="RID"> </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> - <method name="particles_create"> + <method name="instance_get_base_aabb" qualifiers="const"> <return type="RID"> </return> - <description> - </description> - </method> - <method name="particles_set_amount"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> - <method name="particles_get_amount" qualifiers="const"> + <method name="instance_get_object_instance_ID" qualifiers="const"> <return type="int"> </return> <argument index="0" name="arg0" type="RID"> @@ -44474,106 +44558,104 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="particles_set_emitting"> + <method name="instance_get_room" qualifiers="const"> + <return type="RID"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="bool"> - </argument> <description> </description> </method> - <method name="particles_is_emitting" qualifiers="const"> - <return type="bool"> + <method name="instance_get_skeleton" qualifiers="const"> + <return type="RID"> </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="particles_set_visibility_aabb"> + <method name="instance_get_transform" qualifiers="const"> + <return type="Transform"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="AABB"> - </argument> <description> </description> </method> - <method name="particles_get_visibility_aabb" qualifiers="const"> - <return type="AABB"> + <method name="instance_is_exterior" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="particles_set_variable"> + <method name="instance_set_exterior"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="float"> + <argument index="1" name="arg1" type="bool"> </argument> <description> </description> </method> - <method name="particles_get_variable" qualifiers="const"> - <return type="float"> - </return> + <method name="instance_set_room"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="RID"> </argument> <description> </description> </method> - <method name="particles_set_randomness"> + <method name="instance_set_transform"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="float"> + <argument index="1" name="arg1" type="Transform"> </argument> <description> </description> </method> - <method name="particles_get_randomness" qualifiers="const"> - <return type="float"> + <method name="instances_cull_aabb" qualifiers="const"> + <return type="Array"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="arg0" type="AABB"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="RID"> </argument> <description> </description> </method> - <method name="particles_set_color_phases"> - <argument index="0" name="arg0" type="RID"> + <method name="instances_cull_convex" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="arg0" type="Array"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="RID"> </argument> <description> </description> </method> - <method name="particles_get_color_phases" qualifiers="const"> - <return type="int"> + <method name="instances_cull_ray" qualifiers="const"> + <return type="Array"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="arg0" type="Vector3"> + </argument> + <argument index="1" name="arg1" type="Vector3"> + </argument> + <argument index="2" name="arg2" type="RID"> </argument> <description> </description> </method> - <method name="particles_set_color_phase_pos"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="float"> + <method name="light_create"> + <return type="RID"> + </return> + <argument index="0" name="arg0" type="int"> </argument> <description> </description> </method> - <method name="particles_get_color_phase_pos" qualifiers="const"> - <return type="float"> + <method name="light_get_color" qualifiers="const"> + <return type="Color"> </return> <argument index="0" name="arg0" type="RID"> </argument> @@ -44582,27 +44664,25 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="particles_set_color_phase_color"> + <method name="light_get_projector" qualifiers="const"> + <return type="RID"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="Color"> - </argument> <description> </description> </method> - <method name="particles_get_color_phase_color" qualifiers="const"> - <return type="Color"> + <method name="light_get_type" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> - <method name="particles_set_attractors"> + <method name="light_get_var" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="int"> @@ -44610,65 +44690,59 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="particles_get_attractors" qualifiers="const"> - <return type="int"> + <method name="light_has_shadow" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="particles_set_attractor_pos"> + <method name="light_is_volumetric" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="Vector3"> - </argument> <description> </description> </method> - <method name="particles_get_attractor_pos" qualifiers="const"> - <return type="Vector3"> - </return> + <method name="light_set_color"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="int"> </argument> + <argument index="2" name="arg2" type="Color"> + </argument> <description> </description> </method> - <method name="particles_set_attractor_strength"> + <method name="light_set_projector"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="float"> + <argument index="1" name="arg1" type="RID"> </argument> <description> </description> </method> - <method name="particles_get_attractor_strength" qualifiers="const"> - <return type="float"> - </return> + <method name="light_set_shadow"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="bool"> </argument> <description> </description> </method> - <method name="particles_set_material"> + <method name="light_set_var"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID"> + <argument index="1" name="arg1" type="int"> </argument> - <argument index="2" name="arg2" type="bool" default="false"> + <argument index="2" name="arg2" type="float"> </argument> <description> </description> </method> - <method name="particles_set_height_from_velocity"> + <method name="light_set_volumetric"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="bool"> @@ -44676,23 +44750,25 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="particles_has_height_from_velocity" qualifiers="const"> - <return type="bool"> + <method name="make_sphere_mesh"> + <return type="RID"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="arg0" type="int"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <argument index="2" name="arg2" type="float"> </argument> <description> </description> </method> - <method name="light_create"> + <method name="material_create"> <return type="RID"> </return> - <argument index="0" name="arg0" type="int"> - </argument> <description> </description> </method> - <method name="light_get_type" qualifiers="const"> + <method name="material_get_blend_mode" qualifiers="const"> <return type="int"> </return> <argument index="0" name="arg0" type="RID"> @@ -44700,109 +44776,113 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="light_set_color"> + <method name="material_get_flag" qualifiers="const"> + <return type="bool"> + </return> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="int"> </argument> - <argument index="2" name="arg2" type="Color"> - </argument> <description> </description> </method> - <method name="light_get_color" qualifiers="const"> - <return type="Color"> + <method name="material_get_line_width" qualifiers="const"> + <return type="float"> </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> - <method name="light_set_shadow"> + <method name="material_get_param" qualifiers="const"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="arg1" type="String"> </argument> <description> </description> </method> - <method name="light_has_shadow" qualifiers="const"> - <return type="bool"> + <method name="material_get_shader" qualifiers="const"> + <return type="RID"> </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="light_set_volumetric"> + <method name="material_set_blend_mode"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="light_is_volumetric" qualifiers="const"> - <return type="bool"> - </return> + <method name="material_set_flag"> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <argument index="2" name="arg2" type="bool"> + </argument> <description> </description> </method> - <method name="light_set_projector"> + <method name="material_set_line_width"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID"> + <argument index="1" name="arg1" type="float"> </argument> <description> </description> </method> - <method name="light_get_projector" qualifiers="const"> - <return type="RID"> - </return> + <method name="material_set_param"> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="String"> + </argument> + <argument index="2" name="arg2" type="Variant"> + </argument> <description> </description> </method> - <method name="light_set_var"> + <method name="material_set_shader"> + <argument index="0" name="shader" type="RID"> + </argument> + <argument index="1" name="arg1" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_add_surface"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="int"> </argument> - <argument index="2" name="arg2" type="float"> + <argument index="2" name="arg2" type="Array"> + </argument> + <argument index="3" name="arg3" type="Array"> + </argument> + <argument index="4" name="arg4" type="bool" default="-1"> </argument> <description> </description> </method> - <method name="light_get_var" qualifiers="const"> - <return type="float"> - </return> + <method name="mesh_add_surface_from_planes"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="Array"> </argument> <description> </description> </method> - <method name="skeleton_create"> + <method name="mesh_create"> <return type="RID"> </return> <description> </description> </method> - <method name="skeleton_resize"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="skeleton_get_bone_count" qualifiers="const"> + <method name="mesh_get_surface_count" qualifiers="const"> <return type="int"> </return> <argument index="0" name="arg0" type="RID"> @@ -44810,18 +44890,16 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="skeleton_bone_set_transform"> + <method name="mesh_remove_surface"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="int"> </argument> - <argument index="2" name="arg2" type="Transform"> - </argument> <description> </description> </method> - <method name="skeleton_bone_get_transform"> - <return type="Transform"> + <method name="mesh_surface_get_array_index_len" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="arg0" type="RID"> </argument> @@ -44830,213 +44908,221 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="room_create"> - <return type="RID"> + <method name="mesh_surface_get_array_len" qualifiers="const"> + <return type="int"> </return> - <description> - </description> - </method> - <method name="room_set_bounds"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Dictionary"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="room_get_bounds" qualifiers="const"> - <return type="Dictionary"> + <method name="mesh_surface_get_format" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="int"> + </argument> <description> </description> </method> - <method name="portal_create"> + <method name="mesh_surface_get_material" qualifiers="const"> <return type="RID"> </return> - <description> - </description> - </method> - <method name="portal_set_shape"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Vector2Array"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="portal_get_shape" qualifiers="const"> - <return type="Vector2Array"> + <method name="mesh_surface_get_primitive_type" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="int"> + </argument> <description> </description> </method> - <method name="portal_set_enabled"> + <method name="mesh_surface_set_material"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="arg1" type="int"> + </argument> + <argument index="2" name="arg2" type="RID"> + </argument> + <argument index="3" name="arg3" type="bool" default="false"> </argument> <description> </description> </method> - <method name="portal_is_enabled" qualifiers="const"> - <return type="bool"> + <method name="multimesh_create"> + <return type="RID"> </return> - <argument index="0" name="arg0" type="RID"> - </argument> <description> </description> </method> - <method name="portal_set_disable_distance"> + <method name="multimesh_get_aabb" qualifiers="const"> + <return type="AABB"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="arg1" type="AABB"> </argument> <description> </description> </method> - <method name="portal_get_disable_distance" qualifiers="const"> - <return type="float"> + <method name="multimesh_get_mesh" qualifiers="const"> + <return type="RID"> </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="portal_set_disabled_color"> + <method name="multimesh_instance_get_color" qualifiers="const"> + <return type="Color"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Color"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="portal_get_disabled_color" qualifiers="const"> - <return type="Color"> + <method name="multimesh_instance_get_transform" qualifiers="const"> + <return type="Transform"> </return> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="int"> + </argument> <description> </description> </method> - <method name="camera_create"> - <return type="RID"> - </return> + <method name="multimesh_instance_set_color"> + <argument index="0" name="arg0" type="RID"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <argument index="2" name="arg2" type="Color"> + </argument> <description> </description> </method> - <method name="camera_set_perspective"> + <method name="multimesh_instance_set_transform"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> - </argument> - <argument index="2" name="arg2" type="float"> + <argument index="1" name="arg1" type="int"> </argument> - <argument index="3" name="arg3" type="float"> + <argument index="2" name="arg2" type="Transform"> </argument> <description> </description> </method> - <method name="camera_set_orthogonal"> + <method name="multimesh_set_aabb"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> - </argument> - <argument index="2" name="arg2" type="float"> - </argument> - <argument index="3" name="arg3" type="float"> + <argument index="1" name="arg1" type="AABB"> </argument> <description> </description> </method> - <method name="camera_set_transform"> + <method name="multimesh_set_mesh"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Transform"> + <argument index="1" name="arg1" type="RID"> </argument> <description> </description> </method> - <method name="viewport_create"> + <method name="particles_create"> <return type="RID"> </return> <description> </description> </method> - <method name="viewport_set_rect"> + <method name="particles_get_amount" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Rect2"> - </argument> <description> </description> </method> - <method name="viewport_get_rect" qualifiers="const"> - <return type="Rect2"> + <method name="particles_get_attractor_pos" qualifiers="const"> + <return type="Vector3"> </return> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="int"> + </argument> <description> </description> </method> - <method name="viewport_attach_camera"> + <method name="particles_get_attractor_strength" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID" default="RID()"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="viewport_get_attached_camera" qualifiers="const"> - <return type="RID"> + <method name="particles_get_attractors" qualifiers="const"> + <return type="int"> </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="viewport_get_scenario" qualifiers="const"> - <return type="RID"> + <method name="particles_get_color_phase_color" qualifiers="const"> + <return type="Color"> </return> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="int"> + </argument> <description> </description> </method> - <method name="viewport_attach_canvas"> + <method name="particles_get_color_phase_pos" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="viewport_remove_canvas"> + <method name="particles_get_color_phases" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID"> - </argument> <description> </description> </method> - <method name="viewport_set_global_canvas_transform"> + <method name="particles_get_randomness" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Matrix32"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="scenario_create"> - <return type="RID"> + <method name="particles_get_variable" qualifiers="const"> + <return type="float"> </return> - <description> - </description> - </method> - <method name="scenario_set_debug"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="int"> @@ -45044,93 +45130,95 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="instance_create"> - <return type="RID"> + <method name="particles_get_visibility_aabb" qualifiers="const"> + <return type="AABB"> </return> + <argument index="0" name="arg0" type="RID"> + </argument> <description> </description> </method> - <method name="instance_get_base" qualifiers="const"> - <return type="RID"> + <method name="particles_has_height_from_velocity" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="instance_get_base_aabb" qualifiers="const"> - <return type="RID"> + <method name="particles_is_emitting" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="instance_set_transform"> + <method name="particles_set_amount"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Transform"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="instance_get_transform" qualifiers="const"> - <return type="Transform"> - </return> + <method name="particles_set_attractor_pos"> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <argument index="2" name="arg2" type="Vector3"> + </argument> <description> </description> </method> - <method name="instance_attach_object_instance_ID"> + <method name="particles_set_attractor_strength"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="int"> </argument> - <description> - </description> - </method> - <method name="instance_get_object_instance_ID" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> + <argument index="2" name="arg2" type="float"> </argument> <description> </description> </method> - <method name="instance_attach_skeleton"> + <method name="particles_set_attractors"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="instance_get_skeleton" qualifiers="const"> - <return type="RID"> - </return> + <method name="particles_set_color_phase_color"> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <argument index="2" name="arg2" type="Color"> + </argument> <description> </description> </method> - <method name="instance_set_room"> + <method name="particles_set_color_phase_pos"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID"> + <argument index="1" name="arg1" type="int"> + </argument> + <argument index="2" name="arg2" type="float"> </argument> <description> </description> </method> - <method name="instance_get_room" qualifiers="const"> - <return type="RID"> - </return> + <method name="particles_set_color_phases"> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="int"> + </argument> <description> </description> </method> - <method name="instance_set_exterior"> + <method name="particles_set_emitting"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="bool"> @@ -45138,115 +45226,107 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="instance_is_exterior" qualifiers="const"> - <return type="bool"> - </return> + <method name="particles_set_height_from_velocity"> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="bool"> + </argument> <description> </description> </method> - <method name="instances_cull_aabb" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="arg0" type="AABB"> + <method name="particles_set_material"> + <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="RID"> </argument> + <argument index="2" name="arg2" type="bool" default="false"> + </argument> <description> </description> </method> - <method name="instances_cull_ray" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="arg0" type="Vector3"> + <method name="particles_set_randomness"> + <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Vector3"> + <argument index="1" name="arg1" type="int"> </argument> - <argument index="2" name="arg2" type="RID"> + <argument index="2" name="arg2" type="float"> </argument> <description> </description> </method> - <method name="instances_cull_convex" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="arg0" type="Array"> + <method name="particles_set_variable"> + <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID"> + <argument index="1" name="arg1" type="int"> </argument> - <description> - </description> - </method> - <method name="instance_geometry_override_material_param" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> + <argument index="2" name="arg2" type="float"> </argument> <description> </description> </method> - <method name="instance_geometry_get_material_param" qualifiers="const"> - <return type="RID"> - </return> + <method name="particles_set_visibility_aabb"> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="AABB"> + </argument> <description> </description> </method> - <method name="get_test_cube"> + <method name="portal_create"> <return type="RID"> </return> <description> </description> </method> - <method name="canvas_create"> - <return type="RID"> + <method name="portal_get_disable_distance" qualifiers="const"> + <return type="float"> </return> + <argument index="0" name="arg0" type="RID"> + </argument> <description> </description> </method> - <method name="canvas_item_create"> - <return type="RID"> + <method name="portal_get_disabled_color" qualifiers="const"> + <return type="Color"> </return> + <argument index="0" name="arg0" type="RID"> + </argument> <description> </description> </method> - <method name="canvas_item_set_parent"> + <method name="portal_get_shape" qualifiers="const"> + <return type="Vector2Array"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="RID"> - </argument> <description> </description> </method> - <method name="canvas_item_get_parent" qualifiers="const"> - <return type="RID"> + <method name="portal_is_enabled" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="canvas_item_set_transform"> + <method name="portal_set_disable_distance"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Matrix32"> + <argument index="1" name="arg1" type="float"> </argument> <description> </description> </method> - <method name="canvas_item_set_custom_rect"> + <method name="portal_set_disabled_color"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <argument index="2" name="arg2" type="Rect2"> + <argument index="1" name="arg1" type="Color"> </argument> <description> </description> </method> - <method name="canvas_item_set_clip"> + <method name="portal_set_enabled"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="bool"> @@ -45254,43 +45334,43 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="canvas_item_set_opacity"> + <method name="portal_set_shape"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="arg1" type="Vector2Array"> </argument> <description> </description> </method> - <method name="canvas_item_get_opacity" qualifiers="const"> - <return type="float"> + <method name="room_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="room_get_bounds" qualifiers="const"> + <return type="Dictionary"> </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> - </argument> <description> </description> </method> - <method name="canvas_item_set_self_opacity"> + <method name="room_set_bounds"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="arg1" type="Dictionary"> </argument> <description> </description> </method> - <method name="canvas_item_get_self_opacity" qualifiers="const"> - <return type="float"> + <method name="scenario_create"> + <return type="RID"> </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="float"> - </argument> <description> </description> </method> - <method name="canvas_item_set_z"> + <method name="scenario_set_debug"> <argument index="0" name="arg0" type="RID"> </argument> <argument index="1" name="arg1" type="int"> @@ -45298,286 +45378,276 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="canvas_item_add_line"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Vector2"> - </argument> - <argument index="2" name="arg2" type="Vector2"> - </argument> - <argument index="3" name="arg3" type="Color"> - </argument> - <argument index="4" name="arg4" type="float" default="1"> + <method name="set_default_clear_color"> + <argument index="0" name="arg0" type="Color"> </argument> <description> </description> </method> - <method name="canvas_item_add_rect"> - <argument index="0" name="arg0" type="RID"> + <method name="shader_create"> + <return type="RID"> + </return> + <argument index="0" name="mode" type="int" default="0"> </argument> - <argument index="1" name="arg1" type="Rect2"> + <description> + </description> + </method> + <method name="shader_set_mode"> + <argument index="0" name="shader" type="RID"> </argument> - <argument index="2" name="arg2" type="Color"> + <argument index="1" name="mode" type="int"> </argument> <description> </description> </method> - <method name="canvas_item_add_texture_rect"> + <method name="skeleton_bone_get_transform"> + <return type="Transform"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Rect2"> - </argument> - <argument index="2" name="arg2" type="RID"> - </argument> - <argument index="3" name="arg3" type="bool"> - </argument> - <argument index="4" name="arg4" type="Color" default="Color(1,1,1,1)"> - </argument> - <argument index="5" name="arg5" type="bool" default="false"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="canvas_item_add_texture_rect_region"> + <method name="skeleton_bone_set_transform"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Rect2"> - </argument> - <argument index="2" name="arg2" type="RID"> - </argument> - <argument index="3" name="arg3" type="Rect2"> - </argument> - <argument index="4" name="arg4" type="Color" default="Color(1,1,1,1)"> + <argument index="1" name="arg1" type="int"> </argument> - <argument index="5" name="arg5" type="bool" default="false"> + <argument index="2" name="arg2" type="Transform"> </argument> <description> </description> </method> - <method name="canvas_item_add_style_box"> + <method name="skeleton_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="skeleton_get_bone_count" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Rect2"> - </argument> - <argument index="2" name="arg2" type="Rect2"> - </argument> - <argument index="3" name="arg3" type="RID"> - </argument> - <argument index="4" name="arg4" type="RealArray"> - </argument> - <argument index="5" name="arg5" type="Color" default="Color(1,1,1,1)"> - </argument> <description> </description> </method> - <method name="canvas_item_add_circle"> + <method name="skeleton_resize"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Vector2"> - </argument> - <argument index="2" name="arg2" type="float"> - </argument> - <argument index="3" name="arg3" type="Color"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="viewport_set_canvas_transform"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> + <method name="sync"> + <description> + </description> + </method> + <method name="texture_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="texture_create_from_image"> + <return type="RID"> + </return> + <argument index="0" name="arg0" type="Image"> </argument> - <argument index="2" name="arg2" type="Matrix32"> + <argument index="1" name="arg1" type="int" default="7"> </argument> <description> </description> </method> - <method name="canvas_item_clear"> + <method name="texture_get_flags" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="canvas_item_raise"> + <method name="texture_get_height" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="cursor_set_rotation"> - <argument index="0" name="arg0" type="float"> - </argument> - <argument index="1" name="arg1" type="int"> + <method name="texture_get_width" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="cursor_set_texture"> + <method name="texture_set_flags"> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Vector2"> - </argument> - <argument index="2" name="arg2" type="int"> + <argument index="1" name="arg1" type="int"> </argument> <description> </description> </method> - <method name="cursor_set_visible"> - <argument index="0" name="arg0" type="bool"> - </argument> - <argument index="1" name="arg1" type="int"> + <method name="texture_set_shrink_all_x2_on_set_data"> + <argument index="0" name="shrink" type="bool"> </argument> <description> </description> </method> - <method name="cursor_set_pos"> - <argument index="0" name="arg0" type="Vector2"> + <method name="viewport_attach_camera"> + <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="arg1" type="RID" default="RID()"> </argument> <description> </description> </method> - <method name="black_bars_set_margins"> - <argument index="0" name="left" type="int"> - </argument> - <argument index="1" name="top" type="int"> - </argument> - <argument index="2" name="right" type="int"> + <method name="viewport_attach_canvas"> + <argument index="0" name="arg0" type="RID"> </argument> - <argument index="3" name="bottom" type="int"> + <argument index="1" name="arg1" type="RID"> </argument> <description> </description> </method> - <method name="black_bars_set_images"> - <argument index="0" name="left" type="RID"> - </argument> - <argument index="1" name="top" type="RID"> - </argument> - <argument index="2" name="right" type="RID"> - </argument> - <argument index="3" name="bottom" type="RID"> - </argument> + <method name="viewport_create"> + <return type="RID"> + </return> <description> </description> </method> - <method name="make_sphere_mesh"> + <method name="viewport_get_attached_camera" qualifiers="const"> <return type="RID"> </return> - <argument index="0" name="arg0" type="int"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="float"> + <argument index="0" name="arg0" type="RID"> </argument> <description> </description> </method> - <method name="mesh_add_surface_from_planes"> + <method name="viewport_get_rect" qualifiers="const"> + <return type="Rect2"> + </return> <argument index="0" name="arg0" type="RID"> </argument> - <argument index="1" name="arg1" type="Array"> - </argument> <description> </description> </method> - <method name="draw"> + <method name="viewport_get_scenario" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="arg0" type="RID"> + </argument> <description> </description> </method> - <method name="sync"> + <method name="viewport_remove_canvas"> + <argument index="0" name="arg0" type="RID"> + </argument> + <argument index="1" name="arg1" type="RID"> + </argument> <description> </description> </method> - <method name="free_rid"> + <method name="viewport_set_canvas_transform"> <argument index="0" name="arg0" type="RID"> </argument> + <argument index="1" name="arg1" type="RID"> + </argument> + <argument index="2" name="arg2" type="Matrix32"> + </argument> <description> </description> </method> - <method name="set_default_clear_color"> - <argument index="0" name="arg0" type="Color"> + <method name="viewport_set_global_canvas_transform"> + <argument index="0" name="arg0" type="RID"> + </argument> + <argument index="1" name="arg1" type="Matrix32"> </argument> <description> </description> </method> - <method name="get_render_info"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="int"> + <method name="viewport_set_rect"> + <argument index="0" name="arg0" type="RID"> + </argument> + <argument index="1" name="arg1" type="Rect2"> </argument> <description> </description> </method> </methods> <constants> - <constant name="NO_INDEX_ARRAY" value="-1"> - </constant> - <constant name="CUSTOM_ARRAY_SIZE" value="8"> - </constant> - <constant name="ARRAY_WEIGHTS_SIZE" value="4"> - </constant> - <constant name="MAX_PARTICLE_COLOR_PHASES" value="4"> - </constant> - <constant name="MAX_PARTICLE_ATTRACTORS" value="4"> + <constant name="ARRAY_VERTEX" value="0"> </constant> - <constant name="MAX_CURSORS" value="8"> + <constant name="ARRAY_FORMAT_VERTEX" value="1"> </constant> - <constant name="TEXTURE_FLAG_MIPMAPS" value="1"> + <constant name="ARRAY_NORMAL" value="1"> </constant> - <constant name="TEXTURE_FLAG_REPEAT" value="2"> + <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> </constant> - <constant name="TEXTURE_FLAG_FILTER" value="4"> + <constant name="ARRAY_FORMAT_TEX_UV" value="16"> </constant> - <constant name="TEXTURE_FLAG_CUBEMAP" value="2048"> + <constant name="ARRAY_FORMAT_NORMAL" value="2"> </constant> - <constant name="TEXTURE_FLAGS_DEFAULT" value="7"> + <constant name="ARRAY_TANGENT" value="2"> </constant> - <constant name="CUBEMAP_LEFT" value="0"> + <constant name="ARRAY_FORMAT_INDEX" value="256"> </constant> - <constant name="CUBEMAP_RIGHT" value="1"> + <constant name="ARRAY_COLOR" value="3"> </constant> - <constant name="CUBEMAP_BOTTOM" value="2"> + <constant name="ARRAY_FORMAT_TANGENT" value="4"> </constant> - <constant name="CUBEMAP_TOP" value="3"> + <constant name="ARRAY_TEX_UV" value="4"> </constant> - <constant name="CUBEMAP_FRONT" value="4"> + <constant name="ARRAY_WEIGHTS_SIZE" value="4"> </constant> - <constant name="CUBEMAP_BACK" value="5"> + <constant name="ARRAY_BONES" value="6"> </constant> - <constant name="SHADER_MATERIAL" value="0"> + <constant name="ARRAY_FORMAT_BONES" value="64"> </constant> - <constant name="SHADER_POST_PROCESS" value="2"> + <constant name="ARRAY_WEIGHTS" value="7"> </constant> - <constant name="MATERIAL_FLAG_VISIBLE" value="0"> + <constant name="ARRAY_FORMAT_COLOR" value="8"> </constant> - <constant name="MATERIAL_FLAG_DOUBLE_SIDED" value="1"> + <constant name="ARRAY_INDEX" value="8"> </constant> - <constant name="MATERIAL_FLAG_INVERT_FACES" value="2"> + <constant name="ARRAY_MAX" value="9"> </constant> - <constant name="MATERIAL_FLAG_UNSHADED" value="3"> + <constant name="CUBEMAP_LEFT" value="0"> </constant> - <constant name="MATERIAL_FLAG_ONTOP" value="4"> + <constant name="CUBEMAP_RIGHT" value="1"> </constant> - <constant name="MATERIAL_FLAG_MAX" value="7"> + <constant name="CUBEMAP_BOTTOM" value="2"> </constant> - <constant name="MATERIAL_BLEND_MODE_MIX" value="0"> + <constant name="CUBEMAP_TOP" value="3"> </constant> - <constant name="MATERIAL_BLEND_MODE_ADD" value="1"> + <constant name="CUBEMAP_FRONT" value="4"> </constant> - <constant name="MATERIAL_BLEND_MODE_SUB" value="2"> + <constant name="CUBEMAP_BACK" value="5"> </constant> - <constant name="MATERIAL_BLEND_MODE_MUL" value="3"> + <constant name="CUSTOM_ARRAY_SIZE" value="8"> </constant> <constant name="FIXED_MATERIAL_PARAM_DIFFUSE" value="0"> </constant> + <constant name="FIXED_MATERIAL_TEXCOORD_UV" value="0"> + </constant> <constant name="FIXED_MATERIAL_PARAM_DETAIL" value="1"> </constant> + <constant name="FIXED_MATERIAL_TEXCOORD_UV_TRANSFORM" value="1"> + </constant> <constant name="FIXED_MATERIAL_PARAM_SPECULAR" value="2"> </constant> + <constant name="FIXED_MATERIAL_TEXCOORD_UV2" value="2"> + </constant> <constant name="FIXED_MATERIAL_PARAM_EMISSION" value="3"> </constant> + <constant name="FIXED_MATERIAL_TEXCOORD_SPHERE" value="3"> + </constant> <constant name="FIXED_MATERIAL_PARAM_SPECULAR_EXP" value="4"> </constant> <constant name="FIXED_MATERIAL_PARAM_GLOW" value="5"> @@ -45588,153 +45658,153 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="FIXED_MATERIAL_PARAM_MAX" value="8"> </constant> - <constant name="FIXED_MATERIAL_TEXCOORD_SPHERE" value="3"> + <constant name="INFO_OBJECTS_IN_FRAME" value="0"> </constant> - <constant name="FIXED_MATERIAL_TEXCOORD_UV" value="0"> + <constant name="INFO_VERTICES_IN_FRAME" value="1"> </constant> - <constant name="FIXED_MATERIAL_TEXCOORD_UV_TRANSFORM" value="1"> + <constant name="INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> </constant> - <constant name="FIXED_MATERIAL_TEXCOORD_UV2" value="2"> + <constant name="INFO_SHADER_CHANGES_IN_FRAME" value="3"> </constant> - <constant name="ARRAY_VERTEX" value="0"> + <constant name="INFO_SURFACE_CHANGES_IN_FRAME" value="4"> </constant> - <constant name="ARRAY_NORMAL" value="1"> + <constant name="INFO_DRAW_CALLS_IN_FRAME" value="5"> </constant> - <constant name="ARRAY_TANGENT" value="2"> + <constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="6"> </constant> - <constant name="ARRAY_COLOR" value="3"> + <constant name="INFO_VIDEO_MEM_USED" value="7"> </constant> - <constant name="ARRAY_TEX_UV" value="4"> + <constant name="INFO_TEXTURE_MEM_USED" value="8"> </constant> - <constant name="ARRAY_BONES" value="6"> + <constant name="INFO_VERTEX_MEM_USED" value="9"> </constant> - <constant name="ARRAY_WEIGHTS" value="7"> + <constant name="INSTANCE_MESH" value="1"> </constant> - <constant name="ARRAY_INDEX" value="8"> + <constant name="INSTANCE_MULTIMESH" value="2"> </constant> - <constant name="ARRAY_MAX" value="9"> + <constant name="INSTANCE_GEOMETRY_MASK" value="30"> </constant> - <constant name="ARRAY_FORMAT_VERTEX" value="1"> + <constant name="INSTANCE_PARTICLES" value="4"> </constant> - <constant name="ARRAY_FORMAT_NORMAL" value="2"> + <constant name="INSTANCE_LIGHT" value="5"> </constant> - <constant name="ARRAY_FORMAT_TANGENT" value="4"> + <constant name="INSTANCE_ROOM" value="6"> </constant> - <constant name="ARRAY_FORMAT_COLOR" value="8"> + <constant name="INSTANCE_PORTAL" value="7"> </constant> - <constant name="ARRAY_FORMAT_TEX_UV" value="16"> + <constant name="LIGHT_COLOR_DIFFUSE" value="0"> </constant> - <constant name="ARRAY_FORMAT_BONES" value="64"> + <constant name="LIGHT_DIRECTIONAL" value="0"> </constant> - <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> + <constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="0"> </constant> - <constant name="ARRAY_FORMAT_INDEX" value="256"> + <constant name="LIGHT_COLOR_SPECULAR" value="1"> </constant> - <constant name="PRIMITIVE_POINTS" value="0"> + <constant name="LIGHT_OMNI" value="1"> </constant> - <constant name="PRIMITIVE_LINES" value="1"> + <constant name="LIGHT_PARAM_SPOT_ANGLE" value="1"> </constant> - <constant name="PRIMITIVE_LINE_STRIP" value="2"> + <constant name="LIGHT_PARAM_MAX" value="10"> </constant> - <constant name="PRIMITIVE_LINE_LOOP" value="3"> + <constant name="LIGHT_PARAM_RADIUS" value="2"> </constant> - <constant name="PRIMITIVE_TRIANGLES" value="4"> + <constant name="LIGHT_SPOT" value="2"> </constant> - <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> + <constant name="LIGHT_PARAM_ENERGY" value="3"> </constant> - <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> + <constant name="LIGHT_PARAM_ATTENUATION" value="4"> </constant> - <constant name="PRIMITIVE_MAX" value="7"> + <constant name="MATERIAL_BLEND_MODE_MIX" value="0"> </constant> - <constant name="PARTICLE_LIFETIME" value="0"> + <constant name="MATERIAL_FLAG_VISIBLE" value="0"> </constant> - <constant name="PARTICLE_SPREAD" value="1"> + <constant name="MATERIAL_BLEND_MODE_ADD" value="1"> </constant> - <constant name="PARTICLE_GRAVITY" value="2"> + <constant name="MATERIAL_FLAG_DOUBLE_SIDED" value="1"> </constant> - <constant name="PARTICLE_LINEAR_VELOCITY" value="3"> + <constant name="MATERIAL_BLEND_MODE_SUB" value="2"> </constant> - <constant name="PARTICLE_ANGULAR_VELOCITY" value="4"> + <constant name="MATERIAL_FLAG_INVERT_FACES" value="2"> </constant> - <constant name="PARTICLE_LINEAR_ACCELERATION" value="5"> + <constant name="MATERIAL_BLEND_MODE_MUL" value="3"> </constant> - <constant name="PARTICLE_RADIAL_ACCELERATION" value="6"> + <constant name="MATERIAL_FLAG_UNSHADED" value="3"> </constant> - <constant name="PARTICLE_TANGENTIAL_ACCELERATION" value="7"> + <constant name="MATERIAL_FLAG_ONTOP" value="4"> </constant> - <constant name="PARTICLE_INITIAL_SIZE" value="9"> + <constant name="MATERIAL_FLAG_MAX" value="7"> </constant> - <constant name="PARTICLE_FINAL_SIZE" value="10"> + <constant name="MAX_PARTICLE_ATTRACTORS" value="4"> </constant> - <constant name="PARTICLE_INITIAL_ANGLE" value="11"> + <constant name="MAX_PARTICLE_COLOR_PHASES" value="4"> </constant> - <constant name="PARTICLE_HEIGHT" value="12"> + <constant name="MAX_CURSORS" value="8"> </constant> - <constant name="PARTICLE_HEIGHT_SPEED_SCALE" value="13"> + <constant name="NO_INDEX_ARRAY" value="-1"> </constant> - <constant name="PARTICLE_VAR_MAX" value="14"> + <constant name="PARTICLE_LIFETIME" value="0"> </constant> - <constant name="LIGHT_DIRECTIONAL" value="0"> + <constant name="PARTICLE_SPREAD" value="1"> </constant> - <constant name="LIGHT_OMNI" value="1"> + <constant name="PARTICLE_FINAL_SIZE" value="10"> </constant> - <constant name="LIGHT_SPOT" value="2"> + <constant name="PARTICLE_INITIAL_ANGLE" value="11"> </constant> - <constant name="LIGHT_COLOR_DIFFUSE" value="0"> + <constant name="PARTICLE_HEIGHT" value="12"> </constant> - <constant name="LIGHT_COLOR_SPECULAR" value="1"> + <constant name="PARTICLE_HEIGHT_SPEED_SCALE" value="13"> </constant> - <constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="0"> + <constant name="PARTICLE_VAR_MAX" value="14"> </constant> - <constant name="LIGHT_PARAM_SPOT_ANGLE" value="1"> + <constant name="PARTICLE_GRAVITY" value="2"> </constant> - <constant name="LIGHT_PARAM_RADIUS" value="2"> + <constant name="PARTICLE_LINEAR_VELOCITY" value="3"> </constant> - <constant name="LIGHT_PARAM_ENERGY" value="3"> + <constant name="PARTICLE_ANGULAR_VELOCITY" value="4"> </constant> - <constant name="LIGHT_PARAM_ATTENUATION" value="4"> + <constant name="PARTICLE_LINEAR_ACCELERATION" value="5"> </constant> - <constant name="LIGHT_PARAM_MAX" value="10"> + <constant name="PARTICLE_RADIAL_ACCELERATION" value="6"> </constant> - <constant name="SCENARIO_DEBUG_DISABLED" value="0"> + <constant name="PARTICLE_TANGENTIAL_ACCELERATION" value="7"> </constant> - <constant name="SCENARIO_DEBUG_WIREFRAME" value="1"> + <constant name="PARTICLE_INITIAL_SIZE" value="9"> </constant> - <constant name="SCENARIO_DEBUG_OVERDRAW" value="2"> + <constant name="PRIMITIVE_POINTS" value="0"> </constant> - <constant name="INSTANCE_MESH" value="1"> + <constant name="PRIMITIVE_LINES" value="1"> </constant> - <constant name="INSTANCE_MULTIMESH" value="2"> + <constant name="PRIMITIVE_LINE_STRIP" value="2"> </constant> - <constant name="INSTANCE_PARTICLES" value="4"> + <constant name="PRIMITIVE_LINE_LOOP" value="3"> </constant> - <constant name="INSTANCE_LIGHT" value="5"> + <constant name="PRIMITIVE_TRIANGLES" value="4"> </constant> - <constant name="INSTANCE_ROOM" value="6"> + <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> </constant> - <constant name="INSTANCE_PORTAL" value="7"> + <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> </constant> - <constant name="INSTANCE_GEOMETRY_MASK" value="30"> + <constant name="PRIMITIVE_MAX" value="7"> </constant> - <constant name="INFO_OBJECTS_IN_FRAME" value="0"> + <constant name="SCENARIO_DEBUG_DISABLED" value="0"> </constant> - <constant name="INFO_VERTICES_IN_FRAME" value="1"> + <constant name="SCENARIO_DEBUG_WIREFRAME" value="1"> </constant> - <constant name="INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> + <constant name="SCENARIO_DEBUG_OVERDRAW" value="2"> </constant> - <constant name="INFO_SHADER_CHANGES_IN_FRAME" value="3"> + <constant name="SHADER_MATERIAL" value="0"> </constant> - <constant name="INFO_SURFACE_CHANGES_IN_FRAME" value="4"> + <constant name="SHADER_POST_PROCESS" value="2"> </constant> - <constant name="INFO_DRAW_CALLS_IN_FRAME" value="5"> + <constant name="TEXTURE_FLAG_MIPMAPS" value="1"> </constant> - <constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="6"> + <constant name="TEXTURE_FLAG_REPEAT" value="2"> </constant> - <constant name="INFO_VIDEO_MEM_USED" value="7"> + <constant name="TEXTURE_FLAG_CUBEMAP" value="2048"> </constant> - <constant name="INFO_TEXTURE_MEM_USED" value="8"> + <constant name="TEXTURE_FLAG_FILTER" value="4"> </constant> - <constant name="INFO_VERTEX_MEM_USED" value="9"> + <constant name="TEXTURE_FLAGS_DEFAULT" value="7"> </constant> </constants> </class> @@ -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. </description> <methods> - <method name="set_title"> - <argument index="0" name="title" type="String"> - </argument> + <method name="get_close_button"> + <return type="TextureButton"> + </return> <description> - Set the title of the window. + Return the close [TextureButton]. </description> </method> <method name="get_title" qualifiers="const"> @@ -45779,34 +45849,34 @@ This method controls whether the position between two cached points is interpola Return the title of the window. </description> </method> - <method name="get_close_button"> - <return type="TextureButton"> - </return> + <method name="set_title"> + <argument index="0" name="title" type="String"> + </argument> <description> - Return the close [TextureButton]. + Set the title of the window. </description> </method> </methods> <constants> </constants> <theme_items> - <theme_item name="close_h_ofs" type="int"> + <theme_item name="close" type="Texture"> </theme_item> - <theme_item name="titlebar_height" type="int"> + <theme_item name="close_h_ofs" type="int"> </theme_item> - <theme_item name="title_height" type="int"> + <theme_item name="close_hilite" type="Texture"> </theme_item> <theme_item name="close_v_ofs" type="int"> </theme_item> - <theme_item name="title_color" type="Color"> - </theme_item> - <theme_item name="close_hilite" type="Texture"> + <theme_item name="panel" type="StyleBox"> </theme_item> - <theme_item name="close" type="Texture"> + <theme_item name="title_color" type="Color"> </theme_item> <theme_item name="title_font" type="Font"> </theme_item> - <theme_item name="panel" type="StyleBox"> + <theme_item name="title_height" type="int"> + </theme_item> + <theme_item name="titlebar_height" type="int"> </theme_item> </theme_items> </class> @@ -45818,39 +45888,39 @@ 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. </description> <methods> - <method name="get_space" qualifiers="const"> - <return type="RID"> + <method name="get_direct_space_state"> + <return type="PhysicsDirectSpaceState"> </return> <description> </description> </method> - <method name="get_scenario" qualifiers="const"> - <return type="RID"> + <method name="get_environment" qualifiers="const"> + <return type="Environment"> </return> <description> </description> </method> - <method name="get_sound_space" qualifiers="const"> + <method name="get_scenario" qualifiers="const"> <return type="RID"> </return> <description> </description> </method> - <method name="set_environment"> - <argument index="0" name="env" type="Environment"> - </argument> + <method name="get_sound_space" qualifiers="const"> + <return type="RID"> + </return> <description> </description> </method> - <method name="get_environment" qualifiers="const"> - <return type="Environment"> + <method name="get_space" qualifiers="const"> + <return type="RID"> </return> <description> </description> </method> - <method name="get_direct_space_state"> - <return type="PhysicsDirectSpaceState"> - </return> + <method name="set_environment"> + <argument index="0" name="env" type="Environment"> + </argument> <description> </description> </method> @@ -45872,8 +45942,8 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_space"> - <return type="RID"> + <method name="get_direct_space_state"> + <return type="Physics2DDirectSpaceState"> </return> <description> </description> @@ -45884,8 +45954,8 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_direct_space_state"> - <return type="Physics2DDirectSpaceState"> + <method name="get_space"> + <return type="RID"> </return> <description> </description> @@ -45900,18 +45970,18 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="set_environment"> - <argument index="0" name="env" type="Environment"> - </argument> - <description> - </description> - </method> <method name="get_environment" qualifiers="const"> <return type="Environment"> </return> <description> </description> </method> + <method name="set_environment"> + <argument index="0" name="env" type="Environment"> + </argument> + <description> + </description> + </method> </methods> <constants> </constants> @@ -45922,76 +45992,76 @@ This method controls whether the position between two cached points is interpola <description> </description> <methods> - <method name="read"> + <method name="get_attribute_count" qualifiers="const"> <return type="int"> </return> <description> </description> </method> - <method name="get_node_type"> - <return type="int"> + <method name="get_attribute_name" qualifiers="const"> + <return type="String"> </return> + <argument index="0" name="idx" type="int"> + </argument> <description> </description> </method> - <method name="get_node_name" qualifiers="const"> + <method name="get_attribute_value" qualifiers="const"> <return type="String"> </return> + <argument index="0" name="idx" type="int"> + </argument> <description> </description> </method> - <method name="get_node_data" qualifiers="const"> - <return type="String"> + <method name="get_current_line" qualifiers="const"> + <return type="int"> </return> <description> </description> </method> - <method name="get_node_offset" qualifiers="const"> - <return type="int"> + <method name="get_named_attribute_value" qualifiers="const"> + <return type="String"> </return> + <argument index="0" name="name" type="String"> + </argument> <description> </description> </method> - <method name="get_attribute_count" qualifiers="const"> - <return type="int"> + <method name="get_named_attribute_value_safe" qualifiers="const"> + <return type="String"> </return> + <argument index="0" name="name" type="String"> + </argument> <description> </description> </method> - <method name="get_attribute_name" qualifiers="const"> + <method name="get_node_data" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="get_attribute_value" qualifiers="const"> + <method name="get_node_name" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="idx" type="int"> - </argument> <description> </description> </method> - <method name="has_attribute" qualifiers="const"> - <return type="bool"> + <method name="get_node_offset" qualifiers="const"> + <return type="int"> </return> - <argument index="0" name="name" type="String"> - </argument> <description> </description> </method> - <method name="get_named_attribute_value" qualifiers="const"> - <return type="String"> + <method name="get_node_type"> + <return type="int"> </return> - <argument index="0" name="name" type="String"> - </argument> <description> </description> </method> - <method name="get_named_attribute_value_safe" qualifiers="const"> - <return type="String"> + <method name="has_attribute" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="name" type="String"> </argument> @@ -46004,40 +46074,40 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_current_line" qualifiers="const"> + <method name="open"> <return type="int"> </return> + <argument index="0" name="file" type="String"> + </argument> <description> </description> </method> - <method name="skip_section"> - <description> - </description> - </method> - <method name="seek"> + <method name="open_buffer"> <return type="int"> </return> - <argument index="0" name="pos" type="int"> + <argument index="0" name="buffer" type="RawArray"> </argument> <description> </description> </method> - <method name="open"> + <method name="read"> <return type="int"> </return> - <argument index="0" name="file" type="String"> - </argument> <description> </description> </method> - <method name="open_buffer"> + <method name="seek"> <return type="int"> </return> - <argument index="0" name="buffer" type="RawArray"> + <argument index="0" name="pos" type="int"> </argument> <description> </description> </method> + <method name="skip_section"> + <description> + </description> + </method> </methods> <constants> <constant name="NODE_NONE" value="0"> @@ -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. </description> <methods> - <method name="set_sort_enabled"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Set whether the children nodes are sorted or not. (default true) - </description> - </method> <method name="is_sort_enabled" qualifiers="const"> <return type="bool"> </return> @@ -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. </description> </method> + <method name="set_sort_enabled"> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set whether the children nodes are sorted or not. (default true) + </description> + </method> </methods> <constants> </constants> |