Merge pull request #34159 from akien-mga/doc-enums-constants

doc: Markup fixes for enums and constants
This commit is contained in:
Rémi Verschelde 2019-12-07 00:11:17 +01:00 committed by GitHub
commit 07a739e7e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
50 changed files with 167 additions and 158 deletions

View File

@ -66,7 +66,7 @@
<return type="int"> <return type="int">
</return> </return>
<description> <description>
Returns the index of the longest axis of the [AABB] (according to [Vector3]::AXIS* enum). Returns the index of the longest axis of the [AABB] (according to [Vector3]'s [code]AXIS_*[/code] constants).
</description> </description>
</method> </method>
<method name="get_longest_axis_size"> <method name="get_longest_axis_size">

View File

@ -15,7 +15,7 @@
<return type="int" enum="ARVRPositionalTracker.TrackerHand"> <return type="int" enum="ARVRPositionalTracker.TrackerHand">
</return> </return>
<description> <description>
Returns the hand holding this tracker, if known. See [code]TRACKER_*[/code] constants. Returns the hand holding this tracker, if known. See [enum TrackerHand] constants.
</description> </description>
</method> </method>
<method name="get_joy_id" qualifiers="const"> <method name="get_joy_id" qualifiers="const">

View File

@ -656,7 +656,7 @@
<argument index="1" name="mode" type="int" enum="Animation.UpdateMode"> <argument index="1" name="mode" type="int" enum="Animation.UpdateMode">
</argument> </argument>
<description> <description>
Sets the update mode ([code]UPDATE_*[/code]) of a value track. Sets the update mode (see [enum UpdateMode]) of a value track.
</description> </description>
</method> </method>
</methods> </methods>

View File

@ -285,7 +285,7 @@
<argument index="0" name="id" type="String"> <argument index="0" name="id" type="String">
</argument> </argument>
<description> <description>
Gets the node type, will return from [code]NODE_*[/code] enum. Gets the node type, will return from [enum NodeType] enum.
</description> </description>
</method> </method>
<method name="node_rename"> <method name="node_rename">

View File

@ -47,7 +47,7 @@
</argument> </argument>
<description> <description>
Creates a new surface. Creates a new surface.
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. See [Mesh] for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface. Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface.
The [code]arrays[/code] argument is an array of arrays. See [enum ArrayType] for the values used in this array. For example, [code]arrays[0][/code] is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for [constant ARRAY_INDEX] if it is used. The [code]arrays[/code] argument is an array of arrays. See [enum ArrayType] for the values used in this array. For example, [code]arrays[0][/code] is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for [constant ARRAY_INDEX] if it is used.
Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data, and the index array defines the order of the vertices. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data, and the index array defines the order of the vertices.
Godot uses clockwise winding order for front faces of triangle primitive modes. Godot uses clockwise winding order for front faces of triangle primitive modes.

View File

@ -57,7 +57,7 @@
Bus on which this audio is playing. Bus on which this audio is playing.
</member> </member>
<member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget" default="0"> <member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget" default="0">
If the audio configuration has more than two speakers, this sets the target channels. See [code]MIX_TARGET_*[/code] constants. If the audio configuration has more than two speakers, this sets the target channels. See [enum MixTarget] constants.
</member> </member>
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0"> <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
Changes the pitch and the tempo of the audio. Changes the pitch and the tempo of the audio.

View File

@ -27,7 +27,7 @@
[b]Note:[/b] This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte. [b]Note:[/b] This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte.
</member> </member>
<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format" default="0"> <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format" default="0">
Audio format. See [code]FORMAT_*[/code] constants for values. Audio format. See [enum Format] constants for values.
</member> </member>
<member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin" default="0"> <member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin" default="0">
Loop start in bytes. Loop start in bytes.
@ -36,7 +36,7 @@
Loop end in bytes. Loop end in bytes.
</member> </member>
<member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode" default="0"> <member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode" default="0">
Loop mode. See [code]LOOP_*[/code] constants for values. Loop mode. See [enum LoopMode] constants for values.
</member> </member>
<member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate" default="44100"> <member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate" default="44100">
The sample rate for mixing this audio. The sample rate for mixing this audio.

View File

@ -22,14 +22,14 @@
<argument index="0" name="button_pressed" type="bool"> <argument index="0" name="button_pressed" type="bool">
</argument> </argument>
<description> <description>
Called when the button is toggled (only if toggle_mode is active). Called when the button is toggled (only if [member toggle_mode] is active).
</description> </description>
</method> </method>
<method name="get_draw_mode" qualifiers="const"> <method name="get_draw_mode" qualifiers="const">
<return type="int" enum="BaseButton.DrawMode"> <return type="int" enum="BaseButton.DrawMode">
</return> </return>
<description> <description>
Returns 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 [code]DRAW_*[/code] enum. Returns 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 [enum DrawMode] enum.
</description> </description>
</method> </method>
<method name="is_hovered" qualifiers="const"> <method name="is_hovered" qualifiers="const">
@ -42,7 +42,7 @@
</methods> </methods>
<members> <members>
<member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode" default="1"> <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode" default="1">
Determines when the button is considered clicked, one of the [code]ACTION_MODE_*[/code] constants. Determines when the button is considered clicked, one of the [enum ActionMode] constants.
</member> </member>
<member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" default="1"> <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" default="1">
Binary mask to choose which mouse buttons this button will respond to. Binary mask to choose which mouse buttons this button will respond to.
@ -62,7 +62,7 @@
If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it. If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it.
</member> </member>
<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false"> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">
If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active).
</member> </member>
<member name="shortcut" type="ShortCut" setter="set_shortcut" getter="get_shortcut"> <member name="shortcut" type="ShortCut" setter="set_shortcut" getter="get_shortcut">
[ShortCut] associated to the button. [ShortCut] associated to the button.

View File

@ -12,7 +12,7 @@
</methods> </methods>
<members> <members>
<member name="align" type="int" setter="set_text_align" getter="get_text_align" enum="Button.TextAlign" default="1"> <member name="align" type="int" setter="set_text_align" getter="get_text_align" enum="Button.TextAlign" default="1">
Text alignment policy for the button's text, use one of the [code]ALIGN_*[/code] constants. Text alignment policy for the button's text, use one of the [enum TextAlign] constants.
</member> </member>
<member name="clip_text" type="bool" setter="set_clip_text" getter="get_clip_text" default="false"> <member name="clip_text" type="bool" setter="set_clip_text" getter="get_clip_text" default="false">
When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text.

View File

@ -103,7 +103,7 @@
</methods> </methods>
<members> <members>
<member name="anchor_mode" type="int" setter="set_anchor_mode" getter="get_anchor_mode" enum="Camera2D.AnchorMode" default="1"> <member name="anchor_mode" type="int" setter="set_anchor_mode" getter="get_anchor_mode" enum="Camera2D.AnchorMode" default="1">
The Camera2D's anchor point. See [code]ANCHOR_MODE_*[/code] constants. The Camera2D's anchor point. See [enum AnchorMode] constants.
</member> </member>
<member name="current" type="bool" setter="_set_current" getter="is_current" default="false"> <member name="current" type="bool" setter="_set_current" getter="is_current" default="false">
If [code]true[/code], the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera [code]current[/code] will disable this one. If [code]true[/code], the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera [code]current[/code] will disable this one.

View File

@ -4,7 +4,7 @@
Defines a 2D collision polygon. Defines a 2D collision polygon.
</brief_description> </brief_description>
<description> <description>
Provides a 2D collision polygon to a [CollisionObject2D] parent. Polygon can be drawn in the editor or specified by a list of vertices. Provides a 2D collision polygon to a [CollisionObject2D] parent. Polygons can be drawn in the editor or specified by a list of vertices.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -12,18 +12,18 @@
</methods> </methods>
<members> <members>
<member name="build_mode" type="int" setter="set_build_mode" getter="get_build_mode" enum="CollisionPolygon2D.BuildMode" default="0"> <member name="build_mode" type="int" setter="set_build_mode" getter="get_build_mode" enum="CollisionPolygon2D.BuildMode" default="0">
Collision build mode. Use one of the [code]BUILD_*[/code] constants. Collision build mode. Use one of the [enum BuildMode] constants.
</member> </member>
<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false"> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">
If [code]true[/code], no collisions will be detected. If [code]true[/code], no collisions will be detected.
</member> </member>
<member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" default="false"> <member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" default="false">
If [code]true[/code], only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. If [code]true[/code], only edges that face up, relative to [CollisionPolygon2D]'s rotation, will collide with other objects.
</member> </member>
<member name="one_way_collision_margin" type="float" setter="set_one_way_collision_margin" getter="get_one_way_collision_margin" default="1.0"> <member name="one_way_collision_margin" type="float" setter="set_one_way_collision_margin" getter="get_one_way_collision_margin" default="1.0">
</member> </member>
<member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon" default="PoolVector2Array( )"> <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon" default="PoolVector2Array( )">
The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the PoolVector2Array, not a reference. The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the [PoolVector2Array], not a reference.
</member> </member>
</members> </members>
<constants> <constants>

View File

@ -104,7 +104,8 @@
<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 [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="load_encrypted"> <method name="load_encrypted">
@ -133,7 +134,8 @@
<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 [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="save_encrypted"> <method name="save_encrypted">

View File

@ -22,7 +22,7 @@
<argument index="0" name="side" type="int" enum="CubeMap.Side"> <argument index="0" name="side" type="int" enum="CubeMap.Side">
</argument> </argument>
<description> <description>
Returns an [Image] for a side of the [CubeMap] using one of the [code]SIDE_*[/code] constants or an integer 0-5. Returns an [Image] for a side of the [CubeMap] using one of the [enum Side] constants.
</description> </description>
</method> </method>
<method name="get_width" qualifiers="const"> <method name="get_width" qualifiers="const">
@ -40,19 +40,19 @@
<argument index="1" name="image" type="Image"> <argument index="1" name="image" type="Image">
</argument> </argument>
<description> <description>
Sets an [Image] for a side of the [CubeMap] using one of the [code]SIDE_*[/code] constants or an integer 0-5. Sets an [Image] for a side of the [CubeMap] using one of the [enum Side] constants.
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="flags" type="int" setter="set_flags" getter="get_flags" default="7"> <member name="flags" type="int" setter="set_flags" getter="get_flags" default="7">
The render flags for the [CubeMap]. See the [code]FLAG_*[/code] constants for details. The render flags for the [CubeMap]. See the [enum Flags] constants for details.
</member> </member>
<member name="lossy_storage_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality" default="0.7"> <member name="lossy_storage_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality" default="0.7">
The lossy storage quality of the [CubeMap] if the storage mode is set to STORAGE_COMPRESS_LOSSY. The lossy storage quality of the [CubeMap] if the storage mode is set to [constant STORAGE_COMPRESS_LOSSY].
</member> </member>
<member name="storage_mode" type="int" setter="set_storage" getter="get_storage" enum="CubeMap.Storage" default="0"> <member name="storage_mode" type="int" setter="set_storage" getter="get_storage" enum="CubeMap.Storage" default="0">
The [CubeMap]'s storage mode. See [code]STORAGE_*[/code] constants. The [CubeMap]'s storage mode. See [enum Storage] constants.
</member> </member>
</members> </members>
<constants> <constants>

View File

@ -33,7 +33,7 @@
</argument> </argument>
<description> <description>
Changes 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]). Changes 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 [@GlobalScope] ([code]OK[/code] or [code]ERR_*[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="copy"> <method name="copy">
@ -45,7 +45,7 @@
</argument> </argument>
<description> <description>
Copies the [code]from[/code] file to the [code]to[/code] 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. Copies the [code]from[/code] file to the [code]to[/code] 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 [@GlobalScope] ([code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="current_is_dir" qualifiers="const"> <method name="current_is_dir" qualifiers="const">
@ -145,7 +145,7 @@
</argument> </argument>
<description> <description>
Creates a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]). Creates a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]).
The method returns one of the error code constants defined in [@GlobalScope] ([code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="make_dir_recursive"> <method name="make_dir_recursive">
@ -155,7 +155,7 @@
</argument> </argument>
<description> <description>
Creates a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. Creates a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path.
Returns one of the error code constants defined in [@GlobalScope] ([code]0K[/code], [code]FAILED[/code] or [code]ERR_*[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="open"> <method name="open">
@ -165,7 +165,7 @@
</argument> </argument>
<description> <description>
Opens an existing directory of the filesystem. The [code]path[/code] 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]). Opens an existing directory of the filesystem. The [code]path[/code] 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 [@GlobalScope] ([code]OK[/code] or [code]ERR_*[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="remove"> <method name="remove">
@ -175,7 +175,7 @@
</argument> </argument>
<description> <description>
Deletes 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. Deletes 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 [@GlobalScope] ([code]OK[/code] or [code]FAILED[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="rename"> <method name="rename">
@ -187,7 +187,7 @@
</argument> </argument>
<description> <description>
Renames (move) the [code]from[/code] file to the [code]to[/code] 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. Renames (move) the [code]from[/code] file to the [code]to[/code] 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 [@GlobalScope] ([code]OK[/code] or [code]FAILED[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
</methods> </methods>

View File

@ -21,7 +21,10 @@
<argument index="0" name="info" type="Dictionary"> <argument index="0" name="info" type="Dictionary">
</argument> </argument>
<description> <description>
Adds a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see [code]TYPE_*[/code] in [@GlobalScope]), and optionally hint:[int](see [code]PROPERTY_HINT_*[/code] in [@GlobalScope]), hint_string:[String]. Adds a custom property info to a property. The dictionary must contain:
- [code]name[/code]: [String] (the name of the property)
- [code]type[/code]: [int] (see [enum Variant.Type])
- optionally [code]hint[/code]: [int] (see [enum PropertyHint]) and [code]hint_string[/code]: [String]
[b]Example:[/b] [b]Example:[/b]
[codeblock] [codeblock]
editor_settings.set("category/property_name", 0) editor_settings.set("category/property_name", 0)

View File

@ -45,7 +45,7 @@
Global contrast value of the rendered scene (default value is 1). Global contrast value of the rendered scene (default value is 1).
</member> </member>
<member name="adjustment_enabled" type="bool" setter="set_adjustment_enable" getter="is_adjustment_enabled" default="false"> <member name="adjustment_enabled" type="bool" setter="set_adjustment_enable" getter="is_adjustment_enabled" default="false">
Enables the adjustment_* options provided by this resource. If [code]false[/code], adjustments modifications will have no effect on the rendered scene. Enables the [code]adjustment_*[/code] options provided by this resource. If [code]false[/code], adjustments modifications will have no effect on the rendered scene.
</member> </member>
<member name="adjustment_saturation" type="float" setter="set_adjustment_saturation" getter="get_adjustment_saturation" default="1.0"> <member name="adjustment_saturation" type="float" setter="set_adjustment_saturation" getter="get_adjustment_saturation" default="1.0">
Global color saturation value of the rendered scene (default value is 1). Global color saturation value of the rendered scene (default value is 1).

View File

@ -79,7 +79,7 @@
<return type="int" enum="HTTPClient.Status"> <return type="int" enum="HTTPClient.Status">
</return> </return>
<description> <description>
Returns a [code]STATUS_*[/code] enum constant. Need to call [method poll] in order to get status updates. Returns a [enum Status] constant. Need to call [method poll] in order to get status updates.
</description> </description>
</method> </method>
<method name="has_response" qualifiers="const"> <method name="has_response" qualifiers="const">
@ -143,7 +143,7 @@
</argument> </argument>
<description> <description>
Sends a request to the connected host. The URL parameter is just the part after the host, so for [code]http://somehost.com/index.php[/code], it is [code]index.php[/code]. Sends a request to the connected host. The URL parameter is just the part after the host, so for [code]http://somehost.com/index.php[/code], it is [code]index.php[/code].
Headers are HTTP request headers. For available HTTP methods, see [code]METHOD_*[/code]. Headers are HTTP request headers. For available HTTP methods, see [enum Method].
To create a POST request with query strings to push to the server, do: To create a POST request with query strings to push to the server, do:
[codeblock] [codeblock]
var fields = {"username" : "user", "password" : "pass"} var fields = {"username" : "user", "password" : "pass"}
@ -166,7 +166,7 @@
</argument> </argument>
<description> <description>
Sends a raw request to the connected host. The URL parameter is just the part after the host, so for [code]http://somehost.com/index.php[/code], it is [code]index.php[/code]. Sends a raw request to the connected host. The URL parameter is just the part after the host, so for [code]http://somehost.com/index.php[/code], it is [code]index.php[/code].
Headers are HTTP request headers. For available HTTP methods, see [code]METHOD_*[/code]. Headers are HTTP request headers. For available HTTP methods, see [enum Method].
Sends the body data raw, as a byte array and does not encode it in any way. Sends the body data raw, as a byte array and does not encode it in any way.
</description> </description>
</method> </method>

View File

@ -67,7 +67,7 @@
<return type="int" enum="HTTPClient.Status"> <return type="int" enum="HTTPClient.Status">
</return> </return>
<description> <description>
Returns the current status of the underlying [HTTPClient]. See [code]STATUS_*[/code] enum on [HTTPClient]. Returns the current status of the underlying [HTTPClient]. See [enum HTTPClient.Status].
</description> </description>
</method> </method>
<method name="request"> <method name="request">

View File

@ -65,7 +65,7 @@
<argument index="0" name="id" type="int"> <argument index="0" name="id" type="int">
</argument> </argument>
<description> <description>
Returns a queued hostname's status as a [code]RESOLVER_STATUS_*[/code] constant, given its queue [code]id[/code]. Returns a queued hostname's status as a [enum ResolverStatus] constant, given its queue [code]id[/code].
</description> </description>
</method> </method>
<method name="resolve_hostname"> <method name="resolve_hostname">
@ -76,7 +76,7 @@
<argument index="1" name="ip_type" type="int" enum="IP.Type" default="3"> <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3">
</argument> </argument>
<description> <description>
Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the [code]TYPE_*[/code] constant given as [code]ip_type[/code]. Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the [enum Type] constant given as [code]ip_type[/code].
</description> </description>
</method> </method>
<method name="resolve_hostname_queue_item"> <method name="resolve_hostname_queue_item">
@ -87,7 +87,7 @@
<argument index="1" name="ip_type" type="int" enum="IP.Type" default="3"> <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3">
</argument> </argument>
<description> <description>
Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the [code]TYPE_*[/code] constant given as [code]ip_type[/code]. Returns the queue ID if successful, or [constant RESOLVER_INVALID_ID] on error. Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the [enum Type] constant given as [code]ip_type[/code]. Returns the queue ID if successful, or [constant RESOLVER_INVALID_ID] on error.
</description> </description>
</method> </method>
</methods> </methods>

View File

@ -90,7 +90,7 @@
<argument index="2" name="lossy_quality" type="float"> <argument index="2" name="lossy_quality" type="float">
</argument> </argument>
<description> <description>
Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See [code]COMPRESS_*[/code] constants. Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See [enum CompressMode] and [enum CompressSource] constants.
</description> </description>
</method> </method>
<method name="convert"> <method name="convert">
@ -99,7 +99,7 @@
<argument index="0" name="format" type="int" enum="Image.Format"> <argument index="0" name="format" type="int" enum="Image.Format">
</argument> </argument>
<description> <description>
Converts the image's format. See [code]FORMAT_*[/code] constants. Converts the image's format. See [enum Format] constants.
</description> </description>
</method> </method>
<method name="copy_from"> <method name="copy_from">
@ -123,7 +123,7 @@
<argument index="3" name="format" type="int" enum="Image.Format"> <argument index="3" name="format" type="int" enum="Image.Format">
</argument> </argument>
<description> <description>
Creates an empty image of given size and format. See [code]FORMAT_*[/code] constants. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps]. Creates an empty image of given size and format. See [enum Format] constants. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps].
</description> </description>
</method> </method>
<method name="create_from_data"> <method name="create_from_data">
@ -140,7 +140,7 @@
<argument index="4" name="data" type="PoolByteArray"> <argument index="4" name="data" type="PoolByteArray">
</argument> </argument>
<description> <description>
Creates a new image of given size and format. See [code]FORMAT_*[/code] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps]. Creates a new image of given size and format. See [enum Format] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps].
</description> </description>
</method> </method>
<method name="crop"> <method name="crop">
@ -165,7 +165,7 @@
<return type="int" enum="Image.AlphaMode"> <return type="int" enum="Image.AlphaMode">
</return> </return>
<description> <description>
Returns ALPHA_BLEND if the image has data for alpha values. Returns ALPHA_BIT if all the alpha values are below a certain threshold or the maximum value. Returns ALPHA_NONE if no data for alpha values is found. Returns [constant ALPHA_BLEND] if the image has data for alpha values. Returns [constant ALPHA_BIT] if all the alpha values are below a certain threshold or the maximum value. Returns [constant ALPHA_NONE] if no data for alpha values is found.
</description> </description>
</method> </method>
<method name="expand_x2_hq2x"> <method name="expand_x2_hq2x">
@ -225,7 +225,7 @@
<return type="int" enum="Image.Format"> <return type="int" enum="Image.Format">
</return> </return>
<description> <description>
Returns the image's format. See [code]FORMAT_*[/code] constants. Returns the image's format. See [enum Format] constants.
</description> </description>
</method> </method>
<method name="get_height" qualifiers="const"> <method name="get_height" qualifiers="const">
@ -491,7 +491,7 @@
</methods> </methods>
<members> <members>
<member name="data" type="Dictionary" setter="_set_data" getter="_get_data" default="{&quot;data&quot;: PoolByteArray( ),&quot;format&quot;: &quot;Lum8&quot;,&quot;height&quot;: 0,&quot;mipmaps&quot;: false,&quot;width&quot;: 0}"> <member name="data" type="Dictionary" setter="_set_data" getter="_get_data" default="{&quot;data&quot;: PoolByteArray( ),&quot;format&quot;: &quot;Lum8&quot;,&quot;height&quot;: 0,&quot;mipmaps&quot;: false,&quot;width&quot;: 0}">
Holds all of the image's color data in a given format. See [code]FORMAT_*[/code] constants. Holds all of the image's color data in a given format. See [enum Format] constants.
</member> </member>
</members> </members>
<constants> <constants>

View File

@ -41,8 +41,8 @@
<argument index="1" name="texture" type="Texture" default="null"> <argument index="1" name="texture" type="Texture" default="null">
</argument> </argument>
<description> <description>
Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references. Begin drawing (and optionally pass a texture override). When done call [method end]. For more information on how this works, search for [code]glBegin()[/code] and [code]glEnd()[/code] references.
For the type of primitive, use the [Mesh].[code]PRIMITIVE_*[/code] enumerations. For the type of primitive, see the [enum Mesh.PrimitiveType] enum.
</description> </description>
</method> </method>
<method name="clear"> <method name="clear">

View File

@ -314,7 +314,7 @@
<argument index="2" name="hotspot" type="Vector2" default="Vector2( 0, 0 )"> <argument index="2" name="hotspot" type="Vector2" default="Vector2( 0, 0 )">
</argument> </argument>
<description> <description>
Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See enum [code]CURSOR_*[/code] for the list of shapes. Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See [enum CursorShape] for the list of shapes.
[code]image[/code]'s size must be lower than 256×256. [code]image[/code]'s size must be lower than 256×256.
[code]hotspot[/code] must be within [code]image[/code]'s size. [code]hotspot[/code] must be within [code]image[/code]'s size.
[b]Note:[/b] [AnimatedTexture]s aren't supported as custom mouse cursors. If using an [AnimatedTexture], only the first frame will be displayed. [b]Note:[/b] [AnimatedTexture]s aren't supported as custom mouse cursors. If using an [AnimatedTexture], only the first frame will be displayed.

View File

@ -12,13 +12,13 @@
</methods> </methods>
<members> <members>
<member name="error" type="int" setter="set_error" getter="get_error" enum="Error"> <member name="error" type="int" setter="set_error" getter="get_error" enum="Error">
The error type if the JSON source was not successfully parsed. See the [@GlobalScope] [code]ERR_*[/code] constants. The error type if the JSON source was not successfully parsed. See the [enum Error] constants.
</member> </member>
<member name="error_line" type="int" setter="set_error_line" getter="get_error_line" default="-1"> <member name="error_line" type="int" setter="set_error_line" getter="get_error_line" default="-1">
The line number where the error occurred if JSON source was not successfully parsed. The line number where the error occurred if JSON source was not successfully parsed.
</member> </member>
<member name="error_string" type="String" setter="set_error_string" getter="get_error_string" default="&quot;&quot;"> <member name="error_string" type="String" setter="set_error_string" getter="get_error_string" default="&quot;&quot;">
The error message if JSON source was not successfully parsed. See the [@GlobalScope] [code]ERR_*[/code] constants. The error message if JSON source was not successfully parsed. See the [enum Error] constants.
</member> </member>
<member name="result" type="Variant" setter="set_result" getter="get_result"> <member name="result" type="Variant" setter="set_result" getter="get_result">
A [Variant] containing the parsed JSON. Use [method @GDScript.typeof] or the [code]is[/code] keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ([code]{}[/code]), a [Dictionary] will be returned. If the JSON source starts with braces ([code][][/code]), an [Array] will be returned. A [Variant] containing the parsed JSON. Use [method @GDScript.typeof] or the [code]is[/code] keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ([code]{}[/code]), a [Dictionary] will be returned. If the JSON source starts with braces ([code][][/code]), an [Array] will be returned.

View File

@ -125,7 +125,7 @@
</argument> </argument>
<description> <description>
Moves the body while keeping it attached to slopes. Similar to [method move_and_slide]. Moves the body while keeping it attached to slopes. Similar to [method move_and_slide].
As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting[code]snap[/code] to[code](0, 0, 0)[/code] or by using [method move_and_slide] instead. As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting [code]snap[/code] to [code](0, 0, 0)[/code] or by using [method move_and_slide] instead.
</description> </description>
</method> </method>
<method name="set_axis_lock"> <method name="set_axis_lock">

View File

@ -41,7 +41,7 @@
</methods> </methods>
<members> <members>
<member name="align" type="int" setter="set_align" getter="get_align" enum="Label.Align" default="0"> <member name="align" type="int" setter="set_align" getter="get_align" enum="Label.Align" default="0">
Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the [code]ALIGN_*[/code] constants. Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the [enum Align] constants.
</member> </member>
<member name="autowrap" type="bool" setter="set_autowrap" getter="has_autowrap" default="false"> <member name="autowrap" type="bool" setter="set_autowrap" getter="has_autowrap" default="false">
If [code]true[/code], wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. If [code]true[/code], wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text.
@ -67,7 +67,7 @@
If [code]true[/code], all the text displays as UPPERCASE. If [code]true[/code], all the text displays as UPPERCASE.
</member> </member>
<member name="valign" type="int" setter="set_valign" getter="get_valign" enum="Label.VAlign" default="0"> <member name="valign" type="int" setter="set_valign" getter="get_valign" enum="Label.VAlign" default="0">
Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the [code]VALIGN_*[/code] constants. Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the [enum VAlign] constants.
</member> </member>
<member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters" default="-1"> <member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters" default="-1">
Restricts the number of characters to display. Set to -1 to disable. Restricts the number of characters to display. Set to -1 to disable.

View File

@ -26,7 +26,7 @@
The Light2D's energy value. The larger the value, the stronger the light. The Light2D's energy value. The larger the value, the stronger the light.
</member> </member>
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="Light2D.Mode" default="0"> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="Light2D.Mode" default="0">
The Light2D's mode. See [code]MODE_*[/code] constants for values. The Light2D's mode. See [enum Mode] constants for values.
</member> </member>
<member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset" default="Vector2( 0, 0 )"> <member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset" default="Vector2( 0, 0 )">
The offset of the Light2D's [code]texture[/code]. The offset of the Light2D's [code]texture[/code].

View File

@ -70,13 +70,13 @@
If [code]true[/code], the line's border will be anti-aliased. If [code]true[/code], the line's border will be anti-aliased.
</member> </member>
<member name="begin_cap_mode" type="int" setter="set_begin_cap_mode" getter="get_begin_cap_mode" enum="Line2D.LineCapMode" default="0"> <member name="begin_cap_mode" type="int" setter="set_begin_cap_mode" getter="get_begin_cap_mode" enum="Line2D.LineCapMode" default="0">
Controls the style of the line's first point. Use [code]LINE_CAP_*[/code] constants. Controls the style of the line's first point. Use [enum LineCapMode] constants.
</member> </member>
<member name="default_color" type="Color" setter="set_default_color" getter="get_default_color" default="Color( 0.4, 0.5, 1, 1 )"> <member name="default_color" type="Color" setter="set_default_color" getter="get_default_color" default="Color( 0.4, 0.5, 1, 1 )">
The line's color. Will not be used if a gradient is set. The line's color. Will not be used if a gradient is set.
</member> </member>
<member name="end_cap_mode" type="int" setter="set_end_cap_mode" getter="get_end_cap_mode" enum="Line2D.LineCapMode" default="0"> <member name="end_cap_mode" type="int" setter="set_end_cap_mode" getter="get_end_cap_mode" enum="Line2D.LineCapMode" default="0">
Controls the style of the line's last point. Use [code]LINE_CAP_*[/code] constants. Controls the style of the line's last point. Use [enum LineCapMode] constants.
</member> </member>
<member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient"> <member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient">
The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set.
@ -97,7 +97,7 @@
The texture used for the line's texture. Uses [code]texture_mode[/code] for drawing style. The texture used for the line's texture. Uses [code]texture_mode[/code] for drawing style.
</member> </member>
<member name="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="Line2D.LineTextureMode" default="0"> <member name="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="Line2D.LineTextureMode" default="0">
The style to render the [code]texture[/code] on the line. Use [code]LINE_TEXTURE_*[/code] constants. The style to render the [code]texture[/code] on the line. Use [enum LineTextureMode] constants.
</member> </member>
<member name="width" type="float" setter="set_width" getter="get_width" default="10.0"> <member name="width" type="float" setter="set_width" getter="get_width" default="10.0">
The line's width. The line's width.

View File

@ -54,7 +54,7 @@
<argument index="0" name="option" type="int"> <argument index="0" name="option" type="int">
</argument> </argument>
<description> <description>
Executes a given action as defined in the[code]MENU_*[/code] enum. Executes a given action as defined in the [enum MenuItems] enum.
</description> </description>
</method> </method>
<method name="select"> <method name="select">
@ -84,7 +84,7 @@
</methods> </methods>
<members> <members>
<member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align" default="0"> <member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align" default="0">
Text alignment as defined in the [code]ALIGN_*[/code] enum. Text alignment as defined in the [enum Align] enum.
</member> </member>
<member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled" default="false"> <member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled" default="false">
If [code]true[/code], the caret (visual cursor) blinks. If [code]true[/code], the caret (visual cursor) blinks.

View File

@ -92,7 +92,7 @@
[b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
</member> </member>
<member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer">
The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with [method is_network_server]) and will set root node's network mode to master (see [code]NETWORK_MODE_*[/code] constants in [Node]), or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with [method is_network_server]) and will set root node's network mode to master, or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals.
</member> </member>
<member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections" default="false"> <member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections" default="false">
If [code]true[/code], the MultiplayerAPI's [member network_peer] refuses new incoming connections. If [code]true[/code], the MultiplayerAPI's [member network_peer] refuses new incoming connections.

View File

@ -51,7 +51,7 @@
Number of particles to emit. Number of particles to emit.
</member> </member>
<member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles.DrawOrder" default="0"> <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles.DrawOrder" default="0">
Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Particle draw order. Uses [enum DrawOrder] values.
</member> </member>
<member name="draw_pass_1" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> <member name="draw_pass_1" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh">
[Mesh] that is drawn for the first draw pass. [Mesh] that is drawn for the first draw pass.

View File

@ -31,7 +31,7 @@
Number of particles emitted in one emission cycle. Number of particles emitted in one emission cycle.
</member> </member>
<member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles2D.DrawOrder" default="0"> <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles2D.DrawOrder" default="0">
Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Particle draw order. Uses [enum DrawOrder] values.
</member> </member>
<member name="emitting" type="bool" setter="set_emitting" getter="is_emitting" default="true"> <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting" default="true">
If [code]true[/code], particles are being emitted. If [code]true[/code], particles are being emitted.

View File

@ -157,7 +157,7 @@
Particles will be emitted at positions determined by sampling this texture at a random position. Used with [constant EMISSION_SHAPE_POINTS] and [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar. Particles will be emitted at positions determined by sampling this texture at a random position. Used with [constant EMISSION_SHAPE_POINTS] and [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.
</member> </member>
<member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="ParticlesMaterial.EmissionShape" default="0"> <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="ParticlesMaterial.EmissionShape" default="0">
Particles will be emitted inside this region. Use [code]EMISSION_SHAPE_*[/code] constants for values. Particles will be emitted inside this region. Use [enum EmissionShape] constants for values.
</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 sphere's radius if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_SPHERE]. The sphere's radius if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_SPHERE].

View File

@ -203,7 +203,7 @@
</argument> </argument>
<description> <description>
Sets 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: Sets 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. 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area.
2: [RID] of the object that entered/exited the area. 2: [RID] of the object that entered/exited the area.
3: Instance ID 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. 4: The shape index of the object that entered/exited the area.
@ -1155,7 +1155,7 @@
Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. Constant to set/get the 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>
<constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4" enum="AreaParameter"> <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4" enum="AreaParameter">
This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE. This constant was used to set/get the falloff factor for point gravity. It has been superseded by [constant AREA_PARAM_GRAVITY_DISTANCE_SCALE].
</constant> </constant>
<constant name="AREA_PARAM_LINEAR_DAMP" value="5" enum="AreaParameter"> <constant name="AREA_PARAM_LINEAR_DAMP" value="5" enum="AreaParameter">
Constant to set/get the linear dampening factor of an area. Constant to set/get the linear dampening factor of an area.

View File

@ -68,7 +68,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.AreaParameter"> <argument index="1" name="param" type="int" enum="PhysicsServer.AreaParameter">
</argument> </argument>
<description> <description>
Returns an area parameter value. A list of available parameters is on the [code]AREA_PARAM_*[/code] constants. Returns an area parameter value. A list of available parameters is on the [enum AreaParameter] constants.
</description> </description>
</method> </method>
<method name="area_get_shape" qualifiers="const"> <method name="area_get_shape" qualifiers="const">
@ -194,7 +194,7 @@
</argument> </argument>
<description> <description>
Sets 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: Sets 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. 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area.
2: [RID] of the object that entered/exited the area. 2: [RID] of the object that entered/exited the area.
3: Instance ID 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. 4: The shape index of the object that entered/exited the area.
@ -221,7 +221,7 @@
<argument index="2" name="value" type="Variant"> <argument index="2" name="value" type="Variant">
</argument> </argument>
<description> <description>
Sets the value for an area parameter. A list of available parameters is on the [code]AREA_PARAM_*[/code] constants. Sets the value for an area parameter. A list of available parameters is on the [enum AreaParameter] constants.
</description> </description>
</method> </method>
<method name="area_set_ray_pickable"> <method name="area_set_ray_pickable">
@ -292,7 +292,7 @@
<argument index="1" name="mode" type="int" enum="PhysicsServer.AreaSpaceOverrideMode"> <argument index="1" name="mode" type="int" enum="PhysicsServer.AreaSpaceOverrideMode">
</argument> </argument>
<description> <description>
Sets the space override mode for the area. The modes are described in the constants [code]AREA_SPACE_OVERRIDE_*[/code]. Sets the space override mode for the area. The modes are described in the [enum AreaSpaceOverrideMode] constants.
</description> </description>
</method> </method>
<method name="area_set_transform"> <method name="area_set_transform">
@ -426,7 +426,7 @@
<argument index="1" name="init_sleeping" type="bool" default="false"> <argument index="1" name="init_sleeping" type="bool" default="false">
</argument> </argument>
<description> <description>
Creates 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. Creates a physics body. The first parameter can be any value from [enum BodyMode] constants, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
</description> </description>
</method> </method>
<method name="body_get_collision_layer" qualifiers="const"> <method name="body_get_collision_layer" qualifiers="const">
@ -500,7 +500,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.BodyParameter"> <argument index="1" name="param" type="int" enum="PhysicsServer.BodyParameter">
</argument> </argument>
<description> <description>
Returns the value of a body parameter. A list of available parameters is on the [code]BODY_PARAM_*[/code] constants. Returns the value of a body parameter. A list of available parameters is on the [enum BodyParameter] constants.
</description> </description>
</method> </method>
<method name="body_get_shape" qualifiers="const"> <method name="body_get_shape" qualifiers="const">
@ -715,7 +715,7 @@
<argument index="1" name="mode" type="int" enum="PhysicsServer.BodyMode"> <argument index="1" name="mode" type="int" enum="PhysicsServer.BodyMode">
</argument> </argument>
<description> <description>
Sets the body mode, from one of the constants BODY_MODE*. Sets the body mode, from one of the [enum BodyMode] constants.
</description> </description>
</method> </method>
<method name="body_set_omit_force_integration"> <method name="body_set_omit_force_integration">
@ -739,7 +739,7 @@
<argument index="2" name="value" type="float"> <argument index="2" name="value" type="float">
</argument> </argument>
<description> <description>
Sets a body parameter. A list of available parameters is on the [code]BODY_PARAM_*[/code] constants. Sets a body parameter. A list of available parameters is on the [enum BodyParameter] constants.
</description> </description>
</method> </method>
<method name="body_set_ray_pickable"> <method name="body_set_ray_pickable">
@ -812,7 +812,7 @@
<argument index="2" name="value" type="Variant"> <argument index="2" name="value" type="Variant">
</argument> </argument>
<description> <description>
Sets a body state (see BODY_STATE* constants). Sets a body state (see [enum BodyState] constants).
</description> </description>
</method> </method>
<method name="cone_twist_joint_get_param" qualifiers="const"> <method name="cone_twist_joint_get_param" qualifiers="const">
@ -823,7 +823,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.ConeTwistJointParam"> <argument index="1" name="param" type="int" enum="PhysicsServer.ConeTwistJointParam">
</argument> </argument>
<description> <description>
Gets a cone_twist_joint parameter (see CONE_TWIST_JOINT* constants). Gets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants).
</description> </description>
</method> </method>
<method name="cone_twist_joint_set_param"> <method name="cone_twist_joint_set_param">
@ -836,7 +836,7 @@
<argument index="2" name="value" type="float"> <argument index="2" name="value" type="float">
</argument> </argument>
<description> <description>
Sets a cone_twist_joint parameter (see CONE_TWIST_JOINT* constants). Sets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants).
</description> </description>
</method> </method>
<method name="free_rid"> <method name="free_rid">
@ -858,7 +858,7 @@
<argument index="2" name="flag" type="int" enum="PhysicsServer.G6DOFJointAxisFlag"> <argument index="2" name="flag" type="int" enum="PhysicsServer.G6DOFJointAxisFlag">
</argument> </argument>
<description> <description>
Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG* constants). Gets a generic_6_DOF_joint flag (see [enum G6DOFJointAxisFlag] constants).
</description> </description>
</method> </method>
<method name="generic_6dof_joint_get_param"> <method name="generic_6dof_joint_get_param">
@ -871,7 +871,7 @@
<argument index="2" name="param" type="int" enum="PhysicsServer.G6DOFJointAxisParam"> <argument index="2" name="param" type="int" enum="PhysicsServer.G6DOFJointAxisParam">
</argument> </argument>
<description> <description>
Gets a generic_6_DOF_joint parameter (see G6DOF_JOINT* constants without the G6DOF_JOINT_FLAG*). Gets a generic_6_DOF_joint parameter (see [enum G6DOFJointAxisParam] constants).
</description> </description>
</method> </method>
<method name="generic_6dof_joint_set_flag"> <method name="generic_6dof_joint_set_flag">
@ -886,7 +886,7 @@
<argument index="3" name="enable" type="bool"> <argument index="3" name="enable" type="bool">
</argument> </argument>
<description> <description>
Sets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG* constants). Sets a generic_6_DOF_joint flag (see [enum G6DOFJointAxisFlag] constants).
</description> </description>
</method> </method>
<method name="generic_6dof_joint_set_param"> <method name="generic_6dof_joint_set_param">
@ -901,7 +901,7 @@
<argument index="3" name="value" type="float"> <argument index="3" name="value" type="float">
</argument> </argument>
<description> <description>
Sets a generic_6_DOF_joint parameter (see G6DOF_JOINT* constants without the G6DOF_JOINT_FLAG*). Sets a generic_6_DOF_joint parameter (see [enum G6DOFJointAxisParam] constants).
</description> </description>
</method> </method>
<method name="get_process_info"> <method name="get_process_info">
@ -921,7 +921,7 @@
<argument index="1" name="flag" type="int" enum="PhysicsServer.HingeJointFlag"> <argument index="1" name="flag" type="int" enum="PhysicsServer.HingeJointFlag">
</argument> </argument>
<description> <description>
Gets a hinge_joint flag (see HINGE_JOINT_FLAG* constants). Gets a hinge_joint flag (see [enum HingeJointFlag] constants).
</description> </description>
</method> </method>
<method name="hinge_joint_get_param" qualifiers="const"> <method name="hinge_joint_get_param" qualifiers="const">
@ -932,7 +932,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.HingeJointParam"> <argument index="1" name="param" type="int" enum="PhysicsServer.HingeJointParam">
</argument> </argument>
<description> <description>
Gets a hinge_joint parameter (see HINGE_JOINT* constants without the HINGE_JOINT_FLAG*). Gets a hinge_joint parameter (see [enum HingeJointParam]).
</description> </description>
</method> </method>
<method name="hinge_joint_set_flag"> <method name="hinge_joint_set_flag">
@ -945,7 +945,7 @@
<argument index="2" name="enabled" type="bool"> <argument index="2" name="enabled" type="bool">
</argument> </argument>
<description> <description>
Sets a hinge_joint flag (see HINGE_JOINT_FLAG* constants). Sets a hinge_joint flag (see [enum HingeJointFlag] constants).
</description> </description>
</method> </method>
<method name="hinge_joint_set_param"> <method name="hinge_joint_set_param">
@ -958,7 +958,7 @@
<argument index="2" name="value" type="float"> <argument index="2" name="value" type="float">
</argument> </argument>
<description> <description>
Sets a hinge_joint parameter (see HINGE_JOINT* constants without the HINGE_JOINT_FLAG*). Sets a hinge_joint parameter (see [enum HingeJointParam] constants).
</description> </description>
</method> </method>
<method name="joint_create_cone_twist"> <method name="joint_create_cone_twist">
@ -1091,7 +1091,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.PinJointParam"> <argument index="1" name="param" type="int" enum="PhysicsServer.PinJointParam">
</argument> </argument>
<description> <description>
Gets a pin_joint parameter (see PIN_JOINT* constants). Gets a pin_joint parameter (see [enum PinJointParam] constants).
</description> </description>
</method> </method>
<method name="pin_joint_set_local_a"> <method name="pin_joint_set_local_a">
@ -1126,7 +1126,7 @@
<argument index="2" name="value" type="float"> <argument index="2" name="value" type="float">
</argument> </argument>
<description> <description>
Sets a pin_joint parameter (see PIN_JOINT* constants). Sets a pin_joint parameter (see [enum PinJointParam] constants).
</description> </description>
</method> </method>
<method name="set_active"> <method name="set_active">
@ -1144,7 +1144,7 @@
<argument index="0" name="type" type="int" enum="PhysicsServer.ShapeType"> <argument index="0" name="type" type="int" enum="PhysicsServer.ShapeType">
</argument> </argument>
<description> <description>
Creates a shape of type [code]SHAPE_*[/code]. 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]. Creates a shape of a type from [enum ShapeType]. 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> </description>
</method> </method>
<method name="shape_get_data" qualifiers="const"> <method name="shape_get_data" qualifiers="const">
@ -1162,7 +1162,7 @@
<argument index="0" name="shape" type="RID"> <argument index="0" name="shape" type="RID">
</argument> </argument>
<description> <description>
Returns the type of shape (see [code]SHAPE_*[/code] constants). Returns the type of shape (see [enum ShapeType] constants).
</description> </description>
</method> </method>
<method name="shape_set_data"> <method name="shape_set_data">
@ -1184,7 +1184,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.SliderJointParam"> <argument index="1" name="param" type="int" enum="PhysicsServer.SliderJointParam">
</argument> </argument>
<description> <description>
Gets a slider_joint parameter (see SLIDER_JOINT* constants). Gets a slider_joint parameter (see [enum SliderJointParam] constants).
</description> </description>
</method> </method>
<method name="slider_joint_set_param"> <method name="slider_joint_set_param">
@ -1197,7 +1197,7 @@
<argument index="2" name="value" type="float"> <argument index="2" name="value" type="float">
</argument> </argument>
<description> <description>
Gets a slider_joint parameter (see SLIDER_JOINT* constants). Gets a slider_joint parameter (see [enum SliderJointParam] constants).
</description> </description>
</method> </method>
<method name="space_create"> <method name="space_create">
@ -1257,7 +1257,7 @@
<argument index="2" name="value" type="float"> <argument index="2" name="value" type="float">
</argument> </argument>
<description> <description>
Sets the value for a space parameter. A list of available parameters is on the [code]SPACE_PARAM_*[/code] constants. Sets the value for a space parameter. A list of available parameters is on the [enum SpaceParameter] constants.
</description> </description>
</method> </method>
</methods> </methods>
@ -1509,7 +1509,7 @@
Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. Constant to set/get the 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>
<constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4" enum="AreaParameter"> <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4" enum="AreaParameter">
This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE. This constant was used to set/get the falloff factor for point gravity. It has been superseded by [constant AREA_PARAM_GRAVITY_DISTANCE_SCALE].
</constant> </constant>
<constant name="AREA_PARAM_LINEAR_DAMP" value="5" enum="AreaParameter"> <constant name="AREA_PARAM_LINEAR_DAMP" value="5" enum="AreaParameter">
Constant to set/get the linear dampening factor of an area. Constant to set/get the linear dampening factor of an area.

View File

@ -22,7 +22,8 @@
Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when using a shader to offset vertices. Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when using a shader to offset vertices.
</member> </member>
<member name="flip_faces" type="bool" setter="set_flip_faces" getter="get_flip_faces" default="false"> <member name="flip_faces" type="bool" setter="set_flip_faces" getter="get_flip_faces" default="false">
If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. Result is the same as using *CULL_BACK* in [SpatialMaterial]. If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn.
This gives the same result as using [constant SpatialMaterial.CULL_BACK] in [member SpatialMaterial.params_cull_mode].
</member> </member>
<member name="material" type="Material" setter="set_material" getter="get_material"> <member name="material" type="Material" setter="set_material" getter="get_material">
The current [Material] of the primitive mesh. The current [Material] of the primitive mesh.

View File

@ -17,7 +17,10 @@
<argument index="0" name="hint" type="Dictionary"> <argument index="0" name="hint" type="Dictionary">
</argument> </argument>
<description> <description>
Adds a custom property info to a property. The dictionary must contain: name:[String](the property's name) and type:[int](see [code]TYPE_*[/code] in [@GlobalScope]), and optionally hint:[int](see [code]PROPERTY_HINT_*[/code] in [@GlobalScope]), hint_string:[String]. Adds a custom property info to a property. The dictionary must contain:
- [code]name[/code]: [String] (the property's name)
- [code]type[/code]: [int] (see [enum Variant.Type])
- optionally [code]hint[/code]: [int] (see [enum PropertyHint]) and [code]hint_string[/code]: [String]
[b]Example:[/b] [b]Example:[/b]
[codeblock] [codeblock]
ProjectSettings.set("category/property_name", 0) ProjectSettings.set("category/property_name", 0)

View File

@ -289,7 +289,7 @@
If [code]false[/code], you need to manually call [method MultiplayerAPI.poll] to process network packets and deliver RPCs/RSETs. This allows running RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual [Mutex] protection when accessing the [MultiplayerAPI] from threads. If [code]false[/code], you need to manually call [method MultiplayerAPI.poll] to process network packets and deliver RPCs/RSETs. This allows running RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual [Mutex] protection when accessing the [MultiplayerAPI] from threads.
</member> </member>
<member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer">
The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the [SceneTree] will become a network server (check with [method is_network_server]) and will set the root node's network mode to master (see [code]NETWORK_MODE_*[/code] constants in [Node]), or it will become a regular peer with the root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to [SceneTree]'s signals. The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the [SceneTree] will become a network server (check with [method is_network_server]) and will set the root node's network mode to master, or it will become a regular peer with the root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to [SceneTree]'s signals.
</member> </member>
<member name="paused" type="bool" setter="set_pause" getter="is_paused" default="false"> <member name="paused" type="bool" setter="set_pause" getter="is_paused" default="false">
If [code]true[/code], the [SceneTree] is paused. Doing so will have the following behavior: If [code]true[/code], the [SceneTree] is paused. Doing so will have the following behavior:

View File

@ -167,7 +167,7 @@
</argument> </argument>
<description> <description>
Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh]. Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh].
Default flag is [constant Mesh.ARRAY_COMPRESS_DEFAULT]. See [code]Mesh.ARRAY_COMPRESS_*[/code] constants for other flags. Default flag is [constant Mesh.ARRAY_COMPRESS_DEFAULT]. See [code]ARRAY_COMPRESS_*[/code] constants in [enum Mesh.ArrayFormat] for other flags.
</description> </description>
</method> </method>
<method name="commit_to_arrays"> <method name="commit_to_arrays">

View File

@ -144,7 +144,7 @@
If [code]true[/code], tabs can be rearranged with mouse drag. If [code]true[/code], tabs can be rearranged with mouse drag.
</member> </member>
<member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabContainer.TabAlign" default="1"> <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabContainer.TabAlign" default="1">
The alignment of all tabs in the tab container. See the [code]ALIGN_*[/code] constants for details. The alignment of all tabs in the tab container. See the [enum TabAlign] constants for details.
</member> </member>
<member name="tabs_visible" type="bool" setter="set_tabs_visible" getter="are_tabs_visible" default="true"> <member name="tabs_visible" type="bool" setter="set_tabs_visible" getter="are_tabs_visible" default="true">
If [code]true[/code], tabs are visible. If [code]false[/code], tabs' content and titles are hidden. If [code]true[/code], tabs are visible. If [code]false[/code], tabs' content and titles are hidden.

View File

@ -16,7 +16,7 @@
If [code]true[/code], the texture stretches to the edges of the node's bounding rectangle using the [member stretch_mode]. If [code]false[/code], the texture will not scale with the node. If [code]true[/code], the texture stretches to the edges of the node's bounding rectangle using the [member stretch_mode]. If [code]false[/code], the texture will not scale with the node.
</member> </member>
<member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureButton.StretchMode" default="0"> <member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureButton.StretchMode" default="0">
Controls the texture's behavior when you resize the node's bounding rectangle, [b]only if[/b] [member expand] is [code]true[/code]. Set it to one of the [code]STRETCH_*[/code] constants. See the constants to learn more. Controls the texture's behavior when you resize the node's bounding rectangle, [b]only if[/b] [member expand] is [code]true[/code]. Set it to one of the [enum StretchMode] constants. See the constants to learn more.
</member> </member>
<member name="texture_click_mask" type="BitMap" setter="set_click_mask" getter="get_click_mask"> <member name="texture_click_mask" type="BitMap" setter="set_click_mask" getter="get_click_mask">
Pure black and white [BitMap] image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes. Pure black and white [BitMap] image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes.

View File

@ -26,7 +26,7 @@
<argument index="1" name="type" type="String"> <argument index="1" name="type" type="String">
</argument> </argument>
<description> <description>
Clears the [Color] at [code]name[/code] if the Theme has [code]type[/code]. Clears the [Color] at [code]name[/code] if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="clear_constant"> <method name="clear_constant">
@ -37,7 +37,7 @@
<argument index="1" name="type" type="String"> <argument index="1" name="type" type="String">
</argument> </argument>
<description> <description>
Clears the constant at [code]name[/code] if the Theme has [code]type[/code]. Clears the constant at [code]name[/code] if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="clear_font"> <method name="clear_font">
@ -48,7 +48,7 @@
<argument index="1" name="type" type="String"> <argument index="1" name="type" type="String">
</argument> </argument>
<description> <description>
Clears the [Font] at [code]name[/code] if the Theme has [code]type[/code]. Clears the [Font] at [code]name[/code] if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="clear_icon"> <method name="clear_icon">
@ -59,7 +59,7 @@
<argument index="1" name="type" type="String"> <argument index="1" name="type" type="String">
</argument> </argument>
<description> <description>
Clears the icon at [code]name[/code] if the Theme has [code]type[/code]. Clears the icon at [code]name[/code] if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="clear_stylebox"> <method name="clear_stylebox">
@ -70,14 +70,14 @@
<argument index="1" name="type" type="String"> <argument index="1" name="type" type="String">
</argument> </argument>
<description> <description>
Clears [StyleBox] at [code]name[/code] if the Theme has [code]type[/code]. Clears [StyleBox] at [code]name[/code] if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="copy_default_theme"> <method name="copy_default_theme">
<return type="void"> <return type="void">
</return> </return>
<description> <description>
Sets the Theme's values to a copy of the default theme values. Sets the theme's values to a copy of the default theme values.
</description> </description>
</method> </method>
<method name="copy_theme"> <method name="copy_theme">
@ -86,7 +86,7 @@
<argument index="0" name="other" type="Theme"> <argument index="0" name="other" type="Theme">
</argument> </argument>
<description> <description>
Sets the Theme's values to a copy of a given theme. Sets the theme's values to a copy of a given theme.
</description> </description>
</method> </method>
<method name="get_color" qualifiers="const"> <method name="get_color" qualifiers="const">
@ -97,7 +97,7 @@
<argument index="1" name="type" type="String"> <argument index="1" name="type" type="String">
</argument> </argument>
<description> <description>
Returns the [Color] at [code]name[/code] if the Theme has [code]type[/code]. Returns the [Color] at [code]name[/code] if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_color_list" qualifiers="const"> <method name="get_color_list" qualifiers="const">
@ -106,7 +106,7 @@
<argument index="0" name="type" type="String"> <argument index="0" name="type" type="String">
</argument> </argument>
<description> <description>
Returns all the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if the Theme has [code]type[/code]. Returns all the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_constant" qualifiers="const"> <method name="get_constant" qualifiers="const">
@ -117,7 +117,7 @@
<argument index="1" name="type" type="String"> <argument index="1" name="type" type="String">
</argument> </argument>
<description> <description>
Returns the constant at [code]name[/code] if the Theme has [code]type[/code]. Returns the constant at [code]name[/code] if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_constant_list" qualifiers="const"> <method name="get_constant_list" qualifiers="const">
@ -126,7 +126,7 @@
<argument index="0" name="type" type="String"> <argument index="0" name="type" type="String">
</argument> </argument>
<description> <description>
Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the Theme has [code]type[/code]. Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_font" qualifiers="const"> <method name="get_font" qualifiers="const">
@ -137,7 +137,7 @@
<argument index="1" name="type" type="String"> <argument index="1" name="type" type="String">
</argument> </argument>
<description> <description>
Returns the [Font] at [code]name[/code] if the Theme has [code]type[/code]. Returns the [Font] at [code]name[/code] if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_font_list" qualifiers="const"> <method name="get_font_list" qualifiers="const">
@ -146,7 +146,7 @@
<argument index="0" name="type" type="String"> <argument index="0" name="type" type="String">
</argument> </argument>
<description> <description>
Returns all the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if the Theme has [code]type[/code]. Returns all the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_icon" qualifiers="const"> <method name="get_icon" qualifiers="const">
@ -157,7 +157,7 @@
<argument index="1" name="type" type="String"> <argument index="1" name="type" type="String">
</argument> </argument>
<description> <description>
Returns the icon [Texture] at [code]name[/code] if the Theme has [code]type[/code]. Returns the icon [Texture] at [code]name[/code] if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_icon_list" qualifiers="const"> <method name="get_icon_list" qualifiers="const">
@ -166,7 +166,7 @@
<argument index="0" name="type" type="String"> <argument index="0" name="type" type="String">
</argument> </argument>
<description> <description>
Returns all the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if the Theme has [code]type[/code]. Returns all the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_stylebox" qualifiers="const"> <method name="get_stylebox" qualifiers="const">
@ -177,7 +177,7 @@
<argument index="1" name="type" type="String"> <argument index="1" name="type" type="String">
</argument> </argument>
<description> <description>
Returns the icon [StyleBox] at [code]name[/code] if the Theme has [code]type[/code]. Returns the icon [StyleBox] at [code]name[/code] if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_stylebox_list" qualifiers="const"> <method name="get_stylebox_list" qualifiers="const">
@ -186,14 +186,14 @@
<argument index="0" name="type" type="String"> <argument index="0" name="type" type="String">
</argument> </argument>
<description> <description>
Returns all the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the Theme has [code]type[/code]. Returns all the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_stylebox_types" qualifiers="const"> <method name="get_stylebox_types" qualifiers="const">
<return type="PoolStringArray"> <return type="PoolStringArray">
</return> </return>
<description> <description>
Returns all the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the Theme has [code]type[/code]. Returns all the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="get_type_list" qualifiers="const"> <method name="get_type_list" qualifiers="const">
@ -202,7 +202,7 @@
<argument index="0" name="type" type="String"> <argument index="0" name="type" type="String">
</argument> </argument>
<description> <description>
Returns all the types in [code]type[/code] as a [PoolStringArray] for use in any of the get_* functions, if the Theme has [code]type[/code]. Returns all the types in [code]type[/code] as a [PoolStringArray] for use in any of the [code]get_*[/code] functions, if the theme has [code]type[/code].
</description> </description>
</method> </method>
<method name="has_color" qualifiers="const"> <method name="has_color" qualifiers="const">
@ -214,7 +214,7 @@
</argument> </argument>
<description> <description>
Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]type[/code]. Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the Theme does not have [code]type[/code]. Returns [code]false[/code] if the theme does not have [code]type[/code].
</description> </description>
</method> </method>
<method name="has_constant" qualifiers="const"> <method name="has_constant" qualifiers="const">
@ -226,7 +226,7 @@
</argument> </argument>
<description> <description>
Returns [code]true[/code] if constant with [code]name[/code] is in [code]type[/code]. Returns [code]true[/code] if constant with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the Theme does not have [code]type[/code]. Returns [code]false[/code] if the theme does not have [code]type[/code].
</description> </description>
</method> </method>
<method name="has_font" qualifiers="const"> <method name="has_font" qualifiers="const">
@ -238,7 +238,7 @@
</argument> </argument>
<description> <description>
Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]type[/code]. Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the Theme does not have [code]type[/code]. Returns [code]false[/code] if the theme does not have [code]type[/code].
</description> </description>
</method> </method>
<method name="has_icon" qualifiers="const"> <method name="has_icon" qualifiers="const">
@ -250,7 +250,7 @@
</argument> </argument>
<description> <description>
Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]type[/code]. Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the Theme does not have [code]type[/code]. Returns [code]false[/code] if the theme does not have [code]type[/code].
</description> </description>
</method> </method>
<method name="has_stylebox" qualifiers="const"> <method name="has_stylebox" qualifiers="const">
@ -262,7 +262,7 @@
</argument> </argument>
<description> <description>
Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]type[/code]. Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the Theme does not have [code]type[/code]. Returns [code]false[/code] if the theme does not have [code]type[/code].
</description> </description>
</method> </method>
<method name="set_color"> <method name="set_color">
@ -275,8 +275,8 @@
<argument index="2" name="color" type="Color"> <argument index="2" name="color" type="Color">
</argument> </argument>
<description> <description>
Sets the Theme's [Color] to [code]color[/code] at [code]name[/code] in [code]type[/code]. Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the Theme does not have [code]type[/code]. Does nothing if the theme does not have [code]type[/code].
</description> </description>
</method> </method>
<method name="set_constant"> <method name="set_constant">
@ -289,8 +289,8 @@
<argument index="2" name="constant" type="int"> <argument index="2" name="constant" type="int">
</argument> </argument>
<description> <description>
Sets the Theme's constant to [code]constant[/code] at [code]name[/code] in [code]type[/code]. Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the Theme does not have [code]type[/code]. Does nothing if the theme does not have [code]type[/code].
</description> </description>
</method> </method>
<method name="set_font"> <method name="set_font">
@ -303,8 +303,8 @@
<argument index="2" name="font" type="Font"> <argument index="2" name="font" type="Font">
</argument> </argument>
<description> <description>
Sets the Theme's [Font] to [code]font[/code] at [code]name[/code] in [code]type[/code]. Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the Theme does not have [code]type[/code]. Does nothing if the theme does not have [code]type[/code].
</description> </description>
</method> </method>
<method name="set_icon"> <method name="set_icon">
@ -317,8 +317,8 @@
<argument index="2" name="texture" type="Texture"> <argument index="2" name="texture" type="Texture">
</argument> </argument>
<description> <description>
Sets the Theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]type[/code]. Sets the theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the Theme does not have [code]type[/code]. Does nothing if the theme does not have [code]type[/code].
</description> </description>
</method> </method>
<method name="set_stylebox"> <method name="set_stylebox">
@ -331,8 +331,8 @@
<argument index="2" name="texture" type="StyleBox"> <argument index="2" name="texture" type="StyleBox">
</argument> </argument>
<description> <description>
Sets Theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]type[/code]. Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the Theme does not have [code]type[/code]. Does nothing if the theme does not have [code]type[/code].
</description> </description>
</method> </method>
</methods> </methods>

View File

@ -229,7 +229,7 @@
The number of columns. The number of columns.
</member> </member>
<member name="drop_mode_flags" type="int" setter="set_drop_mode_flags" getter="get_drop_mode_flags" default="0"> <member name="drop_mode_flags" type="int" setter="set_drop_mode_flags" getter="get_drop_mode_flags" default="0">
The drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. Once dropping is done, reverts to [constant DROP_MODE_DISABLED]. Setting this during [method Control.can_drop_data] is recommended. The drop mode as an OR combination of flags. See [enum DropModeFlags] constants. Once dropping is done, reverts to [constant DROP_MODE_DISABLED]. Setting this during [method Control.can_drop_data] is recommended.
</member> </member>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="2" /> <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="2" />
<member name="hide_folding" type="bool" setter="set_hide_folding" getter="is_folding_hidden" default="false"> <member name="hide_folding" type="bool" setter="set_hide_folding" getter="is_folding_hidden" default="false">
@ -240,7 +240,7 @@
</member> </member>
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" override="true" default="true" /> <member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" override="true" default="true" />
<member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="Tree.SelectMode" default="0"> <member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="Tree.SelectMode" default="0">
Allows single or multiple selection. See the [code]SELECT_*[/code] constants. Allows single or multiple selection. See the [enum SelectMode] constants.
</member> </member>
</members> </members>
<signals> <signals>

View File

@ -396,7 +396,7 @@
<argument index="1" name="mode" type="int" enum="TreeItem.TreeCellMode"> <argument index="1" name="mode" type="int" enum="TreeItem.TreeCellMode">
</argument> </argument>
<description> <description>
Sets the given column's cell mode to [code]mode[/code]. See [code]CELL_MODE_*[/code] constants. Sets the given column's cell mode to [code]mode[/code]. See [enum TreeCellMode] constants.
</description> </description>
</method> </method>
<method name="set_checked"> <method name="set_checked">

View File

@ -433,10 +433,10 @@
The interpolation starts quickly and slows down towards the end. The interpolation starts quickly and slows down towards the end.
</constant> </constant>
<constant name="EASE_IN_OUT" value="2" enum="EaseType"> <constant name="EASE_IN_OUT" value="2" enum="EaseType">
A combination of EASE_IN and EASE_OUT. The interpolation is slowest at both ends. A combination of [constant EASE_IN] and [constant EASE_OUT]. The interpolation is slowest at both ends.
</constant> </constant>
<constant name="EASE_OUT_IN" value="3" enum="EaseType"> <constant name="EASE_OUT_IN" value="3" enum="EaseType">
A combination of EASE_IN and EASE_OUT. The interpolation is fastest at both ends. A combination of [constant EASE_IN] and [constant EASE_OUT]. The interpolation is fastest at both ends.
</constant> </constant>
</constants> </constants>
</class> </class>

View File

@ -17,7 +17,7 @@
- VisualScript tracks properties inside Variants as well, but it also uses static typing. The GUI interface enforces that properties have a particular type that doesn't change over time. - VisualScript tracks properties inside Variants as well, but it also uses static typing. The GUI interface enforces that properties have a particular type that doesn't change over time.
- C# is statically typed, but uses the Mono [code]object[/code] type in place of Godot's Variant class when it needs to represent a dynamic value. [code]object[/code] is the Mono runtime's equivalent of the same concept. - C# is statically typed, but uses the Mono [code]object[/code] type in place of Godot's Variant class when it needs to represent a dynamic value. [code]object[/code] is the Mono runtime's equivalent of the same concept.
- The statically-typed language NativeScript C++ does not define a built-in Variant-like class. Godot's GDNative bindings provide their own godot::Variant class for users; Any point at which the C++ code starts interacting with the Godot runtime is a place where you might have to start wrapping data inside Variant objects. - The statically-typed language NativeScript C++ does not define a built-in Variant-like class. Godot's GDNative bindings provide their own godot::Variant class for users; Any point at which the C++ code starts interacting with the Godot runtime is a place where you might have to start wrapping data inside Variant objects.
The global [method @GDScript.typeof] function returns the enumerated value of the Variant type stored in the current variable. These correspond to [code]TYPE_*[/code] constants in the [@GlobalScope] docs. The global [method @GDScript.typeof] function returns the enumerated value of the Variant type stored in the current variable (see [enum Variant.Type]).
[codeblock] [codeblock]
var foo = 2 var foo = 2
match typeof(foo): match typeof(foo):

View File

@ -789,7 +789,7 @@
<argument index="1" name="mode" type="int" enum="VisualServer.CanvasLightMode"> <argument index="1" name="mode" type="int" enum="VisualServer.CanvasLightMode">
</argument> </argument>
<description> <description>
The mode of the light, see [code]CANVAS_LIGHT_MODE_*[/code] constants. The mode of the light, see [enum CanvasLightMode] constants.
</description> </description>
</method> </method>
<method name="canvas_light_set_scale"> <method name="canvas_light_set_scale">
@ -843,7 +843,7 @@
<argument index="1" name="filter" type="int" enum="VisualServer.CanvasLightShadowFilter"> <argument index="1" name="filter" type="int" enum="VisualServer.CanvasLightShadowFilter">
</argument> </argument>
<description> <description>
Sets the canvas light's shadow's filter, see [code]CANVAS_LIGHT_SHADOW_FILTER_*[/code] constants. Sets the canvas light's shadow's filter, see [enum CanvasLightShadowFilter] constants.
</description> </description>
</method> </method>
<method name="canvas_light_set_shadow_gradient_length"> <method name="canvas_light_set_shadow_gradient_length">
@ -926,7 +926,7 @@
<argument index="1" name="mode" type="int" enum="VisualServer.CanvasOccluderPolygonCullMode"> <argument index="1" name="mode" type="int" enum="VisualServer.CanvasOccluderPolygonCullMode">
</argument> </argument>
<description> <description>
Sets an occluder polygons cull mode. See [code]CANVAS_OCCLUDER_POLYGON_CULL_MODE_*[/code] constants. Sets an occluder polygons cull mode. See [enum CanvasOccluderPolygonCullMode] constants.
</description> </description>
</method> </method>
<method name="canvas_occluder_polygon_set_shape"> <method name="canvas_occluder_polygon_set_shape">
@ -1332,7 +1332,7 @@
<argument index="0" name="info" type="int" enum="VisualServer.RenderInfo"> <argument index="0" name="info" type="int" enum="VisualServer.RenderInfo">
</argument> </argument>
<description> <description>
Returns a certain information, see [code]RENDER_INFO_*[/code] for options. Returns a certain information, see [enum RenderInfo] for options.
</description> </description>
</method> </method>
<method name="get_test_cube"> <method name="get_test_cube">
@ -2308,7 +2308,7 @@
</return> </return>
<argument index="0" name="mesh" type="RID"> <argument index="0" name="mesh" type="RID">
</argument> </argument>
<argument index="1" name="primtive" type="int" enum="VisualServer.PrimitiveType"> <argument index="1" name="primitive" type="int" enum="VisualServer.PrimitiveType">
</argument> </argument>
<argument index="2" name="arrays" type="Array"> <argument index="2" name="arrays" type="Array">
</argument> </argument>
@ -2317,7 +2317,7 @@
<argument index="4" name="compress_format" type="int" default="97280"> <argument index="4" name="compress_format" type="int" default="97280">
</argument> </argument>
<description> <description>
Adds a surface generated from the Arrays to a mesh. See [code]PRIMITIVE_TYPE_*[/code] constants for types. Adds a surface generated from the Arrays to a mesh. See [enum PrimitiveType] constants for types.
</description> </description>
</method> </method>
<method name="mesh_clear"> <method name="mesh_clear">
@ -3665,7 +3665,7 @@
<argument index="1" name="info" type="int" enum="VisualServer.ViewportRenderInfo"> <argument index="1" name="info" type="int" enum="VisualServer.ViewportRenderInfo">
</argument> </argument>
<description> <description>
Returns a viewport's render information. For options, see the [code]VIEWPORT_RENDER_INFO*[/code] constants. Returns a viewport's render information. For options, see the [enum ViewportRenderInfo] constants.
</description> </description>
</method> </method>
<method name="viewport_get_texture" qualifiers="const"> <method name="viewport_get_texture" qualifiers="const">

View File

@ -84,7 +84,7 @@
<return type="int" enum="XMLParser.NodeType"> <return type="int" enum="XMLParser.NodeType">
</return> </return>
<description> <description>
Gets the type of the current node. Compare with [code]NODE_*[/code] constants. Gets the type of the current node. Compare with [enum NodeType] constants.
</description> </description>
</method> </method>
<method name="has_attribute" qualifiers="const"> <method name="has_attribute" qualifiers="const">

View File

@ -208,7 +208,7 @@
<argument index="1" name="type" type="int"> <argument index="1" name="type" type="int">
</argument> </argument>
<description> <description>
Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the enum [code]TYPE_*[/code] in [@GlobalScope]. Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the [enum Variant.Type] values.
[codeblock] [codeblock]
a = Vector2(1, 0) a = Vector2(1, 0)
# Prints 1 # Prints 1
@ -1217,7 +1217,7 @@
<argument index="0" name="what" type="Variant"> <argument index="0" name="what" type="Variant">
</argument> </argument>
<description> <description>
Returns the internal type of the given Variant object, using the [code]TYPE_*[/code] enum in [@GlobalScope]. Returns the internal type of the given Variant object, using the [enum Variant.Type] values.
[codeblock] [codeblock]
p = parse_json('["a", "b", "c"]') p = parse_json('["a", "b", "c"]')
if typeof(p) == TYPE_ARRAY: if typeof(p) == TYPE_ARRAY:
@ -1233,7 +1233,7 @@
<argument index="0" name="json" type="String"> <argument index="0" name="json" type="String">
</argument> </argument>
<description> <description>
Checks that [code]json[/code] is valid JSON data. Returns empty string if valid. Returns error message if not valid. Checks that [code]json[/code] is valid JSON data. Returns an empty string if valid, or an error message otherwise.
[codeblock] [codeblock]
j = to_json([1, 2, 3]) j = to_json([1, 2, 3])
v = validate_json(j) v = validate_json(j)

View File

@ -45,7 +45,7 @@
<argument index="0" name="idx" type="int"> <argument index="0" name="idx" type="int">
</argument> </argument>
<description> <description>
Return the specified input port's type. See the [code]TYPE_*[/code] enum in [@GlobalScope]. Return the specified input port's type. See the [enum Variant.Type] values.
</description> </description>
</method> </method>
<method name="_get_output_sequence_port_count" qualifiers="virtual"> <method name="_get_output_sequence_port_count" qualifiers="virtual">
@ -86,7 +86,7 @@
<argument index="0" name="idx" type="int"> <argument index="0" name="idx" type="int">
</argument> </argument>
<description> <description>
Return the specified output's type. See the [code]TYPE_*[/code] enum in [@GlobalScope]. Return the specified output's type. See the [enum Variant.Type] values.
</description> </description>
</method> </method>
<method name="_get_text" qualifiers="virtual"> <method name="_get_text" qualifiers="virtual">
@ -136,17 +136,17 @@
The start mode used the first time when [method _step] is called. The start mode used the first time when [method _step] is called.
</constant> </constant>
<constant name="START_MODE_CONTINUE_SEQUENCE" value="1" enum="StartMode"> <constant name="START_MODE_CONTINUE_SEQUENCE" value="1" enum="StartMode">
The start mode used when [method _step] is called after coming back from a STEP_PUSH_STACK_BIT. The start mode used when [method _step] is called after coming back from a [constant STEP_PUSH_STACK_BIT].
</constant> </constant>
<constant name="START_MODE_RESUME_YIELD" value="2" enum="StartMode"> <constant name="START_MODE_RESUME_YIELD" value="2" enum="StartMode">
The start mode used when [method _step] is called after resuming from STEP_YIELD_BIT. The start mode used when [method _step] is called after resuming from [constant STEP_YIELD_BIT].
</constant> </constant>
<constant name="STEP_PUSH_STACK_BIT" value="16777216"> <constant name="STEP_PUSH_STACK_BIT" value="16777216">
Hint used by [method _step] to tell that control should return to it when there is no other node left to execute. Hint used by [method _step] to tell that control should return to it when there is no other node left to execute.
This is used by [VisualScriptCondition] to redirect the sequence to the "Done" port after the [code]true[/code]/[code]false[/code] branch has finished execution. This is used by [VisualScriptCondition] to redirect the sequence to the "Done" port after the [code]true[/code]/[code]false[/code] branch has finished execution.
</constant> </constant>
<constant name="STEP_GO_BACK_BIT" value="33554432"> <constant name="STEP_GO_BACK_BIT" value="33554432">
Hint used by [method _step] to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function. Hint used by [method _step] to tell that control should return back, either hitting a previous [constant STEP_PUSH_STACK_BIT] or exiting the function.
</constant> </constant>
<constant name="STEP_NO_ADVANCE_BIT" value="67108864"> <constant name="STEP_NO_ADVANCE_BIT" value="67108864">
</constant> </constant>

View File

@ -1693,7 +1693,7 @@ void VisualServer::_bind_methods() {
ClassDB::bind_method(D_METHOD("mesh_create"), &VisualServer::mesh_create); ClassDB::bind_method(D_METHOD("mesh_create"), &VisualServer::mesh_create);
ClassDB::bind_method(D_METHOD("mesh_surface_get_format_offset", "format", "vertex_len", "index_len", "array_index"), &VisualServer::mesh_surface_get_format_offset); ClassDB::bind_method(D_METHOD("mesh_surface_get_format_offset", "format", "vertex_len", "index_len", "array_index"), &VisualServer::mesh_surface_get_format_offset);
ClassDB::bind_method(D_METHOD("mesh_surface_get_format_stride", "format", "vertex_len", "index_len"), &VisualServer::mesh_surface_get_format_stride); ClassDB::bind_method(D_METHOD("mesh_surface_get_format_stride", "format", "vertex_len", "index_len"), &VisualServer::mesh_surface_get_format_stride);
ClassDB::bind_method(D_METHOD("mesh_add_surface_from_arrays", "mesh", "primtive", "arrays", "blend_shapes", "compress_format"), &VisualServer::mesh_add_surface_from_arrays, DEFVAL(Array()), DEFVAL(ARRAY_COMPRESS_DEFAULT)); ClassDB::bind_method(D_METHOD("mesh_add_surface_from_arrays", "mesh", "primitive", "arrays", "blend_shapes", "compress_format"), &VisualServer::mesh_add_surface_from_arrays, DEFVAL(Array()), DEFVAL(ARRAY_COMPRESS_DEFAULT));
ClassDB::bind_method(D_METHOD("mesh_set_blend_shape_count", "mesh", "amount"), &VisualServer::mesh_set_blend_shape_count); ClassDB::bind_method(D_METHOD("mesh_set_blend_shape_count", "mesh", "amount"), &VisualServer::mesh_set_blend_shape_count);
ClassDB::bind_method(D_METHOD("mesh_get_blend_shape_count", "mesh"), &VisualServer::mesh_get_blend_shape_count); ClassDB::bind_method(D_METHOD("mesh_get_blend_shape_count", "mesh"), &VisualServer::mesh_get_blend_shape_count);
ClassDB::bind_method(D_METHOD("mesh_set_blend_shape_mode", "mesh", "mode"), &VisualServer::mesh_set_blend_shape_mode); ClassDB::bind_method(D_METHOD("mesh_set_blend_shape_mode", "mesh", "mode"), &VisualServer::mesh_set_blend_shape_mode);