File: Particles_Colored.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (44 lines) | stat: -rw-r--r-- 1,606 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<?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>Particles_Colored</title>
    <category>Particles</category>
    <version>5.3.3 OC</version>
    <syntax>
      <rtype>proplist</rtype>
      <params>
        <param>
          <type>proplist</type>
          <name>prototype</name>
          <desc>Particle prototype of which a colored version is returned.</desc>
        </param>
        <param>
          <type>int</type>
          <name>color1</name>
          <desc>RGB color in format 0xRRGGBB</desc>
        </param>
        <param>
          <type>int</type>
          <name>color2</name>
          <desc>Secondary color. If given, particles are created with a random color between color and color2.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Creates a colored version of another particle definition.</desc>
    <examples>
      <example>
        <code>CreateParticle("MagicSpark", 0,0, PV_Random(-10,10), PV_Random(-10,10), PV_Random(10,50), Particles_Colored(Particles_Spark(),0xff0000,0x00ff00), 15);</code>
        <text>Creates 15 particles with coloration varying between red and green.</text>
      </example>
    </examples>
    <remark>See the <emlink href="particle/index.html">particle documentation</emlink> for further explanations of the particle system.</remark>
    <related>
      <funclink>CreateParticle</funclink>
    </related>
  </func>
  <author>Sven2</author><date>2013-12</date>
</funcs>