forked from Mirrors/openclonk
81 lines
3.0 KiB
XML
81 lines
3.0 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>DrawParticleLine</title>
|
|
<category>Particles</category>
|
|
<version>5.1 OC</version>
|
|
<syntax>
|
|
<rtype>int</rtype>
|
|
<params>
|
|
<param>
|
|
<type>string</type>
|
|
<name>particle</name>
|
|
<desc>Type of particle to be created.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>x0</name>
|
|
<desc>X coordinate of the starting point. Offset in local calls.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>y0</name>
|
|
<desc>Y coordinate of the starting point. Offset in local calls.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>x1</name>
|
|
<desc>X coordinate of the end point. Offset in local calls.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>y1</name>
|
|
<desc>Y coordinate of the end point. Offset in local calls.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>prtdist</name>
|
|
<desc>Distance between particles. This may not be applied exactly as particles are always spread evenly over the total distance.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>a</name>
|
|
<desc>Extra parameter. This is usually the size of the particle in 1/5 pixels.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>b0</name>
|
|
<desc>Extra starting parameter. This is usually the color modulation at the starting point.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>b1</name>
|
|
<desc>Extra end parameter. This parameter is interpolated from starting to end point and then applied.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>ydir</name>
|
|
<desc>Initial vertical velocity.</desc>
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Creates a line of particles between two points. Returns the number of particles created.</desc>
|
|
<examples>
|
|
<example>
|
|
<code>DrawParticleLine("MagicSpark", 0, 0, <funclink>GetX</funclink>(<funclink>GetCursor</funclink>())-<funclink>GetX</funclink>(), <funclink>GetY</funclink>(<funclink>GetCursor</funclink>())-<funclink>GetY</funclink>(), 20, 100, <funclink>RGBa</funclink>(255,50,50,50), <funclink>RGBa</funclink>(50,255,50,100), -10);</code>
|
|
<text>Creates a line from the calling object to the selected clonk of the first player, color fading from red to blue.</text>
|
|
</example>
|
|
</examples>
|
|
<related>
|
|
<funclink>CreateParticle</funclink>
|
|
<funclink>CastParticles</funclink>
|
|
<funclink>RGB</funclink>
|
|
<funclink>RGBa</funclink>
|
|
</related>
|
|
</func>
|
|
<author>Sven2</author><date>2002-05</date>
|
|
</funcs>
|