https://wiki.wesnoth.org/api.php?action=feedcontributions&user=Samwyse&feedformat=atomThe Battle for Wesnoth Wiki - User contributions [en]2024-03-29T00:02:53ZUser contributionsMediaWiki 1.31.16https://wiki.wesnoth.org/index.php?title=CampaignWML&diff=47140CampaignWML2012-09-01T12:18:24Z<p>Samwyse: changed '''extra_defines''' to use a nested definition list</p>
<hr />
<div>{{WML Tags}}<br />
<br />
<!--<br />
<br />
Dacyn and/or Invisible Philosopher -- please be careful<br />
you don't reduce the signal-to-noise ratio on the WML pages<br />
when editing! Eg. knowing that a tag is translatable is _important_<br />
for the 29 translations we have in progress. -- ott<br />
<br />
--><br />
<br />
This page describes how the campaign is displayed in the "Campaign" menu, and how it starts.<br />
<br />
==The [campaign] Tag==<br />
<br />
The following keys and tags are recognized in '''[campaign]''' tags:<br />
* '''id''': the internal campaign identifier used to classify saved games<br />
* '''icon''': the image displayed in the campaign selection menu<br />
* '''name''': (translatable) name displayed in the campaign selection menu<br />
* '''abbrev''': (translatable) abbreviation used as a prefix for savefile names made from this campaign<br />
* '''image''': the image shown in the information pane when this campaign is selected in the campaign selection menu (typically a transparent, 350×350 pixels portrait)<br />
* '''description''': (translatable) text shown in the information pane when this campaign is selected in the campaign selection menu<br />
* '''define'''='''''CAMPAIGN_SYMBOL''''' when this campaign is started, the preprocessor symbol '''''CAMPAIGN_SYMBOL''''' will be defined. See '''#ifdef''' in [[PreprocessorRef]] for how this can be used to isolate parts of the campaign file from other campaigns. Only the tags '''[campaign]''' and '''[binary_path]''' (see [[BinaryPathWML]]) should go outside of '''#ifdef ''CAMPAIGN_SYMBOL'''''. This symbol will be defined ''before'' any .cfg is preprocessed. Important note: starting with 1.7.13, [binary_path] does no longer need to be outside of the '''#ifdef ''CAMPAIGN_SYMBOL''''' block to make custom binary data available, which could easily cause overwrites. E.g. icon=data/add-ons/whatever/something.png is supposed to work. This seems to have been a bug since at least BfW 1.0 which means that practically all available examples of user made add-ons are wrong in this aspect.<br />
* '''extra_defines''': a comma(''',''') separated list of preprocessor symbols. Those symbols will be defined ''before'' any .cfg is preprocessed. Currently supported extra_defines are:<br />
<ul><br />
;ENABLE_ARMAGEDDON_DRAKE<br />
:allows the advancement ''Inferno Drake'' -> ''Armageddon Drake''<br />
;ENABLE_DWARVISH_ARCANISTER<br />
:allows the advancement ''Dwarvish Runemaster'' -> ''Dwarvish Arcanister''<br />
;ENABLE_DWARVISH_RUNESMITH<br />
:allows the advancement ''Dwarvish Fighter'' -> ''Dwarvish Runesmith''<br />
;DISABLE_GRAND_MARSHAL<br />
:disallows the advancement ''General'' -> ''Grand Marshal''<br />
;ENABLE_ANCIENT_LICH<br />
:allows the advancement ''Lich'' -> ''Ancient Lich''<br />
;ENABLE_DEATH_KNIGHT<br />
:allows the advancement ''Revenant'' -> ''Death Knight'<br />
;ENABLE_TROLL_SHAMAN {{DevFeature1.11}}<br />
:allows the advancement ''Troll Whelp'' -> ''Troll Shaman''<br />
;ENABLE_WOLF_ADVANCEMENT {{DevFeature1.11}}<br />
:allows the advancements ''Wolf'' -> ''Great Wolf'' -> ''Direwolf''<br />
</ul><br />
* '''difficulties''': a comma(''',''') separated list of preprocessor symbols, exactly one of which will be stored depending on the difficulty setting chosen when the campaign is started. The symbols '''EASY''', '''NORMAL''', and '''HARD''' are usually used, and there are several macros in utils.cfg (see [[UtilWML]]) which check for these values to set WML keys to different values depending on difficulty. If you use different difficulty symbols, you may need to define your own versions of these macros.<br />
* '''difficulty_descriptions''': the menu of difficulties; this is a list of descriptions (see [[DescriptionWML]]) that correspond to different difficulty levels. Since each description is a menu option for a difficulty level, this must provide the same number of descriptions as there are levels in the ''difficulties'' list.<br />
* '''allow_difficulty_change''': {{DevFeature1.11}} Allows difficulty switching during an ongoing campaign. Default:yes<br />
* '''first_scenario''': the ID of the first scenario in the campaign; see ''id'' in [[ScenarioWML]]<br />
* '''rank''': a number that determines the order of campaigns in the campaign selection menu. Lower ''rank'' campaigns appear earlier, with unranked campaigns at the end. Currently the mainline campaigns use multiples of 10 from 0 to 399, with 0-99 for Novice campaigns, 100-199 for Intermediate campaigns, and 200-399 for Expert campaigns; if you specify this, it should not be less than 400. (Note: This replaces an older convention that topped out at 50.)<br />
* '''[about]''': inserts your own credits into the game's list of credits. See below for syntax.<br />
* '''end_credits''': {{DevFeature1.11}} Whether to display the credits screen at the end of the campaign. Defaults to ''yes''.<br />
* '''end_text''': (translatable) Text that is shown centered in a black screen at the end of a campaign. Defaults to "The End".<br />
* '''end_text_duration''': Delay, in milliseconds, before displaying the game credits at the end of a campaign. In other words, for how much time '''end_text''' is displayed on screen. Defaults to 3500.<br />
<br />
== Campaign credits ==<br />
<br />
The campaign's name automatically is inserted at the top of the rolling credits followed by title/text key pairs. There can be any number of '''[about]''' tags inside a '''[campaign]''' tag, but none of them will display credits if there is no "id" key present inside [campaign] (see above). The '''[about]''' tag has the following keys:<br />
* '''title''': (translatable) large text used to start a new subsection (writers, artists, units, balancing) in the rolling credits<br />
* '''text''': (translatable, but you probably won't want to make it such) smaller text which is displayed before the contributor names<br />
* '''[entry]''': Contains information about a single contributor. Only the ''name'' key will be used in-game, the other three keys are for display on the [[Credits]] page ('''note:''' the values of these keys will only display on the Credits page for mainline campaigns; they will not display for UMC campaigns)<br />
** '''name''': The name of the contributor<br />
** '''comment''': Optional short note about what that person did<br />
** '''email''': Optional email address<br />
** '''wikiuser''': Optional, the user name on the wiki<br />
<br />
== See Also ==<br />
<br />
* [[PreprocessorRef]]<br />
* [[ScenarioWML]]<br />
* [[ReferenceWML]]<br />
* [[PblWML]]<br />
<br />
<br />
[[Category: WML Reference]]</div>Samwyse