forked from Mirrors/openclonk
46 lines
1.5 KiB
XML
46 lines
1.5 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>PlayerMessage</title>
|
|
<category>Messages</category>
|
|
<version>5.1 OC</version>
|
|
<syntax>
|
|
<rtype>bool</rtype>
|
|
<params>
|
|
<param>
|
|
<type>int</type>
|
|
<name>player</name>
|
|
<desc>Number of the player for whom to display the message.</desc>
|
|
</param>
|
|
<param>
|
|
<type>string</type>
|
|
<name>message</name>
|
|
<desc>Message to be displayed</desc>
|
|
</param>
|
|
<param>
|
|
<type/>
|
|
<name>...</name>
|
|
<desc>Additional message formatting parameters. Also see <funclink>Format</funclink>.</desc>
|
|
<optional />
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Displays a message in the viewport of the specified player. Message formatting is done accoring to <funclink>Message</funclink>.</desc>
|
|
<examples>
|
|
<example>
|
|
<code>var cursor=<funclink>GetCursor</funclink>(0);
|
|
cursor->PlayerMessage(0, "Hello, I am %s!", <funclink>GetName</funclink>(cursor));</code>
|
|
<text>Tells the name of the selected clonk to the owner of the clonk only.</text>
|
|
</example>
|
|
</examples>
|
|
<related>
|
|
<funclink>Message</funclink>
|
|
<funclink>CustomMessage</funclink>
|
|
</related>
|
|
</func>
|
|
<author>Sven2</author><date>2002-08</date>
|
|
</funcs>
|