summaryrefslogtreecommitdiff
path: root/doc/base
diff options
context:
space:
mode:
authorDaniel J. Ramirez <djrmuv@gmail.com>2016-05-02 13:11:14 -0500
committerDaniel J. Ramirez <djrmuv@gmail.com>2016-05-02 13:11:14 -0500
commit520e6f5b0944df0140521158f05c7d3fbd8bc2c0 (patch)
treec5a8fb089055f61fe5e14514d97589d5633b8881 /doc/base
parent5bb7cef8367e77c70b9a1ad045741fb97b32ef9d (diff)
Documented float
Diffstat (limited to 'doc/base')
-rw-r--r--doc/base/classes.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 774cea50fb..99c19dd6d3 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -43946,8 +43946,10 @@ This method controls whether the position between two cached points is interpola
</class>
<class name="float" category="Built-In Types">
<brief_description>
+ Float built-in type
</brief_description>
<description>
+ Float built-in type.
</description>
<methods>
<method name="float">
@@ -43956,6 +43958,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="bool">
</argument>
<description>
+ Cast a [bool] value to a floating point value, [code]float(true)[/code] will be equals to 1.0 and [code]float(false)[/code] will be equals to 0.0.
</description>
</method>
<method name="float">
@@ -43964,6 +43967,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="int">
</argument>
<description>
+ Cast an [int] value to a floating point value, [code]float(1)[/code] will be equals to 1.0.
</description>
</method>
<method name="float">
@@ -43972,6 +43976,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="String">
</argument>
<description>
+ Cast a [String] value to a floating point value. This method accepts float value strings like [code] '1.23' [/code] and exponential notation strings for its parameter so calling [code] float('1e3') [/code] will return 1000.0 and calling [code] float('1e-3') [/code] will return -0.001.
</description>
</method>
</methods>