Provisional leader system (VGN and later)

The game can now replace dead leaders with others, taken from the DB, if a provisional leaders list was set in place, for a given faction.



== Commands ==

The commands to use for that are:

[[ChangeLeadersPool]] = [;<LeaderRankAlias|Variation>] ..

:LeaderRankAlias values: 1 to 3 for Land leaders, 11 to 13 for Naval leaders. Variation is a variation in the allowance (all allowances start at 0).
:If you want to allow 4 admiral 3* at a given time for a nation, you would use:
::ChangeLeadersPool = 13|4

These aliases can be also used

$ldrRankLand1 = 1

$ldrRankLand2 = 2

$ldrRankLand3 = 3

$ldrRankNav1  = 11

$ldrRankNav2  = 12

$ldrRankNav3  = 13


Then you must make sure that the leader is in the 'provisional list', i.e the list of leaders permitted to be drawn, some could not be on purpose (outside the provisional system). You have two (complementary choices) here. The first choice, is to fill up the Model DB, ProvLeaderTag field, with the FactionTag of the faction the leader belongs to. For example a French general will have FRA in this entry. The alternate way is to use a scripted command, the syntax being:

[[AddProvLeaders]] = [LdrUID1;LdrUID2;..]
(all leaders goes into this same list)

Why use a scripted command? If you want to have a leader that is provisional only in case of a specific event. For example, if there is a war, the leader becomes provisional (can be used to replace losses). If a leader is 'inconditionally provisional' then add him in the DB, this is simpler. 

== Models changes and choices ==

In the Model DB, for each leader, you also have (this is optional) to set a DateIn, DateOut in English date format YYYY/MM/DD. Leaders outside the date range will also be excluded when a leader must be picked (see below). If you don't specify a date, the leader is available for the duration of the game. Don't mistake DateIn/DateOut with the leader's death chance (DeathChance etc.).



== How it works ==

Every turn, during hosting, if the current number of 3* leaders is under the allowance, then the most senior 2* on map will first be checked to see if he can be promoted, there is at most one check for each missing 3* (There is no automated promotion from 1* to 2* though). Then, once it is done, ranks will be filled, in all 3 ranks, by drawing from the provisional leaders.



=== Death of Leaders ===

:Leaders can die from various reasons, including old age, disease or retiring. This is controlled by data at the model level, using the columns DeathChance, DeathBySicknessThresold, DeathChanceInc. Leaders can die in combat, this is controlled by CombatDeathChance. 

:Finally, leaders can die from weather or extreme combat loss (if all their unit is eliminated) if they fail a 6-sided roll (6 is rolled), or if there is no recovery location (if the dice was 1-5 they should be wounded and sent to recover). This can happen theoretically for all leaders, including a 3* without any CombatDeathChance or any other variable. In practice there is no report it has ever happen for the like of Lee or Napoleon...

[[Category:Definitions|Provisional Leaders]]