summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/base/classes.xml86
1 files changed, 79 insertions, 7 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 75f28e5c40..9577fb2aa9 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -8288,8 +8288,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 +8300,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 +8316,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 +8325,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 +8334,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 +8343,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 +8352,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 +23007,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 +23085,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 +23101,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 +23110,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 +23119,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 +23128,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 +23137,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 +23167,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 +23243,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 +23358,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>
@@ -27518,6 +27568,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="minsize" type="Vector2" default="Vector2(0,0)">
</argument>
<description>
+ 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">
@@ -27529,18 +27580,21 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="enable" type="bool">
</argument>
<description>
+ 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">
<description>
+ This signal is emitted when a popup is hidden.
</description>
</signal>
<signal name="about_to_show">
@@ -27551,8 +27605,10 @@ This method controls whether the position between two cached points is interpola
</signals>
<constants>
<constant name="NOTIFICATION_POST_POPUP" value="80">
+ Notification sent right after the popup is shown.
</constant>
<constant name="NOTIFICATION_POPUP_HIDE" value="81">
+ Notification sent right after the popup is hidden.
</constant>
</constants>
</class>
@@ -27561,6 +27617,7 @@ This method controls whether the position between two cached points is interpola
Base class for Popup Dialogs.
</brief_description>
<description>
+ PopupDialog is a base class for popup dialogs, along with [WindowDialog].
</description>
<methods>
</methods>
@@ -27585,7 +27642,7 @@ This method controls whether the position between two cached points is interpola
<argument index="3" 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. If no id is 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_item">
@@ -27596,7 +27653,7 @@ This method controls whether the position between two cached points is interpola
<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. If no id is provided, one will be created from the index.
+ 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">
@@ -27609,7 +27666,7 @@ This method controls whether the position between two cached points is interpola
<argument index="3" name="accel" type="int" default="0">
</argument>
<description>
- Add a new check able item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
+ Add a new 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">
@@ -27631,6 +27688,7 @@ This method controls whether the position between two cached points is interpola
<argument index="2" name="id" type="int" default="-1">
</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.
</description>
</method>
<method name="set_item_text">
@@ -27666,6 +27724,7 @@ This method controls whether the position between two cached points is interpola
<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.
</description>
</method>
<method name="set_item_checked">
@@ -27683,6 +27742,7 @@ This method controls whether the position between two cached points is interpola
<argument index="1" name="disabled" type="bool">
</argument>
<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.
</description>
</method>
<method name="set_item_submenu">
@@ -27691,6 +27751,7 @@ This method controls whether the position between two cached points is interpola
<argument index="1" name="submenu" type="String">
</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.
</description>
</method>
<method name="set_item_as_separator">
@@ -27699,6 +27760,7 @@ This method controls whether the position between two cached points is interpola
<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.
</description>
</method>
<method name="set_item_as_checkable">
@@ -27707,6 +27769,7 @@ This method controls whether the position between two cached points is interpola
<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">
@@ -27740,6 +27803,7 @@ This method controls whether the position between two cached points is interpola
<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.
</description>
</method>
<method name="get_item_accelerator" qualifiers="const">
@@ -27757,6 +27821,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="idx" type="int">
</argument>
<description>
+ Return the submenu name of the item at index "idx".
</description>
</method>
<method name="is_item_separator" qualifiers="const">
@@ -27765,6 +27830,7 @@ This method controls whether the position between two cached points is interpola
<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="is_item_checkable" qualifiers="const">
@@ -27773,6 +27839,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="idx" 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.
</description>
</method>
<method name="is_item_checked" qualifiers="const">
@@ -27790,6 +27857,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="idx" type="int">
</argument>
<description>
+ 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_ID" qualifiers="const">
@@ -27826,11 +27894,12 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="idx" type="int">
</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">
<description>
- Clear the popup menu.
+ Clear the popup menu, in effect removing all items.
</description>
</method>
</methods>
@@ -27878,9 +27947,10 @@ This method controls whether the position between two cached points is interpola
</class>
<class name="PopupPanel" inherits="Popup" category="Core">
<brief_description>
- Base class for Popup Panels
+ Class for displaying popups with a panel background.
</brief_description>
<description>
+ Class for displaying popups with a panel background. In some cases it might be simpler to use than [Popup], since it provides a configurable background. If you are making windows, better check [WindowDialog].
</description>
<methods>
</methods>
@@ -39638,9 +39708,11 @@ This method controls whether the position between two cached points is interpola
</constant>
<constant name="CELL_MODE_RANGE" value="2">
</constant>
- <constant name="CELL_MODE_ICON" value="3">
+ <constant name="CELL_MODE_RANGE_EXPRESSION" value="3">
</constant>
- <constant name="CELL_MODE_CUSTOM" value="4">
+ <constant name="CELL_MODE_ICON" value="4">
+ </constant>
+ <constant name="CELL_MODE_CUSTOM" value="5">
</constant>
</constants>
</class>
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-27 23:11:31 +0000