summaryrefslogtreecommitdiff
path: root/doc/classes/float.xml
blob: 8153d62bc990011997658c4c027a54918effc5cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<?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">
			<return type="float">
			</return>
			<description>
				Constructs a default-initialized [float] set to [code]0.0[/code].
			</description>
		</method>
		<method name="float">
			<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">
			<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">
			<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>
	</methods>
	<constants>
	</constants>
</class>