A garrison script that incorporates the ‘destroy_units’ command

[TNZ]

Making a garrison script that incorporates the ‘destroy_units’ command is not a new idea. So this is not a step-by-step tutorial, it is rather an illustration of the method of writing a garrison script that uses the ‘destroy_units’ command.

The garrison script:

Spoiler Alert, click show to read: 

;###### Isengard Garrison Script: By TNZ and Withwnar #######
;###### For TA 3.1 #######

declare_counter france_garrison

;###### Isengard Garrison Script: Local vs AI #######

	monitor_event GeneralAssaultsResidence FactionIsLocal
		and TargetFactionType france
		and I_IsFactionAIControlled france
		and IsTargetRegionOneOf Nan-Curunir_Province
    		and I_SettlementUnderSiege Nan-Curunir
		create_unit Nan-Curunir, Garrison Orthanc Guard, num 4, exp 2, arm 0, wep 0
		create_unit Nan-Curunir, Garrison Uruk-Hai Raiders, num 4, exp 2, arm 0, wep 0
		create_unit Nan-Curunir, Garrison Uruk-Hai Archers, num 2, exp 0, arm 0, wep 0
		set_counter france_garrison 1
	end_monitor

	monitor_event GeneralAssaultsResidence FactionIsLocal 
		and TargetFactionType france
		and I_IsFactionAIControlled france
		and IsTargetRegionOneOf Dunland_Province
    		and I_SettlementUnderSiege Dunland
		create_unit Dunland, Garrison Dunlendings, num 4, exp 0, arm 0, wep 0
		create_unit Dunland, Garrison Dunlending Axemen, num 2, exp 0, arm 0, wep 0
		set_counter france_garrison 1
	end_monitor

	monitor_event GeneralAssaultsResidence FactionIsLocal
		and TargetFactionType france
		and I_IsFactionAIControlled france
		and IsTargetRegionOneOf Dunland-Hills_Province
    		and I_SettlementUnderSiege Dunland-Hills
		create_unit Dunland-Hills, Garrison Dunlendings, num 4, exp 0, arm 0, wep 0
		create_unit Dunland-Hills, Garrison Dunlending Axemen, num 2, exp 0, arm 0, wep 0
		set_counter france_garrison 1
	end_monitor

;###### Isengard Garrison Script: AI vs AI #######

	monitor_event GeneralAssaultsResidence not FactionIsLocal
		and TargetFactionType france
		and I_IsFactionAIControlled france
		and IsTargetRegionOneOf Nan-Curunir_Province
    		and I_SettlementUnderSiege Nan-Curunir
		create_unit Nan-Curunir, Garrison Orthanc Guard, num 6, exp 2, arm 0, wep 0
		create_unit Nan-Curunir, Garrison Uruk-Hai Raiders, num 6, exp 2, arm 0, wep 0
		create_unit Nan-Curunir, Garrison Uruk-Hai Archers, num 4, exp 0, arm 0, wep 0
		set_counter france_garrison 1
	end_monitor

	monitor_event GeneralAssaultsResidence not FactionIsLocal 
		and TargetFactionType france
		and I_IsFactionAIControlled france
		and IsTargetRegionOneOf Dunland_Province
    		and I_SettlementUnderSiege Dunland
		create_unit Dunland, Garrison Dunlendings, num 6, exp 0, arm 0, wep 0
		create_unit Dunland, Garrison Dunlending Axemen, num 4, exp 0, arm 0, wep 0
		set_counter france_garrison 1
	end_monitor

	monitor_event GeneralAssaultsResidence not FactionIsLocal
		and TargetFactionType france
		and I_IsFactionAIControlled france
		and IsTargetRegionOneOf Dunland-Hills_Province
    		and I_SettlementUnderSiege Dunland-Hills
		create_unit Dunland-Hills, Garrison Dunlendings, num 6, exp 0, arm 0, wep 0
		create_unit Dunland-Hills, Garrison Dunlending Axemen, num 4, exp 0, arm 0, wep 0
		set_counter france_garrison 1
	end_monitor

;###### Isengard Garrison Script: Destroy France Garrison #######

	monitor_event PostBattle IsRegionOneOf Nan-Curunir_Province, Dunland_Province, Dunland-Hills_Province
		and I_CompareCounter france_garrison = 1
		destroy_units france garrison_unit
		set_counter france_garrison 0
	end_monitor

	monitor_event PreBattleWithdrawal IsRegionOneOf Nan-Curunir_Province, Dunland_Province, Dunland-Hills_Province
		and I_CompareCounter france_garrison = 1
		destroy_units france garrison_unit
		set_counter france_garrison 0
	end_monitor

Because the script uses ‘GeneralAssaultsResidence’ as the ‘monitor_event’ ,there can only ever be one scripted Garrison on the map at any one time, removing the need to write an elaborate script that puts the scripted Garrison's back in settlements which are still under siege after you have use the ‘destroy_units’ command.

There are two ‘monitor_event’ that handle destroying the units. The first one uses ‘PostBattle’: that one is pretty self-explanatory, that is, the units are destroyed after the battle. The second one uses ‘PreBattleWithdrawal’. If the player hits the assault button, but then decides to withdraw from the battle, the scripted Garrison is destroyed.

You can find a working example and more information on the script here:
http://www.twcenter.net/forums/showthread.php?t=513944

I'd like to thank, Withwnar for helping with the units for the garrison script demonstration, and Gigantus for the idea of using ‘GeneralAssaultsResidence’ as the monitor event for a garrison script.

[Emperor of Hell]

It looks very good. The only disadvantage of this garrison script is that it takes, if you create it for every faction, many unit slots. What happens when there are multiple garrison script settlements under siege at the same time? Are there side effects?

[Aikanár]

If I understand the script right, it fires for GeneralAssaultsResidence thus the garrison will only be created when one attack the settlement, not when it's just besieged. That's why TNZ wrote about the singularity of the garrison.

Nice script TNZ

[ilmrik]

Indeed a clever script, in many better than the Settlement besieged alternative.

[EP!anastasi]

What happens in the case that with the addition of the garisson units to the existing units the total units are more than the max? Do the extra ones appear as reinforcements in the battle? And would the extra ones be those that were created last?

[Gigantus]

This script obviously requires additional units in the EDU. The best way to do this would be to restrict it to 3 units (one each sword\pike\missile). If you have drastically different cultures (European, middle-east) then you might need additional sets of 3 units each.

[ilmrik]

This script obviously requires additional units in the EDU. The best way to do this would be to restrict it to 3 units (one each sword\pike\missile). If you have drastically different cultures (European, middle-east) then you might need additional sets of 3 units each.

If you're really pressed for unit entries you could use the armor_ug's to represent the different cultures.
Since you are always creating them trough script it's easy to set and they use different battle models.

Obviously this will mean that some have a higher quality than others.

[The Uruk]

How do you use destroy_units to destroy all units in a specific settlement?

[EP!anastasi]

How do you use destroy_units to destroy all units in a specific settlement?

That's not exactly what this script does. As Gigantus said:

This script obviously requires additional units in the EDU.

So you create and destroy only those additional units, only in the attacked settlement.

What happens in the case that with the addition of the garisson units to the existing units the total units are more than the max? Do the extra ones appear as reinforcements in the battle? And would the extra ones be those that were created last?

The answer is you can't create more than the max units that can fit in a settlement, right?

[The Uruk]

That's not exactly what this script does. As Gigantus said:

So you create and destroy only those additional units, only in the attacked settlement.


The answer is you can't create more than the max units that can fit in a settlement, right?

I understand that but I thought that people here would know as destroy_units is used in the script.

[Gigantus]

destroy_units needs an attribute from the EDU's attribute line (in this example) as definition, meaning that all units that have that attribute will be removed from the defined faction in the game. There is no "destroy_all_units in_this_ city"

[The Uruk]

Thanks,
Is there a way to destroy all units in a city?

[Gigantus]

There is no "destroy_all_units in_this_ city"

If you destroy units you destroy them faction wide, you cannot restrict it to settlements.

[Taiji]

It's actually game-wide, so it will affect every faction.

[Gigantus]

Identifier: destroy_units
Parameters: faction, attribute_or_type
Description: Disbands all units in the faction's armies with the specified name or attribute.
Sample use: destroy_units England free_upkeep_unit

[Taiji]

Ah, my bad, thanks for correcting me

[Gigantus]

No problem, you will get your chance to return the favor...

[Withwnar]

What happens in the case that with the addition of the garisson units to the existing units the total units are more than the max? Do the extra ones appear as reinforcements in the battle? And would the extra ones be those that were created last?

create_unit will only add as many units as the settlement can hold. If there are 2 slots free and create_unit is adding 3 then only 2 will be added. No spill-over onto an adjacent tile so no creation of a "reinforcement" army.

However, attempting to create_unit more units than the settlement can hold seems to corrupt the free-slots logic of the settlement. It works the first time but the next time it fails with an error message along the lines of "there is no room for this unit", even if there is room. It can also affect normal recruitment (same error). I don't know if it always happens.

Fortunately [console_command create_unit] does not suffer from this. So I'd recommend using...

console_command create_unit Nan-Curunir "Garrison Orthanc Guard" 4 2 0 0

...instead of...

create_unit Nan-Curunir, Garrison Orthanc Guard, num 4, exp 2, arm 0, wep 0

EDIT: the error still appears in the log but it does not affect the settlement in the way that create_unit does. The error is: "err: cannot add unit(s) because the garrison already contains the maximum number of units".

~~~

While attacking one of these garrisoned settlements I noticed something odd. The garrison units are not counted in the enemy's soldier count. (See attached.)

The number is correct after viewing the enemy army details - which isn't always done by the player - but that seems to be the only place that does use the right number.

The major concern, I think, is the percentage killed value. During battle it hit 100% when I had killed 75 soldiers and by the time I had killed 375 it was showing 500%. This would also pose a problem for anything else using "percent killed" in the game:
- trait/anc triggers: awards for killing >x% of the enemy would be handed out more often than they should
- battle AI: Germanicu5's uses I_PercentageOfArmyKilled as a trigger to do something
- the game itself: I'm guessing that things such as the "only half of the enemy remains" voiceover are tied to the displayed %

I wonder if it affects auto-resolve as well. i.e. Is the garrison ignored in battle outcome calculations, including AI-AI battles?

[Withwnar]

I wonder if it affects auto-resolve as well. i.e. Is the garrison ignored in battle outcome calculations, including AI-AI battles?

Yes and no. It seems that the garrison is taken into account for player-vs-AI auto-resolve battles but ignored for AI-vs-AI ones.

This was tested by creating massive auto-garrisons that attackers should not have won against, then sitting back and letting the AI try to capture settements as normal over a few turns. Settlements were captured all over the place. I know for a fact that some of the attacking armies were very small (I was watching them) so while it is possible that some attackers were actually stronger than the garrison, it is certain that not all of them were. Suggesting that the auto-garrisons were not counted in the AI-AI battles.

The way I did not test it was by using script [siege_settlement...attack] because that does not trigger a GeneralAssaultsResidence event. Never knew that. Good to know.