File: ScheduleCall.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 (53 lines) | stat: -rw-r--r-- 2,107 bytes parent folder | download | duplicates (7)
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
49
50
51
52
53
<?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>ScheduleCall</title>
    <category>Script</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>object</type>
          <name>obj</name>
          <desc>Object in which to call the function. <code>nil</code> for no object context.</desc>
        </param>
        <param>
          <type>string</type>
          <name>function</name>
          <desc>Name of the function to call.</desc>
        </param>
        <param>
          <type>int</type>
          <name>delay</name>
          <desc>Delay after which the first call is made. If repeat is greather than 1, this is also the delay inbetween subsequent calls.</desc>
        </param>
        <param>
          <type>int</type>
          <name>repeat</name>
          <desc>Number of calls. If 0 or not specified, the call is made exactly once.</desc>
        </param>
        <param>
          <name>...</name>
          <desc>Additional parameters which are passed to the function called.</desc>
        </param>
      </params>
    </syntax>
    <desc>Calls a function after a specified delay.</desc>
    <remark>This function is implemented in System.ocg using the <emlink href="script/Effects.html">effect</emlink> "IntScheduleCall" in function <funclink>Call</funclink>.</remark>
    <examples>
      <example>
        <code>ScheduleCall(this, &quot;Explode&quot;, 500, 0, 50);</code>
        <text>Calls the function "Explode" in this object with a delay of 500 ticks and passes 50 as additional parameter. This will cause the object to explode with a strength of 50 after 500 frames unless the call is cancelled earlier using <funclink>ClearScheduleCall</funclink>.</text>
      </example>
    </examples>
    <related>
      <funclink>Schedule</funclink>
      <funclink>ClearScheduleCall</funclink>
    </related>
  </func>
  <author>PeterW</author><date>2005-08</date>
</funcs>