Modding events
From AACWWiki
Contents |
Event structure
StartEvent Conditions 0 or more conditions Actions SelectFaction SelectRegion (not required) 0 or more actions EndEvent
|
Syntax StartEvent = Name|Occurences|DisplayType|EventText|EventPic|Region|Sound Description Starts the instruction block for an event. The instruction block is always terminated by the keyword EndEvent Example StartEvent = evt_nam_USA_ReinforceSumter1861|1|2|evt_txt_USA_ReinforceSumter1861 (Note that it is broken over two lines for displaying here; in use, it should be on a single line) |
Parameters
String; the event name, also the alias for a localized string in the string file
Integer; How often the event can occur (from 0 to 999)
Integer [0, 1, 2]; Mute, line-event, Full-event
String; Alias for the event text in the string file or NULL
Filename for the event picture within the "ACW\Graphics\Events"-directory (full events) or NULL
Alias for the region where the event occurs or NULL. Use NULL if you do a conditional region selection in the event.
String: ID for the sound-file, as per the mapping in "ACW\Sounds\Sounds.ini" or NULL | ||
Conditions
This are criteria that are checked to see if an event should be triggered. Usually, all conditions listed for an event need to be fulfilled for the event to trigger.
Note: The date parameters use ISO ("European") notation. Make sure to get the components' order correct.
|
Syntax CountUnits = area alias; region or area; faction; unit type; operator; number of units Description This condition is fulfilled if the specified number of units belonging to the specified faction exist in the specified area. Example CountUnits = $Close_to_Richmond;1;$USA;-1;>=;10 This condition will be fulfilled if the USA has 10 units (any type) in the Close_to_Richmond area. |
Parameters
String; alias of a region or area
0 or 1; 0 for region, 1 for area
String; alias of a faction
Integer; -1 for any type $Regular = 0 $Irregular = 1 $Militia = 2 $Cavalry = 3 $Artillery = 4 $Arty = 4 $SupplyType = 5 $Ship = 6
<,<=,>,>=,=
Integer; the number of units that will fulfil the condition | ||
|
Syntax EvalConscript = Operator; Target Description This condition will compare the selected faction's manpower to either a given value, or to the manpower of a given faction. Which values that will cause this condition to be considered fulfilled depends on the operator used. Example EvalConscript = <;200 will trigger if the selected faction's manpower is less than 200. |
Parameters
One of [<,>,<=,>=,DICE]
This can either be a numerical value (integer) or it can be a faction tag | ||
|
Syntax EvalEvent = EventName; Condition; NumOccurs Description A logical test will carried out to compare the occurrences of an event with a given number. The event which contains the EvalEvent condition will only trigger if the condition is true. Example EvalEvent = evt_nam_CSA_EnglishTimer;>=;4 Condition is fulfilled if the event "evt_nam_CSA_EnglishTimer" has occured 4 or more times. |
Parameters
String; Name of the event to test.
String; [=,>,<=]
Number of occurrences of the named event. | ||
|
Syntax EvalMoney = Operator; Target Description This condition will compare the selected faction's amount of money to either a given value, or to how much money a given faction has. Which values that will cause this condition to be considered fulfilled depends on the operator used. Example EvalMoney = >=;400 will trigger if the selected faction's amount of money is larger than 400. |
Parameters
One of [<,>,<=,>=,DICE]
This can either be a numerical value (integer) or it can be a faction tag. | ||
|
Syntax EvalMorale = Operator; Target Description This condition will compare the selected faction's national morale to either a given value, or to the morale of a given faction. Which values that will cause this condition to be considered fulfilled depends on the operator used. Example EvalMorale = <=;80 will trigger if the selected faction's morale is less than or equal to 80. EvalMorale = >;USA will trigger if the selected faction's morale is greater than USA's is. |
Parameters
One of [<,>,<=,>=,DICE]
This can either be a numerical value (integer) or it can be a faction tag (Note: Factions don't need to be aliased with $). | ||
|
Syntax EvalUnqUnit = Name; [FixValue]; [NOT] Description Tests if a given unit is present in the game and if it is fixed. NOT reverses the result. Example EvalUnqUnit = Stonewall Bde;NOT This condition will be considered fulfilled if the unit identified as "Stonewall Bde" is not in the game. |
Parameters
String; Name of the unit. (From 'SetName' keyword)
String; [Fixed, Unfixed]
String ['NOT']; logical NOT | ||
|
Syntax EvalVP = Operator; Target Description This condition will compare the selected faction's number of victory points (VP) to either a given value, or to the victory points of a given faction. Which values that will cause this condition to be considered fulfilled depends on the operator used. Example EvalVP = <;500 will trigger if the selected faction's number of victory points is less than 500. |
Parameters
One of [<,>,<=,>=,DICE]
This can either be a numerical value (integer) or it can be a faction tag. | ||
|
Syntax EvalWSU = Operator; Target Description This condition will compare the selected faction's pool of war supplies (WSU) to either a given value, or to the war supply of a given faction. Which values that will cause this condition to be considered fulfilled depends on the operator used. Example EvalWSU = >;80 will trigger if the selected faction's pool of war supplies is higher than 80. |
Parameters
One of [<,>,<=,>=,DICE]
This can either be a numerical value (integer) or it can be a faction tag | ||
|
Syntax FixedDate = YYYY/MM/DD Description Specific chronological date to determine if event conditions are met. If the (other) conditions are fulfilled on this date, and this date only, the event will trigger Example FixedDate = 1861/05/16 Event conditions will be checked on May 16th 1861. |
Parameters
Integer; Year
Integer; Month
Integer; Day | ||
|
Syntax Probability = Value Description Sets the probability that the event fire. Example Probability = 75 In this case, any given time the event conditions are checked, there will be a 75% chance that this one is considered to be fulfilled. |
Parameters
Integer; [0..100]; Probability in percent | ||
|
Syntax MaxDate = YYYY/MM/DD Description This condition is fulfilled on any date up to and including the one specified (less than or equal to). Example MaxDate = 1863/12/31 This condition will be on any date up to and including December 31st 1863 |
Parameters
Integer; Year
Integer; Month
Integer; Day | ||
|
Syntax MinDate = YYYY/MM/DD Description This condition is fulfilled if the actual date is this date or later (greater than or equal to). Example MinDate = 1864/10/01 This condition will be fulfilled on October 1st 1864, and on any date thereafter. |
Parameters
Integer; Year
Integer; Month
Integer; Day | ||
Actions
|
Syntax AddHarborBlockaded = RegionAlias1;Value1;RegionAlias2;Value2;... Description Sets the impact of single blockaded harbors (brown water blockade) for the overall blockade percentage.
|
Parameters
String; Region alias (region must contain a harbor)
| ||
|
Syntax AddToRegList = Region1; Region2; Region3 ... Description Creates a list of regions from which one can be picked by PickFromRegList. NOTE: Under some circumstances, the list is ADDED to an already selected Region or list of Regions. Example AddToRegList = $Iberville, LA;$Mobile, AL;$Galveston, TX;$Jamaica;$Cuba;$West Indies;$Plaquemine, LA |
Parameters
Region alias
... and another province...
.. and another | ||
|
Syntax Alliance = Value Description Unknown; might be assigning a faction to an alliance, or an alliance ID to a faction? (Seems to be used in scenario setups.)
|
Parameters
| ||
|
Syntax AutoRaiseON = Value Description Activates the levy of militias/partisans. Example AutoRaiseON = 1 Levy activated! |
Parameters
| ||
|
Syntax ChangeAssetsProd = Supply; Ammo; Power; Money; WSU; Conscripts Description Changes the various resources' production rate per turn for a selected region. Example ChangeAssetsProd = 0;0;0;0;10;0 will add 10 to the production of war supplies in the given region ChangeAssetsProd = 0;-10;0;0;0;0 will reduce the ammo production in the given region by 10 |
Parameters
Integer; Production rate of general supply
Integer; Production rate of ammunition
Integer; Production rate of coal/fuel units, not used for now.
Integer; Production rate of money
Integer; Production rate of war supplies
Integer; Production rate of conscripts | ||
|
Syntax ChangeConscriptPool = Value Description Changes the number of conscripts by the given number. Example ChangeConscriptPool = 750 will add 750 to your conscript pool. |
Parameters
Integer | ||
|
Syntax ChangeFacMorale = Value Description Changes the National Morale of the faction by the given number. Example ChangeFacMorale = -2 Subtract 2 from the selected faction's NM. |
Parameters
Integer; Value by which you want to adjust National Morale. | ||
|
Syntax ChangeFixing = Value Description Sets a new fixation value for a selected unit. Example ChangeFixing = 3 Select unit will be fixed for 3 turns. |
Parameters
Integer; [0..999]; Number of turns a unit is fixed. 999 = forever | ||
|
Syntax ChangeLoyaltyFac = [Area]; Value Description Changes the loyalty in the selected region (if no area given) or area for the selected faction. Example ChangeLoyaltyFac = 10 Increases loyalty in the selected region by 10%. ChangeLoyaltyFac = $Northern_Texas;-50 Reduces the loyalty in all regions in the area "Northern Texas" by 50%. |
Parameters
String; Alias of an area
Integer; Value in percent for the loyalty change | ||
|
Syntax ChangeMoneyPool = Value Description Changes the amount of money by the given number. Example ChangeMoneyPool = 220 Add 220,000 dollars to the selected faction's money |
Parameters
Integer; value by which to modify the money pool | ||
|
Syntax ChangePriceInc = Value Description Changes the inflation rate in percent. Example ChangePriceInc = 15 Increase the selected faction's inflation rate with 15 (percent) |
Parameters
Integer; Value by which you want to modify the inflation rate | ||
|
Syntax ChangeRailPool = Value Description Changes the rail transport capacity by the given number. Example ChangeRailPool = 15 Add 15 to the selected faction's rail pool. |
Parameters
Integer; Amount to modify rail pool with. | ||
|
Syntax ChangeRiverPool = Value Description Changes the river transport capacity by the given number. Example ChangeRiverPool = -2 Subtract 2 from the selected faction's river transport capacity. |
Parameters
Integer; Value by which you want to modify the river transport capacity. | ||
|
Syntax ChangeVPCount = Value Description Changes the number of Victory Points for the selected faction by the given number. Example ChangeVPCount = 275 adds 275 to the selected faction's VP total. |
Parameters
Integer; Amount by which to adjust the VP count | ||
|
Syntax ChangeWSUPool = Value Description Changes the number of war supplies by the given number. Example ChangeWSUPool = 30 Add 30 to the selected faction's pool of war supplies. |
Parameters
Integer; Value by which to modify the war supply pool. | ||
|
Syntax ChgEvtOccurs = EventName; OccParam; Value Description Changes the allowed occurences of a given event or changes the counter how often the event already occured. Example ChgEvtOccurs = evt_nam_CSA_ChapmanPlot1863Succeeds;CuOccurs;2 This sets the count for the event evt_nam_CSA_ChapmanPlot1863Succeeds to two occurrences. ChgEvtOccurs = evt_nam_CSA_FranceDeclaresWar;MaxOccurs;1 This sets that the event evt_nam_CSA_FranceDeclaresWar can occur a total of one time. |
Parameters
String; Name (alias) of the event
String; [MaxOccurs, CuOccurs];
Integer; [-999, 0+] | ||
|
Syntax CreateFaction = Faction Description Adds the faction to the setup. Example CreateFaction = $USA Brings the faction aliased as "$USA" into play |
Parameters
String, FactionTag of the faction. | ||
|
Syntax CreateGroup
Posture = PostureAlias
SetKind = KindAlias
Entranch = EntrenchLevel
InCS = CSStatus
FixType = FixValue
SetName = GroupName
Apply
Description Creates a new stack of units. The CreateGroup command block is followed by one or more CreateUnit command blocks which add units to the new stack. Example CreateGroup
Posture = $Defensive
SetKind = $Land
Entranch = 4
InCS = 1
FixType = 999
SetName = Ft Sumter Garrison
Apply
Create a land stack called Ft Sumter Garrison, defensive posture, inside the structure in the region, level 4 trenches and fixed permanently. CreateGroup
Posture = $Defensive
SetKind = $Nav
Entranch = 0
FixType = 0
SetName = Florie
Apply
Create a naval group called Florie, defensive posture. Not entrenched, not inside any structure (both these have little meaning for naval stacks) and unfixed. |
Parameters
String; Alias of the current posture. One of $Passive, $Defensive or $Offensive.
String; Alias for grouptype. In AACW: Either $Land or $Nav.
Integer; Level of entrenchment (0 to 8, 5 to 8 only with artillery).
Whether the group is inside a structure 0 (in structure) or 1 (outside structure).
Integer; represents the fixation of the unit:
String; Name of the group (not alias for text from string-file). | ||
|
Syntax CreateStruc
SetType = StructureAlias
SetLevel = StructureLevel
SetName = Name
Apply
Description The command block started by CreateStruct is used to create a structure in the selected region. Example CreateStruc
SetType = $Depot
SetLevel = 1
SetName = Corinth Depot
Apply
Creates a level 1 depot named Corinth Depot in the selected region. CreateStruc
SetType = $Fort
SetLevel = 2
SetName = Saint Louis Fortifications
Apply
Creates a level 2 fort named Saint Louis Fortifications in the selected region. |
Parameters
String; Alias of the structure type to be created. In AACW this is one of $Harbor, $Fort, $Depot, $City or $Village.
Integer; Level of the structure. Valid values in AACW are:
String; Name of the structure | ||
|
Syntax CreateUnit
SetType = UnitAlias
FlavorName = FName
NumCreate = Number
SUFlavorName = Name1|Name2|Name3...
SetName = UnitName
Apply
Description Creates units of various kinds.
|
Parameters
String; alias of the unit to be created
Name of commander. If left empty, it will be taken from the unit definition.
Integer; Number of Units to be created
'|'-seperated list of names for the unit's elements
String; Name of the unit | ||
|
Syntax DescEvent = StringAlias Description Define a string for the tooltip description of the event. Example DescEvent = evt_desc_USA_Andersonville1864 Use the text identified by the key evt_desc_USA_Andersonville1864 for the current event's tolltip description. |
Parameters
String; String alias of an entry in the string DB. | ||
|
Syntax GenMsg Description Link map position of selected region with event message.
|
Parameters This component doesn't make use of any parameters. | ||
|
Syntax LooseParams = StrAlias1|DisplayType|StrAlias2|Picture|Sound Description For selected faction: Determines the apperance of the defeat screen when triggered by the sudden death rule. Example LooseParams = StrLose|2|txt_Loose|scores_USA_defeat.png|$snd_Defeat |
Parameters
String; alias for a localized string in the string-file, event text.
[0, 1, 2] = Mute, line-event, Full-event
String; alias for a localized string in the string-file, event description.
String; Filename of the event picture
String; Alias for the sound effect | ||
|
Syntax LooseParamsVP = StrAlias1|DisplayType|StrAlias2|Picture|Sound Description For selected faction: Determines the appearance of the defeat screen when defeat is triggered by victory points. Example LooseParamsVP = StrLoseVP|2|txt_LooseVP|scores_CMN_Stalemate.png|$snd_Defeat |
Parameters
String; alias for a localized string in the string-file, event text.
[0, 1, 2] = Mute, line-event, Full-event
String; alias for a localized string in the string-file, event description.
String; Filename of the event picture
String; Alias for the sound effect | ||
|
Syntax MapOffsets = x;y Description Map specific for AACW -2500;-3000. Sets the focus on this coordinate.
|
Parameters
X coordinate to focus on
Y coordinate to focus on | ||
|
Syntax Objectives = RegionAlias1;Value1[;RegionAliasN;ValueN]* Description Assigns which regions should be considered objectives, as well as how much they are worth as such. Example Objectives = $Prince George's, MD;10;$Adams, PA;5 Assigns Prince George's as a 10-point objective and Adams, PA as a 5-point objective. |
Parameters
Alias for first region in list.
Objective value for the first region.
Alias number N in the list (there is no practical limit to number of regions).
Objective value of region N. | ||
|
Syntax PickFromRegList = [NotEnemy];[NotAdj] Description Select a random region from the region list (AddToRegList). Example PickFromRegList = NotEnemy Select a random region that doesn't contain any enemy stacks. PickFromRegList = NotEnemy;NotAdj Select a random region that doesn't contain any enemy stacks and isn't next to such a region either. |
Parameters
Literal; Region is not picked if an enemy unit is present in the region.
Literal; To use with NotEnemy. Region is not selected if enemy unit is resent in adjacent region. | ||
|
=== Replacement ===| Replacement | |||
|
Syntax Replacement = Faction; Element family; Number Description Changes the number of available replacements for a given unit family. Note: Earlier versions of the engine used the "Remplacement" keyword (typographical error). Both keywords are now supported by the scripting engine. Example Replacement = CSA;$famMilitia;3 This will increase the militia replacements available to the CSA by 3. Replacement = USA;$famLine;2 This will increase the line infantry replacements available to the USA by 2. |
Parameters
String; Faction alias
String; Alias of element family
Numerical value | ||
|
Syntax RulPettyWar = Value Description Activates the "petty war"-rule (capturing or looting a region with irregular units earns 1 VP each time for that side). Example RulPettyWar = 0 "Petty war" disabled. |
Parameters
0 or 1; Rule "petty war" on (1) or off (0). | ||
|
Syntax RulSuddenDeath = Value Description If the rule is activated (for the faction) the game will end as soon as the faction has fulfilled the victory conditions. Example RulSuddenDeath = 1 Sets game to end as soon as victory is achieved by the specified side. |
Parameters
0 or 1; Rule 'Sudden Death' on (1) or off (0) | ||
|
Syntax ScenBackground1 = StringAlias Description Description of the scenario background in the ledger, page 1. Independent from a selected faction. Example ScenBackground1 = str1861Campaign2Background1 Use the string identified by the key str1861Campaign2Background1 as the scenario's first background page. |
Parameters
String; alias for a localized string in the string-file. | ||
|
Syntax ScenBackground2 = StringAlias Description Description of the scenario background in the ledger, page 2. Independent from a selected faction. Example ScenBackground2 = str1861Campaign2Background1 Use the string identified by the key str1861Campaign2Background2 as the scenario's second background page. |
Parameters
String; alias for a localized string in the string-file. | ||
|
Syntax ScenDispName = StringAlias Description Name of the scenario displayed in the scenario list when starting a new game. Independent from a selected faction. Example ScenDispName = str1862ShilohDispName Use the string identified by the key str1862ShilohDispName as the scenario's display name. |
Parameters
String; alias for a localized string in the string-file. | ||
|
Syntax ScenDuration = StringAlias Description Scenario description: Duration of the scenario. Independent from a selected faction. Example ScenDuration = str1861BullRunDuration Use the text identified by the key str1861BullRunDuration to describe this scenario's duration. |
Parameters
String; alias for a localized string in the string-file | ||
|
Syntax ScenEnd = YYYY/MM/DD Description Determines when the scenario ends. Example ScenEnd = 1863/09/01 Scenario ends September 1st, 1863 |
Parameters
Integer; Year
Integer; Month
Integer; Day | ||
|
Syntax ScenFavoured = StringAlias Description Scenario description: Favoured side of the scenario. Independent from a selected faction. Seemingly not currently in use in AACW.
|
Parameters
String; Alias for a localized string in the string-file | ||
|
Syntax ScenName = Filename Description Used by the game if scenario is saved in Edit Mode, at the top of Script.ini Example ScenName = 1863 Gettysburg.scn This will load the file "1863 Gettysburg.scn" for this scenario |
Parameters
Name of the .scn scenario file to load | ||
|
Syntax ScenStart = YYYY/MM/DD Description Determines when the scenario starts. Example ScenStart = 1861/04/01 Scenario starts April 1st, 1861 |
Parameters
Integer; Year
Integer; Month
Integer; Day | ||
|
Syntax ScenText = StringAlias Description Identifies the description to use for the scenario. Independent from a selected faction. Example ScenText = str1863GettysburgDescription Use the text identified by the key str1863GettysburgDescription for this scenario's description. |
Parameters
String; Alias for a localized string in the string-file. | ||
|
Syntax ScenVictoryCond = StringAlias Description Description text explaining the victory conditions. Example ScenVictoryCond = str1861ACampaign2VC_USA The description for the victory conditions are in the string with the ID key str1861ACampaign2VC_USA. |
Parameters
Alias for the string containing the description of the victory conditions. The actual string will be in the localized textfiles. | ||
|
Syntax SelectFaction = Faction Description The commands in the Action-Block will only affect the selected faction. Example SelectFaction = $CSA Actions following this will only affect the CSA. |
Parameters
String, FactionTag of the faction. | ||
|
Syntax SelectRegion = RegionAlias; [NotEnemy]; [NoAdj]; [CondSkip] Description Selects a region. Example SelectRegion = $Jefferson, KY Select Jefferson, KY; later actions acting on a region will act on Jefferson, KY. |
Parameters
String; Alias of region to be selected.
Literal; Region is not picked if an enemy unit is present.
Literal; To use with NotEnemy. Region is not selected if enemy unit is resent in adjacent region.
Literal; Skip pick if already have a valid region. (Needs confirmation.) | ||
|
Syntax SelectSubUnits = Region <RgnUID>;Area <AreaUID>;Families <Fam1> <Fam2> ...;
Models <Mdl1> <Mdl2> ... ;FactionTags <Tag1> <Tag2> ... ;
Domains <_domLand> <_domNav> <_domAir>;<Attributes>
Description This command selects a unit or set of units as defined by one or more of the parameters in the above semi-colon delimited list. The exact filtering is determined by which of the parameters are included and the values listed for the specific parameters. Note: Though the list above has been spread over several lines for better display, the full list needs to be on the same line when applied in the gamaefiles. Example SelectSubUnits = SelectSubUnits = Area $OMB_WestIndies;Models $mdl_CSA_Mer;OnlyNotFixed will trigger if an unfixed unit containing the model $mdl_CSA_Mer exists in the $OMB_WestIndies Area |
Parameters
The region
The area (a predefined collection of regions)
A list of families (model types)
A list of Models you wish to select
The faction or factions to which you wish to limit the selection
The domain (broad class of models, units or groups)
Any or all of the attributes will filter the selection list: OnlyFixed, OnlyNotFixed, Enemy, FriendOnly, FriendAndSelf, UniqueName <Name> | ||
|
Syntax SelUnqUnit = Name [;CondSkip] Description This command set the Unit Selector to the selected unit, so that following commands can operate on it, i.e. a particular unit of some kind, be it an ordinary unit, a general or a ship. Example SelUnqUnit = Columbus Militia This will select the unit named "Columbus Militia" SelUnqUnit = Irvin McDowell This will select the unit (general, actually) called "Irvin McDowell" |
Parameters
String, Name of the unit to select
If this parameter is set, the select-command will be skipped if there is already a unit selected | ||
|
Syntax SetBlockades = RegionAlias1; Value1; RegionAlias2; Value2;... Description Sets the regions where warships carry out the blue water blockade against the selected faction. AACW: Only against CSA, Region alias: $Atlantic Blockade; $Gulf Blockade Example SetBlockades = $Atlantic Blockade;6;$Gulf Blockade;6 Sets Atlantic Blockade and Gulf Blockade as blockade regions, each with a coefficient(?) of 6 |
Parameters
Region alias for a blockade box
Coefficient for how blockade ratings should affect the blockade(?) | ||
|
Syntax SetCapital = RegionAlias; Value [RegionAlias2; Value2] ... Description Define the region where the capital is to be located; move it there if necessary. The region must contain a city. Note: 'SetCapitals' is a valid alias for this action, as some factions can have several capitals. Example SetCapital = $Richmond, VA;5 Move capital to Richmond, assign a coefficient of 5. |
Parameters
String; Alias for the region where the capital should be.
A coefficient attached to the capital (to the objective value). Generally between 1 and 5. | ||
|
Syntax SetCohesion = Value Description Set the cohesion value of all units named in the event in percent of their maximum cohesion value. Example SetCohesion = 75 Unit's cohesion will be 3/4 of full. |
Parameters
Integer; 0..100. Value can also be -1 (unknown what that means). | ||
|
Syntax SetHealth = Value Description Set the health of all units named in the event in percent of their maximum health. Example SetHealth = 20 Unit's health will be 1/5 of full. |
Parameters
Integer; 0..100. Value can also be -1 (unknown what that means). | ||
|
Syntax SetMoraleLevels = DefeatLevel;WinLevel Description Set levels for victory/defeat due to National Moral level. If the "sudden death"-rule isn't set, these will only be checked in the last turn of the game. If it is set, they will be checked each turn. Example SetMoraleLevels = 25;185 Sets that NM below 25 means defeat, while NM above 185 means victory. |
Parameters
Integer; Faction will loose if National Morale is less than or equal to this.
Integer; Faction will win if National Morale is equal to or higher than this. | ||
|
Syntax SetNavalPool = RegionAlias, Coefficient Description The transport capacity of ships in that region is a measure for the naval transport pool of that faction. In AACW: Union only, and only for "$Shipping Lanes" Example SetNavalPool = $Shipping Lanes;4 Set coefficient for all units in "$Shipping Lanes" to 4. |
Parameters
Region that the new coefficient should be applied to
How much each naval transport unit (element? transport rating?) should be counted as towards transport capacity. | ||
|
Syntax SetRevoltersInfos = UnitAlias; CityRaiseChance; DismissChance; ConvertChance Description Initializes various values related to partisans/insurgents Example SetRevoltersInfos = $uni_USA_Par;15;35;50 Will use $uni_USA_Par for partisans raised. |
Parameters
String; Unit Alias; Unit type used for partisans
Integer;
Integer;
Integer; | ||
|
Syntax SetTRSAssetsInfo = unitAliasRail; unitAliasRiver; unitAliasSupply Description Determine the units used for transport by the transport pool, i.e. the virtual supply wagon used by the supply algorithm, as defined in the database. Example SetTRSAssetsInfo = $uni_CMN_Rail;$uni_CMN_Riv;$uni_CMN_Sup1 Sets up the "virtual units" to be the default ones. |
Parameters
Unit used for railroad transport (transport pool)
Unit used for River transport (transport pool)
Unit used for Supply transport (transport pool) | ||
|
Syntax SetWinLevel = Number Description Determines the number of strategic towns the faction must own to win the game (sudden death rule). Example SetWinLevel = 12 This will set that 12 strategic towns are needed for a sudden death victory. |
Parameters
Integer; Number of strategic towns required to fulfil the victory condition. | ||
|
Syntax Side1 = FactionAlias[; FactionAlias]* Description List of the factions on side 1 (scenario info screen). Independent from a selected faction. Example Side1 = USA This side consists of USA (only). |
Parameters
Alias of the faction to include on this side. | ||
|
Syntax Side2 = FactionAlias[; FactionAlias]* Description List of the factions on side 1 (scenario info screen). Independent from a selected faction. Example Side2 = CSA; GBR This side consists of CSA and GBR. |
Parameters
Alias of the faction to include on this side. | ||
|
Syntax TurnsPerYear = Number Description Sets the number of turns in each year. Example TurnsPerYear = 24 Let each year have 24 turns (standard for AACW). |
Parameters
Integer; Number of turns each year should have | ||
|
=== VP ===| VP | |||
|
Syntax VP = Value Description Sets the number of victory points for the selected faction. Example VP = 10 Selected faction will now have a total of 10 VPs. |
Parameters
New value for selected faction's VP. | ||
|
Syntax WinParams = StrAlias1|DisplayType|StrAlias2|Picture|Sound Description For selected faction: Determines the apperance of the victory screen when triggered by the sudden death rule. Example WinParams = StrWin|2|txt_Win|scores_USA_victory.png|$snd_Victory |
Parameters
String; alias for a localized string in the string-file, event text.
[0, 1, 2] = Mute, line-event, Full-event
String; alias for a localized string in the string-file, event description.
String; Filename of the event picture
String; Alias for the sound effect | ||
|
Syntax WinParamsVP = StrAlias1|DisplayType|StrAlias2|Picture|Sound Description For selected faction: Determines the apperance of the victory screen when win is triggered by victory points. Example WinParamsVP = StrWin|2|txt_Win|scores_CMN_limited_victory.png|$snd_Victory |
Parameters
String; alias for a localized string in the string-file, event text.
[0, 1, 2] = Mute, line-event, Full-event
String; alias for a localized string in the string-file, event description.
String; Filename of the event picture
String; Alias for the sound effect | ||
