virtualx-engine/doc/classes/int.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="int" category="Built-In Types" version="3.1">
	<brief_description>
		Integer built-in type.
	</brief_description>
	<description>
		Integer built-in type.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="int">
			<return type="int">
			</return>
			<argument index="0" name="from" type="bool">
			</argument>
			<description>
				Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0.
			</description>
		</method>
		<method name="int">
			<return type="int">
			</return>
			<argument index="0" name="from" type="float">
			</argument>
			<description>
				Cast a float value to an integer value, this method simply removes the number fractions, so for example [code]int(2.7)[/code] will be equals to 2, [code]int(.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2.
			</description>
		</method>
		<method name="int">
			<return type="int">
			</return>
			<argument index="0" name="from" type="String">
			</argument>
			<description>
				Cast a [String] value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like [code]'1.7'[/code]. This method will ignore all non-number characters, so calling [code]int('1e3')[/code] will return 13.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>