summaryrefslogtreecommitdiff
path: root/doc/base
diff options
context:
space:
mode:
Diffstat (limited to 'doc/base')
-rw-r--r--doc/base/classes.xml72
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 88274a4516..dd0b729286 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -2735,12 +2735,14 @@
<argument index="1" name="custom_blend" type="float" default="-1">
</argument>
<description>
+ Play a given animation by the animation name in reverse.
</description>
</method>
<method name="stop">
<argument index="0" name="reset" type="bool" default="true">
</argument>
<description>
+ Stop the currently playing animation.
</description>
</method>
<method name="stop_all">
@@ -2900,6 +2902,7 @@
<argument index="0" name="delta" type="float">
</argument>
<description>
+ Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip.
</description>
</method>
</methods>
@@ -2908,6 +2911,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
+ Notifies when an animation starts playing.
</description>
</signal>
<signal name="animation_changed">
@@ -8288,8 +8292,10 @@
</class>
<class name="ColorRamp" inherits="Resource" category="Core">
<brief_description>
+ Color interpolator node
</brief_description>
<description>
+ Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset offset 0 and the other (white) at the ramp higher offset 1.
</description>
<methods>
<method name="add_point">
@@ -8298,12 +8304,14 @@
<argument index="1" name="color" type="Color">
</argument>
<description>
+ 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">
</argument>
<description>
+ Removes the color at the index [i]offset[/i]
</description>
</method>
<method name="set_offset">
@@ -8312,6 +8320,7 @@
<argument index="1" name="offset" type="float">
</argument>
<description>
+ Sets the offset for the ramp color at index [i]point[/i]
</description>
</method>
<method name="get_offset" qualifiers="const">
@@ -8320,6 +8329,7 @@
<argument index="0" name="point" type="int">
</argument>
<description>
+ Returns the offset of the ramp color at index [i]point[/i]
</description>
</method>
<method name="set_color">
@@ -8328,6 +8338,7 @@
<argument index="1" name="color" type="Color">
</argument>
<description>
+ Sets the color of the ramp color at index [i]point[/i]
</description>
</method>
<method name="get_color" qualifiers="const">
@@ -8336,6 +8347,7 @@
<argument index="0" name="point" type="int">
</argument>
<description>
+ Returns the color of the ramp color at index [i]point[/i]
</description>
</method>
<method name="interpolate">
@@ -8344,36 +8356,42 @@
<argument index="0" name="offset" type="float">
</argument>
<description>
+ 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">
</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>
<method name="get_offsets" qualifiers="const">
<return type="RealArray">
</return>
<description>
+ Returns the offsets for the colors in this ramp
</description>
</method>
<method name="set_colors">
<argument index="0" name="colors" type="ColorArray">
</argument>
<description>
+ 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>
<description>
+ Returns the colors in the ramp
</description>
</method>
</methods>
@@ -22993,56 +23011,66 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
</class>
<class name="Particles2D" inherits="Node2D" category="Core">
<brief_description>
+ 2D Particle emitter
</brief_description>
<description>
+ 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>
<description>
+ If this is set to true then the particle emitter will emit particles, if its false it will not.
</description>
</method>
<method name="is_emitting" qualifiers="const">
<return type="bool">
</return>
<description>
+ Returns whether this emitter is currently emitting or not
</description>
</method>
<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="get_amount" 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>
<description>
+ Sets the amount of seconds that each particle will be visible.
</description>
</method>
<method name="get_lifetime" qualifiers="const">
<return type="float">
</return>
<description>
+ Gets the amount of seconds that each particle will be visible.
</description>
</method>
<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="get_time_scale" qualifiers="const">
<return type="float">
</return>
<description>
+ Returns the emitter time scale
</description>
</method>
<method name="set_pre_process_time">
@@ -23061,12 +23089,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<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="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="set_param">
@@ -23075,6 +23105,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<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="get_param" qualifiers="const">
@@ -23083,6 +23114,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<argument index="0" name="param" type="int">
</argument>
<description>
+ Returns the value of the specified emitter parameter
</description>
</method>
<method name="set_randomness">
@@ -23091,6 +23123,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<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="get_randomness" qualifiers="const">
@@ -23099,6 +23132,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<argument index="0" name="param" type="int">
</argument>
<description>
+ Returns the randomness value of the specified emitter parameter
</description>
</method>
<method name="set_texture">
@@ -23107,24 +23141,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<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>
<description>
+ Returns the texture for emitted particles
</description>
</method>
<method name="set_color">
<argument index="0" name="color" type="Color">
</argument>
<description>
+ Set the tint color for each particle.
</description>
</method>
<method name="get_color" qualifiers="const">
<return type="Color">
</return>
<description>
+ Returns the tint color for each particle.
</description>
</method>
<method name="set_color_ramp">
@@ -23133,24 +23171,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<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="get_color_ramp" qualifiers="const">
<return type="ColorRamp">
</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>
<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">
</return>
<description>
+ Returns the particle spawn origin position relative to the emitter.
</description>
</method>
<method name="set_flip_h">
@@ -23205,12 +23247,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<argument index="0" name="extents" type="Vector2">
</argument>
<description>
+ 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>
<description>
+ Returns the half extents of the emission box.
</description>
</method>
<method name="set_color_phases">
@@ -23318,30 +23362,40 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
</methods>
<constants>
<constant name="PARAM_DIRECTION" value="0">
+ Direction in degrees 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_LINEAR_VELOCITY" value="2">
+ Velocity at which the particles will be launched.
</constant>
<constant name="PARAM_SPIN_VELOCITY" value="3">
+ The speed at which particles will spin around its own center.
</constant>
<constant name="PARAM_ORBIT_VELOCITY" value="4">
+ Velocity at which the particles will orbit around the emitter center
</constant>
<constant name="PARAM_GRAVITY_DIRECTION" value="5">
+ Direction in degrees at which the particles will be attracted
</constant>
<constant name="PARAM_GRAVITY_STRENGTH" value="6">
+ Strength of the gravitation attraction for each particle
</constant>
<constant name="PARAM_RADIAL_ACCEL" value="7">
</constant>
<constant name="PARAM_TANGENTIAL_ACCEL" value="8">
</constant>
<constant name="PARAM_DAMPING" value="9">
+ Amount of damping for each particle
</constant>
<constant name="PARAM_INITIAL_ANGLE" value="10">
+ Initial angle 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>
@@ -38485,6 +38539,7 @@ This method controls whether the position between two cached points is interpola
</class>
<class name="Timer" inherits="Node" category="Core">
<brief_description>
+ A simple Timer node.
</brief_description>
<description>
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.
@@ -38546,12 +38601,14 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="active" type="bool">
</argument>
<description>
+ 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>
<description>
+ Return if the timer is active or not.
</description>
</method>
<method name="get_time_left" qualifiers="const">
@@ -43834,20 +43891,24 @@ This method controls whether the position between two cached points is interpola
</class>
<class name="YSort" inherits="Node2D" category="Core">
<brief_description>
+ Sort all child nodes based on their Y positions.
</brief_description>
<description>
+ 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>
<description>
+ Returns true if the children nodes are being sorted.
</description>
</method>
</methods>
@@ -43868,6 +43929,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="int">
</argument>
<description>
+ Cast an [int] value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case.
</description>
</method>
<method name="bool">
@@ -43876,6 +43938,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="float">
</argument>
<description>
+ Cast a [float] value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case.
</description>
</method>
<method name="bool">
@@ -43884,6 +43947,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="String">
</argument>
<description>
+ Cast a [String] value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: [code]bool('False')[/code] returns true, [code]bool('')[/code]. returns false
</description>
</method>
</methods>
@@ -43892,8 +43956,10 @@ This method controls whether the position between two cached points is interpola
</class>
<class name="float" category="Built-In Types">
<brief_description>
+ Float built-in type
</brief_description>
<description>
+ Float built-in type.
</description>
<methods>
<method name="float">
@@ -43902,6 +43968,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="bool">
</argument>
<description>
+ Cast a [bool] value to a floating point value, [code]float(true)[/code] will be equals to 1.0 and [code]float(false)[/code] will be equals to 0.0.
</description>
</method>
<method name="float">
@@ -43910,6 +43977,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="int">
</argument>
<description>
+ Cast an [int] value to a floating point value, [code]float(1)[/code] will be equals to 1.0.
</description>
</method>
<method name="float">
@@ -43918,6 +43986,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="String">
</argument>
<description>
+ Cast a [String] value to a floating point value. This method accepts float value strings like [code] '1.23' [/code] and exponential notation strings for its parameter so calling [code] float('1e3') [/code] will return 1000.0 and calling [code] float('1e-3') [/code] will return -0.001.
</description>
</method>
</methods>
@@ -43938,6 +44007,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="bool">
</argument>
<description>
+ Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0.
</description>
</method>
<method name="int">
@@ -43946,6 +44016,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="float">
</argument>
<description>
+ Cast a float value to an integer value, this method simply removes the number fractions, so for example [code]int(2.7)[/code] will be equals to 2, [code]int(.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2.
</description>
</method>
<method name="int">
@@ -43954,6 +44025,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="String">
</argument>
<description>
+ Cast a [String] value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like [code]'1.7'[/code]. This method will ignore all non-number characters, so calling [code]int('1e3')[/code] will return 13.
</description>
</method>
</methods>
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-16 15:31:46 +0000