File: GameCallEx.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 (40 lines) | stat: -rw-r--r-- 1,496 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
<?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>GameCallEx</title>
    <category>Script</category>
    <subcat>Function call</subcat>
    <version>5.1 OC</version>
    <syntax>
      <rtype>any</rtype>
      <params>
        <param>
          <type>string</type>
          <name>function</name>
          <desc>Name of the script function.</desc>
        </param>
        <param>
          <type>any</type>
          <name>...</name>
          <desc>Up to nine parameters which are passed to the scenario script function.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Makes a broadcast call to the scenario script, all goals, rules and environment objects. This is what the engine does when it makes a scenario callback, see <emlink href="scenario/script.html#Callbacks">scenario script callbacks</emlink>.</desc>
    <examples>
      <example>
        <code>GameCallEx(&quot;InitializePlayer&quot;,0);</code>
        <text>Causes the scenario script and all goals, rules and environment objects to re-execute intialization for the first player. This is what is done on the normal initialization of a player.</text>
      </example>
    </examples>
    <related>
      <funclink>GameCall</funclink>
      <funclink>Call</funclink>
    </related>
  </func>
  <author>Newton</author><date>2011-07</date>
</funcs>