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

36 lines
1.1 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>SetController</title>
<category>Objects</category>
<subcat>Status</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>player</name>
<desc>Player number of the new controller. <code>NO_OWNER</code> for no controller.</desc>
</param>
</params>
</syntax>
<desc>Changes the controller of the calling object.</desc>
<examples>
<example>
<code>protected func Entrance(object container) { SetController(container-&gt;<funclink>GetController</funclink>()); }</code>
<text>This object changes its controller when it is collected.</text>
</example>
</examples>
<related>
<funclink>GetController</funclink>
<funclink>GetKiller</funclink>
<funclink>SetOwner</funclink>
</related>
</func>
<author>Sven2</author><date>2007-04</date>
</funcs>