doc: Fix invalid tags or properties introduced in recent cherry-picks
This commit is contained in:
Rémi Verschelde
parent
2a9c2d95f5
commit
a5082c010a
|
|
@ -4,10 +4,10 @@
|
||||||
Blends two of three animations additively inside of an [AnimationNodeBlendTree].
|
Blends two of three animations additively inside of an [AnimationNodeBlendTree].
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
A resource to add to an [AnimationNodeBlendTree]. Blends two animations together additively out of three based on a value in the [-1.0, 1.0] range.
|
A resource to add to an [AnimationNodeBlendTree]. Blends two animations together additively out of three based on a value in the [code][-1.0, 1.0][/code] range.
|
||||||
This node has three inputs:
|
This node has three inputs:
|
||||||
- The base animation to add to
|
- The base animation to add to
|
||||||
- A -add animation to blend with when the blend amount is in the [-1.0, 0.0] range.
|
- A -add animation to blend with when the blend amount is in the [code][-1.0, 0.0][/code] range.
|
||||||
- A +add animation to blend with when the blend amount is in the [code][0.0, 1.0][/code] range
|
- A +add animation to blend with when the blend amount is in the [code][0.0, 1.0][/code] range
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
|
|
|
||||||
|
|
@ -4,10 +4,10 @@
|
||||||
Blends two of three animations linearly inside of an [AnimationNodeBlendTree].
|
Blends two of three animations linearly inside of an [AnimationNodeBlendTree].
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
A resource to add to an [AnimationNodeBlendTree]. Blends two animations together linearly out of three based on a value in the [-1.0, 1.0] range.
|
A resource to add to an [AnimationNodeBlendTree]. Blends two animations together linearly out of three based on a value in the [code][-1.0, 1.0][/code] range.
|
||||||
This node has three inputs:
|
This node has three inputs:
|
||||||
- The base animation
|
- The base animation
|
||||||
- A -blend animation to blend with when the blend amount is in the [-1.0, 0.0] range.
|
- A -blend animation to blend with when the blend amount is in the [code][-1.0, 0.0][/code] range.
|
||||||
- A +blend animation to blend with when the blend amount is in the [code][0.0, 1.0][/code] range
|
- A +blend animation to blend with when the blend amount is in the [code][0.0, 1.0][/code] range
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
|
|
|
||||||
|
|
@ -161,7 +161,7 @@
|
||||||
The blend space plays the animation of the node the blending position is closest to. Useful for frame-by-frame 2D animations.
|
The blend space plays the animation of the node the blending position is closest to. Useful for frame-by-frame 2D animations.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="BLEND_MODE_DISCRETE_CARRY" value="2" enum="BlendMode">
|
<constant name="BLEND_MODE_DISCRETE_CARRY" value="2" enum="BlendMode">
|
||||||
Similar to [const BLEND_MODE_DISCRETE], but starts the new animation at the last animation's playback position.
|
Similar to [constant BLEND_MODE_DISCRETE], but starts the new animation at the last animation's playback position.
|
||||||
</constant>
|
</constant>
|
||||||
</constants>
|
</constants>
|
||||||
</class>
|
</class>
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,7 @@
|
||||||
Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the [AnimationTree] that can be controlled from code (see [url=https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#controlling-from-code][/url]). For example, if [member AnimationTree.tree_root] is an [AnimationNodeStateMachine] and [member advance_condition] is set to "idle":
|
Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the [AnimationTree] that can be controlled from code (see [url=https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#controlling-from-code][/url]). For example, if [member AnimationTree.tree_root] is an [AnimationNodeStateMachine] and [member advance_condition] is set to "idle":
|
||||||
[codeblock]
|
[codeblock]
|
||||||
$animation_tree["parameters/conditions/idle"] = is_on_floor and linear_velocity.x == 0
|
$animation_tree["parameters/conditions/idle"] = is_on_floor and linear_velocity.x == 0
|
||||||
[codeblock]
|
[/codeblock]
|
||||||
</member>
|
</member>
|
||||||
<member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance">
|
<member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance">
|
||||||
Turn on the transition automatically when this state is reached. This works best with [constant SWITCH_MODE_AT_END].
|
Turn on the transition automatically when this state is reached. This works best with [constant SWITCH_MODE_AT_END].
|
||||||
|
|
|
||||||
|
|
@ -36,6 +36,8 @@
|
||||||
<member name="bake_energy" type="float" setter="set_energy" getter="get_energy">
|
<member name="bake_energy" type="float" setter="set_energy" getter="get_energy">
|
||||||
Multiplies the light sources' intensity by this value. For instance, if the value is set to 2, lights will be twice as bright. If the value is set to 0.5, lights will be half as bright.
|
Multiplies the light sources' intensity by this value. For instance, if the value is set to 2, lights will be twice as bright. If the value is set to 0.5, lights will be half as bright.
|
||||||
</member>
|
</member>
|
||||||
|
<member name="bake_extents" type="Vector3" setter="set_extents" getter="get_extents">
|
||||||
|
</member>
|
||||||
<member name="bake_hdr" type="bool" setter="set_hdr" getter="is_hdr">
|
<member name="bake_hdr" type="bool" setter="set_hdr" getter="is_hdr">
|
||||||
If [code]true[/code], lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller lightmap. Default value:[code]false[/code].
|
If [code]true[/code], lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller lightmap. Default value:[code]false[/code].
|
||||||
</member>
|
</member>
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
Joint used with [Skeleton2D] to control and animate other nodes.
|
Joint used with [Skeleton2D] to control and animate other nodes.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
Use a hierarchy of [code]Bone2D[/code] bound to a [Skeleton2D] to control, and animate other [class Node2D] nodes.
|
Use a hierarchy of [code]Bone2D[/code] bound to a [Skeleton2D] to control, and animate other [Node2D] nodes.
|
||||||
You can use [code]Bone2D[/code] and [code]Skeleton2D[/code] nodes to animate 2D meshes created with the Polygon 2D UV editor.
|
You can use [code]Bone2D[/code] and [code]Skeleton2D[/code] nodes to animate 2D meshes created with the Polygon 2D UV editor.
|
||||||
Each bone has a [member rest] transform that you can reset to with [method apply_rest]. These rest poses are relative to the bone's parent.
|
Each bone has a [member rest] transform that you can reset to with [method apply_rest]. These rest poses are relative to the bone's parent.
|
||||||
If in the editor, you can set the rest pose of an entire skeleton using a menu option, from the code, you need to iterate over the bones to set their individual rest poses.
|
If in the editor, you can set the rest pose of an entire skeleton using a menu option, from the code, you need to iterate over the bones to set their individual rest poses.
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
Length of the bone's representation drawn in the editor's viewport in pixels.
|
Length of the bone's representation drawn in the editor's viewport in pixels.
|
||||||
</member>
|
</member>
|
||||||
<member name="rest" type="Transform2D" setter="set_rest" getter="get_rest">
|
<member name="rest" type="Transform2D" setter="set_rest" getter="get_rest">
|
||||||
Rest transform of the bone. You can reset the node's transforms to this value using [member apply_rest].
|
Rest transform of the bone. You can reset the node's transforms to this value using [method apply_rest].
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
<constants>
|
<constants>
|
||||||
|
|
|
||||||
|
|
@ -68,10 +68,10 @@
|
||||||
Animation speed randomness ratio. Default value: [code]0[/code].
|
Animation speed randomness ratio. Default value: [code]0[/code].
|
||||||
</member>
|
</member>
|
||||||
<member name="color" type="Color" setter="set_color" getter="get_color">
|
<member name="color" type="Color" setter="set_color" getter="get_color">
|
||||||
Each particle's initial color. If [member texture] is defined, it will be multiplied by this color.
|
Unused for 3D particles.
|
||||||
</member>
|
</member>
|
||||||
<member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp">
|
<member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp">
|
||||||
Each particle's color will vary along this [Gradient].
|
Unused for 3D particles.
|
||||||
</member>
|
</member>
|
||||||
<member name="damping" type="float" setter="set_param" getter="get_param">
|
<member name="damping" type="float" setter="set_param" getter="get_param">
|
||||||
The rate at which particles lose velocity.
|
The rate at which particles lose velocity.
|
||||||
|
|
@ -86,7 +86,7 @@
|
||||||
Particle draw order. Uses [enum DrawOrder] values. Default value: [constant DRAW_ORDER_INDEX].
|
Particle draw order. Uses [enum DrawOrder] values. Default value: [constant DRAW_ORDER_INDEX].
|
||||||
</member>
|
</member>
|
||||||
<member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents">
|
<member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents">
|
||||||
The rectangle's extents if [member emission_shape] is set to [const EMISSION_SHAPE_BOX].
|
The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX].
|
||||||
</member>
|
</member>
|
||||||
<member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors">
|
<member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors">
|
||||||
</member>
|
</member>
|
||||||
|
|
@ -219,37 +219,34 @@
|
||||||
<constant name="PARAM_ANGULAR_VELOCITY" value="1" enum="Parameter">
|
<constant name="PARAM_ANGULAR_VELOCITY" value="1" enum="Parameter">
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angular velocity properties.
|
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angular velocity properties.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="PARAM_ORBIT_VELOCITY" value="2" enum="Parameter">
|
<constant name="PARAM_LINEAR_ACCEL" value="2" enum="Parameter">
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set orbital velocity properties.
|
|
||||||
</constant>
|
|
||||||
<constant name="PARAM_LINEAR_ACCEL" value="3" enum="Parameter">
|
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set linear acceleration properties.
|
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set linear acceleration properties.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="PARAM_RADIAL_ACCEL" value="4" enum="Parameter">
|
<constant name="PARAM_RADIAL_ACCEL" value="3" enum="Parameter">
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set radial acceleration properties.
|
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set radial acceleration properties.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="PARAM_TANGENTIAL_ACCEL" value="5" enum="Parameter">
|
<constant name="PARAM_TANGENTIAL_ACCEL" value="4" enum="Parameter">
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set tangential acceleration properties.
|
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set tangential acceleration properties.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="PARAM_DAMPING" value="6" enum="Parameter">
|
<constant name="PARAM_DAMPING" value="5" enum="Parameter">
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set damping properties.
|
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set damping properties.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="PARAM_ANGLE" value="7" enum="Parameter">
|
<constant name="PARAM_ANGLE" value="6" enum="Parameter">
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angle properties.
|
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angle properties.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="PARAM_SCALE" value="8" enum="Parameter">
|
<constant name="PARAM_SCALE" value="7" enum="Parameter">
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set scale properties.
|
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set scale properties.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="PARAM_HUE_VARIATION" value="9" enum="Parameter">
|
<constant name="PARAM_HUE_VARIATION" value="8" enum="Parameter">
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set hue variation properties.
|
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set hue variation properties.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="PARAM_ANIM_SPEED" value="10" enum="Parameter">
|
<constant name="PARAM_ANIM_SPEED" value="9" enum="Parameter">
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation speed properties.
|
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation speed properties.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="PARAM_ANIM_OFFSET" value="11" enum="Parameter">
|
<constant name="PARAM_ANIM_OFFSET" value="10" enum="Parameter">
|
||||||
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation offset properties.
|
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation offset properties.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="PARAM_MAX" value="12" enum="Parameter">
|
<constant name="PARAM_MAX" value="11" enum="Parameter">
|
||||||
Represents the size of the [enum Parameter] enum.
|
Represents the size of the [enum Parameter] enum.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="Flags">
|
<constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="Flags">
|
||||||
|
|
@ -271,10 +268,10 @@
|
||||||
Particles will be emitted in the volume of a box.
|
Particles will be emitted in the volume of a box.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape">
|
<constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape">
|
||||||
Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle color will be modulated by [member emission_color_texture].
|
Particles will be emitted at a position chosen randomly among [member emission_points]. Particle color will be modulated by [member emission_colors].
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
|
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
|
||||||
Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture].
|
Particles will be emitted at a position chosen randomly among [member emission_points]. Particle velocity and rotation will be set based on [member emission_normals]. Particle color will be modulated by [member emission_colors].
|
||||||
</constant>
|
</constant>
|
||||||
</constants>
|
</constants>
|
||||||
</class>
|
</class>
|
||||||
|
|
|
||||||
|
|
@ -93,13 +93,13 @@
|
||||||
<member name="emission_points" type="PoolVector2Array" setter="set_emission_points" getter="get_emission_points">
|
<member name="emission_points" type="PoolVector2Array" setter="set_emission_points" getter="get_emission_points">
|
||||||
</member>
|
</member>
|
||||||
<member name="emission_rect_extents" type="Vector2" setter="set_emission_rect_extents" getter="get_emission_rect_extents">
|
<member name="emission_rect_extents" type="Vector2" setter="set_emission_rect_extents" getter="get_emission_rect_extents">
|
||||||
The rectangle's extents if [member emission_shape] is set to [const EMISSION_SHAPE_RECTANGLE].
|
The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_RECTANGLE].
|
||||||
</member>
|
</member>
|
||||||
<member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles2D.EmissionShape">
|
<member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles2D.EmissionShape">
|
||||||
Particles will be emitted inside this region. Use [enum EmissionShape] for values. Default value: [constant EMISSION_SHAPE_POINT].
|
Particles will be emitted inside this region. Use [enum EmissionShape] for values. Default value: [constant EMISSION_SHAPE_POINT].
|
||||||
</member>
|
</member>
|
||||||
<member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius">
|
<member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius">
|
||||||
The circle's radius if [member emission_shape] is set to [const EMISSION_SHAPE_CIRCLE].
|
The circle's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_CIRCLE].
|
||||||
</member>
|
</member>
|
||||||
<member name="emitting" type="bool" setter="set_emitting" getter="is_emitting">
|
<member name="emitting" type="bool" setter="set_emitting" getter="is_emitting">
|
||||||
If [code]true[/code], particles are being emitted. Default value: [code]true[/code].
|
If [code]true[/code], particles are being emitted. Default value: [code]true[/code].
|
||||||
|
|
@ -261,10 +261,10 @@
|
||||||
Particles will be emitted in the area of a rectangle.
|
Particles will be emitted in the area of a rectangle.
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape">
|
<constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape">
|
||||||
Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle color will be modulated by [member emission_color_texture].
|
Particles will be emitted at a position chosen randomly among [member emission_points]. Particle color will be modulated by [member emission_colors].
|
||||||
</constant>
|
</constant>
|
||||||
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
|
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
|
||||||
Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture].
|
Particles will be emitted at a position chosen randomly among [member emission_points]. Particle velocity and rotation will be set based on [member emission_normals]. Particle color will be modulated by [member emission_colors].
|
||||||
</constant>
|
</constant>
|
||||||
</constants>
|
</constants>
|
||||||
</class>
|
</class>
|
||||||
|
|
|
||||||
|
|
@ -94,7 +94,7 @@
|
||||||
<argument index="0" name="path" type="String">
|
<argument index="0" name="path" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [constant OK], [constant FAILED] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [constant OK].
|
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [constant @GlobalScope.OK], [constant @GlobalScope.FAILED] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [constant @GlobalScope.OK].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="save">
|
<method name="save">
|
||||||
|
|
@ -103,7 +103,7 @@
|
||||||
<argument index="0" name="path" type="String">
|
<argument index="0" name="path" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [constant OK], [constant FAILED] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [constant OK].
|
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [constant @GlobalScope.OK], [constant @GlobalScope.FAILED] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [constant @GlobalScope.OK].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="set_value">
|
<method name="set_value">
|
||||||
|
|
|
||||||
|
|
@ -684,7 +684,7 @@
|
||||||
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents">
|
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents">
|
||||||
Enables whether rendering of children should be clipped to this control's rectangle. If [code]true[/code], parts of a child which would be visibly outside of this control's rectangle will not be rendered.
|
Enables whether rendering of children should be clipped to this control's rectangle. If [code]true[/code], parts of a child which would be visibly outside of this control's rectangle will not be rendered.
|
||||||
</member>
|
</member>
|
||||||
<member name="rect_global_position" type="Vector2" setter="_set_global_position" getter="get_global_position">
|
<member name="rect_global_position" type="Vector2" setter="set_global_position" getter="get_global_position">
|
||||||
The node's global position, relative to the world (usually to the top-left corner of the window).
|
The node's global position, relative to the world (usually to the top-left corner of the window).
|
||||||
</member>
|
</member>
|
||||||
<member name="rect_min_size" type="Vector2" setter="set_custom_minimum_size" getter="get_custom_minimum_size">
|
<member name="rect_min_size" type="Vector2" setter="set_custom_minimum_size" getter="get_custom_minimum_size">
|
||||||
|
|
@ -693,7 +693,7 @@
|
||||||
<member name="rect_pivot_offset" type="Vector2" setter="set_pivot_offset" getter="get_pivot_offset">
|
<member name="rect_pivot_offset" type="Vector2" setter="set_pivot_offset" getter="get_pivot_offset">
|
||||||
By default, the node's pivot is its top-left corner. When you change its [member rect_scale], it will scale around this pivot. Set this property to [member rect_size] / 2 to center the pivot in the node's rectangle.
|
By default, the node's pivot is its top-left corner. When you change its [member rect_scale], it will scale around this pivot. Set this property to [member rect_size] / 2 to center the pivot in the node's rectangle.
|
||||||
</member>
|
</member>
|
||||||
<member name="rect_position" type="Vector2" setter="_set_position" getter="get_position">
|
<member name="rect_position" type="Vector2" setter="set_position" getter="get_position">
|
||||||
The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by [member rect_pivot_offset].
|
The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by [member rect_pivot_offset].
|
||||||
</member>
|
</member>
|
||||||
<member name="rect_rotation" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
|
<member name="rect_rotation" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
|
||||||
|
|
@ -702,7 +702,7 @@
|
||||||
<member name="rect_scale" type="Vector2" setter="set_scale" getter="get_scale">
|
<member name="rect_scale" type="Vector2" setter="set_scale" getter="get_scale">
|
||||||
The node's scale, relative to its [member rect_size]. Change this property to scale the node around its [member rect_pivot_offset].
|
The node's scale, relative to its [member rect_size]. Change this property to scale the node around its [member rect_pivot_offset].
|
||||||
</member>
|
</member>
|
||||||
<member name="rect_size" type="Vector2" setter="_set_size" getter="get_size">
|
<member name="rect_size" type="Vector2" setter="set_size" getter="get_size">
|
||||||
The size of the node's bounding rectangle, in pixels. [Container] nodes update this property automatically.
|
The size of the node's bounding rectangle, in pixels. [Container] nodes update this property automatically.
|
||||||
</member>
|
</member>
|
||||||
<member name="size_flags_horizontal" type="int" setter="set_h_size_flags" getter="get_h_size_flags">
|
<member name="size_flags_horizontal" type="int" setter="set_h_size_flags" getter="get_h_size_flags">
|
||||||
|
|
|
||||||
|
|
@ -73,7 +73,7 @@
|
||||||
<argument index="0" name="idx" type="int">
|
<argument index="0" name="idx" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns the [Color] set by [member set_custom_bg_color]. Default value is [code]Color(0, 0, 0, 0)[/code].
|
Returns the [Color] set by [method set_item_custom_bg_color]. Default value is [code]Color(0, 0, 0, 0)[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_item_custom_fg_color" qualifiers="const">
|
<method name="get_item_custom_fg_color" qualifiers="const">
|
||||||
|
|
@ -82,7 +82,7 @@
|
||||||
<argument index="0" name="idx" type="int">
|
<argument index="0" name="idx" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns the [Color] set by [member set_custom_fg_color]. Default value is [code]Color(0, 0, 0, 0)[/code].
|
Returns the [Color] set by [method set_item_custom_fg_color]. Default value is [code]Color(0, 0, 0, 0)[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_item_icon" qualifiers="const">
|
<method name="get_item_icon" qualifiers="const">
|
||||||
|
|
@ -91,7 +91,7 @@
|
||||||
<argument index="0" name="idx" type="int">
|
<argument index="0" name="idx" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns the icon associated with the specified index. Default value is [code]null[/code]
|
Returns the icon associated with the specified index. Default value is [code]null[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_item_icon_modulate" qualifiers="const">
|
<method name="get_item_icon_modulate" qualifiers="const">
|
||||||
|
|
@ -117,7 +117,7 @@
|
||||||
<argument index="0" name="idx" type="int">
|
<argument index="0" name="idx" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns the metadata value of the specified index set by [member set_item_metadata].
|
Returns the metadata value of the specified index set by [method set_item_metadata].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_item_text" qualifiers="const">
|
<method name="get_item_text" qualifiers="const">
|
||||||
|
|
@ -416,7 +416,7 @@
|
||||||
Sets the default icon size in pixels.
|
Sets the default icon size in pixels.
|
||||||
</member>
|
</member>
|
||||||
<member name="icon_mode" type="int" setter="set_icon_mode" getter="get_icon_mode" enum="ItemList.IconMode">
|
<member name="icon_mode" type="int" setter="set_icon_mode" getter="get_icon_mode" enum="ItemList.IconMode">
|
||||||
Sets the default position of the icon to either [const ICON_MODE_LEFT] or [const ICON_MODE_TOP].
|
Sets the default position of the icon to either [constant ICON_MODE_LEFT] or [constant ICON_MODE_TOP].
|
||||||
</member>
|
</member>
|
||||||
<member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale">
|
<member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale">
|
||||||
Sets the icon size to its initial size multiplied by the specified scale. Default value is 1.0.
|
Sets the icon size to its initial size multiplied by the specified scale. Default value is 1.0.
|
||||||
|
|
|
||||||
|
|
@ -56,17 +56,6 @@
|
||||||
Returns the [Transform2D] of a specific instance.
|
Returns the [Transform2D] of a specific instance.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="set_as_bulk_array">
|
|
||||||
<return type="void">
|
|
||||||
</return>
|
|
||||||
<argument index="0" name="array" type="PoolRealArray">
|
|
||||||
</argument>
|
|
||||||
<description>
|
|
||||||
Set all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative.
|
|
||||||
All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc...
|
|
||||||
[Transform] is stored as 12 floats, [Transform2D] is stored as 8 floats, COLOR_8BIT / CUSTOM_DATA_8BIT is stored as 1 float (4 bytes as is) and COLOR_FLOAT / CUSTOM_DATA_FLOAT is stored as 4 floats.
|
|
||||||
</description>
|
|
||||||
</method>
|
|
||||||
<method name="set_instance_color">
|
<method name="set_instance_color">
|
||||||
<return type="void">
|
<return type="void">
|
||||||
</return>
|
</return>
|
||||||
|
|
|
||||||
|
|
@ -20,7 +20,7 @@
|
||||||
<return type="int" enum="Error">
|
<return type="int" enum="Error">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
Try locking this [code]Mutex[/code], does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
|
Try locking this [code]Mutex[/code], does not block. Returns [constant @GlobalScope.OK] on success, [constant @GlobalScope.ERR_BUSY] otherwise.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="unlock">
|
<method name="unlock">
|
||||||
|
|
|
||||||
|
|
@ -279,7 +279,7 @@
|
||||||
If [code]true[/code], enables warnings when using a property as if it was a function.
|
If [code]true[/code], enables warnings when using a property as if it was a function.
|
||||||
</member>
|
</member>
|
||||||
<member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter="">
|
<member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter="">
|
||||||
If [code]true[/code], enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [Error] type.
|
If [code]true[/code], enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [enum @GlobalScope.Error] enum.
|
||||||
</member>
|
</member>
|
||||||
<member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter="">
|
<member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter="">
|
||||||
If [code]true[/code], enables warnings when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement.
|
If [code]true[/code], enables warnings when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement.
|
||||||
|
|
|
||||||
|
|
@ -35,7 +35,7 @@
|
||||||
<argument index="0" name="bbcode" type="String">
|
<argument index="0" name="bbcode" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Parses [code]bbcode[/code] and adds tags to the tag stack as needed. Returns the result of the parsing, [constant OK] if successful.
|
Parses [code]bbcode[/code] and adds tags to the tag stack as needed. Returns the result of the parsing, [constant @GlobalScope.OK] if successful.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="clear">
|
<method name="clear">
|
||||||
|
|
@ -93,7 +93,7 @@
|
||||||
<argument index="0" name="bbcode" type="String">
|
<argument index="0" name="bbcode" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
The assignment version of [method append_bbcode]. Clears the tag stack and inserts the new content. Returns [constant OK] if parses [code]bbcode[/code] successfully.
|
The assignment version of [method append_bbcode]. Clears the tag stack and inserts the new content. Returns [constant @GlobalScope.OK] if parses [code]bbcode[/code] successfully.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="pop">
|
<method name="pop">
|
||||||
|
|
|
||||||
|
|
@ -13,14 +13,14 @@
|
||||||
<return type="int" enum="Error">
|
<return type="int" enum="Error">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
Lowers the [code]Semaphore[/code], allowing one more thread in. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
|
Lowers the [code]Semaphore[/code], allowing one more thread in. Returns [constant @GlobalScope.OK] on success, [constant @GlobalScope.ERR_BUSY] otherwise.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="wait">
|
<method name="wait">
|
||||||
<return type="int" enum="Error">
|
<return type="int" enum="Error">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
Tries to wait for the [code]Semaphore[/code], if its value is zero, blocks until non-zero. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
|
Tries to wait for the [code]Semaphore[/code], if its value is zero, blocks until non-zero. Returns [constant @GlobalScope.OK] on success, [constant @GlobalScope.ERR_BUSY] otherwise.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
|
|
|
||||||
|
|
@ -17,7 +17,7 @@
|
||||||
<argument index="1" name="port" type="int">
|
<argument index="1" name="port" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Connect to the specified host:port pair. A hostname will be resolved if valid. Returns [constant OK] on success or [constant FAILED] on failure.
|
Connect to the specified host:port pair. A hostname will be resolved if valid. Returns [constant @GlobalScope.OK] on success or [constant @GlobalScope.FAILED] on failure.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="disconnect_from_host">
|
<method name="disconnect_from_host">
|
||||||
|
|
|
||||||
|
|
@ -104,7 +104,7 @@
|
||||||
<description>
|
<description>
|
||||||
Moves the cursor at the specified [code]line[/code] index.
|
Moves the cursor at the specified [code]line[/code] index.
|
||||||
If [code]adjust_viewport[/code] is set to true, the viewport will center at the cursor position after the move occurs. Default value is [code]true[/code].
|
If [code]adjust_viewport[/code] is set to true, the viewport will center at the cursor position after the move occurs. Default value is [code]true[/code].
|
||||||
If [code]can_be_hidden[/code] is set to true, the specified [code]line[/code] can be hidden using [member set_line_as_hidden]. Default value is [code]true[/code].
|
If [code]can_be_hidden[/code] is set to true, the specified [code]line[/code] can be hidden using [method set_line_as_hidden]. Default value is [code]true[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="cut">
|
<method name="cut">
|
||||||
|
|
@ -364,7 +364,7 @@
|
||||||
<return type="void">
|
<return type="void">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
Unhide all lines that were previously set to hidden by [member set_line_as_hidden].
|
Unhide all lines that were previously set to hidden by [method set_line_as_hidden].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
|
|
@ -389,6 +389,8 @@
|
||||||
<member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled">
|
<member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled">
|
||||||
If [code]true[/code], a right click displays the context menu.
|
If [code]true[/code], a right click displays the context menu.
|
||||||
</member>
|
</member>
|
||||||
|
<member name="hiding_enabled" type="int" setter="set_hiding_enabled" getter="is_hiding_enabled">
|
||||||
|
</member>
|
||||||
<member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled">
|
<member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled">
|
||||||
If [code]true[/code], all occurrences of the selected text will be highlighted.
|
If [code]true[/code], all occurrences of the selected text will be highlighted.
|
||||||
</member>
|
</member>
|
||||||
|
|
|
||||||
|
|
@ -140,6 +140,12 @@
|
||||||
Returns [code]true[/code] if the size override is enabled. See [method set_size_override].
|
Returns [code]true[/code] if the size override is enabled. See [method set_size_override].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
|
<method name="is_size_override_stretch_enabled" qualifiers="const">
|
||||||
|
<return type="bool">
|
||||||
|
</return>
|
||||||
|
<description>
|
||||||
|
</description>
|
||||||
|
</method>
|
||||||
<method name="set_attach_to_screen_rect">
|
<method name="set_attach_to_screen_rect">
|
||||||
<return type="void">
|
<return type="void">
|
||||||
</return>
|
</return>
|
||||||
|
|
@ -167,6 +173,14 @@
|
||||||
Sets the size override of the viewport. If the [code]enable[/code] parameter is [code]true[/code] the override is used, otherwise it uses the default size. If the size parameter is [code](-1, -1)[/code], it won't update the size.
|
Sets the size override of the viewport. If the [code]enable[/code] parameter is [code]true[/code] the override is used, otherwise it uses the default size. If the size parameter is [code](-1, -1)[/code], it won't update the size.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
|
<method name="set_size_override_stretch">
|
||||||
|
<return type="void">
|
||||||
|
</return>
|
||||||
|
<argument index="0" name="enabled" type="bool">
|
||||||
|
</argument>
|
||||||
|
<description>
|
||||||
|
</description>
|
||||||
|
</method>
|
||||||
<method name="unhandled_input">
|
<method name="unhandled_input">
|
||||||
<return type="void">
|
<return type="void">
|
||||||
</return>
|
</return>
|
||||||
|
|
|
||||||
|
|
@ -1932,7 +1932,7 @@
|
||||||
<argument index="2" name="scenario" type="RID">
|
<argument index="2" name="scenario" type="RID">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDscript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query.
|
Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query.
|
||||||
Warning: this function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
|
Warning: this function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
|
|
|
||||||
|
|
@ -34,7 +34,7 @@
|
||||||
<argument index="4" name="client_port" type="int" default="0">
|
<argument index="4" name="client_port" type="int" default="0">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Create client that connects to a server at [code]address[/code] using specified [code]port[/code]. The given address needs to be either a fully qualified domain name (e.g. [code]www.example.com[/code]) or an IP address in IPv4 or IPv6 format (e.g. [code]192.168.1.1[/code]). The [code]port[/code] is the port the server is listening on. The [code]in_bandwidth[/code] and [code]out_bandwidth[/code] parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns [constant OK] if a client was created, [constant ERR_ALREADY_IN_USE] if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the client could not be created. If [code]client_port[/code] is specified, the client will also listen to the given port, this is useful in some NAT traversal technique.
|
Create client that connects to a server at [code]address[/code] using specified [code]port[/code]. The given address needs to be either a fully qualified domain name (e.g. [code]www.example.com[/code]) or an IP address in IPv4 or IPv6 format (e.g. [code]192.168.1.1[/code]). The [code]port[/code] is the port the server is listening on. The [code]in_bandwidth[/code] and [code]out_bandwidth[/code] parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns [constant @GlobalScope.OK] if a client was created, [constant @GlobalScope.ERR_ALREADY_IN_USE] if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant @GlobalScope.ERR_CANT_CREATE] if the client could not be created. If [code]client_port[/code] is specified, the client will also listen to the given port, this is useful in some NAT traversal technique.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="create_server">
|
<method name="create_server">
|
||||||
|
|
@ -49,7 +49,7 @@
|
||||||
<argument index="3" name="out_bandwidth" type="int" default="0">
|
<argument index="3" name="out_bandwidth" type="int" default="0">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Create server that listens to connections via [code]port[/code]. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use [method set_bind_ip]. The default IP is the wildcard [code]*[/code], which listens on all available interfaces. [code]max_clients[/code] is the maximum number of clients that are allowed at once, any number up to 4096 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see [method create_client]. Returns [constant OK] if a server was created, [constant ERR_ALREADY_IN_USE] if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the server could not be created.
|
Create server that listens to connections via [code]port[/code]. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use [method set_bind_ip]. The default IP is the wildcard [code]*[/code], which listens on all available interfaces. [code]max_clients[/code] is the maximum number of clients that are allowed at once, any number up to 4096 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see [method create_client]. Returns [constant @GlobalScope.OK] if a server was created, [constant @GlobalScope.ERR_ALREADY_IN_USE] if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant @GlobalScope.ERR_CANT_CREATE] if the server could not be created.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="disconnect_peer">
|
<method name="disconnect_peer">
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue