virtualx-engine/doc/classes/float.xml
2020-11-10 15:00:50 +01:00

269 lines
6.7 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="float" version="4.0">
<brief_description>
Float built-in type.
</brief_description>
<description>
Float built-in type.
</description>
<tutorials>
</tutorials>
<methods>
<method name="float" qualifiers="constructor">
<return type="float">
</return>
<description>
Constructs a default-initialized [float] set to [code]0.0[/code].
</description>
</method>
<method name="float" qualifiers="constructor">
<return type="float">
</return>
<argument index="0" name="from" type="float">
</argument>
<description>
Constructs a [float] as a copy of the given [float].
</description>
</method>
<method name="float" qualifiers="constructor">
<return type="float">
</return>
<argument index="0" name="from" type="bool">
</argument>
<description>
Cast a [bool] value to a floating-point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0.
</description>
</method>
<method name="float" qualifiers="constructor">
<return type="float">
</return>
<argument index="0" name="from" type="int">
</argument>
<description>
Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to [code]1.0[/code].
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2">
</return>
<argument index="0" name="right" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector2i">
</return>
<argument index="0" name="right" type="Vector2i">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3">
</return>
<argument index="0" name="right" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Vector3i">
</return>
<argument index="0" name="right" type="Vector3i">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Quat">
</return>
<argument index="0" name="right" type="Quat">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="Color">
</return>
<argument index="0" name="right" type="Color">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="float">
</return>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator +" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="float">
</return>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator -" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator /" qualifiers="operator">
<return type="float">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="float">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="int">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>