File: SaveScenarioObjectAction.xml

package info (click to toggle)
openclonk 8.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 169,656 kB
  • sloc: cpp: 180,484; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 148; sh: 101; javascript: 34
file content (37 lines) | stat: -rw-r--r-- 1,223 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
<?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>SaveScenarioObjectAction</title>
    <category>System</category>
    <version>5.3 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>proplist</type>
          <name>props</name>
          <desc>Handle to proplist for storage of this object.</desc>
        </param>
      </params>
    </syntax>
    <desc>Stores object action and phase for Objects.c scenario saving (See <emlink href="definition/script.html#ScenSave">Scenario objects saving</emlink>).</desc>
    <examples>
      <example>
        <code>func SaveScenarioObject(props)
{
	if (!inherited(props, ...)) return false;
	if (!ActIdle())SaveScenarioObjectAction(props);
	return false;
}</code>
        <text>In addition to default properties, this object also saved its current action unless it is idle.</text>
      </example>
    </examples>
    <related>
      <emlink href="definition/script.html#ScenSave">Scenario objects saving</emlink>
    </related>
  </func>
  <author>Sven2</author><date>2013-12</date>
</funcs>