openclonk/docs/sdk/script/fn/Bubble.xml

39 lines
1.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>Bubble</title>
<category>Environment</category>
<subcat>Effects</subcat>
<version>1.0 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>x</name>
<desc>X position of the bubble. Offset in local calls.</desc>
<optional />
</param>
<param>
<type>int</type>
<name>y</name>
<desc>Y position of the bubble. Offset in local calls.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Creates a bubble.</desc>
<remark>The maximum number of bubbles simultaneously present in a game depends on the smoke level configuration. In network games, this value is forced to 150.</remark>
<examples>
<example>
<code>Bubble();</code>
<text>Creates a bubble at the calling object.</text>
</example>
</examples>
</func>
<author>Sven2</author><date>2001-11</date>
</funcs>