diff options
Diffstat (limited to 'doc/classes/bool.xml')
| -rw-r--r-- | doc/classes/bool.xml | 84 |
1 files changed, 56 insertions, 28 deletions
diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index ce4d000a9b..d0ef664281 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="bool" version="4.0"> +<class name="bool" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Boolean built-in type. </brief_description> <description> - Boolean is a built-in type. There are two boolean values: [code]true[/code] and [code]false[/code]. You can think of it as an switch with on or off (1 or 0) setting. Booleans are used in programming for logic in condition statements, like [code]if[/code] statements. + Boolean is a built-in type. There are two boolean values: [code]true[/code] and [code]false[/code]. You can think of it as a switch with on or off (1 or 0) setting. Booleans are used in programming for logic in condition statements, like [code]if[/code] statements. Booleans can be directly used in [code]if[/code] statements. The code below demonstrates this on the [code]if can_shoot:[/code] line. You don't need to use [code]== true[/code], you only need [code]if can_shoot:[/code]. Similarly, use [code]if not can_shoot:[/code] rather than [code]== false[/code]. [codeblocks] [gdscript] @@ -49,9 +49,10 @@ [/csharp] [/codeblocks] The following code will set [code]can_shoot[/code] to [code]false[/code] and start a timer. This will prevent player from shooting until the timer runs out. Next [code]can_shoot[/code] will be set to [code]true[/code] again allowing player to shoot once again. + [codeblocks] [gdscript] var _can_shoot = true - onready var _cool_down = $CoolDownTimer + @onready var _cool_down = $CoolDownTimer func shoot(): if _can_shoot and Input.is_action_pressed("shoot"): @@ -90,36 +91,63 @@ </description> <tutorials> </tutorials> - <methods> - <method name="bool"> - <return type="bool"> - </return> - <argument index="0" name="from" type="int"> - </argument> + <constructors> + <constructor name="bool"> + <return type="bool" /> <description> - Cast an [int] value to a boolean value, this method will return [code]false[/code] if [code]0[/code] is passed in, and [code]true[/code] for all other ints. + Constructs a default-initialized [bool] set to [code]false[/code]. + </description> + </constructor> + <constructor name="bool"> + <return type="bool" /> + <param index="0" name="from" type="bool" /> + <description> + Constructs a [bool] as a copy of the given [bool]. </description> - </method> - <method name="bool"> - <return type="bool"> - </return> - <argument index="0" name="from" type="float"> - </argument> + </constructor> + <constructor name="bool"> + <return type="bool" /> + <param index="0" name="from" type="float" /> <description> Cast a [float] value to a boolean value, this method will return [code]false[/code] if [code]0.0[/code] is passed in, and [code]true[/code] for all other floats. </description> - </method> - <method name="bool"> - <return type="bool"> - </return> - <argument index="0" name="from" type="String"> - </argument> + </constructor> + <constructor name="bool"> + <return type="bool" /> + <param index="0" name="from" type="int" /> + <description> + Cast an [int] value to a boolean value, this method will return [code]false[/code] if [code]0[/code] is passed in, and [code]true[/code] for all other ints. + </description> + </constructor> + </constructors> + <operators> + <operator name="operator !="> + <return type="bool" /> + <param index="0" name="right" type="bool" /> + <description> + Returns [code]true[/code] if two bools are different, i.e. one is [code]true[/code] and the other is [code]false[/code]. + </description> + </operator> + <operator name="operator <"> + <return type="bool" /> + <param index="0" name="right" type="bool" /> + <description> + Returns [code]true[/code] if the left operand is [code]false[/code] and the right operand is [code]true[/code]. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <param index="0" name="right" type="bool" /> + <description> + Returns [code]true[/code] if two bools are equal, i.e. both are [code]true[/code] or both are [code]false[/code]. + </description> + </operator> + <operator name="operator >"> + <return type="bool" /> + <param index="0" name="right" type="bool" /> <description> - Cast a [String] value to a boolean value, this method will return [code]false[/code] if [code]""[/code] is passed in, and [code]true[/code] for all non-empty strings. - Examples: [code]bool("False")[/code] returns [code]true[/code], [code]bool("")[/code] returns [code]false[/code]. + Returns [code]true[/code] if the left operand is [code]true[/code] and the right operand is [code]false[/code]. </description> - </method> - </methods> - <constants> - </constants> + </operator> + </operators> </class> |