diff options
Diffstat (limited to 'doc/classes')
29 files changed, 418 insertions, 136 deletions
diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 4244e66a35..f87a40b8aa 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -92,8 +92,10 @@ </methods> <members> <member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok"> + If [code]true[/code] the dialog is hidden when accepted. Default value: [code]true[/code]. </member> <member name="dialog_text" type="String" setter="set_text" getter="get_text"> + The text displayed by this dialog. </member> </members> <signals> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 9542c83eaf..2cfbaffe04 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -104,6 +104,7 @@ <return type="Array"> </return> <description> + Returns a copy of this [code]Array[/code]. </description> </method> <method name="empty"> @@ -177,8 +178,10 @@ </description> </method> <method name="invert"> + <return type="Array"> + </return> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array. </description> </method> <method name="pop_back"> @@ -238,17 +241,21 @@ </description> </method> <method name="sort"> + <return type="Array"> + </return> <description> - Sort the array using natural order. + Sort the array using natural order and return reference to the array. </description> </method> <method name="sort_custom"> + <return type="Array"> + </return> <argument index="0" name="obj" type="Object"> </argument> <argument index="1" name="func" type="String"> </argument> <description> - Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. + Sort the array using a custom method and return reference to the array. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. </description> </method> </methods> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index d872d0892d..63e6a5f682 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -77,6 +77,9 @@ </methods> <members> <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> + Returns a [Dictionary] with two keys : + [code]data[/code] : [PoolByteArray] with [code]true[/code]/[code]false[/code] [code]BitMap[/code] data. + [code]size[/code] : The [code]Bitmap[/code]'s size. </member> </members> <constants> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 228b6ebf91..c627112af5 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -5,7 +5,7 @@ </brief_description> <description> Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [CanvasItem] based nodes. - This node is intended to be a simple helper get get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from [Node2D] and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in [Viewport]. + This node is intended to be a simple helper to get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from [Node2D] and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in [Viewport]. </description> <tutorials> </tutorials> diff --git a/doc/classes/CanvasModulate.xml b/doc/classes/CanvasModulate.xml index f0e3132da5..b4b20e29f9 100644 --- a/doc/classes/CanvasModulate.xml +++ b/doc/classes/CanvasModulate.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CanvasModulate" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Tint the entire canvas + Tint the entire canvas. </brief_description> <description> - CanvasModulate tints the canvas elements using its assigned color + [code]CanvasModulate[/code] tints the canvas elements using its assigned [code]color[/code]. </description> <tutorials> </tutorials> @@ -30,6 +30,7 @@ </methods> <members> <member name="color" type="Color" setter="set_color" getter="get_color"> + The tint color to apply. </member> </members> <constants> diff --git a/doc/classes/ColorRect.xml b/doc/classes/ColorRect.xml index 90e88603b0..6e70a1e8b7 100644 --- a/doc/classes/ColorRect.xml +++ b/doc/classes/ColorRect.xml @@ -38,6 +38,10 @@ </methods> <members> <member name="color" type="Color" setter="set_frame_color" getter="get_frame_color"> + The color to fill the [code]ColorRect[/code]. + [codeblock] + $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect node's color to red + [/codeblock] </member> </members> <constants> diff --git a/doc/classes/ConvexPolygonShape.xml b/doc/classes/ConvexPolygonShape.xml index 9a7cb0d475..822b99547e 100644 --- a/doc/classes/ConvexPolygonShape.xml +++ b/doc/classes/ConvexPolygonShape.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ConvexPolygonShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Convex Polygon Shape. + Convex polygon shape for 3D physics. </brief_description> <description> - Convex polygon shape resource, which can be set into a [PhysicsBody] or area. + Convex polygon shape resource, which can be added to a [PhysicsBody] or area. </description> <tutorials> </tutorials> @@ -28,6 +28,7 @@ </methods> <members> <member name="points" type="PoolVector3Array" setter="set_points" getter="get_points"> + The list of 3D points forming the convex polygon shape. </member> </members> <constants> diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index c5b6d90041..0cb4f4045b 100644 --- a/doc/classes/ConvexPolygonShape2D.xml +++ b/doc/classes/ConvexPolygonShape2D.xml @@ -16,7 +16,7 @@ <return type="PoolVector2Array"> </return> <description> - Return a list of points in either clockwise or counter clockwise order, forming a convex polygon. + Returns a list of points in either clockwise or counter clockwise order, forming a convex polygon. </description> </method> <method name="set_point_cloud"> @@ -34,12 +34,13 @@ <argument index="0" name="points" type="PoolVector2Array"> </argument> <description> - Set a list of points in either clockwise or counter clockwise order, forming a convex polygon. + Sets a list of points in either clockwise or counter clockwise order, forming a convex polygon. </description> </method> </methods> <members> <member name="points" type="PoolVector2Array" setter="set_points" getter="get_points"> + The polygon's list of vertices. Can be in either clockwise or counterclockwise order. </member> </members> <constants> diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index ee0b873084..c3c4c7a8ac 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -85,6 +85,7 @@ <return type="int"> </return> <description> + Returns the currently opened directory's drive index. See [method get_drive] to convert returned index to the name of the drive. </description> </method> <method name="get_drive"> diff --git a/doc/classes/File.xml b/doc/classes/File.xml index fd71f42a04..6272d4105c 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -30,14 +30,14 @@ <return type="void"> </return> <description> - Close the currently opened file. + Closes the currently opened file. </description> </method> <method name="eof_reached" qualifiers="const"> <return type="bool"> </return> <description> - Returns [code]true[/code] if the file cursor reached the end of the file. + Returns [code]true[/code] if the file cursor has reached the end of the file. </description> </method> <method name="file_exists" qualifiers="const"> @@ -46,42 +46,42 @@ <argument index="0" name="path" type="String"> </argument> <description> - Returns [code]true[/code] if the file in the specified path exists. + Returns [code]true[/code] if the file exists in the given path. </description> </method> <method name="get_16" qualifiers="const"> <return type="int"> </return> <description> - Get the next 16 bits from the file as an integer. + Returns the next 16 bits from the file as an integer. </description> </method> <method name="get_32" qualifiers="const"> <return type="int"> </return> <description> - Get the next 32 bits from the file as an integer. + Returns the next 32 bits from the file as an integer. </description> </method> <method name="get_64" qualifiers="const"> <return type="int"> </return> <description> - Get the next 64 bits from the file as an integer. + Returns the next 64 bits from the file as an integer. </description> </method> <method name="get_8" qualifiers="const"> <return type="int"> </return> <description> - Get the next 8 bits from the file as an integer. + Returns the next 8 bits from the file as an integer. </description> </method> <method name="get_as_text" qualifiers="const"> <return type="String"> </return> <description> - Get the whole file as a [String]. + Returns the whole file as a [String]. </description> </method> <method name="get_buffer" qualifiers="const"> @@ -90,7 +90,7 @@ <argument index="0" name="len" type="int"> </argument> <description> - Get next len bytes of the file as a [PoolByteArray]. + Returns next [code]len[/code] bytes of the file as a [PoolByteArray]. </description> </method> <method name="get_csv_line" qualifiers="const"> @@ -99,14 +99,14 @@ <argument index="0" name="delim" type="String" default="",""> </argument> <description> - Get the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma). + Returns the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma). </description> </method> <method name="get_double" qualifiers="const"> <return type="float"> </return> <description> - Get the next 64 bits from the file as a floating point number. + Returns the next 64 bits from the file as a floating point number. </description> </method> <method name="get_endian_swap"> @@ -120,14 +120,14 @@ <return type="int" enum="Error"> </return> <description> - Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope]. + Returns the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope]. </description> </method> <method name="get_float" qualifiers="const"> <return type="float"> </return> <description> - Get the next 32 bits from the file as a floating point number. + Returns the next 32 bits from the file as a floating point number. </description> </method> <method name="get_len" qualifiers="const"> @@ -141,7 +141,7 @@ <return type="String"> </return> <description> - Get the next line of the file as a [String]. + Returns the next line of the file as a [String]. </description> </method> <method name="get_md5" qualifiers="const"> @@ -150,7 +150,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Returns a MD5 String representing the file at the given path or an empty [String] on failure. + Returns an MD5 String representing the file at the given path or an empty [String] on failure. </description> </method> <method name="get_modified_time" qualifiers="const"> @@ -159,28 +159,28 @@ <argument index="0" name="file" type="String"> </argument> <description> - Returns the modified time in unix timestamp of the [code]file[/code] or returns a [String] "ERROR IN [code]file[/code]". This unix timestamp can be converted to datetime by using [method OS.get_datetime_from_unix_time]. + Returns the last time the [code]file[/code] was modified in unix timestamp format or returns a [String] "ERROR IN [code]file[/code]". This unix timestamp can be converted to datetime by using [method OS.get_datetime_from_unix_time]. </description> </method> <method name="get_pascal_string"> <return type="String"> </return> <description> - Get a [String] saved in Pascal format from the file. + Returns a [String] saved in Pascal format from the file. </description> </method> <method name="get_position" qualifiers="const"> <return type="int"> </return> <description> - Returns the file cursor position. + Returns the file cursor's position. </description> </method> <method name="get_real" qualifiers="const"> <return type="float"> </return> <description> - Get the next bits from the file as a floating point number. + Returns the next bits from the file as a floating point number. </description> </method> <method name="get_sha256" qualifiers="const"> @@ -189,14 +189,14 @@ <argument index="0" name="path" type="String"> </argument> <description> - Returns a SHA-256 String representing the file at the given path or an empty [String] on failure. + Returns a SHA-256 [String] representing the file at the given path or an empty [String] on failure. </description> </method> <method name="get_var" qualifiers="const"> <return type="Variant"> </return> <description> - Get the next Variant value from the file. + Returns the next [Variant] value from the file. </description> </method> <method name="is_open" qualifiers="const"> @@ -214,7 +214,7 @@ <argument index="1" name="flags" type="int"> </argument> <description> - Open the file for writing or reading, depending on the flags. + Opens the file for writing or reading, depending on the flags. </description> </method> <method name="open_compressed"> @@ -227,7 +227,7 @@ <argument index="2" name="compression_mode" type="int" default="0"> </argument> <description> - Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION_* constants. + Opens a compressed file for reading or writing. Use COMPRESSION_* constants to set [code]compression_mode[/code]. </description> </method> <method name="open_encrypted"> @@ -240,7 +240,7 @@ <argument index="2" name="key" type="PoolByteArray"> </argument> <description> - Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. + Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. </description> </method> <method name="open_encrypted_with_pass"> @@ -253,7 +253,7 @@ <argument index="2" name="pass" type="String"> </argument> <description> - Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. + Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. </description> </method> <method name="seek"> @@ -271,7 +271,7 @@ <argument index="0" name="position" type="int" default="0"> </argument> <description> - Change the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file. + Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file. </description> </method> <method name="set_endian_swap"> @@ -290,7 +290,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Store an integer as 16 bits in the file. + Stores an integer as 16 bits in the file. </description> </method> <method name="store_32"> @@ -299,7 +299,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Store an integer as 32 bits in the file. + Stores an integer as 32 bits in the file. </description> </method> <method name="store_64"> @@ -308,7 +308,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Store an integer as 64 bits in the file. + Stores an integer as 64 bits in the file. </description> </method> <method name="store_8"> @@ -317,7 +317,7 @@ <argument index="0" name="value" type="int"> </argument> <description> - Store an integer as 8 bits in the file. + Stores an integer as 8 bits in the file. </description> </method> <method name="store_buffer"> @@ -326,7 +326,7 @@ <argument index="0" name="buffer" type="PoolByteArray"> </argument> <description> - Store the given array of bytes in the file. + Stores the given array of bytes in the file. </description> </method> <method name="store_double"> @@ -335,7 +335,7 @@ <argument index="0" name="value" type="float"> </argument> <description> - Store a floating point number as 64 bits in the file. + Stores a floating point number as 64 bits in the file. </description> </method> <method name="store_float"> @@ -344,7 +344,7 @@ <argument index="0" name="value" type="float"> </argument> <description> - Store a floating point number as 32 bits in the file. + Stores a floating point number as 32 bits in the file. </description> </method> <method name="store_line"> @@ -353,7 +353,7 @@ <argument index="0" name="line" type="String"> </argument> <description> - Store the given [String] as a line in the file. + Stores the given [String] as a line in the file. </description> </method> <method name="store_pascal_string"> @@ -362,7 +362,7 @@ <argument index="0" name="string" type="String"> </argument> <description> - Store the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). + Stores the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). </description> </method> <method name="store_real"> @@ -371,7 +371,7 @@ <argument index="0" name="value" type="float"> </argument> <description> - Store a floating point number in the file. + Stores a floating point number in the file. </description> </method> <method name="store_string"> @@ -380,7 +380,7 @@ <argument index="0" name="string" type="String"> </argument> <description> - Store the given [String] in the file. + Stores the given [String] in the file. </description> </method> <method name="store_var"> @@ -389,34 +389,34 @@ <argument index="0" name="value" type="Variant"> </argument> <description> - Store any Variant value in the file. + Stores any Variant value in the file. </description> </method> </methods> <constants> <constant name="READ" value="1"> - Open the file for read operations. + Opens the file for read operations. </constant> <constant name="WRITE" value="2"> - Open the file for write operations. Create it if the file does not exist and truncate if it exists. + Opens the file for write operations. Create it if the file does not exist and truncate if it exists. </constant> <constant name="READ_WRITE" value="3"> - Open the file for read and write operations. Does not truncate the file. + Opens the file for read and write operations. Does not truncate the file. </constant> <constant name="WRITE_READ" value="7"> - Open the file for read and write operations. Create it if the file does not exist and truncate if it exists. + Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists. </constant> <constant name="COMPRESSION_FASTLZ" value="0"> - Use the FastLZ compression method. + Uses the FastLZ compression method. </constant> <constant name="COMPRESSION_DEFLATE" value="1"> - Use the Deflate compression method. + Uses the Deflate compression method. </constant> <constant name="COMPRESSION_ZSTD" value="2"> - Use the Zstd compression method. + Uses the Zstd compression method. </constant> <constant name="COMPRESSION_GZIP" value="3"> - Use the GZip compression method. + Uses the gzip compression method. </constant> </constants> </class> diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml index a7593dc2a1..1277cef77d 100644 --- a/doc/classes/FuncRef.xml +++ b/doc/classes/FuncRef.xml @@ -16,6 +16,7 @@ <return type="Variant"> </return> <description> + Calls the referenced function previously set by [method set_function] or [method @GDScript.funcref]. </description> </method> <method name="set_function"> @@ -24,7 +25,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Set the name of the function to call on the object, without parentheses or any parameters. + The name of the referenced function to call on the object, without parentheses or any parameters. </description> </method> <method name="set_instance"> @@ -33,7 +34,7 @@ <argument index="0" name="instance" type="Object"> </argument> <description> - Set the object on which to call the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary]. + The object containing the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary]. </description> </method> </methods> diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index f97908b0a2..e086ae86b1 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Gradient" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Color interpolator node + Color interpolator node. </brief_description> <description> Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset offset 0 and the other (white) at the ramp higher offset 1. @@ -122,8 +122,10 @@ </methods> <members> <member name="colors" type="PoolColorArray" setter="set_colors" getter="get_colors"> + Gradient's colors returned as a [PoolColorArray]. </member> <member name="offsets" type="PoolRealArray" setter="set_offsets" getter="get_offsets"> + Gradient's offsets returned as a [PoolRealArray]. </member> </members> <constants> diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml index ca7b868cd8..30976eff99 100644 --- a/doc/classes/GridContainer.xml +++ b/doc/classes/GridContainer.xml @@ -30,6 +30,7 @@ </methods> <members> <member name="columns" type="int" setter="set_columns" getter="get_columns"> + The number of columns in the [code]GridContainer[/code]. If modified, [code]GridContainer[/code] reorders its children to accommodate the new layout. </member> </members> <constants> diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index 4fcdf684c0..fdaee798db 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -4,7 +4,7 @@ A [Texture] based on an [Image]. </brief_description> <description> - A [Texture] based on an [Image]. Can be created from an [Image]. + A [Texture] based on an [Image]. Can be created from an [Image] with [method create_from_image]. </description> <tutorials> </tutorials> @@ -93,6 +93,7 @@ <argument index="0" name="size" type="Vector2"> </argument> <description> + Resizes the [code]ImageTexture[/code] to the specified dimensions. </description> </method> <method name="set_storage"> diff --git a/doc/classes/ImmediateGeometry.xml b/doc/classes/ImmediateGeometry.xml index b12f9c99a9..cd7074aeaf 100644 --- a/doc/classes/ImmediateGeometry.xml +++ b/doc/classes/ImmediateGeometry.xml @@ -1,9 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ImmediateGeometry" inherits="GeometryInstance" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Node to draw simple geometry from code, ala OpenGL 1.x + Draws simple geometry from code. </brief_description> <description> + Draws simple geometry from code. Uses a drawing mode similar to OpenGL 1.x. </description> <tutorials> </tutorials> @@ -31,7 +32,7 @@ <argument index="0" name="position" type="Vector3"> </argument> <description> - Add a vertex with the currently set color/uv/etc. + Adds a vertex with the currently set color/uv/etc. </description> </method> <method name="begin"> @@ -50,14 +51,14 @@ <return type="void"> </return> <description> - Clear everything that was drawn using begin/end. + Clears everything that was drawn using begin/end. </description> </method> <method name="end"> <return type="void"> </return> <description> - Call this when done adding a batch of geometry, otherwise it can't be displayed. + Ends a drawing context and displays the results. </description> </method> <method name="set_color"> @@ -66,7 +67,7 @@ <argument index="0" name="color" type="Color"> </argument> <description> - Set the color that the next vertex will use to be drawn. + The current drawing color. </description> </method> <method name="set_normal"> @@ -75,7 +76,7 @@ <argument index="0" name="normal" type="Vector3"> </argument> <description> - Set the normal that the next vertex will use to be drawn. + The next vertex's normal. </description> </method> <method name="set_tangent"> @@ -84,7 +85,7 @@ <argument index="0" name="tangent" type="Plane"> </argument> <description> - Set the tangent (and binormal facing) that the next vertex will use to be drawn. + The next vertex's tangent (and binormal facing). </description> </method> <method name="set_uv"> @@ -93,7 +94,7 @@ <argument index="0" name="uv" type="Vector2"> </argument> <description> - Set the UV that the next vertex will use to be drawn. + The next vertex's UV. </description> </method> <method name="set_uv2"> @@ -102,7 +103,7 @@ <argument index="0" name="uv" type="Vector2"> </argument> <description> - Set the second layer of UV that the next vertex will use to be drawn. + The next vertex's second layer UV. </description> </method> </methods> diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 8c5e69b407..1d1ce63a58 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -15,7 +15,7 @@ <return type="int" enum="Label.Align"> </return> <description> - Return the alignment mode (any of the ALIGN_* enumeration values). + Returns the alignment mode (any of the ALIGN_* enumeration values). </description> </method> <method name="get_line_count" qualifiers="const"> @@ -36,76 +36,77 @@ <return type="int"> </return> <description> - Return the the number of lines to skipped before displaying. + Returns the the number of lines to skip before displaying. </description> </method> <method name="get_max_lines_visible" qualifiers="const"> <return type="int"> </return> <description> - Return the restricted number of lines to display. Returns -1 if unrestricted. + Returns the maximum number of lines to display. Returns -1 if unrestricted. </description> </method> <method name="get_percent_visible" qualifiers="const"> <return type="float"> </return> <description> - Return the restricted number of characters to display (as a percentage of the total text). + Returns the maximum number of characters to display as a percentage of the total text. </description> </method> <method name="get_text" qualifiers="const"> <return type="String"> </return> <description> - Return the label text. Text can contain newlines. + Returns the label text. Text can contain newlines. </description> </method> <method name="get_total_character_count" qualifiers="const"> <return type="int"> </return> <description> - Return the total length of the text. + Returns the total length of the text. </description> </method> <method name="get_valign" qualifiers="const"> <return type="int" enum="Label.VAlign"> </return> <description> - Return the vertical alignment mode (any of the VALIGN_* enumeration values). + Returns the vertical alignment mode (any of the VALIGN_* enumeration values). </description> </method> <method name="get_visible_characters" qualifiers="const"> <return type="int"> </return> <description> - Return the restricted number of characters to display. Returns -1 if unrestricted. + Returns the restricted number of characters to display. Returns -1 if unrestricted. </description> </method> <method name="get_visible_line_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of lines shown. Useful if the [code]Label[/code] 's height cannot currently display all lines. </description> </method> <method name="has_autowrap" qualifiers="const"> <return type="bool"> </return> <description> - Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]). + Returns [code]true[/code] if [i]autowrap[/i] mode (see [method set_autowrap]). </description> </method> <method name="is_clipping_text" qualifiers="const"> <return type="bool"> </return> <description> - Return [code]true[/code] if text would be cut off if it is too wide. + Returns [code]true[/code] if text would be cut off if it is too wide. </description> </method> <method name="is_uppercase" qualifiers="const"> <return type="bool"> </return> <description> - Return [code]true[/code] if text is displayed in all capitals. + Returns [code]true[/code] if text is displayed in all capitals. </description> </method> <method name="set_align"> diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml index e4cabdc556..f5416488f6 100644 --- a/doc/classes/LargeTexture.xml +++ b/doc/classes/LargeTexture.xml @@ -5,7 +5,7 @@ </brief_description> <description> A Texture capable of storing many smaller Textures with offsets. - You can dynamically add pieces(Textures) to this fLargeTexture] using different offsets. + You can dynamically add pieces([Texture]) to this [code]LargeTexture[/code] using different offsets. </description> <tutorials> </tutorials> @@ -20,21 +20,21 @@ <argument index="1" name="texture" type="Texture"> </argument> <description> - Add another [Texture] to this [LargeTexture], starting on offset "ofs". + Add another [Texture] to this [code]LargeTexture[/code], starting on offset "ofs". </description> </method> <method name="clear"> <return type="void"> </return> <description> - Clear the [LargeTexture]. + Clears the [code]LargeTexture[/code]. </description> </method> <method name="get_piece_count" qualifiers="const"> <return type="int"> </return> <description> - Return the number of pieces currently in this [LargeTexture]. + Returns the number of pieces currently in this [code]LargeTexture[/code]. </description> </method> <method name="get_piece_offset" qualifiers="const"> @@ -43,7 +43,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the offset of the piece with index "idx". + Returns the offset of the piece with index "idx". </description> </method> <method name="get_piece_texture" qualifiers="const"> @@ -52,7 +52,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the [Texture] of the piece with index "idx". + Returns the [Texture] of the piece with index "idx". </description> </method> <method name="set_piece_offset"> @@ -63,7 +63,7 @@ <argument index="1" name="ofs" type="Vector2"> </argument> <description> - Set the offset of the piece with index "idx" to "ofs". + Sets the offset of the piece with index "idx" to "ofs". </description> </method> <method name="set_piece_texture"> @@ -74,7 +74,7 @@ <argument index="1" name="texture" type="Texture"> </argument> <description> - Set the [Texture] of the piece with index "idx" to "ofs". + Sets the [Texture] of the piece with index "idx" to "ofs". </description> </method> <method name="set_size"> @@ -83,12 +83,16 @@ <argument index="0" name="size" type="Vector2"> </argument> <description> - Set the size of this [LargeTexture]. + Sets the size of this [code]LargeTexture[/code]. </description> </method> </methods> <members> <member name="_data" type="Array" setter="_set_data" getter="_get_data"> + Returns an [Array] with offsets and textures data of each added piece. Schema is [offsets1, texture1, offsets2, texture2, large_texture_size]. + [code]offsets[/code] : [Vector2] offsets of the texture piece. + [code]second[/code] : [StreamTexture] data of the texture piece. + [code]last entry[/code] : [Vector2] size of the entire large texture. </member> </members> <constants> diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index 7ce7cef7c1..05054e06fd 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Light2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Node that casts light in a 2D environment. + Casts light in a 2D environment. </brief_description> <description> - Node that casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask. + Casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask. </description> <tutorials> </tutorials> @@ -385,7 +385,7 @@ If [code]true[/code] the Light2D will cast shadows. Default value: [code]false[/code]. </member> <member name="shadow_filter" type="int" setter="set_shadow_filter" getter="get_shadow_filter" enum="Light2D.ShadowFilter"> - Shadow filter type. May be one of [code][None, PCF5, PCF9, PCF13][/code]. Default value: [code]None[/code]. + Shadow filter type. Use SHADOW_FILTER_* constants to set [code]shadow_filter[/code]. Default value: [code]None[/code]. </member> <member name="shadow_filter_smooth" type="float" setter="set_shadow_smooth" getter="get_shadow_smooth"> Smoothing value for shadows. @@ -408,7 +408,7 @@ Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. </constant> <constant name="MODE_SUB" value="1"> - Subtract the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. + Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. </constant> <constant name="MODE_MIX" value="2"> Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. @@ -417,16 +417,22 @@ The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. </constant> <constant name="SHADOW_FILTER_NONE" value="0"> + No filter applies to the shadow map. See [method shadow_filter]. </constant> <constant name="SHADOW_FILTER_PCF3" value="1"> + Percentage closer filtering (3 samples) applies to the shadow map. See [method shadow_filter]. </constant> <constant name="SHADOW_FILTER_PCF5" value="2"> + Percentage closer filtering (5 samples) applies to the shadow map. See [method shadow_filter]. </constant> <constant name="SHADOW_FILTER_PCF7" value="3"> + Percentage closer filtering (7 samples) applies to the shadow map. See [method shadow_filter]. </constant> <constant name="SHADOW_FILTER_PCF9" value="4"> + Percentage closer filtering (9 samples) applies to the shadow map. See [method shadow_filter]. </constant> <constant name="SHADOW_FILTER_PCF13" value="5"> + Percentage closer filtering (13 samples) applies to the shadow map. See [method shadow_filter]. </constant> </constants> </class> diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index e6e615ccf1..3cca256a5d 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -17,7 +17,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Add a point at the x/y position in the supplied [Vector2] + Add a point at the [code]position[/code]. Appends the point at the end of the line. </description> </method> <method name="get_begin_cap_mode" qualifiers="const"> @@ -54,6 +54,7 @@ <return type="int"> </return> <description> + Returns the Line2D's amount of points. </description> </method> <method name="get_point_position" qualifiers="const"> @@ -62,6 +63,7 @@ <argument index="0" name="i" type="int"> </argument> <description> + Returns point [code]i[code]'s position. </description> </method> <method name="get_points" qualifiers="const"> @@ -106,7 +108,7 @@ <argument index="0" name="i" type="int"> </argument> <description> - Remove the point at index 'i' from the line. + Remove the point at index [code]i[/code] from the line. </description> </method> <method name="set_begin_cap_mode"> @@ -157,6 +159,7 @@ <argument index="1" name="position" type="Vector2"> </argument> <description> + Overwites the position in point [code]i[/code] with the supplied [code]position[/code]. </description> </method> <method name="set_points"> @@ -210,44 +213,63 @@ </methods> <members> <member name="begin_cap_mode" type="int" setter="set_begin_cap_mode" getter="get_begin_cap_mode" enum="Line2D.LineCapMode"> + Controls the style of the line's first point. Use [code]LINE_CAP_*[/code] constants. Default value: [code]LINE_CAP_NONE[/code]. </member> <member name="default_color" type="Color" setter="set_default_color" getter="get_default_color"> + The line's color. Will not be used if a gradient is set. </member> <member name="end_cap_mode" type="int" setter="set_end_cap_mode" getter="get_end_cap_mode" enum="Line2D.LineCapMode"> + Controls the style of the line's last point. Use [code]LINE_CAP_*[/code] constants. Default value: [code]LINE_CAP_NONE[/code]. </member> <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. </member> <member name="joint_mode" type="int" setter="set_joint_mode" getter="get_joint_mode" enum="Line2D.LineJointMode"> + The style for the points inbetween the start and the end. </member> <member name="points" type="PoolVector2Array" setter="set_points" getter="get_points"> + The points that form the lines. The line is drawn between every point set in this array. </member> <member name="round_precision" type="int" setter="set_round_precision" getter="get_round_precision"> + The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. </member> <member name="sharp_limit" type="float" setter="set_sharp_limit" getter="get_sharp_limit"> + The direction difference in radians between vector points. This value is only used if [code]joint mode[/code] is set to [code]LINE_JOINT_SHARP[/code]. </member> <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + The texture used for the line's texture. Uses [code]texture_mode[/code] for drawing style. </member> <member name="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="Line2D.LineTextureMode"> + The style to render the [code]texture[/code] on the line. Use [code]LINE_TEXTURE_*[/code] constants. Default value: [code]LINE_TEXTURE_NONE[/code]. </member> <member name="width" type="float" setter="set_width" getter="get_width"> + The line's width. </member> </members> <constants> <constant name="LINE_JOINT_SHARP" value="0"> + The line's joints will be pointy. If [code]sharp_limit[/code] is greater than the rotation of a joint, it becomes a bevel joint instead. </constant> <constant name="LINE_JOINT_BEVEL" value="1"> + The line's joints will be bevelled/chamfered. </constant> <constant name="LINE_JOINT_ROUND" value="2"> + The line's joints will be rounded. </constant> <constant name="LINE_CAP_NONE" value="0"> + Don't have a line cap. </constant> <constant name="LINE_CAP_BOX" value="1"> + Draws the line cap as a box. </constant> <constant name="LINE_CAP_ROUND" value="2"> + Draws the line cap as a circle. </constant> <constant name="LINE_TEXTURE_NONE" value="0"> + Takes the left pixels of the texture and renders it over the whole line. </constant> <constant name="LINE_TEXTURE_TILE" value="1"> + Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly. </constant> </constants> </class> diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index e17e60f2bc..1e89d2194c 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Particles" inherits="GeometryInstance" category="Core" version="3.0.alpha.custom_build"> <brief_description> + 3D particle emitter. </brief_description> <description> + 3D particle node used to create a variety of particle systems and effects. [code]Particles[/code] features an emitter that generates some number of particles at a given rate. + Use the [code]process_material[/code] property to add a [ParticlesMaterial] to configure particle appearance and behavior. Alternatively, you can add a [ShaderMaterial] which will be applied to all particles. </description> <tutorials> </tutorials> @@ -252,8 +255,10 @@ </methods> <members> <member name="amount" type="int" setter="set_amount" getter="get_amount"> + Number of particles to emit. </member> <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles.DrawOrder"> + Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Default value: [code]DRAW_ORDER_INDEX[/code]. </member> <member name="draw_pass_1" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> </member> @@ -266,36 +271,47 @@ <member name="draw_passes" type="int" setter="set_draw_passes" getter="get_draw_passes"> </member> <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting"> + If [code]true[/code] particles are being emitted. Default value: [code]true[/code]. </member> <member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio"> + Time ratio between each emission. If [code]0[/code] particles are emitted continuously. If [code]1[/code] all particles are emitted simultaneously. Default value: [code]0[/code]. </member> <member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps"> </member> <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta"> </member> <member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime"> + Amount of time each particle will exist. Default value: [code]1[/code]. </member> <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates"> + If [code]true[/code] particles use the parent node's coordinate space. If [code]false[/code] they use global coordinates. Default value: [code]true[/code]. </member> <member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot"> + If [code]true[/code] only [code]amount[/code] particles will be emitted. Default value: [code]false[/code]. </member> <member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time"> </member> <member name="process_material" type="Material" setter="set_process_material" getter="get_process_material"> + [Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial]. </member> <member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio"> + Emission randomness ratio. Default value: [code]0[/code]. </member> <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> + Speed scaling ratio. Default value: [code]1[/code]. </member> <member name="visibility_aabb" type="Rect3" setter="set_visibility_aabb" getter="get_visibility_aabb"> </member> </members> <constants> <constant name="DRAW_ORDER_INDEX" value="0"> + Particles are drawn in the order emitted. </constant> <constant name="DRAW_ORDER_LIFETIME" value="1"> + Particles are drawn in order of remaining lifetime. </constant> <constant name="DRAW_ORDER_VIEW_DEPTH" value="2"> + Particles are drawn in order of depth. </constant> <constant name="MAX_DRAW_PASSES" value="4" enum=""> </constant> diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml index d837d6eb62..b2c63ea0c3 100644 --- a/doc/classes/Particles2D.xml +++ b/doc/classes/Particles2D.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Particles2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> <brief_description> - 2D Particle emitter + 2D particle emitter. </brief_description> <description> - Particles2D is a particle system 2D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility bounding box (although helpers to create one automatically exist). + 2D particle node used to create a variety of particle systems and effects. [code]Particles2D[/code] features an emitter that generates some number of particles at a given rate. + Use the [code]process_material[/code] property to add a [ParticlesMaterial] to configure particle appearance and behavior. Alternatively, you can add a [ShaderMaterial] which will be applied to all particles. </description> <tutorials> </tutorials> @@ -285,46 +286,61 @@ </methods> <members> <member name="amount" type="int" setter="set_amount" getter="get_amount"> + Number of particles to emit. </member> <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles2D.DrawOrder"> + Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Default value: [code]DRAW_ORDER_INDEX[/code]. </member> <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting"> + If [code]true[/code] particles are being emitted. Default value: [code]true[/code]. </member> <member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio"> + Time ratio between each emission. If [code]0[/code] particles are emitted continuously. If [code]1[/code] all particles are emitted simultaneously. Default value: [code]0[/code]. </member> <member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps"> </member> <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta"> </member> <member name="h_frames" type="int" setter="set_h_frames" getter="get_h_frames"> + Number of horizontal frames in [code]texture[/code]. </member> <member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime"> + Amount of time each particle will exist. Default value: [code]1[/code]. </member> <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates"> + If [code]true[/code] particles use the parent node's coordinate space. If [code]false[/code] they use global coordinates. Default value: [code]true[/code]. </member> <member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map"> </member> <member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot"> + If [code]true[/code] only [code]amount[/code] particles will be emitted. Default value: [code]false[/code]. </member> <member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time"> </member> <member name="process_material" type="Material" setter="set_process_material" getter="get_process_material"> + [Material] for processing particles. Can be a [ParticlesMaterial] or a [ShaderMaterial]. </member> <member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio"> + Emission randomness ratio. Default value: [code]0[/code]. </member> <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> + Speed scaling ratio. Default value: [code]1[/code]. </member> <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + Particle texture. If [code]null[/code] particles will be squares. </member> <member name="v_frames" type="int" setter="set_v_frames" getter="get_v_frames"> + Number of vertical frames in [code]texture[/code]. </member> <member name="visibility_rect" type="Rect2" setter="set_visibility_rect" getter="get_visibility_rect"> </member> </members> <constants> <constant name="DRAW_ORDER_INDEX" value="0"> + Particles are drawn in the order emitted. </constant> <constant name="DRAW_ORDER_LIFETIME" value="1"> + Particles are drawn in order of remaining lifetime. </constant> </constants> </class> diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 1767a19a9f..bebdc44b69 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ParticlesMaterial" inherits="Material" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Particle properties for [Particles] and [Particles2D] nodes. </brief_description> <description> + ParticlesMaterial defines particle properties and behavior. It is used in the [code]process_material[/code] of [Particles] and [Particles2D] emitter nodes. + Some of this material's properties are applied to each particle when emitted, while others can have a [CurveTexture] applied to vary values over the lifetime of the particle. </description> <tutorials> </tutorials> @@ -294,152 +297,217 @@ </methods> <members> <member name="angle" type="float" setter="set_param" getter="get_param"> + Initial rotation applied to each particle. </member> <member name="angle_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Each particle's rotation will be animated along this [CurveTexture]. </member> <member name="angle_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Rotation randomness ratio. Default value: [code]0[/code]. </member> <member name="angular_velocity" type="float" setter="set_param" getter="get_param"> + Initial angular velocity applied to each particle. </member> <member name="angular_velocity_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Each particle's angular velocity will vary along this [CurveTexture]. </member> <member name="angular_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Angular velocity randomness ratio. Default value: [code]0[/code]. </member> <member name="anim_loop" type="bool" setter="set_flag" getter="get_flag"> + If [code]true[/code] animation will loop. Default value: [code]false[/code]. </member> <member name="anim_offset" type="float" setter="set_param" getter="get_param"> + Particle animation offset. </member> <member name="anim_offset_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Each particle's animation offset will vary along this [CurveTexture]. </member> <member name="anim_offset_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Animation offset randomness ratio. Default value: [code]0[/code]. </member> <member name="anim_speed" type="float" setter="set_param" getter="get_param"> + Particle animation speed. </member> <member name="anim_speed_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Each particle's animation speed will vary along this [CurveTexture]. </member> <member name="anim_speed_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Animation speed randomness ratio. Default value: [code]0[/code]. </member> <member name="color" type="Color" setter="set_color" getter="get_color"> + Each particle's initial color. If the [Particle2D]'s [code]texture[/code] is defined, it will be multiplied by this color. </member> <member name="color_ramp" type="Texture" setter="set_color_ramp" getter="get_color_ramp"> + Each particle's color will vary along this [GradientTexture]. </member> <member name="damping" type="float" setter="set_param" getter="get_param"> + The rate at which particles lose velocity. </member> <member name="damping_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Damping will vary along this [CurveTexture]. </member> <member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Damping randomness ratio. Default value: [code]0[/code]. </member> <member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents"> + The box's extents if [code]emission_shape[/code] is set to [code]EMISSION_SHAPE_BOX[/code]. </member> <member name="emission_color_texture" type="Texture" setter="set_emission_color_texture" getter="get_emission_color_texture"> </member> <member name="emission_normal_texture" type="Texture" setter="set_emission_normal_texture" getter="get_emission_normal_texture"> </member> <member name="emission_point_count" type="int" setter="set_emission_point_count" getter="get_emission_point_count"> + The number of emission points if [code]emission_shape[/code] is set to [code]EMISSION_SHAPE_POINTS[/code] or [code]EMISSION_SHAPE_DIRECTED_POINTS[/code]. </member> <member name="emission_point_texture" type="Texture" setter="set_emission_point_texture" getter="get_emission_point_texture"> </member> <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="ParticlesMaterial.EmissionShape"> + Particles will be emitted inside this region. Use [code]EMISSION_SHAPE_*[/code] constants for values. Default value: [code]EMISSION_SHAPE_POINT[/code]. </member> <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 [code]EMISSION_SHAPE_SPHERE[/code]. </member> <member name="flag_align_y" type="bool" setter="set_flag" getter="get_flag"> </member> <member name="flag_disable_z" type="bool" setter="set_flag" getter="get_flag"> + If [code]true[/code] particles will not move on the z axis. Default value: [code]true[/code] for [Particles2D], [code]false[/code] for [Particles]. </member> <member name="flag_rotate_y" type="bool" setter="set_flag" getter="get_flag"> </member> <member name="flatness" type="float" setter="set_flatness" getter="get_flatness"> </member> <member name="gravity" type="Vector3" setter="set_gravity" getter="get_gravity"> + Gravity applied to every particle. Default value: [code](0, 98, 0)[/code]. </member> <member name="hue_variation" type="float" setter="set_param" getter="get_param"> + Initial hue variation applied to each particle. </member> <member name="hue_variation_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Each particle's hue will vary along this [CurveTexture]. </member> <member name="hue_variation_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Hue variation randomness ratio. Default value: [code]0[/code]. </member> <member name="initial_velocity" type="float" setter="set_param" getter="get_param"> + Initial velocity for each particle. </member> <member name="initial_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Initial velocity randomness ratio. Default value: [code]0[/code]. </member> <member name="linear_accel" type="float" setter="set_param" getter="get_param"> + Linear acceleration applied to each particle. </member> <member name="linear_accel_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Each particle's linear acceleration will vary along this [CurveTexture]. </member> <member name="linear_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Linear acceleration randomness ratio. Default value: [code]0[/code]. </member> <member name="orbit_velocity" type="float" setter="set_param" getter="get_param"> + Orbital velocity applied to each particle. </member> <member name="orbit_velocity_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Each particle's orbital velocity will vary along this [CurveTexture]. </member> <member name="orbit_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Orbital velocity randomness ratio. Default value: [code]0[/code]. </member> <member name="radial_accel" type="float" setter="set_param" getter="get_param"> + Linear acceleration applied to each particle. </member> <member name="radial_accel_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Each particle's radial acceleration will vary along this [CurveTexture]. </member> <member name="radial_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Radial acceleration randomness ratio. Default value: [code]0[/code]. </member> <member name="scale" type="float" setter="set_param" getter="get_param"> + Initial scale applied to each particle. </member> <member name="scale_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Each particle's scale will vary along this [CurveTexture]. </member> <member name="scale_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Scale randomness ratio. Default value: [code]0[/code]. </member> <member name="spread" type="float" setter="set_spread" getter="get_spread"> + Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Default value: [code]45[/code]. </member> <member name="tangential_accel" type="float" setter="set_param" getter="get_param"> + Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity. </member> <member name="tangential_accel_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + Each particle's tangential acceleration will vary along this [CurveTexture]. </member> <member name="tangential_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + Tangential acceleration randomness ratio. Default value: [code]0[/code]. </member> <member name="trail_color_modifier" type="GradientTexture" setter="set_trail_color_modifier" getter="get_trail_color_modifier"> + Trail particles' color will vary along this [GradientTexture]. </member> <member name="trail_divisor" type="int" setter="set_trail_divisor" getter="get_trail_divisor"> + Emitter will emit [code]amount[/code] divided by [code]trail_divisor[/code] particles. The remaining particles will be used as trail(s). </member> <member name="trail_size_modifier" type="CurveTexture" setter="set_trail_size_modifier" getter="get_trail_size_modifier"> + Trail particles' size will vary along this [CurveTexture]. </member> </members> <constants> <constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set initial velocity properties. </constant> <constant name="PARAM_ANGULAR_VELOCITY" value="1"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angular velocity properties. </constant> <constant name="PARAM_ORBIT_VELOCITY" value="2"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set orbital_velocity properties. </constant> <constant name="PARAM_LINEAR_ACCEL" value="3"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set linear acceleration properties. </constant> <constant name="PARAM_RADIAL_ACCEL" value="4"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set radial acceleration properties. </constant> <constant name="PARAM_TANGENTIAL_ACCEL" value="5"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set tangential acceleration properties. </constant> <constant name="PARAM_DAMPING" value="6"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set damping properties. </constant> <constant name="PARAM_ANGLE" value="7"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angle properties. </constant> <constant name="PARAM_SCALE" value="8"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set scale properties. </constant> <constant name="PARAM_HUE_VARIATION" value="9"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set hue_variation properties. </constant> <constant name="PARAM_ANIM_SPEED" value="10"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation speed properties. </constant> <constant name="PARAM_ANIM_OFFSET" value="11"> + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation offset properties. </constant> <constant name="PARAM_MAX" value="12"> </constant> <constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0"> + Use with [method set_flag] to set [member flag_align_y]. </constant> <constant name="FLAG_ROTATE_Y" value="1"> + Use with [method set_flag] to set [member flag_rotate_y] </constant> <constant name="FLAG_MAX" value="4"> </constant> <constant name="EMISSION_SHAPE_POINT" value="0"> + All particles will be emitted from a single point. </constant> <constant name="EMISSION_SHAPE_SPHERE" value="1"> + Particles will be emitted in the volume of a sphere. </constant> <constant name="EMISSION_SHAPE_BOX" value="2"> + Particles will be emitted in the volume of a box. </constant> <constant name="EMISSION_SHAPE_POINTS" value="3"> </constant> diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index 71987ace9e..82ee3531f1 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Performance" inherits="Object" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Exposes performance related data. </brief_description> <description> + This class provides access to a number of different monitors related to performance, such as memory usage, draw calls, and FPS. These are the same as the values displayed in the [i]Monitor[/i] tab in the editor's [i]Debugger[/i] panel. By using the [method get_monitor] method of this class, you can access this data from your code. Note that a few of these monitors are only available in debug mode and will always return 0 when used in a release build. + Many of these monitors are not updated in real-time, so there may be a short delay between changes. </description> <tutorials> </tutorials> @@ -15,63 +18,93 @@ <argument index="0" name="monitor" type="int" enum="Performance.Monitor"> </argument> <description> + Returns the value of one of the available monitors. You should provide one of this class's constants as the argument, like this: + [codeblock] + print(Performance.get_monitor(Performance.TIME_FPS)) # Prints the FPS to the console + [/codeblock] </description> </method> </methods> <constants> <constant name="TIME_FPS" value="0"> + Frames per second. </constant> <constant name="TIME_PROCESS" value="1"> + Time it took to complete one frame. </constant> - <constant name="TIME_FIXED_PROCESS" value="2"> + <constant name="TIME_PHYSICS_PROCESS" value="2"> + Time it took to complete one physics frame. </constant> <constant name="MEMORY_STATIC" value="3"> + Static memory currently used, in bytes. Not available in release builds. </constant> <constant name="MEMORY_DYNAMIC" value="4"> + Dynamic memory currently used, in bytes. Not available in release builds. </constant> <constant name="MEMORY_STATIC_MAX" value="5"> + Available static memory. Not available in release builds. </constant> <constant name="MEMORY_DYNAMIC_MAX" value="6"> + Available dynamic memory. Not available in release builds. </constant> <constant name="MEMORY_MESSAGE_BUFFER_MAX" value="7"> + Largest amount of memory the message queue buffer has used, in bytes. The message queue is used for deferred functions calls and notifications. </constant> <constant name="OBJECT_COUNT" value="8"> + Number of objects currently instanced (including nodes). </constant> <constant name="OBJECT_RESOURCE_COUNT" value="9"> + Number of resources currently used. </constant> <constant name="OBJECT_NODE_COUNT" value="10"> + Number of nodes currently instanced. This also includes the root node, as well as any nodes not in the scene tree. </constant> <constant name="RENDER_OBJECTS_IN_FRAME" value="11"> + 3D objects drawn per frame. </constant> <constant name="RENDER_VERTICES_IN_FRAME" value="12"> + Vertices drawn per frame. 3D only. </constant> <constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="13"> + Material changes per frame. 3D only </constant> <constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="14"> + Shader changes per frame. 3D only. </constant> <constant name="RENDER_SURFACE_CHANGES_IN_FRAME" value="15"> + Render surface changes per frame. 3D only. </constant> <constant name="RENDER_DRAW_CALLS_IN_FRAME" value="16"> - </constant> - <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20"> + Draw calls per frame. 3D only. </constant> <constant name="RENDER_VIDEO_MEM_USED" value="17"> + Video memory used. Includes both texture and vertex memory. </constant> <constant name="RENDER_TEXTURE_MEM_USED" value="18"> + Texture memory used. </constant> <constant name="RENDER_VERTEX_MEM_USED" value="19"> + Vertex memory used. + </constant> + <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20"> </constant> <constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21"> + Number of active [RigidBody2D] nodes in the game. </constant> <constant name="PHYSICS_2D_COLLISION_PAIRS" value="22"> + Number of collision pairs in the 2D physics engine. </constant> <constant name="PHYSICS_2D_ISLAND_COUNT" value="23"> + Number of islands in the 2D physics engine. </constant> <constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="24"> + Number of active [RigidBody] and [VehicleBody] nodes in the game. </constant> <constant name="PHYSICS_3D_COLLISION_PAIRS" value="25"> + Number of collision pairs in the 3D physics engine. </constant> <constant name="PHYSICS_3D_ISLAND_COUNT" value="26"> + Number of islands in the 3D physics engine. </constant> <constant name="MONITOR_MAX" value="27"> </constant> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 82e85126cc..bf9245d23a 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -4,8 +4,8 @@ Control to show a tree of items. </brief_description> <description> - This shows a tree of items that can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like text editing, buttons and popups. It can be useful for structural displaying and interactions. - Trees are built via code, using [TreeItem] objects to create the structure. They have a single root but multiple root can be simulated if a dummy hidden root is added. + This shows a tree of items that can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like text editing, buttons and popups. It can be useful for structured displays and interactions. + Trees are built via code, using [TreeItem] objects to create the structure. They have a single root but multiple roots can be simulated if a dummy hidden root is added. [codeblock] func _ready(): var tree = Tree.new() @@ -26,14 +26,14 @@ <return type="bool"> </return> <description> - Get whether the column titles are being shown. + Returns [code]true[/code] if the column titles are being shown. </description> </method> <method name="clear"> <return type="void"> </return> <description> - Clear the tree. This erases all of the items. + Clears the tree. This removes all items. </description> </method> <method name="create_item"> @@ -42,27 +42,28 @@ <argument index="0" name="parent" type="Object" default="null"> </argument> <description> - Create an item in the tree and add it as the last child of [code]parent[/code]. If parent is not given, it will be added as the last child of the root, or it'll the be the root itself if the tree is empty. + Create an item in the tree and add it as the last child of [code]parent[/code]. If parent is not given, it will be added as the root's last child, or it'll the be the root itself if the tree is empty. </description> </method> <method name="ensure_cursor_is_visible"> <return type="void"> </return> <description> - Make the current selected item visible. This will scroll the tree to make sure the selected item is in sight. + Makes the currently selected item visible. This will scroll the tree to make sure the selected item is visible. </description> </method> <method name="get_allow_reselect" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if a cell that is currently already selected may be selected again. </description> </method> <method name="get_allow_rmb_select" qualifiers="const"> <return type="bool"> </return> <description> - Get whether a right click can select items. + Returns [code]true[/code] if a right click can select items. </description> </method> <method name="get_column_at_position" qualifiers="const"> @@ -71,7 +72,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Get the column index under the given point. + Returns the column index under the given point. </description> </method> <method name="get_column_title" qualifiers="const"> @@ -80,7 +81,7 @@ <argument index="0" name="column" type="int"> </argument> <description> - Get the title of the given column. + Returns the column's title. </description> </method> <method name="get_column_width" qualifiers="const"> @@ -89,28 +90,28 @@ <argument index="0" name="column" type="int"> </argument> <description> - Get the width of the given column in pixels. + Returns the column's width in pixels. </description> </method> <method name="get_columns" qualifiers="const"> <return type="int"> </return> <description> - Get the amount of columns. + Returns the amount of columns. </description> </method> <method name="get_custom_popup_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Get the rectangle for custom popups. Helper to create custom cell controls that display a popup. See [method TreeItem.set_cell_mode]. + Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See [method TreeItem.set_cell_mode]. </description> </method> <method name="get_drop_mode_flags" qualifiers="const"> <return type="int"> </return> <description> - Get the flags of the current drop mode. + Returns the current drop mode's flags. </description> </method> <method name="get_drop_section_at_position" qualifiers="const"> @@ -125,14 +126,14 @@ <return type="TreeItem"> </return> <description> - Get the current edited item. This is only available for custom cell mode. + Returns the currently edited item. This is only available for custom cell mode. </description> </method> <method name="get_edited_column" qualifiers="const"> <return type="int"> </return> <description> - Get the column of the cell for the current edited icon. This is only available for custom cell mode. + Returns the column for the currently edited item. This is only available for custom cell mode. </description> </method> <method name="get_item_area_rect" qualifiers="const"> @@ -143,7 +144,7 @@ <argument index="1" name="column" type="int" default="-1"> </argument> <description> - Get the rectangle area of the the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. + Returns the rectangle area for the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. </description> </method> <method name="get_item_at_position" qualifiers="const"> @@ -152,7 +153,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Get the tree item at the specified position (relative to the tree origin position). + Returns the tree item at the specified position (relative to the tree origin position). </description> </method> <method name="get_next_selected"> @@ -161,49 +162,49 @@ <argument index="0" name="from" type="Object"> </argument> <description> - Get the next selected item after the given one. + Returns the next selected item after the given one. </description> </method> <method name="get_pressed_button" qualifiers="const"> <return type="int"> </return> <description> - Get the index of the last pressed button. + Returns the last pressed button's index. </description> </method> <method name="get_root"> <return type="TreeItem"> </return> <description> - Get the root item of the tree. + Returns the tree's root item. </description> </method> <method name="get_scroll" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the current scrolling position. + Returns the current scrolling position. </description> </method> <method name="get_selected" qualifiers="const"> <return type="TreeItem"> </return> <description> - Get the currently selected item. + Returns the currently selected item. </description> </method> <method name="get_selected_column" qualifiers="const"> <return type="int"> </return> <description> - Get the column number of the current selection. + Returns the current selection's column. </description> </method> <method name="is_folding_hidden" qualifiers="const"> <return type="bool"> </return> <description> - Get whether the folding arrow is hidden. + Returns [code]true[/code] if the folding arrow is hidden. </description> </method> <method name="set_allow_reselect"> @@ -212,6 +213,7 @@ <argument index="0" name="allow" type="bool"> </argument> <description> + If [code]true[/code] the currently selected cell may be selected again. </description> </method> <method name="set_allow_rmb_select"> @@ -220,7 +222,7 @@ <argument index="0" name="allow" type="bool"> </argument> <description> - Set whether or not a right mouse button click can select items. + If [code]true[/code] a right mouse button click can select items. </description> </method> <method name="set_column_expand"> @@ -231,7 +233,7 @@ <argument index="1" name="expand" type="bool"> </argument> <description> - Set whether a column will have the "Expand" flag of [Control]. + If [code]true[/code] the column will have the "Expand" flag of [Control]. </description> </method> <method name="set_column_min_width"> @@ -262,7 +264,7 @@ <argument index="0" name="visible" type="bool"> </argument> <description> - Set whether the column titles visibility. + If [code]true[/code] column titles are visible. </description> </method> <method name="set_columns"> @@ -289,7 +291,7 @@ <argument index="0" name="hide" type="bool"> </argument> <description> - Set whether the folding arrow should be hidden. + If [code]true[/code] the folding arrow is hidden. </description> </method> <method name="set_hide_root"> @@ -298,7 +300,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether the root of the tree should be hidden. + If [code]true[/code] the tree's root is hidden. </description> </method> <method name="set_select_mode"> @@ -307,7 +309,7 @@ <argument index="0" name="mode" type="int" enum="Tree.SelectMode"> </argument> <description> - Set the selection mode. Use one of the [code]SELECT_*[/code] constants. + Allow single or multiple selection. See the [code]SELECT_*[/code] constants. </description> </method> </methods> @@ -332,6 +334,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Emitted when a column's title is pressed. </description> </signal> <signal name="custom_popup_edited"> @@ -366,15 +369,17 @@ </signal> <signal name="item_double_clicked"> <description> + Emitted when an item is double clicked. </description> </signal> <signal name="item_edited"> <description> - Emitted when an item is editted. + Emitted when an item is edited. </description> </signal> <signal name="item_rmb_edited"> <description> + Emitted when an item is edited using the right mouse button. </description> </signal> <signal name="item_rmb_selected"> @@ -397,15 +402,18 @@ <argument index="2" name="selected" type="bool"> </argument> <description> + Emitted instead of [code]item_selected[/code] when [code]select_mode[/code] is [code]SELECT_MULTI[/code]. </description> </signal> </signals> <constants> <constant name="SELECT_SINGLE" value="0"> + Allow selection of a single item at a time. </constant> <constant name="SELECT_ROW" value="1"> </constant> <constant name="SELECT_MULTI" value="2"> + Allow selection of multiple items at the same time. </constant> <constant name="DROP_MODE_DISABLED" value="0"> </constant> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index d1e45bd10f..10ebc72134 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="TreeItem" inherits="Object" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Control for a single item inside a [Tree]. </brief_description> <description> + Control for a single item inside a [Tree]. May have child [TreeItem]\ s and be styled as well as contain buttons. </description> <tutorials> </tutorials> @@ -23,6 +25,7 @@ <argument index="4" name="tooltip" type="String" default=""""> </argument> <description> + Adds a button with [Texture] [code]button[/code] at column [code]column[/code]. The [code]button_idx[/code] index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling [code]get_buton_count()[/code] immediately after this method. Optionally, the button can be [code]disabled[/code] and have a [code]tooltip[/code]. </description> </method> <method name="clear_custom_bg_color"> @@ -31,6 +34,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Resets the background color for the given column to default. </description> </method> <method name="clear_custom_color"> @@ -39,6 +43,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Resets the color for the given column to default. </description> </method> <method name="deselect"> @@ -47,6 +52,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Deselects the given column. </description> </method> <method name="erase_button"> @@ -57,6 +63,7 @@ <argument index="1" name="button_idx" type="int"> </argument> <description> + Removes the button at index [code]button_idx[/code] in column [code]column[/code]. </description> </method> <method name="get_button" qualifiers="const"> @@ -67,6 +74,7 @@ <argument index="1" name="button_idx" type="int"> </argument> <description> + Returns the [Texture] of the button at index [code]button_idx[/code] in column [code]column[/code]. </description> </method> <method name="get_button_count" qualifiers="const"> @@ -75,6 +83,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns the number of buttons in column [code]column[/code]. May be used to get the most recently added button's index, if no index was specified. </description> </method> <method name="get_cell_mode" qualifiers="const"> @@ -83,12 +92,14 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns the column's cell mode. See [code]CELL_MODE_*[/code] constants. </description> </method> <method name="get_children"> <return type="TreeItem"> </return> <description> + Returns the TreeItem's child items. </description> </method> <method name="get_custom_bg_color" qualifiers="const"> @@ -97,12 +108,14 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns the custom background color of column [code]column[/code]. </description> </method> <method name="get_custom_minimum_height" qualifiers="const"> <return type="int"> </return> <description> + Returns the custom minimum height. </description> </method> <method name="get_expand_right" qualifiers="const"> @@ -111,6 +124,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns [code]true[/code] if [code]expand_right[/code] is set. </description> </method> <method name="get_icon" qualifiers="const"> @@ -119,6 +133,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns the given column's icon [Texture]. Error if no icon is set. </description> </method> <method name="get_icon_max_width" qualifiers="const"> @@ -127,6 +142,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns the column's icon's maximum width. </description> </method> <method name="get_icon_region" qualifiers="const"> @@ -135,6 +151,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns the icon [Texture] region as [Rect2]. </description> </method> <method name="get_metadata" qualifiers="const"> @@ -149,30 +166,35 @@ <return type="TreeItem"> </return> <description> + Returns the next TreeItem in the tree. </description> </method> <method name="get_next_visible"> <return type="TreeItem"> </return> <description> + Returns the next visible TreeItem in the tree. </description> </method> <method name="get_parent"> <return type="TreeItem"> </return> <description> + Returns the parent TreeItem. </description> </method> <method name="get_prev"> <return type="TreeItem"> </return> <description> + Returns the previous TreeItem in the tree. </description> </method> <method name="get_prev_visible"> <return type="TreeItem"> </return> <description> + Returns the previous visible TreeItem in the tree. </description> </method> <method name="get_range" qualifiers="const"> @@ -197,6 +219,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns the given column's text. </description> </method> <method name="get_text_align" qualifiers="const"> @@ -205,6 +228,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns the given column's text alignment. </description> </method> <method name="get_tooltip" qualifiers="const"> @@ -213,6 +237,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns the given column's tooltip. </description> </method> <method name="is_button_disabled" qualifiers="const"> @@ -223,6 +248,7 @@ <argument index="1" name="button_idx" type="int"> </argument> <description> + Returns [code]true[/code] if the button at index [code]button_idx[/code] for the given column is disabled. </description> </method> <method name="is_checked" qualifiers="const"> @@ -231,12 +257,14 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns [code]true[/code] if the given column is checked. </description> </method> <method name="is_collapsed"> <return type="bool"> </return> <description> + Returns [code]true[/code] if this TreeItem is collapsed. </description> </method> <method name="is_custom_set_as_button" qualifiers="const"> @@ -253,12 +281,14 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns [code]true[/code] if column [code]column[/code] is editable. </description> </method> <method name="is_folding_disabled" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if folding is disabled for this TreeItem. </description> </method> <method name="is_selectable" qualifiers="const"> @@ -267,6 +297,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns [code]true[/code] if column [code]column[/code] is selectable. </description> </method> <method name="is_selected"> @@ -275,18 +306,21 @@ <argument index="0" name="column" type="int"> </argument> <description> + Returns [code]true[/code] if column [code]column[/code] is selected. </description> </method> <method name="move_to_bottom"> <return type="void"> </return> <description> + Moves this TreeItem to the bottom in the [Tree] hierarchy. </description> </method> <method name="move_to_top"> <return type="void"> </return> <description> + Moves this TreeItem to the top in the [Tree] hierarchy. </description> </method> <method name="remove_child"> @@ -295,6 +329,7 @@ <argument index="0" name="child" type="Object"> </argument> <description> + Removes the child TreeItem at index [code]index[/code]. </description> </method> <method name="select"> @@ -303,6 +338,7 @@ <argument index="0" name="column" type="int"> </argument> <description> + Selects the column [code]column[/code]. </description> </method> <method name="set_button"> @@ -315,6 +351,7 @@ <argument index="2" name="button" type="Texture"> </argument> <description> + Sets the given column's button [Texture] at index [code]button_idx[/code] to [code]button[/code]. </description> </method> <method name="set_cell_mode"> @@ -325,6 +362,7 @@ <argument index="1" name="mode" type="int" enum="TreeItem.TreeCellMode"> </argument> <description> + Sets the given column's cell mode to [code]mode[/code]. See [code]CELL_MODE_*[/code] constants. </description> </method> <method name="set_checked"> @@ -335,6 +373,7 @@ <argument index="1" name="checked" type="bool"> </argument> <description> + If [code]true[/code] the column [code]column[/code] is checked. </description> </method> <method name="set_collapsed"> @@ -343,6 +382,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + If [code]true[/code] the TreeItem is collapsed. </description> </method> <method name="set_custom_as_button"> @@ -365,6 +405,7 @@ <argument index="2" name="just_outline" type="bool" default="false"> </argument> <description> + Sets the given column's custom background color and whether to just use it as an outline. </description> </method> <method name="set_custom_color"> @@ -375,6 +416,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Sets the given column's custom color. </description> </method> <method name="set_custom_draw"> @@ -387,6 +429,7 @@ <argument index="2" name="callback" type="String"> </argument> <description> + Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code]. </description> </method> <method name="set_custom_minimum_height"> @@ -395,6 +438,7 @@ <argument index="0" name="height" type="int"> </argument> <description> + Sets the custom minimum height of this TreeItem. </description> </method> <method name="set_disable_folding"> @@ -403,6 +447,7 @@ <argument index="0" name="disable" type="bool"> </argument> <description> + If [code]true[/code] folding is disabled for this TreeItem. </description> </method> <method name="set_editable"> @@ -413,6 +458,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] column [code]column[/code] is editable. </description> </method> <method name="set_expand_right"> @@ -423,6 +469,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> + If [code]true[/code] column [code]column[/code] is expanded to the right. </description> </method> <method name="set_icon"> @@ -433,6 +480,7 @@ <argument index="1" name="texture" type="Texture"> </argument> <description> + Sets the given column's icon [Texture]. </description> </method> <method name="set_icon_max_width"> @@ -443,6 +491,7 @@ <argument index="1" name="width" type="int"> </argument> <description> + Sets the given column's icon's maximum width. </description> </method> <method name="set_icon_region"> @@ -453,6 +502,7 @@ <argument index="1" name="region" type="Rect2"> </argument> <description> + Sets the given column's icon's texture region. </description> </method> <method name="set_metadata"> @@ -499,6 +549,7 @@ <argument index="1" name="selectable" type="bool"> </argument> <description> + If [code]true[/code] the given column is selectable. </description> </method> <method name="set_text"> @@ -519,6 +570,7 @@ <argument index="1" name="text_align" type="int" enum="TreeItem.TextAlign"> </argument> <description> + Sets the given column's text alignment. See [code]ALIGN_*[/code] constants. </description> </method> <method name="set_tooltip"> @@ -529,27 +581,36 @@ <argument index="1" name="tooltip" type="String"> </argument> <description> + Sets the given column's tooltip text. </description> </method> </methods> <constants> <constant name="CELL_MODE_STRING" value="0"> + Cell contains a string. </constant> <constant name="CELL_MODE_CHECK" value="1"> + Cell can be checked. </constant> <constant name="CELL_MODE_RANGE" value="2"> + Cell contains a range. </constant> <constant name="CELL_MODE_RANGE_EXPRESSION" value="3"> + Cell contains a range expression. </constant> <constant name="CELL_MODE_ICON" value="4"> + Cell contains an icon. </constant> <constant name="CELL_MODE_CUSTOM" value="5"> </constant> <constant name="ALIGN_LEFT" value="0"> + Align text to the left. See [code]set_text_align()[/code]. </constant> <constant name="ALIGN_CENTER" value="1"> + Center text. See [code]set_text_align()[/code]. </constant> <constant name="ALIGN_RIGHT" value="2"> + Align text to the right. See [code]set_text_align()[/code]. </constant> </constants> </class> diff --git a/doc/classes/VisualScriptComment.xml b/doc/classes/VisualScriptComment.xml index da65998e78..69126052d0 100644 --- a/doc/classes/VisualScriptComment.xml +++ b/doc/classes/VisualScriptComment.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptComment" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> - A Visual Script node used to store information for the developer. + A Visual Script node used to annotate the script. </brief_description> <description> - A Visual Script node used to display text, so that code is more readable and better documented. + A Visual Script node used to display annotations in the script, so that code may be documented. Comment nodes can be resized so they encompass a group of nodes. </description> <tutorials> @@ -60,10 +60,10 @@ The text inside the comment node. </member> <member name="size" type="Vector2" setter="set_size" getter="get_size"> - The size (in pixels) of the comment node. + The comment node's size (in pixels). </member> <member name="title" type="String" setter="set_title" getter="get_title"> - The title of the comment node. + The comment node's title. </member> </members> <constants> diff --git a/doc/classes/VisualScriptCondition.xml b/doc/classes/VisualScriptCondition.xml index de814a6b17..a776c9bc9b 100644 --- a/doc/classes/VisualScriptCondition.xml +++ b/doc/classes/VisualScriptCondition.xml @@ -4,7 +4,14 @@ A Visual Script node which branches the flow. </brief_description> <description> - A Visual Script node which switches the flow based on a boolean. It acts similar to if/else in typical programming languages. + A Visual Script node that checks a [bool] input port. If [code]true[/code] it will exit via the “true” sequence port. If [code]false[/code] it will exit via the "false" sequence port. After exiting either, it exits via the “done” port. Sequence ports may be left disconnected. + [b]Input Ports:[/b] + - Sequence: [code]if (cond) is[/code] + - Data (boolean): [code]cond[/code] + [b]Output Ports:[/b] + - Sequence: [code]true[/code] + - Sequence: [code]false[/code] + - Sequence: [code]done[/code] </description> <tutorials> </tutorials> diff --git a/doc/classes/VisualScriptOperator.xml b/doc/classes/VisualScriptOperator.xml index 82951c9e0c..7e85af8af2 100644 --- a/doc/classes/VisualScriptOperator.xml +++ b/doc/classes/VisualScriptOperator.xml @@ -3,6 +3,13 @@ <brief_description> </brief_description> <description> + [b]Input Ports:[/b] + - Data (variant): [code]A[/code] + - Data (variant): [code]B[/code] + [b]Output Ports:[/b] + - Sequence: [code]true[/code] + - Sequence: [code]false[/code] + - Sequence: [code]done[/code] </description> <tutorials> </tutorials> diff --git a/doc/classes/VisualScriptSceneNode.xml b/doc/classes/VisualScriptSceneNode.xml index 90a8f132c0..b71bd9adfb 100644 --- a/doc/classes/VisualScriptSceneNode.xml +++ b/doc/classes/VisualScriptSceneNode.xml @@ -1,8 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptSceneNode" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Node reference. </brief_description> <description> + A direct reference to a node. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data: [code]node[/code] (obj) </description> <tutorials> </tutorials> @@ -26,6 +32,7 @@ </methods> <members> <member name="node_path" type="NodePath" setter="set_node_path" getter="get_node_path"> + The node's path in the scene tree. </member> </members> <constants> |