/docs/sdk/script/fn/ExtractLiquid.xml

https://bitbucket.org/randrian/openclonk2 · XML · 33 lines · 32 code · 1 blank · 0 comment · 0 complexity · a943367ac4b94e13703490fd4fc2da70 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>ExtractLiquid</title>
  7. <category>Landschaft</category>
  8. <subcat>Material</subcat>
  9. <version>4.6.5.0 CP</version>
  10. <syntax>
  11. <rtype>int</rtype>
  12. <params>
  13. <param><type>int</type><name>iX</name><desc>X-Position, an der abgesogen wird. Bei lokalem Aufruf Offset zum aufrufenden Objekt.</desc><optional /></param>
  14. <param><type>int</type><name>iY</name><desc>Y-Position, an der abgesogen wird. Bei lokalem Aufruf Offset zum aufrufenden Objekt.</desc><optional /></param>
  15. </params>
  16. </syntax>
  17. <desc>Saugt ein Pixel Flüssigkeit an der angegebenen Position ab. Zurückgegeben wird die Materialnummer des abgesogenen Materials; bei Misserfolg -1.</desc>
  18. <examples>
  19. <example>
  20. <code>var mat=ExtractLiquid();
  21. if (mat!=-1) <funclink>InsertMaterial</funclink>(mat,0,-100)</code>
  22. <text>Saugt ein Flüssigkeitspixel ab, und fügt es 100 Pixel oberhalb wieder ein.</text>
  23. </example>
  24. </examples>
  25. <related>
  26. <funclink>ExtractMaterialAmount</funclink>
  27. <funclink>InsertMaterial</funclink>
  28. <funclink>GBackLiquid</funclink>
  29. </related>
  30. </func>
  31. <author>Sven2</author><date>November 2001</date>
  32. </funcs>