Merge pull request #4529 from djrm/classref-float

Documented float
This commit is contained in:
Rémi Verschelde 2016-05-02 20:14:28 +02:00
commit 1d9c4c559b

View File

@ -43953,8 +43953,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">
@ -43963,6 +43965,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">
@ -43971,6 +43974,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">
@ -43979,6 +43983,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>