diff options
Diffstat (limited to 'doc/classes/int.xml')
| -rw-r--r-- | doc/classes/int.xml | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/classes/int.xml b/doc/classes/int.xml new file mode 100644 index 0000000000..7c2267ac9a --- /dev/null +++ b/doc/classes/int.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="int" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Integer built-in type. + </brief_description> + <description> + Integer built-in type. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="int"> + <return type="int"> + </return> + <argument index="0" name="from" type="bool"> + </argument> + <description> + Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0. + </description> + </method> + <method name="int"> + <return type="int"> + </return> + <argument index="0" name="from" type="float"> + </argument> + <description> + Cast a float value to an integer value, this method simply removes the number fractions, so for example [code]int(2.7)[/code] will be equals to 2, [code]int(.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2. + </description> + </method> + <method name="int"> + <return type="int"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <description> + Cast a [String] value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like [code]'1.7'[/code]. This method will ignore all non-number characters, so calling [code]int('1e3')[/code] will return 13. + </description> + </method> + </methods> + <constants> + </constants> +</class> |