File: DoShockwave.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (48 lines) | stat: -rw-r--r-- 1,588 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<?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>DoShockwave</title>
    <category>Objects</category>
    <version>7.0 OC</version>
    <syntax>
      <rtype>nil</rtype>
      <params>
        <param>
          <type>int</type>
          <name>x</name>
          <desc>X coordinate</desc>
        </param>
        <param>
          <type>int</type>
          <name>y</name>
          <desc>Y coordinate</desc>
        </param>
        <param>
          <type>int</type>
          <name>radius</name>
          <desc>Radius and strength of the shock wave.</desc>
        </param>
        <param>
          <type>int</type>
          <name>caused_by</name>
		  <optional />
          <desc>Number of the player who has caused the shock wave. If not specified, the the controller of the calling object is considered to have caused the damage in local calls.</desc>
        </param>
      </params>
    </syntax>
    <desc>Flings all objects at the specified position in the specified radius. Has no visual effect. The x and y coordinates are always global coordinates.</desc>
    <examples>
      <example>
        <code>DoShockwave(<funclink>GetX</funclink>(), <funclink>GetY</funclink>(), 35);</code>
        <text>The calling object causes a shock wave that extends 35 pixels.</text>
      </example>
    </examples>
    <related>
      <funclink>Explode</funclink>
    </related>
  </func>
  <author>Marky</author><date>2015-07</date>
</funcs>