/docs/sdk/script/fn/Par.xml

https://bitbucket.org/randrian/openclonk2 · XML · 54 lines · 49 code · 4 blank · 1 comment · 0 complexity · a109abfd907dedbcf2e746d50892b3e9 MD5 · raw file

  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. <desc>Gibt einen der an die Funktion übergebenen Parameter zurück.</desc>
  21. <remark>Diese Funktion war in der alten (&lt; gwe4) Funktionssyntax die einzige Möglichkeit, um
  22. die Funktionsparameter abzufragen. Mit der neuen Syntax können den Parametern Namen zugewiesen
  23. werden, was in den meisten Fällen auch zu empfehlen ist (Ausnahme: siehe Beispiel)</remark>
  24. <examples>
  25. <example>
  26. <code>private Multiply3:
  27. <funclink>return</funclink>(Par() * Par(1) * Par(2));</code>
  28. <text>Definiert eine Funktion Multiply3, die ihre drei Parameter miteinander multipliziert.</text>
  29. </example>
  30. <example>
  31. <code>private func Multiply3(v1, v2, v3)
  32. {
  33. return(v1 * v2 * v3);
  34. }</code>
  35. <text>Dieselbe Funktion mit in neuer Funktionssyntax</text>
  36. <code>private func MultiplyX(cnt)
  37. {
  38. var x = 1;
  39. for(var i = 0; i &lt; cnt; i++)
  40. x *= Par(i + 1);
  41. return(x);
  42. }</code>
  43. <text>Ein Beispiel für gemischte Verwendung von benannten und unbenannten Parametern. Diese
  44. Funktion kann bis zu 9 Zahlen multiplizieren. Dabei wird jeweils die Anzahl der zu
  45. multiplizierenden Zahlen übergeben (z.B. MultiplyX(4, 10, 3, 4, 7) = 10 * 3 * 4 * 7 = 840)</text>
  46. </example>
  47. </examples>
  48. </func>
  49. <author>Sven2</author><date>August 2002</date>
  50. </funcs>