summaryrefslogtreecommitdiff
path: root/doc/classes/float.xml
blob: 7297f5bf94921084ec43a1404d0655cffdaf4e3b (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="float" category="Built-In Types" version="3.1">
	<brief_description>
		Float built-in type
	</brief_description>
	<description>
		Float built-in type.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<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 1.0.
			</description>
		</method>
		<method name="float">
			<return type="float">
			</return>
			<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>
	<constants>
	</constants>
</class>