File: PlayerMessage.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 (45 lines) | stat: -rw-r--r-- 1,506 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
45
<?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-&gt;PlayerMessage(0, &quot;Hello, I am %s!&quot;, <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>