File: SetSky.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 (36 lines) | stat: -rw-r--r-- 1,172 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
<?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>SetSky</title>
    <category>Sky</category>
    <version>8.0 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>string</type>
          <name>sky</name>
          <desc>Name of the new sky from Graphics.ocg or the scenario, without filename extension.</desc>
        </param>
      </params>
    </syntax>
    <desc>Changes the current sky graphics.</desc>
    <remark>
      Changing the sky with this function will not persist in savegames. Consider using the <code>Sky</code> entry in Scenario.txt instead, possibly combined with scenario sections.
    </remark>
    <examples>
      <example>
        <code>SetSky("Default");</code>
        <text>Changes to the default sky.</text>
      </example>
    </examples>
    <related>
      <emlink href="scenario/scenario.html">Scenario.txt Documentation</emlink>
      <funclink>SetSkyAdjust</funclink>
    </related>
  </func>
  <author>Luchs</author><date>2016-10</date>
</funcs>