File: SetLightColor.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 (37 lines) | stat: -rw-r--r-- 1,557 bytes parent folder | download | duplicates (6)
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
<?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>SetLightColor</title>
    <category>Objects</category>
    <version>7.0 OC</version>
    <syntax>
      <rtype>void</rtype>
      <params>
        <param>
          <type>int</type>
          <name>color</name>
          <desc>New color for the light. The color value (V in HSV notation of the color) determines the intensity of the light. A light color of <code><funclink>RGB</funclink>(128, 0, 0)</code> has a value/intensity of 50%. This means that it will be weaker than a light with<code><funclink>RGB</funclink>(255, 0, 0)</code>, but it will cover the same area as that light.</desc>
        </param>
      </params>
    </syntax>
    <desc>Sets the color of the light that is emitted from this object. By default the object emits white light, if it has a light range. See <funclink>SetLightRange</funclink> for further details.</desc>
    <examples>
      <example>
		<code>
		var candle_shine=<funclink>CreateObject</funclink>(EnvPack_Candle_Shine);
	  	candle_shine-&gt;<funclink>SetLightRange</funclink>(30, 20);
		candle_shine-&gt;SetLightColor(RGB(255,163,58));
        </code>
        <text>Gives a warm shine to a candle shine object.</text>
      </example>
    </examples>
    <related>
      <funclink>GetLightColor</funclink>
      <funclink>SetLightRange</funclink>
    </related>
  </func>
  <author>Marky</author><date>2015-06</date>
</funcs>