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

75 lines
2.5 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_KeyFrames</title>
<category>Particles</category>
<version>5.3.3 OC</version>
<syntax>
<rtype>array</rtype>
<params>
<param>
<type>int</type>
<name>smoothing</name>
<desc>Smoothing of the curve. 0 means linear interpolation.</desc>
</param>
<param>
<type>int</type>
<name>position1</name>
<desc>Age of the particle in per-mille (0 to 1000) where value1 will be returned.</desc>
</param>
<param>
<type>int</type>
<name>value1</name>
<desc>Value at position1.</desc>
</param>
<param>
<type>int</type>
<name>position2</name>
<desc>Age of the particle in per-mille (0 to 1000) where value2 will be returned.</desc>
</param>
<param>
<type>int</type>
<name>value2</name>
<desc>Value at position2.</desc>
</param>
<param>
<type>int</type>
<name>position3</name>
<desc>Age of the particle in per-mille (0 to 1000) where value3 will be returned.</desc>
</param>
<param>
<type>int</type>
<name>value3</name>
<desc>Value at position3.</desc>
</param>
<param>
<type>int</type>
<name>position4</name>
<desc>Age of the particle in per-mille (0 to 1000) where value4 will be returned.</desc>
</param>
<param>
<type>int</type>
<name>value4</name>
<desc>Value at position4.</desc>
</param>
</params>
</syntax>
<desc>The value returned will be an interpolated value of the (smoothed) curve between the up to 4 key frames. PV_KeyFrames(0, 0, X, 1000, Y) is equivalent to PV_Linear(X, Y).</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_Step</funclink>
<funclink>PC_Die</funclink>
<funclink>PC_Bounce</funclink>
</related>
</func>
<author>Zapper</author><date>2013-10</date>
</funcs>