/docs/sdk/script/fn/Message.xml
XML | 49 lines | 45 code | 4 blank | 0 comment | 0 complexity | 790497ff6f4ba041c34ef2f78ba4c466 MD5 | raw file
Possible License(s): WTFPL, 0BSD, LGPL-2.1, CC-BY-3.0
1<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
2<!DOCTYPE funcs SYSTEM "../../../clonk.dtd">
3<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
4<funcs>
5 <func>
6 <title>Message</title>
7 <category>Nachrichten</category>
8 <version>4.6.5.0 CP</version>
9 <syntax>
10 <rtype>bool</rtype>
11 <params>
12 <param>
13 <type>string</type>
14 <name>strMessage</name>
15 <desc>Nachricht, die angezeigt werden soll.</desc>
16 </param>
17 <param>
18 <type>object</type>
19 <name>pObj</name>
20 <optional/>
21 <desc>Objekt, �ber dem die Nachricht angezeigt werden soll. Wenn nicht angegeben oder 0 wird die Nachricht global angezeigt.</desc>
22 </param>
23 <param>
24 <name>...</name>
25 <optional/>
26 <desc>Zus�tzliche Formatierungsparameter</desc>
27 </param>
28 </params>
29 </syntax>
30
31 <desc>Zeigt eine Nachricht an. Diese kann nach dem C-Formatierungsstil formatiert werden (siehe <funclink>Format</funclink>)</desc>
32
33 <remark>Durch Verwendung des Zeichens "|" kann ein Zeilenvorschub erreicht werden.</remark>
34
35 <examples>
36 <example>
37 <code>Message("Hallo %s!|Ich bin dein Clonk %s!", <funclink>this</funclink>(), <funclink>GetPlayerName</funclink>(<funclink>GetOwner</funclink>()), <funclink>GetName</funclink>());</code>
38 <text>
39 Wird dieser Script in einem Clonk ausgef�hrt, so erscheint �ber seinem Kopf der entsprechende Text (z.B. "Hallo Twonky! Ich bin dein Clonk Yoki!")
40 </text>
41 </example>
42 </examples>
43
44 <related>
45 <funclink>Log</funclink><funclink>PlayerMessage</funclink><funclink>PlrMessage</funclink><funclink>CustomMessage</funclink>
46 </related>
47 </func>
48 <author>PeterW</author><date>Dezember 2001</date>
49</funcs>