/docs/sdk/script/fn/Par.xml
XML | 54 lines | 49 code | 4 blank | 1 comment | 0 complexity | a109abfd907dedbcf2e746d50892b3e9 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>Par</title>
7 <category>Script</category>
8 <version>4.6.5.0 CP</version>
9 <!-- <deprecated /> Ich denke nicht (peter) -->
10 <syntax>
11 <rtype>any</rtype>
12 <params>
13 <param>
14 <type>int</type>
15 <name>iIndex</name>
16 <desc>0-9: Index des abzufragenden Parameters</desc>
17 </param>
18 </params>
19 </syntax>
20
21 <desc>Gibt einen der an die Funktion �bergebenen Parameter zur�ck.</desc>
22
23 <remark>Diese Funktion war in der alten (< gwe4) Funktionssyntax die einzige M�glichkeit, um
24 die Funktionsparameter abzufragen. Mit der neuen Syntax k�nnen den Parametern Namen zugewiesen
25 werden, was in den meisten F�llen auch zu empfehlen ist (Ausnahme: siehe Beispiel)</remark>
26
27 <examples>
28 <example>
29 <code>private Multiply3:
30 <funclink>return</funclink>(Par() * Par(1) * Par(2));</code>
31 <text>Definiert eine Funktion Multiply3, die ihre drei Parameter miteinander multipliziert.</text>
32 </example>
33 <example>
34 <code>private func Multiply3(v1, v2, v3)
35{
36 return(v1 * v2 * v3);
37}</code>
38 <text>Dieselbe Funktion mit in neuer Funktionssyntax</text>
39 <code>private func MultiplyX(cnt)
40{
41 var x = 1;
42 for(var i = 0; i < cnt; i++)
43 x *= Par(i + 1);
44 return(x);
45}</code>
46 <text>Ein Beispiel f�r gemischte Verwendung von benannten und unbenannten Parametern. Diese
47 Funktion kann bis zu 9 Zahlen multiplizieren. Dabei wird jeweils die Anzahl der zu
48 multiplizierenden Zahlen �bergeben (z.B. MultiplyX(4, 10, 3, 4, 7) = 10 * 3 * 4 * 7 = 840)</text>
49 </example>
50 </examples>
51
52 </func>
53 <author>Sven2</author><date>August 2002</date>
54</funcs>