virtualx-engine/modules/visual_script/doc_classes/VisualScriptMathConstant.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptMathConstant" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		Commonly used mathematical constants.
	</brief_description>
	<description>
		Provides common math constants, such as Pi, on an output Data port.
		[b]Input Ports:[/b]
		none
		[b]Output Ports:[/b]
		- Data (variant): [code]get[/code]
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="constant" type="int" setter="set_math_constant" getter="get_math_constant" enum="VisualScriptMathConstant.MathConstant" default="0">
			The math constant.
		</member>
	</members>
	<constants>
		<constant name="MATH_CONSTANT_ONE" value="0" enum="MathConstant">
			Unity: [code]1[/code].
		</constant>
		<constant name="MATH_CONSTANT_PI" value="1" enum="MathConstant">
			Pi: [code]3.141593[/code].
		</constant>
		<constant name="MATH_CONSTANT_HALF_PI" value="2" enum="MathConstant">
			Pi divided by two: [code]1.570796[/code].
		</constant>
		<constant name="MATH_CONSTANT_TAU" value="3" enum="MathConstant">
			Tau: [code]6.283185[/code].
		</constant>
		<constant name="MATH_CONSTANT_E" value="4" enum="MathConstant">
			Mathematical constant [code]e[/code], the natural log base: [code]2.718282[/code].
		</constant>
		<constant name="MATH_CONSTANT_SQRT2" value="5" enum="MathConstant">
			Square root of two: [code]1.414214[/code].
		</constant>
		<constant name="MATH_CONSTANT_INF" value="6" enum="MathConstant">
			Infinity: [code]inf[/code].
		</constant>
		<constant name="MATH_CONSTANT_NAN" value="7" enum="MathConstant">
			Not a number: [code]nan[/code].
		</constant>
		<constant name="MATH_CONSTANT_MAX" value="8" enum="MathConstant">
			Represents the size of the [enum MathConstant] enum.
		</constant>
	</constants>
</class>