From ecb92bc6c3258b784c18484f9001fe3ee17cc58d Mon Sep 17 00:00:00 2001 From: "Daniel J. Ramirez" Date: Sat, 9 Sep 2017 22:05:26 -0500 Subject: Added documentation for some clases Variant, ToolButton, Button, GradientTexture, BitMap Added documentation for CollisionShape(2D) --- doc/base/classes.xml | 55 +++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 39 insertions(+), 16 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index a097470306..69b3628ce7 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -9025,8 +9025,10 @@ + Boolean matrix. + A two-dimensional array of boolean values, can be used to efficiently store a binary matrix (every matrix element takes only one bit) and query the values using natural cartesian coordinates. @@ -9035,6 +9037,7 @@ + Creates a bitmap with the specified size, filled with false. @@ -9043,6 +9046,7 @@ + Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is 0, and true in other case. @@ -9051,18 +9055,21 @@ + Returns bitmap's value at the specified position. + Returns bitmap's dimensions. + Returns the amount of bitmap elements that are set to true. @@ -9073,6 +9080,7 @@ + Sets the bitmap's element at the specified position, to the specified value. @@ -9083,6 +9091,7 @@ + Sets a rectangular portion of the bitmap to the specified value. @@ -9370,35 +9379,30 @@ - Return the button icon. - Return the state of the [i]clip_text[/i] property (see [method set_clip_text]) - Return the button text. - Return the text alignment policy. - Return the state of the [i]flat[/i] property (see [method set_flat]). @@ -9407,7 +9411,6 @@ - Set the icon that will be displayed next to the text inside the button area. @@ -9416,7 +9419,6 @@ - Set the [i]clip_text[/i] property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text. @@ -9425,7 +9427,6 @@ - Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed. @@ -9434,7 +9435,6 @@ - Set the button text, which will be displayed inside the button area. @@ -9443,20 +9443,24 @@ - Set the text alignment policy, using one of the ALIGN_* constants. + Text alignment policy for the button's text, use one of the ALIGN_* constants. + When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. - + + Flat buttons don't display decoration. + Button's icon, if text is present the icon will be placed before the text. + The button's text that will be displayed inside the button's area. @@ -9464,7 +9468,7 @@ Align the text to the left. - Center the text. + Align the text to the center. Align the text to the right. @@ -12155,8 +12159,10 @@ + Node that represents collision shape data in 3D space. + Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area] to give it a detection shape, or add it to a [PhysicsBody] to give create solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape. @@ -12175,6 +12181,7 @@ + Sets the collision shape's shape to the addition of all its convexed [MeshInstance] siblings geometry. @@ -12204,8 +12211,10 @@ + A disabled collision shape has no effect in the world. + The actual shape owned by this collision shape. @@ -12213,17 +12222,16 @@ - Editor-only class for easy editing of shapes. + Node that represents collision shape data in 2D space. - Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. + Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area2D] to give it a detection shape, or add it to a [PhysicsBody2D] to give create solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape. - Return this shape's [Shape2D]. @@ -12260,16 +12268,18 @@ - Set this shape's [Shape2D]. This will not appear as a node, but can be directly edited as a property. + A disabled collision shape has no effect in the world. + Sets whether this collision shape should only detect collision on one side (top or bottom). + The actual shape owned by this collision shape. @@ -20461,8 +20471,10 @@ + Gradient filled texture. + Uses a [Gradient] to fill the texture data, the gradient will be filled from left to right using colors obtained from the gradient, this means that the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see [method set_width]). @@ -20490,8 +20502,10 @@ + The [Gradient] that will be used to fill the texture. + The number of color samples that will be obtained from the [Gradient]. @@ -53197,8 +53211,15 @@ + Flat button helper class. + This is a helper class to generate a flat [Button] (see [method Button.set_flat]), creating a ToolButton is equivalent to: + + [codeblock] + var btn = Button.new() + btn.set_flat(true) + [/codeblock] @@ -55584,8 +55605,10 @@ + The most important data type in Godot. + A Variant takes up only 20 bytes and can store almost any engine datatype inside of it. Variants are rarely used to hold information for long periods of time, instead they are used mainly for communication, editing, serialization and moving data around. -- cgit v1.2.3