/docs/sdk/script/fn/SetPlrShowControl.xml

https://bitbucket.org/randrian/openclonk2 · XML · 57 lines · 57 code · 0 blank · 0 comment · 0 complexity · 611028a6ac75af13af8e344fec414203 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>SetPlrShowControl</title>
  7. <category>Spieler</category>
  8. <version>4.6.5.0 CP</version>
  9. <syntax>
  10. <rtype>bool</rtype>
  11. <params>
  12. <param><type>int</type><name>iPlr</name><desc>Spieler, dessen Tasten darzustellen sind.</desc></param>
  13. <param><type>string</type><name>szDefString</name><desc>Spezifikation der darzustellenden Tasten.</desc></param>
  14. </params>
  15. </syntax>
  16. <desc>Steuert die grafische Darstellung der Clonk-Steuerungstasten eines Spielers in seinem Sichtfenster.<br/><br/>
  17. Es können die folgenden Tasten angezeigt werden:
  18. <table>
  19. <rowh><col>Nummer</col><col>Bedeutung</col></rowh>
  20. <row><col>0</col><col>Cursor Rechts</col></row>
  21. <row><col>1</col><col>Cursor Umschalt</col></row>
  22. <row><col>2</col><col>Cursor Links</col></row>
  23. <row><col>3</col><col>Werfen</col></row>
  24. <row><col>4</col><col>Springen</col></row>
  25. <row><col>5</col><col>Graben</col></row>
  26. <row><col>6</col><col>Links</col></row>
  27. <row><col>7</col><col>Stopp</col></row>
  28. <row><col>8</col><col>Rechts</col></row>
  29. <row><col>9</col><col>Optionen</col></row>
  30. </table>
  31. Für jede Taste kann einzeln angegeben werden, ob und wie sie angezeigt werden soll. Dabei gibt es für jede Taste drei Optionen, die angegeben werden können:
  32. <ul>
  33. <li>Ob sie angezeigt werden soll</li>
  34. <li>Ob die Taste beschriftet sein soll</li>
  35. <li>Ob die Beschriftung blinken soll</li>
  36. </ul>
  37. Entsprechend gibt es 3 Blocks von Optionen. Jeder dieser Blocks besteht dabei aus 10 Buchstaben, wobei "_" und " " für "Nein" und jeder andere Buchstabe für "Ja" steht (siehe Beispiel).
  38. </desc>
  39. <examples>
  40. <example>
  41. <code>SetPlrShowControl(0, "____4_678_ __________");</code>
  42. <text>Zeigt für Spieler 0 die Tasten "Springen", "Links", "Stopp" und "Rechts" an. Die Nummern werden zur Verdeutlichung der angezeigten Tasten verwendet (vergleiche Tabelle). Um die Blöcke voneinander abzuheben, wird im 1. und 3. "_", im 2. dagegen " " benutzt.</text>
  43. <code>SetPlrShowControl(0, "____4_678_ 4 678 ____4_678_");</code>
  44. <text>Ergänzt die Darstellung um eine blinkende Beschriftung.</text>
  45. <code>SetPlrShowControl(0, "____4_678_ 4 678 ____4_____");</code>
  46. <text>Nur die Beschriftung der Taste "Springen" blinkt.</text>
  47. <code>SetPlrShowControl(0, "01234567890123456789__________");</code>
  48. <text>Der gesamte Steuerungsblock wird mit Beschriftung angezeigt.</text>
  49. </example>
  50. </examples>
  51. <related>
  52. <funclink>SetPlrShowControlPos</funclink>
  53. <funclink>SetPlrShowCommand</funclink>
  54. </related>
  55. </func>
  56. <author>PeterW</author><date>Juni 2003</date>
  57. </funcs>