File: PlayRumble.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 (45 lines) | stat: -rw-r--r-- 1,646 bytes parent folder | download | duplicates (5)
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
<?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>PlayRumble</title>
    <category>Player</category>
    <version>8.0 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>int</type>
          <name>player</name>
          <desc>Number of the player whose controller should rumble. Can be NO_OWNER to make all controllers rumble.</desc>
        </param>
        <param>
          <type>int</type>
          <name>strength</name>
          <desc>Strength of the rumble, between 0 and 1000.</desc>
        </param>
        <param>
          <type>int</type>
          <name>length</name>
          <desc>Duration of the rumble in milliseconds.</desc>
        </param>
      </params>
    </syntax>
    <desc>Plays a haptic effect on the given player's gamepad. Returns true if all parameters are valid; there is no way to know whether the rumble was actually played.</desc>
    <examples>
      <example>
<code>
<funclink>ShakeObjects</funclink>(<funclink>LandscapeWidth</funclink>()/2, <funclink>LandscapeHeight</funclink>()/2, <funclink>Distance</funclink>(<funclink>LandscapeWidth</funclink>(), <funclink>LandscapeHeight</funclink>())/2);
PlayRumble(NO_OWNER, 1000, 2000);
</code>
        <text>Earthquake: Shakes all Clonks and rumbles all controllers at full strength for two seconds.</text>
      </example>
    </examples>
    <related>
      <funclink>StopRumble</funclink>
    </related>
  </func>
  <author>Luchs</author><date>2016-02</date>
</funcs>