Info.xml - Revision history

Scratch: /* Includes */

2017-07-27T09:51:10Z

‎Includes

Scratch: /* Modifiers */

2017-07-03T12:45:22Z

‎Modifiers

Scratch: /* Tags */

2017-07-03T12:34:55Z

‎Tags

Scratch at 15:08, 20 June 2017

2017-06-20T15:08:26Z

Scratch: /* Tags */

2017-06-20T15:07:38Z

‎Tags

Scratch at 15:07, 20 June 2017

2017-06-20T15:07:28Z

Scratch at 15:03, 20 June 2017

2017-06-20T15:03:18Z

Scratch at 11:39, 20 June 2017

2017-06-20T11:39:33Z

Scratch at 11:39, 20 June 2017

2017-06-20T11:39:02Z

Scratch: Created page with "This XML file describes a scenario. All tags listed below must be within an block. == Tags == * `name` The name of the scenario that wil..."

2017-06-20T11:38:42Z

Created page with "This XML file describes a scenario. All tags listed below must be within an <code><info></info></code> block. == Tags == * <code>name</code> The name of the scenario that wil..."

New page

This XML file describes a scenario. All tags listed below must be within an <code><info></info></code> block.

== Tags ==
* <code>name</code> The name of the scenario that will show up in the scenario list.
* <code>description</code> The full description of the scenario that will show up when selecting the scenario in the scenario list.
* <code>tag</code> A short tagline description of the scenario, which is shown above the description.
* <code>multiplayer</code> Whether the scenario is multiplayer-only or not. Either <code>true</code> or <code>false</code>. (Default: <code>false</code>)
* <code>saving</code> The save mode to use. Either <code>none</code> where there are no saves at all, <code>current</code> where the current level is saved, or <code>all</code> which is like Hammerwatch, where you can go back to older levels without their progress getting reset. (Default: <code>current</code>)
* <code>players</code> <code>min="X" max="X"</code> The amount of players allowed to play in multiplayer. (Default: unlimited)
* <code>modifiers</code>
* <code>modifier</code> <code>forced="X" id="X" name="X" tooltip="X" locked-by="X" default-on="X" radio="X" multiplayer="X"</code>
* <code>separator</code> <code>multiplayer="X"</code>
* <code>header</code> <code>text="X" tooltip="X" multiplayer="X"</code>
* <code>start</code>
* <code>level</code>
* <code>classmaps</code>
* <code>behavior</code> <code>from="X" to="X"</code>
* <code>script</code> <code>from="X" to="X"</code>
* <code>gamemode</code> <code>from="X" to="X"</code>
* <code>disable-include</code>
* <code>includes</code>
* <code>include</code> <code>modifiers="X" levels="X" classmaps="X" final="X"</code>

== Example ==
Below is the info.xml file for the Payload gamemode on the Workshop:

<pre>
<info>
<name>Payload</name>
<description>Bring the payload to the other side.</description>
<multiplayer>true</multiplayer>

<players min="2" max="12" />

<start>
<level name="Over the Mountain" lvl="levels/payload01.lvl" />
<level name="That belongs in a Museum" lvl="levels/payload02.lvl" />
</start>

<modifiers>
<modifier forced="true" id="VERSUS" />
<modifier forced="true" id="PICKUP_RESPAWN" />
</modifiers>
</info>
</pre>

@@ Line 41: / Line 41: @@
 === Includes ===
 * <code>includes</code> A collection of scenarios that this scenario includes.
-** <code>include</code> <code>modifiers="X" levels="X" classmaps="X" final="X"</code> An included scenario.
+** <code>include</code> <code>name="X" modifiers="X" levels="X" classmaps="X" final="X"</code> An included scenario.
 *** The <code>modifiers</code> attribute defines whether to include any modifiers from this scenario. (Default: <code>false</code>)
 *** The <code>levels</code> attribute defines whether to include any start levels from this scenario. (Default: <code>false</code>)

@@ Line 14: / Line 14: @@
 === Modifiers ===
 * <code>modifiers</code> A collection of switches for the scenario.
 ** <code>modifier</code> <code>forced="X" id="X" name="X" tooltip="X" locked-by="X" default-on="X" radio="X" multiplayer="X"</code> A modifier.

@@ Line 2: / Line 2: @@
 == Tags ==
 * '''Required''' <code>name</code> The name of the scenario that will show up in the scenario list.
 * '''Required''' <code>description</code> The full description of the scenario that will show up when selecting the scenario in the scenario list.
 * <code>tag</code> A short tagline description of the scenario, which is shown above the description.
 * <code>multiplayer</code> Whether the scenario is multiplayer-only or not. Either <code>true</code> or <code>false</code>. (Default: <code>false</code>)
 * <code>saving</code> The save mode to use. Either <code>none</code> where there are no saves at all, <code>current</code> where the current level is saved, or <code>all</code> which is like Hammerwatch, where you can go back to older levels without their progress getting reset. (Default: <code>current</code>)
 * <code>players</code> <code>min="X" max="X"</code> The amount of players allowed to play in multiplayer. (Default: unlimited)
 * <code>modifiers</code> A collection of switches for the scenario.
 ** <code>modifier</code> <code>forced="X" id="X" name="X" tooltip="X" locked-by="X" default-on="X" radio="X" multiplayer="X"</code> A modifier.
@@ Line 20: / Line 26: @@
 ** <code>separator</code> <code>multiplayer="X"</code> A separator line for the switch menu. The <code>multiplayer</code> attribute is the same as for the <code>modifier</code> tag.
 ** <code>header</code> <code>text="X" tooltip="X" multiplayer="X"</code> A header text for the switch menu. The <code>multiplayer</code> attribute is the same as for the <code>modifier</code> tag.
 * <code>start</code> A collection of levels that the player will be able to start from.
 ** <code>level</code> <code>name="X" lvl="X"</code> A level that the player will be able to start from. The <code>name</code> attribute is the name displayed in the list of levels, and the <code>lvl</code> attribute is the filename to the level.
 * <code>classmaps</code> A collection of script classes to rewrite to other class names. See [[Rewriting Classes]] for detailed information.
 ** <code>behavior</code> <code>from="X" to="X"</code> Overwrites a unit's behavior class.
 ** <code>script</code> <code>from="X" to="X"</code> Overwrites a class created in-script with <code>InstantiateClass()</code>.
 ** <code>gamemode</code> <code>from="X" to="X"</code> Overwrites a level's gamemode class.
-* <code>disable-include</code> Set this to <code>true</code> to disallow this scenario from getting included by other scenarios. (Default: <code>false</code>)
 * <code>includes</code> A collection of scenarios that this scenario includes.
 ** <code>include</code> <code>modifiers="X" levels="X" classmaps="X" final="X"</code> An included scenario.
@@ Line 33: / Line 44: @@
 *** The <code>classmaps</code> attribute defines whether to include any class map rewrites from this scenario. (Default: <code>false</code>)
 *** The <code>final</code> attribute defines whether inclusion shouldn't go any deeper than the one you're including. This means that any included scenarios in the scenario you're including will not be included if this is true. (Default: <code>false</code>)
 == Example ==

@@ Line 32: / Line 32: @@
 *** The <code>levels</code> attribute defines whether to include any start levels from this scenario. (Default: <code>false</code>)
 *** The <code>classmaps</code> attribute defines whether to include any class map rewrites from this scenario. (Default: <code>false</code>)
-*** the <code>final</code> attribute defines whether inclusion shouldn't go any deeper than the one you're including. This means that any included scenarios in the scenario you're including will not be included if this is true. (Default: <code>false</code>)
+*** The <code>final</code> attribute defines whether inclusion shouldn't go any deeper than the one you're including. This means that any included scenarios in the scenario you're including will not be included if this is true. (Default: <code>false</code>)
 == Example ==

@@ Line 22: / Line 22: @@
 * <code>start</code> A collection of levels that the player will be able to start from.
 ** <code>level</code> <code>name="X" lvl="X"</code> A level that the player will be able to start from. The <code>name</code> attribute is the name displayed in the list of levels, and the <code>lvl</code> attribute is the filename to the level.
-* <code>classmaps</code>
+* <code>classmaps</code> A collection of script classes to rewrite to other class names. See [[Rewriting Classes]] for detailed information.
-** <code>behavior</code> <code>from="X" to="X"</code>
+** <code>behavior</code> <code>from="X" to="X"</code> Overwrites a unit's behavior class.
-** <code>script</code> <code>from="X" to="X"</code>
+** <code>script</code> <code>from="X" to="X"</code> Overwrites a class created in-script with <code>InstantiateClass()</code>.
-** <code>gamemode</code> <code>from="X" to="X"</code>
+** <code>gamemode</code> <code>from="X" to="X"</code> Overwrites a level's gamemode class.
-* <code>disable-include</code>
+* <code>disable-include</code> Set this to <code>true</code> to disallow this scenario from getting included by other scenarios. (Default: <code>false</code>)
-* <code>includes</code>
+* <code>includes</code> A collection of scenarios that this scenario includes.
-** <code>include</code> <code>modifiers="X" levels="X" classmaps="X" final="X"</code>
+** <code>include</code> <code>modifiers="X" levels="X" classmaps="X" final="X"</code> An included scenario.
 == Example ==

Info.xml - Revision history

Scratch: /* Includes */

Scratch: /* Modifiers */

Scratch: /* Tags */

Scratch at 15:08, 20 June 2017

Scratch: /* Tags */

Scratch at 15:07, 20 June 2017

Scratch at 15:03, 20 June 2017

Scratch at 11:39, 20 June 2017

Scratch at 11:39, 20 June 2017

Scratch: Created page with "This XML file describes a scenario. All tags listed below must be within an block. == Tags == * name The name of the scenario that wil..."

Scratch: Created page with "This XML file describes a scenario. All tags listed below must be within an block. == Tags == * `name` The name of the scenario that wil..."