forked from Mirrors/openclonk
53 lines
1.7 KiB
XML
53 lines
1.7 KiB
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>PV_Step</title>
|
|
<category>Particles</category>
|
|
<version>5.3.3 OC</version>
|
|
<syntax>
|
|
<rtype>array</rtype>
|
|
<params>
|
|
<param>
|
|
<type>int</type>
|
|
<name>step</name>
|
|
<desc>Increase per each step (usually one frame, see the delay-parameter).</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>start_value</name>
|
|
<desc>Value that will be added to the current step-value.</desc>
|
|
<optional />
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>delay</name>
|
|
<desc>Delay in frames for every step (defaults to 1).</desc>
|
|
<optional />
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>maximumValue</name>
|
|
<desc>If not 0, the returned value will be capped at this value and not increase further.</desc>
|
|
<optional />
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>PV_Step can be used for values that do not depend on the particle age (unlike f.e. <funclink>PV_Linear</funclink>).</desc>
|
|
<remark>See the <emlink href="particle/index.html">particle documentation</emlink> for further explanations of the particle system.</remark>
|
|
<related>
|
|
<funclink>CreateParticle</funclink>
|
|
<funclink>PV_Linear</funclink>
|
|
<funclink>PV_Direction</funclink>
|
|
<funclink>PV_Random</funclink>
|
|
<funclink>PV_Speed</funclink>
|
|
<funclink>PV_KeyFrames</funclink>
|
|
<funclink>PC_Die</funclink>
|
|
<funclink>PC_Bounce</funclink>
|
|
</related>
|
|
</func>
|
|
<author>Zapper</author><date>2013-10</date>
|
|
</funcs>
|