diff options
| author | Chris Bradfield <chris@kidscancode.org> | 2017-10-14 20:11:00 -0700 |
|---|---|---|
| committer | Chris Bradfield <chris@kidscancode.org> | 2017-10-15 08:59:38 -0700 |
| commit | 6172f09703847aeac556abf2fca5169e73d22f97 (patch) | |
| tree | 93b7fe8c4e1f84f7cc35081011d85f7ad8de0e13 /doc/classes/VisualScriptMathConstant.xml | |
| parent | b005c5fcec2a1bb6d0ed4ae9637012b3f15ac837 (diff) | |
[DOCS] Update 12 VisualScript* nodes
Diffstat (limited to 'doc/classes/VisualScriptMathConstant.xml')
| -rw-r--r-- | doc/classes/VisualScriptMathConstant.xml | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/classes/VisualScriptMathConstant.xml b/doc/classes/VisualScriptMathConstant.xml index 1ef7d71e10..86744e5caf 100644 --- a/doc/classes/VisualScriptMathConstant.xml +++ b/doc/classes/VisualScriptMathConstant.xml @@ -1,8 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptMathConstant" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Commonly used mathematical constants. </brief_description> <description> + Provides common math constants, such as Pi or Euler's constant, on an output Data port. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] </description> <tutorials> </tutorials> @@ -26,24 +32,33 @@ </methods> <members> <member name="constant" type="int" setter="set_math_constant" getter="get_math_constant" enum="VisualScriptMathConstant.MathConstant"> + The math constant. </member> </members> <constants> <constant name="MATH_CONSTANT_ONE" value="0"> + Unity: [code]1[/code] </constant> <constant name="MATH_CONSTANT_PI" value="1"> + Pi: [code]3.141593[/code] </constant> <constant name="MATH_CONSTANT_2PI" value="2"> + Pi times two: [code]6.283185[/code] </constant> <constant name="MATH_CONSTANT_HALF_PI" value="3"> + Pi divided by two: [code]1.570796[/code] </constant> <constant name="MATH_CONSTANT_E" value="4"> + Natural log: [code]2.718282[/code] </constant> <constant name="MATH_CONSTANT_SQRT2" value="5"> + Square root of two: [code]1.414214[/code] </constant> <constant name="MATH_CONSTANT_INF" value="6"> + Infinity: [code]inf[/code] </constant> <constant name="MATH_CONSTANT_NAN" value="7"> + Not a number: [code]nan[/code] </constant> <constant name="MATH_CONSTANT_MAX" value="8"> </constant> |