openclonk/docs/sdk/script/fn/GetGravity.xml

23 lines
901 B
XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>GetGravity</title>
<category>Global</category>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Returns the current gravity in 1/100 pixel/tick².</desc>
<examples>
<example>
<code><funclink>for</funclink> (var obj in <funclink>FindObjects</funclink>(<funclink>Find_Distance</funclink>(100)))
obj-&gt;<funclink>SetYDir</funclink>(obj-&gt;<funclink>GetYDir</funclink>(100) - GetGravity(), 100);</code>
<text>Makes the gravitation within a radius of 100 pixels vanish if called every frame.</text>
</example>
</examples>
<related><funclink>SetGravity</funclink></related>
</func>
<author>jwk</author><date>2002-08</date>
</funcs>