/docs/sdk/script/fn/GetActMapVal.xml

https://bitbucket.org/randrian/openclonk2 · XML · 59 lines · 54 code · 5 blank · 0 comment · 0 complexity · e68ae6ada0fdfc07f69f883417e0e5a6 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>GetActMapVal</title>
  7. <category>Get*Val</category>
  8. <version>4.9.1.0 GWE</version>
  9. <syntax>
  10. <rtype>any</rtype>
  11. <params>
  12. <param>
  13. <type>string</type>
  14. <name>strEntry</name>
  15. <desc>Name des abzufragenden Eintrags</desc>
  16. </param>
  17. <param>
  18. <type>string</type>
  19. <name>strAction</name>
  20. <desc>Name der Aktion, von der der Eintrag abgefragt werden soll</desc>
  21. <optional/>
  22. </param>
  23. <param>
  24. <type>id</type>
  25. <name>idDef</name>
  26. <desc>Objektdefinition, von der die Aktionsdaten abgefragt werden sollen. Bei Übergabe von 0 wird die Definition des aufrufenden Objekts angenommen.</desc>
  27. <optional/>
  28. </param>
  29. <param>
  30. <type>int</type>
  31. <name>iEntryNr</name>
  32. <desc>Nummer des abzufragenden Wertes, wenn der Eintrag mehrere Werte enthält.</desc>
  33. <optional/>
  34. </param>
  35. </params>
  36. </syntax>
  37. <desc>Fragt Aktionsdaten aus der <emlink href="definition/actmap.html">ActMap.txt</emlink> anhand deren dortigem Namen ab.</desc>
  38. <examples>
  39. <example>
  40. <code>var iActLength = GetActMapVal("Length", <funclink>GetAction</funclink>()) * GetActMapVal("Delay", <funclink>GetAction</funclink>());</code>
  41. <text>Berechnet die Länge in Ticks, die die aktuelle Action dauert</text>
  42. </example>
  43. </examples>
  44. <related>
  45. <funclink>GetDefCoreVal</funclink>
  46. <funclink>GetObjectVal</funclink>
  47. <funclink>GetObjectInfoCoreVal</funclink>
  48. <funclink>GetScenarioVal</funclink>
  49. <funclink>GetPlayerVal</funclink>
  50. <funclink>GetPlayerInfoCoreVal</funclink>
  51. </related>
  52. </func>
  53. <author>PeterW</author><date>April 2002</date>
  54. </funcs>