diff options
| author | Rémi Verschelde | 2017-11-15 21:54:21 +0100 |
|---|---|---|
| committer | GitHub | 2017-11-15 21:54:21 +0100 |
| commit | c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738 (patch) | |
| tree | a22a88d22bd079a8404150fbf5b870df6046240e /modules/visual_script/doc_classes/VisualScriptMathConstant.xml | |
| parent | 4d08e7c4204ff3fa0e17e0de7e5a08ef03968202 (diff) | |
| parent | 11e07d18bd80c0b7d8836698d98e058750e33660 (diff) | |
| download | godot-c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738.tar.gz godot-c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738.tar.zst godot-c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738.zip | |
Merge pull request #12954 from akien-mga/docs
Make module docs self-contained and various improvements
Diffstat (limited to 'modules/visual_script/doc_classes/VisualScriptMathConstant.xml')
| -rw-r--r-- | modules/visual_script/doc_classes/VisualScriptMathConstant.xml | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptMathConstant.xml b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml new file mode 100644 index 000000000..817bcb5ce --- /dev/null +++ b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptMathConstant" inherits="VisualScriptNode" category="Core" version="3.0-alpha"> + <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> + <demos> + </demos> + <methods> + <method name="get_math_constant"> + <return type="int" enum="VisualScriptMathConstant.MathConstant"> + </return> + <description> + </description> + </method> + <method name="set_math_constant"> + <return type="void"> + </return> + <argument index="0" name="which" type="int" enum="VisualScriptMathConstant.MathConstant"> + </argument> + <description> + </description> + </method> + </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_HALF_PI" value="2"> + Pi divided by two: [code]1.570796[/code] + </constant> + <constant name="MATH_CONSTANT_TAU" value="3"> + Tau: [code]6.283185[/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> + </constants> +</class> |