Table of Contents

Class CampaignEventDispatcher

Namespace
TaleWorlds.CampaignSystem
Assembly
TaleWorlds.CampaignSystem.dll
public class CampaignEventDispatcher : CampaignEventReceiver
Inheritance
CampaignEventDispatcher
Inherited Members

Properties

Instance 

public static CampaignEventDispatcher Instance { get; }

Property Value

CampaignEventDispatcher

Methods

AfterGameMenuOpened(MenuCallbackArgs) 

public override void AfterGameMenuOpened(MenuCallbackArgs args)

Parameters

args MenuCallbackArgs

AiHourlyTick(MobileParty, PartyThinkParams) 

public override void AiHourlyTick(MobileParty party, PartyThinkParams partyThinkParams)

Parameters

party MobileParty
partyThinkParams PartyThinkParams

BeforeGameMenuOpened(MenuCallbackArgs) 

public override void BeforeGameMenuOpened(MenuCallbackArgs args)

Parameters

args MenuCallbackArgs

BeforeMissionOpened() 

public override void BeforeMissionOpened()

CanBeGovernorOrHavePartyRole(Hero, ref bool) 

public override void CanBeGovernorOrHavePartyRole(Hero hero, ref bool result)

Parameters

hero Hero
result bool

CanHaveQuestsOrIssues(Hero, ref bool) 

public override void CanHaveQuestsOrIssues(Hero hero, ref bool result)

Parameters

hero Hero
result bool

CanHeroBecomePrisoner(Hero, ref bool) 

public override void CanHeroBecomePrisoner(Hero hero, ref bool result)

Parameters

hero Hero
result bool

CanHeroDie(Hero, KillCharacterActionDetail, ref bool) 

public override void CanHeroDie(Hero hero, KillCharacterAction.KillCharacterActionDetail causeOfDeath, ref bool result)

Parameters

hero Hero
causeOfDeath KillCharacterAction.KillCharacterActionDetail
result bool

CanHeroEquipmentBeChanged(Hero, ref bool) 

public override void CanHeroEquipmentBeChanged(Hero hero, ref bool result)

Parameters

hero Hero
result bool

CanHeroLeadParty(Hero, ref bool) 

public override void CanHeroLeadParty(Hero hero, ref bool result)

Parameters

hero Hero
result bool

CanHeroMarry(Hero, ref bool) 

public override void CanHeroMarry(Hero hero, ref bool result)

Parameters

hero Hero
result bool

CanKingdomBeDiscontinued(Kingdom, ref bool) 

public override void CanKingdomBeDiscontinued(Kingdom kingdom, ref bool result)

Parameters

kingdom Kingdom
result bool

CanMoveToSettlement(Hero, ref bool) 

public override void CanMoveToSettlement(Hero hero, ref bool result)

Parameters

hero Hero
result bool

CollectAvailableTutorials(ref List<CampaignTutorial>) 

public override void CollectAvailableTutorials(ref List<CampaignTutorial> tutorials)

Parameters

tutorials List<CampaignTutorial>

CollectLoots(MapEvent, PartyBase, Dictionary<PartyBase, ItemRoster>, ItemRoster, MBList<TroopRosterElement>, float) 

public override void CollectLoots(MapEvent mapEvent, PartyBase winner, Dictionary<PartyBase, ItemRoster> baseAndLootedItems, ItemRoster gainedLoot, MBList<TroopRosterElement> lootedCasualties, float lootAmount)

Parameters

mapEvent MapEvent
winner PartyBase
baseAndLootedItems Dictionary<PartyBase, ItemRoster>
gainedLoot ItemRoster
lootedCasualties MBList<TroopRosterElement>
lootAmount float

CraftingPartUnlocked(CraftingPiece) 

public override void CraftingPartUnlocked(CraftingPiece craftingPiece)

Parameters

craftingPiece CraftingPiece

DailyTick() 

public override void DailyTick()

DailyTickClan(Clan) 

public override void DailyTickClan(Clan clan)

Parameters

clan Clan

DailyTickHero(Hero) 

public override void DailyTickHero(Hero hero)

Parameters

hero Hero

DailyTickParty(MobileParty) 

public override void DailyTickParty(MobileParty mobileParty)

Parameters

mobileParty MobileParty

DailyTickSettlement(Settlement) 

public override void DailyTickSettlement(Settlement settlement)

Parameters

settlement Settlement

DailyTickTown(Town) 

public override void DailyTickTown(Town town)

Parameters

town Town

ForceSuppliesCompleted(BattleSideEnum, ForceSuppliesEventComponent) 

public override void ForceSuppliesCompleted(BattleSideEnum winnerSide, ForceSuppliesEventComponent forceSuppliesEvent)

Parameters

winnerSide BattleSideEnum
forceSuppliesEvent ForceSuppliesEventComponent

ForceVolunteersCompleted(BattleSideEnum, ForceVolunteersEventComponent) 

public override void ForceVolunteersCompleted(BattleSideEnum winnerSide, ForceVolunteersEventComponent forceVolunteersEvent)

Parameters

winnerSide BattleSideEnum
forceVolunteersEvent ForceVolunteersEventComponent

HourlyTick() 

public override void HourlyTick()

HourlyTickClan(Clan) 

public override void HourlyTickClan(Clan clan)

Parameters

clan Clan

HourlyTickParty(MobileParty) 

public override void HourlyTickParty(MobileParty mobileParty)

Parameters

mobileParty MobileParty

HourlyTickSettlement(Settlement) 

public override void HourlyTickSettlement(Settlement settlement)

Parameters

settlement Settlement

LocationCharactersAreReadyToSpawn(Dictionary<string, int>) 

public override void LocationCharactersAreReadyToSpawn(Dictionary<string, int> unusedUsablePointCount)

Parameters

unusedUsablePointCount Dictionary<string, int>

LocationCharactersSimulated() 

public override void LocationCharactersSimulated()

MissionTick(float) 

public override void MissionTick(float dt)

Parameters

dt float

OnAfterMissionStarted(IMission) 

public override void OnAfterMissionStarted(IMission iMission)

Parameters

iMission IMission

OnAfterSessionStart(CampaignGameStarter) 

public override void OnAfterSessionStart(CampaignGameStarter campaignGameStarter)

Parameters

campaignGameStarter CampaignGameStarter

OnAfterSettlementEntered(MobileParty, Settlement, Hero) 

public override void OnAfterSettlementEntered(MobileParty party, Settlement settlement, Hero hero)

Parameters

party MobileParty
settlement Settlement
hero Hero

OnAgentJoinedConversation(IAgent) 

public override void OnAgentJoinedConversation(IAgent agent)

Parameters

agent IAgent

OnAlleyClearedByPlayer(Alley) 

public override void OnAlleyClearedByPlayer(Alley alley)

Parameters

alley Alley

OnAlleyOccupiedByPlayer(Alley, TroopRoster) 

public override void OnAlleyOccupiedByPlayer(Alley alley, TroopRoster troops)

Parameters

alley Alley
troops TroopRoster

OnAlleyOwnerChanged(Alley, Hero, Hero) 

public override void OnAlleyOwnerChanged(Alley alley, Hero newOwner, Hero oldOwner)

Parameters

alley Alley
newOwner Hero
oldOwner Hero

OnArmyCreated(Army) 

public override void OnArmyCreated(Army army)

Parameters

army Army

OnArmyDispersed(Army, ArmyDispersionReason, bool) 

public override void OnArmyDispersed(Army army, Army.ArmyDispersionReason reason, bool isPlayersArmy)

Parameters

army Army
reason Army.ArmyDispersionReason
isPlayersArmy bool

OnArmyGathered(Army, Settlement) 

public override void OnArmyGathered(Army army, Settlement gatheringSettlement)

Parameters

army Army
gatheringSettlement Settlement

OnArmyLeaderThink(Hero, ArmyLeaderThinkReason) 

public override void OnArmyLeaderThink(Hero hero, Army.ArmyLeaderThinkReason reason)

Parameters

hero Hero
reason Army.ArmyLeaderThinkReason

OnArmyOverlaySetDirty() 

public override void OnArmyOverlaySetDirty()

OnBanditPartyRecruited(MobileParty) 

public override void OnBanditPartyRecruited(MobileParty banditParty)

Parameters

banditParty MobileParty

OnBarterAccepted(Hero, Hero, List<Barterable>) 

public override void OnBarterAccepted(Hero offererHero, Hero otherHero, List<Barterable> barters)

Parameters

offererHero Hero
otherHero Hero
barters List<Barterable>

OnBarterCanceled(Hero, Hero, List<Barterable>) 

public override void OnBarterCanceled(Hero offererHero, Hero otherHero, List<Barterable> barters)

Parameters

offererHero Hero
otherHero Hero
barters List<Barterable>

OnBarterablesRequested(BarterData) 

public override void OnBarterablesRequested(BarterData args)

Parameters

args BarterData

OnBeforeHeroKilled(Hero, Hero, KillCharacterActionDetail, bool) 

public override void OnBeforeHeroKilled(Hero victim, Hero killer, KillCharacterAction.KillCharacterActionDetail detail, bool showNotification = true)

Parameters

victim Hero
killer Hero
detail KillCharacterAction.KillCharacterActionDetail
showNotification bool

OnBeforeMainCharacterDied(Hero, Hero, KillCharacterActionDetail, bool) 

public override void OnBeforeMainCharacterDied(Hero victim, Hero killer, KillCharacterAction.KillCharacterActionDetail detail, bool showNotification = true)

Parameters

victim Hero
killer Hero
detail KillCharacterAction.KillCharacterActionDetail
showNotification bool

OnBeforePlayerCharacterChanged(Hero, Hero) 

public override void OnBeforePlayerCharacterChanged(Hero oldPlayer, Hero newPlayer)

Parameters

oldPlayer Hero
newPlayer Hero

OnBeforeSave() 

public override void OnBeforeSave()

OnBuildingLevelChanged(Town, Building, int) 

public override void OnBuildingLevelChanged(Town town, Building building, int levelChange)

Parameters

town Town
building Building
levelChange int

OnCaravanTransactionCompleted(MobileParty, Town, List<(EquipmentElement, int)>) 

public override void OnCaravanTransactionCompleted(MobileParty caravanParty, Town town, List<(EquipmentElement, int)> itemRosterElements)

Parameters

caravanParty MobileParty
town Town
itemRosterElements List<(EquipmentElement, int)>

OnCharacterBecameFugitive(Hero) 

public override void OnCharacterBecameFugitive(Hero hero)

Parameters

hero Hero

OnCharacterCreationIsOver() 

public override void OnCharacterCreationIsOver()

OnCharacterDefeated(Hero, Hero) 

public override void OnCharacterDefeated(Hero winner, Hero loser)

Parameters

winner Hero
loser Hero

OnCharacterPortraitPopUpClosed() 

public override void OnCharacterPortraitPopUpClosed()

OnCharacterPortraitPopUpOpened(CharacterObject) 

public override void OnCharacterPortraitPopUpOpened(CharacterObject character)

Parameters

character CharacterObject

OnCheckForIssue(Hero) 

public override void OnCheckForIssue(Hero hero)

Parameters

hero Hero

OnChildConceived(Hero) 

public override void OnChildConceived(Hero mother)

Parameters

mother Hero

OnChildEducationCompleted(Hero, int) 

public override void OnChildEducationCompleted(Hero hero, int age)

Parameters

hero Hero
age int

OnClanChangedKingdom(Clan, Kingdom, Kingdom, ChangeKingdomActionDetail, bool) 

public override void OnClanChangedKingdom(Clan clan, Kingdom oldKingdom, Kingdom newKingdom, ChangeKingdomAction.ChangeKingdomActionDetail actionDetail, bool showNotification = true)

Parameters

clan Clan
oldKingdom Kingdom
newKingdom Kingdom
actionDetail ChangeKingdomAction.ChangeKingdomActionDetail
showNotification bool

OnClanDestroyed(Clan) 

public override void OnClanDestroyed(Clan destroyedClan)

Parameters

destroyedClan Clan

OnClanInfluenceChanged(Clan, float) 

public override void OnClanInfluenceChanged(Clan clan, float change)

Parameters

clan Clan
change float

OnClanLeaderChanged(Hero, Hero) 

public override void OnClanLeaderChanged(Hero oldLeader, Hero newLeader)

Parameters

oldLeader Hero
newLeader Hero

OnClanTierChanged(Clan, bool) 

public override void OnClanTierChanged(Clan clan, bool shouldNotify = true)

Parameters

clan Clan
shouldNotify bool

OnCommonAreaStateChanged(Alley, AreaState, AreaState) 

public override void OnCommonAreaStateChanged(Alley alley, Alley.AreaState oldState, Alley.AreaState newState)

Parameters

alley Alley
oldState Alley.AreaState
newState Alley.AreaState

OnCompanionClanCreated(Clan) 

public override void OnCompanionClanCreated(Clan clan)

Parameters

clan Clan

OnCompanionRemoved(Hero, RemoveCompanionDetail) 

public override void OnCompanionRemoved(Hero companion, RemoveCompanionAction.RemoveCompanionDetail detail)

Parameters

companion Hero
detail RemoveCompanionAction.RemoveCompanionDetail

OnConfigChanged() 

public override void OnConfigChanged()

OnConversationEnded(IEnumerable<CharacterObject>) 

public override void OnConversationEnded(IEnumerable<CharacterObject> characters)

Parameters

characters IEnumerable<CharacterObject>

OnCraftingOrderCompleted(Town, CraftingOrder, ItemObject, Hero) 

public override void OnCraftingOrderCompleted(Town town, CraftingOrder craftingOrder, ItemObject craftedItem, Hero completerHero)

Parameters

town Town
craftingOrder CraftingOrder
craftedItem ItemObject
completerHero Hero

OnCrimeRatingChanged(IFaction, float) 

public override void OnCrimeRatingChanged(IFaction kingdom, float deltaCrimeAmount)

Parameters

kingdom IFaction
deltaCrimeAmount float

OnEquipmentSmeltedByHero(Hero, EquipmentElement) 

public override void OnEquipmentSmeltedByHero(Hero hero, EquipmentElement equipmentElement)

Parameters

hero Hero
equipmentElement EquipmentElement

OnGameEarlyLoaded(CampaignGameStarter) 

public override void OnGameEarlyLoaded(CampaignGameStarter campaignGameStarter)

Parameters

campaignGameStarter CampaignGameStarter

OnGameLoadFinished() 

public override void OnGameLoadFinished()

OnGameLoaded(CampaignGameStarter) 

public override void OnGameLoaded(CampaignGameStarter campaignGameStarter)

Parameters

campaignGameStarter CampaignGameStarter

OnGameMenuOpened(MenuCallbackArgs) 

public override void OnGameMenuOpened(MenuCallbackArgs args)

Parameters

args MenuCallbackArgs

OnGameMenuOptionSelected(GameMenuOption) 

public override void OnGameMenuOptionSelected(GameMenuOption gameMenuOption)

Parameters

gameMenuOption GameMenuOption

OnGameOver() 

public override void OnGameOver()

OnGivenBirth(Hero, List<Hero>, int) 

public override void OnGivenBirth(Hero mother, List<Hero> aliveChildren, int stillbornCount)

Parameters

mother Hero
aliveChildren List<Hero>
stillbornCount int

OnGovernorChanged(Town, Hero, Hero) 

public override void OnGovernorChanged(Town fortification, Hero oldGovernor, Hero newGovernor)

Parameters

fortification Town
oldGovernor Hero
newGovernor Hero

OnHeroChangedClan(Hero, Clan) 

public override void OnHeroChangedClan(Hero hero, Clan oldClan)

Parameters

hero Hero
oldClan Clan

OnHeroCombatHit(CharacterObject, CharacterObject, PartyBase, WeaponComponentData, bool, int) 

public override void OnHeroCombatHit(CharacterObject attackerTroop, CharacterObject attackedTroop, PartyBase party, WeaponComponentData usedWeapon, bool isFatal, int xp)

Parameters

attackerTroop CharacterObject
attackedTroop CharacterObject
party PartyBase
usedWeapon WeaponComponentData
isFatal bool
xp int

OnHeroComesOfAge(Hero) 

public override void OnHeroComesOfAge(Hero hero)

Parameters

hero Hero

OnHeroCreated(Hero, bool) 

public override void OnHeroCreated(Hero hero, bool isBornNaturally = false)

Parameters

hero Hero
isBornNaturally bool

OnHeroGainedSkill(Hero, SkillObject, int, bool) 

public override void OnHeroGainedSkill(Hero hero, SkillObject skill, int change = 1, bool shouldNotify = true)

Parameters

hero Hero
skill SkillObject
change int
shouldNotify bool

OnHeroGetsBusy(Hero, HeroGetsBusyReasons) 

public override void OnHeroGetsBusy(Hero hero, HeroGetsBusyReasons heroGetsBusyReason)

Parameters

hero Hero
heroGetsBusyReason HeroGetsBusyReasons

OnHeroGrowsOutOfInfancy(Hero) 

public override void OnHeroGrowsOutOfInfancy(Hero hero)

Parameters

hero Hero

OnHeroJoinedParty(Hero, MobileParty) 

public override void OnHeroJoinedParty(Hero hero, MobileParty party)

Parameters

hero Hero
party MobileParty

OnHeroKilled(Hero, Hero, KillCharacterActionDetail, bool) 

public override void OnHeroKilled(Hero victim, Hero killer, KillCharacterAction.KillCharacterActionDetail detail, bool showNotification = true)

Parameters

victim Hero
killer Hero
detail KillCharacterAction.KillCharacterActionDetail
showNotification bool

OnHeroLevelledUp(Hero, bool) 

public override void OnHeroLevelledUp(Hero hero, bool shouldNotify = true)

Parameters

hero Hero
shouldNotify bool

OnHeroOccupationChanged(Hero, Occupation) 

public override void OnHeroOccupationChanged(Hero hero, Occupation oldOccupation)

Parameters

hero Hero
oldOccupation Occupation

OnHeroOrPartyGaveItem((Hero, PartyBase), (Hero, PartyBase), ItemRosterElement, bool) 

public override void OnHeroOrPartyGaveItem((Hero, PartyBase) giver, (Hero, PartyBase) receiver, ItemRosterElement itemRosterElement, bool showNotification)

Parameters

giver (Hero, PartyBase)
receiver (Hero, PartyBase)
itemRosterElement ItemRosterElement
showNotification bool

OnHeroOrPartyTradedGold((Hero, PartyBase), (Hero, PartyBase), (int, string), bool) 

public override void OnHeroOrPartyTradedGold((Hero, PartyBase) giver, (Hero, PartyBase) recipient, (int, string) goldAmount, bool showNotification)

Parameters

giver (Hero, PartyBase)
recipient (Hero, PartyBase)
goldAmount (int, string)
showNotification bool

OnHeroPrisonerReleased(Hero, PartyBase, IFaction, EndCaptivityDetail) 

public override void OnHeroPrisonerReleased(Hero prisoner, PartyBase party, IFaction capturerFaction, EndCaptivityDetail detail)

Parameters

prisoner Hero
party PartyBase
capturerFaction IFaction
detail EndCaptivityDetail

OnHeroPrisonerTaken(PartyBase, Hero) 

public override void OnHeroPrisonerTaken(PartyBase capturer, Hero prisoner)

Parameters

capturer PartyBase
prisoner Hero

OnHeroReachesTeenAge(Hero) 

public override void OnHeroReachesTeenAge(Hero hero)

Parameters

hero Hero

OnHeroRelationChanged(Hero, Hero, int, bool, ChangeRelationDetail, Hero, Hero) 

public override void OnHeroRelationChanged(Hero effectiveHero, Hero effectiveHeroGainedRelationWith, int relationChange, bool showNotification, ChangeRelationAction.ChangeRelationDetail detail, Hero originalHero, Hero originalGainedRelationWith)

Parameters

effectiveHero Hero
effectiveHeroGainedRelationWith Hero
relationChange int
showNotification bool
detail ChangeRelationAction.ChangeRelationDetail
originalHero Hero
originalGainedRelationWith Hero

OnHeroSharedFoodWithAnother(Hero, Hero, float) 

public override void OnHeroSharedFoodWithAnother(Hero supporterHero, Hero supportedHero, float influence)

Parameters

supporterHero Hero
supportedHero Hero
influence float

OnHeroTeleportationRequested(Hero, Settlement, MobileParty, TeleportationDetail) 

public override void OnHeroTeleportationRequested(Hero hero, Settlement targetSettlement, MobileParty targetParty, TeleportHeroAction.TeleportationDetail detail)

Parameters

hero Hero
targetSettlement Settlement
targetParty MobileParty
detail TeleportHeroAction.TeleportationDetail

OnHeroUnregistered(Hero) 

public override void OnHeroUnregistered(Hero hero)

Parameters

hero Hero

OnHeroWounded(Hero) 

public override void OnHeroWounded(Hero woundedHero)

Parameters

woundedHero Hero

OnHeroesMarried(Hero, Hero, bool) 

public override void OnHeroesMarried(Hero hero1, Hero hero2, bool showNotification)

Parameters

hero1 Hero
hero2 Hero
showNotification bool

OnHideoutBattleCompleted(BattleSideEnum, HideoutEventComponent) 

public override void OnHideoutBattleCompleted(BattleSideEnum winnerSide, HideoutEventComponent hideoutEventComponent)

Parameters

winnerSide BattleSideEnum
hideoutEventComponent HideoutEventComponent

OnHideoutDeactivated(Settlement) 

public override void OnHideoutDeactivated(Settlement hideout)

Parameters

hideout Settlement

OnHideoutSpotted(PartyBase, PartyBase) 

public override void OnHideoutSpotted(PartyBase party, PartyBase hideoutParty)

Parameters

party PartyBase
hideoutParty PartyBase

OnIssueLogAdded(IssueBase, bool) 

public override void OnIssueLogAdded(IssueBase issue, bool hideInformation)

Parameters

issue IssueBase
hideInformation bool

OnIssueOwnerChanged(IssueBase, Hero) 

public override void OnIssueOwnerChanged(IssueBase issue, Hero oldOwner)

Parameters

issue IssueBase
oldOwner Hero

OnIssueUpdated(IssueBase, IssueUpdateDetails, Hero) 

public override void OnIssueUpdated(IssueBase issue, IssueBase.IssueUpdateDetails details, Hero issueSolver)

Parameters

issue IssueBase
details IssueBase.IssueUpdateDetails
issueSolver Hero

OnItemConsumed(ItemObject, Settlement, int) 

public override void OnItemConsumed(ItemObject itemObject, Settlement settlement, int count)

Parameters

itemObject ItemObject
settlement Settlement
count int

OnItemProduced(ItemObject, Settlement, int) 

public override void OnItemProduced(ItemObject itemObject, Settlement settlement, int count)

Parameters

itemObject ItemObject
settlement Settlement
count int

OnItemSold(PartyBase, PartyBase, ItemRosterElement, int, Settlement) 

public override void OnItemSold(PartyBase receiverParty, PartyBase payerParty, ItemRosterElement itemRosterElement, int number, Settlement currentSettlement)

Parameters

receiverParty PartyBase
payerParty PartyBase
itemRosterElement ItemRosterElement
number int
currentSettlement Settlement

OnItemsDiscardedByPlayer(ItemRoster) 

public override void OnItemsDiscardedByPlayer(ItemRoster roster)

Parameters

roster ItemRoster

OnItemsLooted(MobileParty, ItemRoster) 

public override void OnItemsLooted(MobileParty mobileParty, ItemRoster items)

Parameters

mobileParty MobileParty
items ItemRoster

OnItemsRefined(Hero, RefiningFormula) 

public override void OnItemsRefined(Hero hero, Crafting.RefiningFormula refineFormula)

Parameters

hero Hero
refineFormula Crafting.RefiningFormula

OnKingdomCreated(Kingdom) 

public override void OnKingdomCreated(Kingdom createdKingdom)

Parameters

createdKingdom Kingdom

OnKingdomDecisionAdded(KingdomDecision, bool) 

public override void OnKingdomDecisionAdded(KingdomDecision decision, bool isPlayerInvolved)

Parameters

decision KingdomDecision
isPlayerInvolved bool

OnKingdomDecisionCancelled(KingdomDecision, bool) 

public override void OnKingdomDecisionCancelled(KingdomDecision decision, bool isPlayerInvolved)

Parameters

decision KingdomDecision
isPlayerInvolved bool

OnKingdomDecisionConcluded(KingdomDecision, DecisionOutcome, bool) 

public override void OnKingdomDecisionConcluded(KingdomDecision decision, DecisionOutcome chosenOutcome, bool isPlayerInvolved)

Parameters

decision KingdomDecision
chosenOutcome DecisionOutcome
isPlayerInvolved bool

OnKingdomDestroyed(Kingdom) 

public override void OnKingdomDestroyed(Kingdom destroyedKingdom)

Parameters

destroyedKingdom Kingdom

OnLootDistributedToParty(MapEvent, PartyBase, Dictionary<PartyBase, ItemRoster>) 

public override void OnLootDistributedToParty(MapEvent mapEvent, PartyBase winner, Dictionary<PartyBase, ItemRoster> loot)

Parameters

mapEvent MapEvent
winner PartyBase
loot Dictionary<PartyBase, ItemRoster>

OnMainPartyPrisonerRecruited(FlattenedTroopRoster) 

public override void OnMainPartyPrisonerRecruited(FlattenedTroopRoster roster)

Parameters

roster FlattenedTroopRoster

OnMainPartyStarving() 

public override void OnMainPartyStarving()

OnMakePeace(IFaction, IFaction, MakePeaceDetail) 

public override void OnMakePeace(IFaction side1Faction, IFaction side2Faction, MakePeaceAction.MakePeaceDetail detail)

Parameters

side1Faction IFaction
side2Faction IFaction
detail MakePeaceAction.MakePeaceDetail

OnMapEventContinuityNeedsUpdate(IFaction) 

public override void OnMapEventContinuityNeedsUpdate(IFaction faction)

Parameters

faction IFaction

OnMapEventEnded(MapEvent) 

public override void OnMapEventEnded(MapEvent mapEvent)

Parameters

mapEvent MapEvent

OnMapEventStarted(MapEvent, PartyBase, PartyBase) 

public override void OnMapEventStarted(MapEvent mapEvent, PartyBase attackerParty, PartyBase defenderParty)

Parameters

mapEvent MapEvent
attackerParty PartyBase
defenderParty PartyBase

OnMarriageOfferCanceled(Hero, Hero) 

public override void OnMarriageOfferCanceled(Hero suitor, Hero maiden)

Parameters

suitor Hero
maiden Hero

OnMarriageOfferedToPlayer(Hero, Hero) 

public override void OnMarriageOfferedToPlayer(Hero suitor, Hero maiden)

Parameters

suitor Hero
maiden Hero

OnMercenaryNumberChangedInTown(Town, int, int) 

public override void OnMercenaryNumberChangedInTown(Town town, int oldNumber, int newNumber)

Parameters

town Town
oldNumber int
newNumber int

OnMercenaryTroopChangedInTown(Town, CharacterObject, CharacterObject) 

public override void OnMercenaryTroopChangedInTown(Town town, CharacterObject oldTroopType, CharacterObject newTroopType)

Parameters

town Town
oldTroopType CharacterObject
newTroopType CharacterObject

OnMissionEnded(IMission) 

public override void OnMissionEnded(IMission mission)

Parameters

mission IMission

OnMissionStarted(IMission) 

public override void OnMissionStarted(IMission mission)

Parameters

mission IMission

OnMobilePartyCreated(MobileParty) 

public override void OnMobilePartyCreated(MobileParty party)

Parameters

party MobileParty

OnMobilePartyDestroyed(MobileParty, PartyBase) 

public override void OnMobilePartyDestroyed(MobileParty mobileParty, PartyBase destroyerParty)

Parameters

mobileParty MobileParty
destroyerParty PartyBase

OnMobilePartyQuestStatusChanged(MobileParty, bool) 

public override void OnMobilePartyQuestStatusChanged(MobileParty party, bool isUsedByQuest)

Parameters

party MobileParty
isUsedByQuest bool

OnNearbyPartyAddedToPlayerMapEvent(MobileParty) 

public override void OnNearbyPartyAddedToPlayerMapEvent(MobileParty mobileParty)

Parameters

mobileParty MobileParty

OnNewCompanionAdded(Hero) 

public override void OnNewCompanionAdded(Hero newCompanion)

Parameters

newCompanion Hero

OnNewGameCreated(CampaignGameStarter) 

public override void OnNewGameCreated(CampaignGameStarter campaignGameStarter)

Parameters

campaignGameStarter CampaignGameStarter

OnNewIssueCreated(IssueBase) 

public override void OnNewIssueCreated(IssueBase issue)

Parameters

issue IssueBase

OnNewItemCrafted(ItemObject, ItemModifier, bool) 

public override void OnNewItemCrafted(ItemObject itemObject, ItemModifier overriddenItemModifier, bool isCraftingOrderItem)

Parameters

itemObject ItemObject
overriddenItemModifier ItemModifier
isCraftingOrderItem bool

OnPartyAttachedAnotherParty(MobileParty) 

public override void OnPartyAttachedAnotherParty(MobileParty mobileParty)

Parameters

mobileParty MobileParty

OnPartyConsumedFood(MobileParty) 

public override void OnPartyConsumedFood(MobileParty party)

Parameters

party MobileParty

OnPartyDisbandCanceled(MobileParty) 

public override void OnPartyDisbandCanceled(MobileParty disbandParty)

Parameters

disbandParty MobileParty

OnPartyDisbandStarted(MobileParty) 

public override void OnPartyDisbandStarted(MobileParty disbandParty)

Parameters

disbandParty MobileParty

OnPartyDisbanded(MobileParty, Settlement) 

public override void OnPartyDisbanded(MobileParty disbandParty, Settlement relatedSettlement)

Parameters

disbandParty MobileParty
relatedSettlement Settlement

OnPartyJoinedArmy(MobileParty) 

public override void OnPartyJoinedArmy(MobileParty mobileParty)

Parameters

mobileParty MobileParty

OnPartyLeaderChangeOfferCanceled(MobileParty) 

public override void OnPartyLeaderChangeOfferCanceled(MobileParty party)

Parameters

party MobileParty

OnPartyRemoved(PartyBase) 

public override void OnPartyRemoved(PartyBase party)

Parameters

party PartyBase

OnPartyRemovedFromArmy(MobileParty) 

public override void OnPartyRemovedFromArmy(MobileParty mobileParty)

Parameters

mobileParty MobileParty

OnPartySizeChanged(PartyBase) 

public override void OnPartySizeChanged(PartyBase party)

Parameters

party PartyBase

OnPartyVisibilityChanged(PartyBase) 

public override void OnPartyVisibilityChanged(PartyBase party)

Parameters

party PartyBase

OnPeaceOfferCancelled(IFaction) 

public override void OnPeaceOfferCancelled(IFaction opponentFaction)

Parameters

opponentFaction IFaction

OnPeaceOfferedToPlayer(IFaction, int) 

public override void OnPeaceOfferedToPlayer(IFaction opponentFaction, int tributeAmount)

Parameters

opponentFaction IFaction
tributeAmount int

OnPerkOpened(Hero, PerkObject) 

public override void OnPerkOpened(Hero hero, PerkObject perk)

Parameters

hero Hero
perk PerkObject

OnPersuasionProgressCommitted(Tuple<PersuasionOptionArgs, PersuasionOptionResult>) 

public override void OnPersuasionProgressCommitted(Tuple<PersuasionOptionArgs, PersuasionOptionResult> progress)

Parameters

progress Tuple<PersuasionOptionArgs, PersuasionOptionResult>

OnPlayerBattleEnd(MapEvent) 

public override void OnPlayerBattleEnd(MapEvent mapEvent)

Parameters

mapEvent MapEvent

OnPlayerBoardGameOver(Hero, BoardGameState) 

public override void OnPlayerBoardGameOver(Hero opposingHero, BoardGameHelper.BoardGameState state)

Parameters

opposingHero Hero
state BoardGameHelper.BoardGameState

OnPlayerBodyPropertiesChanged() 

public override void OnPlayerBodyPropertiesChanged()

OnPlayerCharacterChanged(Hero, Hero, MobileParty, bool) 

public override void OnPlayerCharacterChanged(Hero oldPlayer, Hero newPlayer, MobileParty newPlayerParty, bool isMainPartyChanged)

Parameters

oldPlayer Hero
newPlayer Hero
newPlayerParty MobileParty
isMainPartyChanged bool

OnPlayerDesertedBattle(int) 

public override void OnPlayerDesertedBattle(int sacrificedMenCount)

Parameters

sacrificedMenCount int

OnPlayerEarnedGoldFromAsset(AssetIncomeType, int) 

public override void OnPlayerEarnedGoldFromAsset(DefaultClanFinanceModel.AssetIncomeType incomeType, int incomeAmount)

Parameters

incomeType DefaultClanFinanceModel.AssetIncomeType
incomeAmount int

OnPlayerEliminatedFromTournament(int, Town) 

public override void OnPlayerEliminatedFromTournament(int round, Town town)

Parameters

round int
town Town

OnPlayerInventoryExchange(List<(ItemRosterElement, int)>, List<(ItemRosterElement, int)>, bool) 

public override void OnPlayerInventoryExchange(List<(ItemRosterElement, int)> purchasedItems, List<(ItemRosterElement, int)> soldItems, bool isTrading)

Parameters

purchasedItems List<(ItemRosterElement, int)>
soldItems List<(ItemRosterElement, int)>
isTrading bool

OnPlayerJoinedTournament(Town, bool) 

public override void OnPlayerJoinedTournament(Town town, bool isParticipant)

Parameters

town Town
isParticipant bool

OnPlayerLearnsAboutHero(Hero) 

public override void OnPlayerLearnsAboutHero(Hero hero)

Parameters

hero Hero

OnPlayerMetHero(Hero) 

public override void OnPlayerMetHero(Hero hero)

Parameters

hero Hero

OnPlayerPartyKnockedOrKilledTroop(CharacterObject) 

public override void OnPlayerPartyKnockedOrKilledTroop(CharacterObject strikedTroop)

Parameters

strikedTroop CharacterObject

OnPlayerSiegeStarted() 

public override void OnPlayerSiegeStarted()

OnPlayerStartRecruitment(CharacterObject) 

public override void OnPlayerStartRecruitment(CharacterObject recruitTroopCharacter)

Parameters

recruitTroopCharacter CharacterObject

OnPlayerStartTalkFromMenu(Hero) 

public override void OnPlayerStartTalkFromMenu(Hero hero)

Parameters

hero Hero

OnPlayerStartedTournamentMatch(Town) 

public override void OnPlayerStartedTournamentMatch(Town town)

Parameters

town Town

OnPlayerTradeProfit(int) 

public override void OnPlayerTradeProfit(int profit)

Parameters

profit int

OnPlayerTraitChanged(TraitObject, int) 

public override void OnPlayerTraitChanged(TraitObject trait, int previousLevel)

Parameters

trait TraitObject
previousLevel int

OnPlayerUpgradedTroops(CharacterObject, CharacterObject, int) 

public override void OnPlayerUpgradedTroops(CharacterObject upgradeFromTroop, CharacterObject upgradeToTroop, int number)

Parameters

upgradeFromTroop CharacterObject
upgradeToTroop CharacterObject
number int

OnPrisonerDonatedToSettlement(MobileParty, FlattenedTroopRoster, Settlement) 

public override void OnPrisonerDonatedToSettlement(MobileParty donatingParty, FlattenedTroopRoster donatedPrisoners, Settlement donatedSettlement)

Parameters

donatingParty MobileParty
donatedPrisoners FlattenedTroopRoster
donatedSettlement Settlement

OnPrisonerReleased(FlattenedTroopRoster) 

public override void OnPrisonerReleased(FlattenedTroopRoster roster)

Parameters

roster FlattenedTroopRoster

OnPrisonerSold(PartyBase, PartyBase, TroopRoster) 

public override void OnPrisonerSold(PartyBase sellerParty, PartyBase buyerParty, TroopRoster prisoners)

Parameters

sellerParty PartyBase
buyerParty PartyBase
prisoners TroopRoster

OnPrisonerTaken(FlattenedTroopRoster) 

public override void OnPrisonerTaken(FlattenedTroopRoster roster)

Parameters

roster FlattenedTroopRoster

OnPrisonersChangeInSettlement(Settlement, FlattenedTroopRoster, Hero, bool) 

public override void OnPrisonersChangeInSettlement(Settlement settlement, FlattenedTroopRoster prisonerRoster, Hero prisonerHero, bool takenFromDungeon)

Parameters

settlement Settlement
prisonerRoster FlattenedTroopRoster
prisonerHero Hero
takenFromDungeon bool

OnQuestCompleted(QuestBase, QuestCompleteDetails) 

public override void OnQuestCompleted(QuestBase quest, QuestBase.QuestCompleteDetails detail)

Parameters

quest QuestBase
detail QuestBase.QuestCompleteDetails

OnQuestLogAdded(QuestBase, bool) 

public override void OnQuestLogAdded(QuestBase quest, bool hideInformation)

Parameters

quest QuestBase
hideInformation bool

OnQuestStarted(QuestBase) 

public override void OnQuestStarted(QuestBase quest)

Parameters

quest QuestBase

OnRansomOfferCancelled(Hero) 

public override void OnRansomOfferCancelled(Hero captiveHero)

Parameters

captiveHero Hero

OnRansomOfferedToPlayer(Hero) 

public override void OnRansomOfferedToPlayer(Hero captiveHero)

Parameters

captiveHero Hero

OnRebellionFinished(Settlement, Clan) 

public override void OnRebellionFinished(Settlement settlement, Clan oldOwnerClan)

Parameters

settlement Settlement
oldOwnerClan Clan

OnRebelliousClanDisbandedAtSettlement(Settlement, Clan) 

public override void OnRebelliousClanDisbandedAtSettlement(Settlement settlement, Clan rebelliousClan)

Parameters

settlement Settlement
rebelliousClan Clan

OnRenownGained(Hero, int, bool) 

public override void OnRenownGained(Hero hero, int gainedRenown, bool doNotNotify)

Parameters

hero Hero
gainedRenown int
doNotNotify bool

OnRomanticStateChanged(Hero, Hero, RomanceLevelEnum) 

public override void OnRomanticStateChanged(Hero hero1, Hero hero2, Romance.RomanceLevelEnum romanceLevel)

Parameters

hero1 Hero
hero2 Hero
romanceLevel Romance.RomanceLevelEnum

OnRulingClanChanged(Kingdom, Clan) 

public override void OnRulingClanChanged(Kingdom kingdom, Clan newRulingClan)

Parameters

kingdom Kingdom
newRulingClan Clan

OnSaveOver(bool, string) 

public override void OnSaveOver(bool isSuccessful, string saveName)

Parameters

isSuccessful bool
saveName string

OnSaveStarted() 

public override void OnSaveStarted()

OnSessionStart(CampaignGameStarter) 

public override void OnSessionStart(CampaignGameStarter campaignGameStarter)

Parameters

campaignGameStarter CampaignGameStarter

OnSettlementEntered(MobileParty, Settlement, Hero) 

public override void OnSettlementEntered(MobileParty party, Settlement settlement, Hero hero)

Parameters

party MobileParty
settlement Settlement
hero Hero

OnSettlementLeft(MobileParty, Settlement) 

public override void OnSettlementLeft(MobileParty party, Settlement settlement)

Parameters

party MobileParty
settlement Settlement

OnSettlementOwnerChanged(Settlement, bool, Hero, Hero, Hero, ChangeOwnerOfSettlementDetail) 

public override void OnSettlementOwnerChanged(Settlement settlement, bool openToClaim, Hero newOwner, Hero oldOwner, Hero capturerHero, ChangeOwnerOfSettlementAction.ChangeOwnerOfSettlementDetail detail)

Parameters

settlement Settlement
openToClaim bool
newOwner Hero
oldOwner Hero
capturerHero Hero
detail ChangeOwnerOfSettlementAction.ChangeOwnerOfSettlementDetail

OnSiegeAftermathApplied(MobileParty, Settlement, SiegeAftermath, Clan, Dictionary<MobileParty, float>) 

public override void OnSiegeAftermathApplied(MobileParty attackerParty, Settlement settlement, SiegeAftermathAction.SiegeAftermath aftermathType, Clan previousSettlementOwner, Dictionary<MobileParty, float> partyContributions)

Parameters

attackerParty MobileParty
settlement Settlement
aftermathType SiegeAftermathAction.SiegeAftermath
previousSettlementOwner Clan
partyContributions Dictionary<MobileParty, float>

OnSiegeBombardmentHit(MobileParty, Settlement, BattleSideEnum, SiegeEngineType, SiegeBombardTargets) 

public override void OnSiegeBombardmentHit(MobileParty besiegerParty, Settlement besiegedSettlement, BattleSideEnum side, SiegeEngineType weapon, SiegeBombardTargets target)

Parameters

besiegerParty MobileParty
besiegedSettlement Settlement
side BattleSideEnum
weapon SiegeEngineType
target SiegeBombardTargets

OnSiegeBombardmentWallHit(MobileParty, Settlement, BattleSideEnum, SiegeEngineType, bool) 

public override void OnSiegeBombardmentWallHit(MobileParty besiegerParty, Settlement besiegedSettlement, BattleSideEnum side, SiegeEngineType weapon, bool isWallCracked)

Parameters

besiegerParty MobileParty
besiegedSettlement Settlement
side BattleSideEnum
weapon SiegeEngineType
isWallCracked bool

OnSiegeEngineDestroyed(MobileParty, Settlement, BattleSideEnum, SiegeEngineType) 

public override void OnSiegeEngineDestroyed(MobileParty besiegerParty, Settlement besiegedSettlement, BattleSideEnum side, SiegeEngineType destroyedEngine)

Parameters

besiegerParty MobileParty
besiegedSettlement Settlement
side BattleSideEnum
destroyedEngine SiegeEngineType

OnSiegeEventEnded(SiegeEvent) 

public override void OnSiegeEventEnded(SiegeEvent siegeEvent)

Parameters

siegeEvent SiegeEvent

OnSiegeEventStarted(SiegeEvent) 

public override void OnSiegeEventStarted(SiegeEvent siegeEvent)

Parameters

siegeEvent SiegeEvent

OnStartBattle(PartyBase, PartyBase, object, bool) 

public override void OnStartBattle(PartyBase attackerParty, PartyBase defenderParty, object subject, bool showNotification)

Parameters

attackerParty PartyBase
defenderParty PartyBase
subject object
showNotification bool

OnTournamentCancelled(Town) 

public override void OnTournamentCancelled(Town town)

Parameters

town Town

OnTournamentFinished(CharacterObject, MBReadOnlyList<CharacterObject>, Town, ItemObject) 

public override void OnTournamentFinished(CharacterObject winner, MBReadOnlyList<CharacterObject> participants, Town town, ItemObject prize)

Parameters

winner CharacterObject
participants MBReadOnlyList<CharacterObject>
town Town
prize ItemObject

OnTournamentStarted(Town) 

public override void OnTournamentStarted(Town town)

Parameters

town Town

OnTradeRumorIsTaken(List<TradeRumor>, Settlement) 

public override void OnTradeRumorIsTaken(List<TradeRumor> newRumors, Settlement sourceSettlement = null)

Parameters

newRumors List<TradeRumor>
sourceSettlement Settlement

OnTroopGivenToSettlement(Hero, Settlement, TroopRoster) 

public override void OnTroopGivenToSettlement(Hero giverHero, Settlement recipientSettlement, TroopRoster roster)

Parameters

giverHero Hero
recipientSettlement Settlement
roster TroopRoster

OnTroopRecruited(Hero, Settlement, Hero, CharacterObject, int) 

public override void OnTroopRecruited(Hero recruiterHero, Settlement recruitmentSettlement, Hero recruitmentSource, CharacterObject troop, int amount)

Parameters

recruiterHero Hero
recruitmentSettlement Settlement
recruitmentSource Hero
troop CharacterObject
amount int

OnTroopsDeserted(MobileParty, TroopRoster) 

public override void OnTroopsDeserted(MobileParty mobileParty, TroopRoster desertedTroops)

Parameters

mobileParty MobileParty
desertedTroops TroopRoster

OnTutorialCompleted(string) 

public override void OnTutorialCompleted(string tutorial)

Parameters

tutorial string

OnUnitRecruited(CharacterObject, int) 

public override void OnUnitRecruited(CharacterObject character, int amount)

Parameters

character CharacterObject
amount int

OnVassalOrMercenaryServiceOfferCanceled(Kingdom) 

public override void OnVassalOrMercenaryServiceOfferCanceled(Kingdom offeredKingdom)

Parameters

offeredKingdom Kingdom

OnVassalOrMercenaryServiceOfferedToPlayer(Kingdom) 

public override void OnVassalOrMercenaryServiceOfferedToPlayer(Kingdom offeredKingdom)

Parameters

offeredKingdom Kingdom

OnVillageBecomeNormal(Village) 

public override void OnVillageBecomeNormal(Village village)

Parameters

village Village

OnVillageBeingRaided(Village) 

public override void OnVillageBeingRaided(Village village)

Parameters

village Village

OnVillageLooted(Village) 

public override void OnVillageLooted(Village village)

Parameters

village Village

OnVillageStateChanged(Village, VillageStates, VillageStates, MobileParty) 

public override void OnVillageStateChanged(Village village, Village.VillageStates oldState, Village.VillageStates newState, MobileParty raiderParty)

Parameters

village Village
oldState Village.VillageStates
newState Village.VillageStates
raiderParty MobileParty

OnWarDeclared(IFaction, IFaction, DeclareWarDetail) 

public override void OnWarDeclared(IFaction faction1, IFaction faction2, DeclareWarAction.DeclareWarDetail declareWarDetail)

Parameters

faction1 IFaction
faction2 IFaction
declareWarDetail DeclareWarAction.DeclareWarDetail

OnWorkshopInitialized(Workshop) 

public override void OnWorkshopInitialized(Workshop workshop)

Parameters

workshop Workshop

OnWorkshopOwnerChanged(Workshop, Hero) 

public override void OnWorkshopOwnerChanged(Workshop workshop, Hero oldOwner)

Parameters

workshop Workshop
oldOwner Hero

OnWorkshopTypeChanged(Workshop) 

public override void OnWorkshopTypeChanged(Workshop workshop)

Parameters

workshop Workshop

QuarterDailyPartyTick(MobileParty) 

public override void QuarterDailyPartyTick(MobileParty party)

Parameters

party MobileParty

RaidCompleted(BattleSideEnum, RaidEventComponent) 

public override void RaidCompleted(BattleSideEnum winnerSide, RaidEventComponent raidEvent)

Parameters

winnerSide BattleSideEnum
raidEvent RaidEventComponent

RemoveListeners(object) 

public override void RemoveListeners(object o)

Parameters

o object

SiegeCompleted(Settlement, MobileParty, bool, BattleTypes) 

public override void SiegeCompleted(Settlement siegeSettlement, MobileParty attackerParty, bool isWin, MapEvent.BattleTypes battleType)

Parameters

siegeSettlement Settlement
attackerParty MobileParty
isWin bool
battleType MapEvent.BattleTypes

SiegeEngineBuilt(SiegeEvent, BattleSideEnum, SiegeEngineType) 

public override void SiegeEngineBuilt(SiegeEvent siegeEvent, BattleSideEnum side, SiegeEngineType siegeEngine)

Parameters

siegeEvent SiegeEvent
side BattleSideEnum
siegeEngine SiegeEngineType

Tick(float) 

public override void Tick(float dt)

Parameters

dt float

TickPartialHourlyAi(MobileParty) 

public override void TickPartialHourlyAi(MobileParty party)

Parameters

party MobileParty

TownRebelliousStateChanged(Town, bool) 

public override void TownRebelliousStateChanged(Town town, bool rebelliousState)

Parameters

town Town
rebelliousState bool

TrackDetected(Track) 

public override void TrackDetected(Track track)

Parameters

track Track

TrackLost(Track) 

public override void TrackLost(Track track)

Parameters

track Track

WeeklyTick() 

public override void WeeklyTick()

This page was last modified at 09/01/2024 16:12:00 +00:00 (UTC).