Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-22 20:23:53 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
e0e4bcc6a6
godot/doc/html/@GDScript.html

93 lines
35 KiB
HTML
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
<html><link href="main.css" rel="stylesheet" type="text/css" /><body><table class="top_table"><tr><td class="top_table"><image src="images/logo.png" /></td><td class="top_table"><a href="index.html">Index</a></td><td class="top_table"><a href="alphabetical.html">Classes</a></td><td class="top_table"><a href="category.html">Categories</a></td><td><a href="inheritance.html">Inheritance</a></td></tr></table><hr /><div class="class"><a name="@GDScript"><h3 class="title class_title">@GDScript</h3></a><div class="description class_description">
Built-in GDScript functions.
</div><br /><div class="category"><span class="category">Category: </span><a class="category_ref" href="category.html#CATEGORY_Core">Core</a></div><h4>Public Methods:</h4><table class="method_list"><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_sin">sin</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_cos">cos</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_tan">tan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_sinh">sinh</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_cosh">cosh</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_tanh">tanh</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_asin">asin</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_acos">acos</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_atan">atan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_atan2">atan2</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_sqrt">sqrt</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_fmod">fmod</a></span><span class="symbol"> (</span><sp
This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects.
</div><h4>Method Documentation:</h4><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_sin">@GDScript::sin</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Standard sine function.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_cos">@GDScript::cos</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Standard cosine function.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_tan">@GDScript::tan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Standard tangent function.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_sinh">@GDScript::sinh</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Hyperbolic sine.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_tanh">@GDScript::tanh</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Hyperbolic tangent.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_asin">@GDScript::asin</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Arc-sine.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_acos">@GDScript::acos</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Arc-cosine.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_atan">@GDScript::atan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Arc-tangent.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_atan2">@GDScript::atan2</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></div><div class="description">
Arc-tangent that takes a 2D vector as argument, retuns the full -pi to +pi range.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_sqrt">@GDScript::sqrt</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Square root.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_fmod">@GDScript::fmod</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></div><div class="description">
Module (remainder of x/y).
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_fposmod">@GDScript::fposmod</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></div><div class="description">
Module (remainder of x/y) that wraps equally in positive and negative.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_floor">@GDScript::floor</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Floor (rounds down to nearest integer).
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_ceil">@GDScript::ceil</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Ceiling (rounds up to nearest integer).
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_round">@GDScript::round</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Round to nearest integer.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_abs">@GDScript::abs</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Remove sign (works for integer and float).
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_sign">@GDScript::sign</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Return sign (-1 or +1).
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_pow">@GDScript::pow</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></div><div class="description">
Power function, x elevate to y.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_log">@GDScript::log</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Natural logarithm.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_exp">@GDScript::exp</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Exponential logarithm.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_isnan">@GDScript::isnan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Return true if the float is not a number.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_isinf">@GDScript::isinf</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description">
Return true if the float is infinite.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_ease">@GDScript::ease</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>curve</span><span class="symbol"> )</span></div><div class="description">
Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_decimals">@GDScript::decimals</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>step</span><span class="symbol"> )</span></div><div class="description">
Return the amount of decimals in the floating point value.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_stepify">@GDScript::stepify</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>step</span><span class="symbol"> )</span></div><div class="description">
Snap float value to a given step.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="int.html">int </a><span class="funcdecl"><a name="@GDScript_rand">@GDScript::rand</a></span><span class="symbol"> (</span><span class="symbol">)</span></div><div class="description">
Random value (integer).
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_randf">@GDScript::randf</a></span><span class="symbol"> (</span><span class="symbol">)</span></div><div class="description">
Random value (0 to 1 float).
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_rand_range">@GDScript::rand_range</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>from</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>to</span><span class="symbol"> )</span></div><div class="description">
Random range.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Array.html">Array </a><span class="funcdecl"><a name="@GDScript_rand_seed">@GDScript::rand_seed</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>seed</span><span class="symbol"> )</span></div><div class="description">
random from seed, pass a seed and an array with both number and new seed is returned.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_deg2rad">@GDScript::deg2rad</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>deg</span><span class="symbol"> )</span></div><div class="description">
Convert from degrees to radians.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_rad2deg">@GDScript::rad2deg</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>rad</span><span class="symbol"> )</span></div><div class="description">
Convert from radias to degrees.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_linear2db">@GDScript::linear2db</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>nrg</span><span class="symbol"> )</span></div><div class="description">
Convert from linear energy to decibels (audio).
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_db2linear">@GDScript::db2linear</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>db</span><span class="symbol"> )</span></div><div class="description">
Convert from decibels to linear energy (audio).
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_max">@GDScript::max</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>a</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>b</span><span class="symbol"> )</span></div><div class="description">
Return the maximum of two values.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_min">@GDScript::min</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>a</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>b</span><span class="symbol"> )</span></div><div class="description">
Return the minimum of two values.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_clamp">@GDScript::clamp</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>val</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>min</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>max</span><span class="symbol"> )</span></div><div class="description">
Clamp both values to a range.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="int.html">int </a><span class="funcdecl"><a name="@GDScript_nearest_po2">@GDScript::nearest_po2</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="int.html">int </a><span>val</span><span class="symbol"> )</span></div><div class="description">
Return the nearest larger power of 2 for an integer.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Object.html">Object </a><span class="funcdecl"><a name="@GDScript_weakref">@GDScript::weakref</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="Object.html">Object </a><span>obj</span><span class="symbol"> )</span></div><div class="description">
Return a weak reference to an object.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Object.html">Object </a><span class="funcdecl"><a name="@GDScript_convert">@GDScript::convert</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><a class="datatype_existing" href="int.html">int </a><span>type</span><span class="symbol"> )</span></div><div class="description">
Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in Global Scope.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="String.html">String </a><span class="funcdecl"><a name="@GDScript_str">@GDScript::str</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></div><div class="description">
Convert one or more arguments to strings in the best way possible.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Nil.html">Nil </a><span class="funcdecl"><a name="@GDScript_print">@GDScript::print</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></div><div class="description">
Print one or more arguments to strings in the best way possible to a console line.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Nil.html">Nil </a><span class="funcdecl"><a name="@GDScript_printerr">@GDScript::printerr</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></div><div class="description">
Print one or more arguments to strings in the best way possible to standard error line.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Nil.html">Nil </a><span class="funcdecl"><a name="@GDScript_printraw">@GDScript::printraw</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></div><div class="description">
Print one or more arguments to strings in the best way possible to console. No newline is added at the end.
</div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Array.html">Array </a><span class="funcdecl"><a name="@GDScript_range">@GDScript::range</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></div><div class="description">
Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial,final-1,increment).
</div></div></div><hr /><span>Copyright 2008-2010 Codenix SRL</span></body></html>
Reference in New Issue Copy Permalink