forked from Mirrors/openclonk
55 lines
1.9 KiB
XML
55 lines
1.9 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>SetLightRange</title>
|
|
<category>Objects</category>
|
|
<version>6.0 OC</version>
|
|
<syntax>
|
|
<rtype>void</rtype>
|
|
<params>
|
|
<param>
|
|
<type>int</type>
|
|
<name>range</name>
|
|
<desc>Light reach in pixels. In this range, the light has 100% intensity.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>fadeout</name>
|
|
<desc>Light fadeout reach in pixels. Default is 80. If the range is set to 0 and this parameter is not defined, the fadeout will also be 0.</desc>
|
|
<optional />
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Sets the light reach of the object. When a clonk is added to the crew via <funclink>MakeCrewMember</funclink>, a light is added automatically with the default range of 300 and a fadeout of 80.</desc>
|
|
<remark>A local offset for the light center can be defined by setting the object property LightOffset to an array with two elements for X- and Y-offset respectively.</remark>
|
|
<examples>
|
|
<example>
|
|
<code>func ControlUse(object clonk)
|
|
{
|
|
clonk->SetLightRange(0);
|
|
<funclink>Sound</funclink>("Scream");
|
|
return true;
|
|
}</code>
|
|
<text>Confused the acid phile with the eye drops, did ya?</text>
|
|
</example>
|
|
<example>
|
|
<code>func Construction()
|
|
{
|
|
SetLightRange(100, 100);
|
|
this.LightOffset = [0,-100];
|
|
return true;
|
|
}</code>
|
|
<text>Script for a lamp post. A light coming from 100 pixel above the object center is enabled when the object is created.</text>
|
|
</example>
|
|
</examples>
|
|
<related>
|
|
<funclink>SetPlrView</funclink>
|
|
<funclink>SetFoW</funclink>
|
|
<funclink>SetLightColor</funclink>
|
|
</related>
|
|
</func>
|
|
</funcs>
|