Table of Contents

Class CampaignEventReceiver

Namespace
TaleWorlds.CampaignSystem
Assembly
TaleWorlds.CampaignSystem.dll
public abstract class CampaignEventReceiver
Inheritance
CampaignEventReceiver
Derived
Inherited Members

Constructors

CampaignEventReceiver() 

protected CampaignEventReceiver()

Methods

AfterGameMenuOpened(MenuCallbackArgs) 

public virtual void AfterGameMenuOpened(MenuCallbackArgs args)

Parameters

args MenuCallbackArgs

AiHourlyTick(MobileParty, PartyThinkParams) 

public virtual void AiHourlyTick(MobileParty party, PartyThinkParams partyThinkParams)

Parameters

party MobileParty
partyThinkParams PartyThinkParams

BeforeGameMenuOpened(MenuCallbackArgs) 

public virtual void BeforeGameMenuOpened(MenuCallbackArgs args)

Parameters

args MenuCallbackArgs

BeforeMissionOpened() 

public virtual void BeforeMissionOpened()

CanBeGovernorOrHavePartyRole(Hero, ref bool) 

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

Parameters

hero Hero
result bool

CanHaveQuestsOrIssues(Hero, ref bool) 

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

Parameters

hero Hero
result bool

CanHeroBecomePrisoner(Hero, ref bool) 

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

Parameters

hero Hero
result bool

CanHeroDie(Hero, KillCharacterActionDetail, ref bool) 

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

Parameters

hero Hero
causeOfDeath KillCharacterAction.KillCharacterActionDetail
result bool

CanHeroEquipmentBeChanged(Hero, ref bool) 

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

Parameters

hero Hero
result bool

CanHeroLeadParty(Hero, ref bool) 

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

Parameters

hero Hero
result bool

CanHeroMarry(Hero, ref bool) 

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

Parameters

hero Hero
result bool

CanKingdomBeDiscontinued(Kingdom, ref bool) 

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

Parameters

kingdom Kingdom
result bool

CanMoveToSettlement(Hero, ref bool) 

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

Parameters

hero Hero
result bool

CollectAvailableTutorials(ref List<CampaignTutorial>) 

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

Parameters

tutorials List<CampaignTutorial>

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

public virtual void CollectLoots(MapEvent mapEvent, PartyBase party, Dictionary<PartyBase, ItemRoster> loot, ItemRoster gainedLoot, MBList<TroopRosterElement> lootedCasualties, float lootAmount)

Parameters

mapEvent MapEvent
party PartyBase
loot Dictionary<PartyBase, ItemRoster>
gainedLoot ItemRoster
lootedCasualties MBList<TroopRosterElement>
lootAmount float

CraftingPartUnlocked(CraftingPiece) 

public virtual void CraftingPartUnlocked(CraftingPiece craftingPiece)

Parameters

craftingPiece CraftingPiece

DailyTick() 

public virtual void DailyTick()

DailyTickClan(Clan) 

public virtual void DailyTickClan(Clan clan)

Parameters

clan Clan

DailyTickHero(Hero) 

public virtual void DailyTickHero(Hero hero)

Parameters

hero Hero

DailyTickParty(MobileParty) 

public virtual void DailyTickParty(MobileParty mobileParty)

Parameters

mobileParty MobileParty

DailyTickSettlement(Settlement) 

public virtual void DailyTickSettlement(Settlement settlement)

Parameters

settlement Settlement

DailyTickTown(Town) 

public virtual void DailyTickTown(Town town)

Parameters

town Town

ForceSuppliesCompleted(BattleSideEnum, ForceSuppliesEventComponent) 

public virtual void ForceSuppliesCompleted(BattleSideEnum winnerSide, ForceSuppliesEventComponent forceSuppliesEvent)

Parameters

winnerSide BattleSideEnum
forceSuppliesEvent ForceSuppliesEventComponent

ForceVolunteersCompleted(BattleSideEnum, ForceVolunteersEventComponent) 

public virtual void ForceVolunteersCompleted(BattleSideEnum winnerSide, ForceVolunteersEventComponent forceVolunteersEvent)

Parameters

winnerSide BattleSideEnum
forceVolunteersEvent ForceVolunteersEventComponent

HourlyTick() 

public virtual void HourlyTick()

HourlyTickClan(Clan) 

public virtual void HourlyTickClan(Clan clan)

Parameters

clan Clan

HourlyTickParty(MobileParty) 

public virtual void HourlyTickParty(MobileParty mobileParty)

Parameters

mobileParty MobileParty

HourlyTickSettlement(Settlement) 

public virtual void HourlyTickSettlement(Settlement settlement)

Parameters

settlement Settlement

LocationCharactersAreReadyToSpawn(Dictionary<string, int>) 

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

Parameters

unusedUsablePointCount Dictionary<string, int>

LocationCharactersSimulated() 

public virtual void LocationCharactersSimulated()

MissionTick(float) 

public virtual void MissionTick(float dt)

Parameters

dt float

OnAfterMissionStarted(IMission) 

public virtual void OnAfterMissionStarted(IMission iMission)

Parameters

iMission IMission

OnAfterSessionStart(CampaignGameStarter) 

public virtual void OnAfterSessionStart(CampaignGameStarter campaignGameStarter)

Parameters

campaignGameStarter CampaignGameStarter

OnAfterSettlementEntered(MobileParty, Settlement, Hero) 

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

Parameters

party MobileParty
settlement Settlement
hero Hero

OnAgentJoinedConversation(IAgent) 

public virtual void OnAgentJoinedConversation(IAgent agent)

Parameters

agent IAgent

OnAlleyClearedByPlayer(Alley) 

public virtual void OnAlleyClearedByPlayer(Alley alley)

Parameters

alley Alley

OnAlleyOccupiedByPlayer(Alley, TroopRoster) 

public virtual void OnAlleyOccupiedByPlayer(Alley alley, TroopRoster troops)

Parameters

alley Alley
troops TroopRoster

OnAlleyOwnerChanged(Alley, Hero, Hero) 

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

Parameters

alley Alley
newOwner Hero
oldOwner Hero

OnArmyCreated(Army) 

public virtual void OnArmyCreated(Army army)

Parameters

army Army

OnArmyDispersed(Army, ArmyDispersionReason, bool) 

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

Parameters

army Army
reason Army.ArmyDispersionReason
isPlayersArmy bool

OnArmyGathered(Army, Settlement) 

public virtual void OnArmyGathered(Army army, Settlement gatheringSettlement)

Parameters

army Army
gatheringSettlement Settlement

OnArmyLeaderThink(Hero, ArmyLeaderThinkReason) 

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

Parameters

hero Hero
reason Army.ArmyLeaderThinkReason

OnArmyOverlaySetDirty() 

public virtual void OnArmyOverlaySetDirty()

OnBanditPartyRecruited(MobileParty) 

public virtual void OnBanditPartyRecruited(MobileParty banditParty)

Parameters

banditParty MobileParty

OnBarterAccepted(Hero, Hero, List<Barterable>) 

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

Parameters

offererHero Hero
otherHero Hero
barters List<Barterable>

OnBarterCanceled(Hero, Hero, List<Barterable>) 

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

Parameters

offererHero Hero
otherHero Hero
barters List<Barterable>

OnBarterablesRequested(BarterData) 

public virtual void OnBarterablesRequested(BarterData args)

Parameters

args BarterData

OnBeforeHeroKilled(Hero, Hero, KillCharacterActionDetail, bool) 

public virtual 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 virtual 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 virtual void OnBeforePlayerCharacterChanged(Hero oldPlayer, Hero newPlayer)

Parameters

oldPlayer Hero
newPlayer Hero

OnBeforeSave() 

public virtual void OnBeforeSave()

OnBuildingLevelChanged(Town, Building, int) 

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

Parameters

town Town
building Building
levelChange int

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

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

Parameters

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

OnCharacterBecameFugitive(Hero) 

public virtual void OnCharacterBecameFugitive(Hero hero)

Parameters

hero Hero

OnCharacterCreationIsOver() 

public virtual void OnCharacterCreationIsOver()

OnCharacterDefeated(Hero, Hero) 

public virtual void OnCharacterDefeated(Hero winner, Hero loser)

Parameters

winner Hero
loser Hero

OnCharacterPortraitPopUpClosed() 

public virtual void OnCharacterPortraitPopUpClosed()

OnCharacterPortraitPopUpOpened(CharacterObject) 

public virtual void OnCharacterPortraitPopUpOpened(CharacterObject character)

Parameters

character CharacterObject

OnCheckForIssue(Hero) 

public virtual void OnCheckForIssue(Hero hero)

Parameters

hero Hero

OnChildConceived(Hero) 

public virtual void OnChildConceived(Hero mother)

Parameters

mother Hero

OnChildEducationCompleted(Hero, int) 

public virtual void OnChildEducationCompleted(Hero hero, int age)

Parameters

hero Hero
age int

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

public virtual 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 virtual void OnClanDestroyed(Clan destroyedClan)

Parameters

destroyedClan Clan

OnClanInfluenceChanged(Clan, float) 

public virtual void OnClanInfluenceChanged(Clan clan, float change)

Parameters

clan Clan
change float

OnClanLeaderChanged(Hero, Hero) 

public virtual void OnClanLeaderChanged(Hero oldLeader, Hero newLeader)

Parameters

oldLeader Hero
newLeader Hero

OnClanTierChanged(Clan, bool) 

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

Parameters

clan Clan
shouldNotify bool

OnCommonAreaStateChanged(Alley, AreaState, AreaState) 

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

Parameters

alley Alley
oldState Alley.AreaState
newState Alley.AreaState

OnCompanionClanCreated(Clan) 

public virtual void OnCompanionClanCreated(Clan clan)

Parameters

clan Clan

OnCompanionRemoved(Hero, RemoveCompanionDetail) 

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

Parameters

companion Hero
detail RemoveCompanionAction.RemoveCompanionDetail

OnConfigChanged() 

public virtual void OnConfigChanged()

OnConversationEnded(IEnumerable<CharacterObject>) 

public virtual void OnConversationEnded(IEnumerable<CharacterObject> characters)

Parameters

characters IEnumerable<CharacterObject>

OnCraftingOrderCompleted(Town, CraftingOrder, ItemObject, Hero) 

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

Parameters

town Town
craftingOrder CraftingOrder
craftedItem ItemObject
completerHero Hero

OnCrimeRatingChanged(IFaction, float) 

public virtual void OnCrimeRatingChanged(IFaction kingdom, float deltaCrimeAmount)

Parameters

kingdom IFaction
deltaCrimeAmount float

OnEquipmentSmeltedByHero(Hero, EquipmentElement) 

public virtual void OnEquipmentSmeltedByHero(Hero hero, EquipmentElement equipmentElement)

Parameters

hero Hero
equipmentElement EquipmentElement

OnGameEarlyLoaded(CampaignGameStarter) 

public virtual void OnGameEarlyLoaded(CampaignGameStarter campaignGameStarter)

Parameters

campaignGameStarter CampaignGameStarter

OnGameLoadFinished() 

public virtual void OnGameLoadFinished()

OnGameLoaded(CampaignGameStarter) 

public virtual void OnGameLoaded(CampaignGameStarter campaignGameStarter)

Parameters

campaignGameStarter CampaignGameStarter

OnGameMenuOpened(MenuCallbackArgs) 

public virtual void OnGameMenuOpened(MenuCallbackArgs args)

Parameters

args MenuCallbackArgs

OnGameMenuOptionSelected(GameMenuOption) 

public virtual void OnGameMenuOptionSelected(GameMenuOption gameMenuOption)

Parameters

gameMenuOption GameMenuOption

OnGameOver() 

public virtual void OnGameOver()

OnGivenBirth(Hero, List<Hero>, int) 

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

Parameters

mother Hero
aliveChildren List<Hero>
stillbornCount int

OnGovernorChanged(Town, Hero, Hero) 

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

Parameters

fortification Town
oldGovernor Hero
newGovernor Hero

OnHeroChangedClan(Hero, Clan) 

public virtual void OnHeroChangedClan(Hero hero, Clan oldClan)

Parameters

hero Hero
oldClan Clan

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

public virtual 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 virtual void OnHeroComesOfAge(Hero hero)

Parameters

hero Hero

OnHeroCreated(Hero, bool) 

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

Parameters

hero Hero
isBornNaturally bool

OnHeroGainedSkill(Hero, SkillObject, int, bool) 

public virtual 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 virtual void OnHeroGetsBusy(Hero hero, HeroGetsBusyReasons heroGetsBusyReason)

Parameters

hero Hero
heroGetsBusyReason HeroGetsBusyReasons

OnHeroGrowsOutOfInfancy(Hero) 

public virtual void OnHeroGrowsOutOfInfancy(Hero hero)

Parameters

hero Hero

OnHeroJoinedParty(Hero, MobileParty) 

public virtual void OnHeroJoinedParty(Hero hero, MobileParty mobileParty)

Parameters

hero Hero
mobileParty MobileParty

OnHeroKilled(Hero, Hero, KillCharacterActionDetail, bool) 

public virtual 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 virtual void OnHeroLevelledUp(Hero hero, bool shouldNotify = true)

Parameters

hero Hero
shouldNotify bool

OnHeroOccupationChanged(Hero, Occupation) 

public virtual void OnHeroOccupationChanged(Hero hero, Occupation oldOccupation)

Parameters

hero Hero
oldOccupation Occupation

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

public virtual 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 virtual 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 virtual void OnHeroPrisonerReleased(Hero prisoner, PartyBase party, IFaction capturerFaction, EndCaptivityDetail detail)

Parameters

prisoner Hero
party PartyBase
capturerFaction IFaction
detail EndCaptivityDetail

OnHeroPrisonerTaken(PartyBase, Hero) 

public virtual void OnHeroPrisonerTaken(PartyBase capturer, Hero prisoner)

Parameters

capturer PartyBase
prisoner Hero

OnHeroReachesTeenAge(Hero) 

public virtual void OnHeroReachesTeenAge(Hero hero)

Parameters

hero Hero

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

public virtual 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 virtual void OnHeroSharedFoodWithAnother(Hero supporterHero, Hero supportedHero, float influence)

Parameters

supporterHero Hero
supportedHero Hero
influence float

OnHeroTeleportationRequested(Hero, Settlement, MobileParty, TeleportationDetail) 

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

Parameters

hero Hero
targetSettlement Settlement
targetParty MobileParty
detail TeleportHeroAction.TeleportationDetail

OnHeroUnregistered(Hero) 

public virtual void OnHeroUnregistered(Hero hero)

Parameters

hero Hero

OnHeroWounded(Hero) 

public virtual void OnHeroWounded(Hero woundedHero)

Parameters

woundedHero Hero

OnHeroesMarried(Hero, Hero, bool) 

public virtual void OnHeroesMarried(Hero hero1, Hero hero2, bool showNotification = true)

Parameters

hero1 Hero
hero2 Hero
showNotification bool

OnHideoutBattleCompleted(BattleSideEnum, HideoutEventComponent) 

public virtual void OnHideoutBattleCompleted(BattleSideEnum winnerSide, HideoutEventComponent hideoutEventComponent)

Parameters

winnerSide BattleSideEnum
hideoutEventComponent HideoutEventComponent

OnHideoutDeactivated(Settlement) 

public virtual void OnHideoutDeactivated(Settlement hideout)

Parameters

hideout Settlement

OnHideoutSpotted(PartyBase, PartyBase) 

public virtual void OnHideoutSpotted(PartyBase party, PartyBase hideoutParty)

Parameters

party PartyBase
hideoutParty PartyBase

OnIssueLogAdded(IssueBase, bool) 

public virtual void OnIssueLogAdded(IssueBase issue, bool hideInformation)

Parameters

issue IssueBase
hideInformation bool

OnIssueOwnerChanged(IssueBase, Hero) 

public virtual void OnIssueOwnerChanged(IssueBase issue, Hero oldOwner)

Parameters

issue IssueBase
oldOwner Hero

OnIssueUpdated(IssueBase, IssueUpdateDetails, Hero) 

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

Parameters

issue IssueBase
details IssueBase.IssueUpdateDetails
issueSolver Hero

OnItemConsumed(ItemObject, Settlement, int) 

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

Parameters

itemObject ItemObject
settlement Settlement
count int

OnItemProduced(ItemObject, Settlement, int) 

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

Parameters

itemObject ItemObject
settlement Settlement
count int

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

public virtual 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 virtual void OnItemsDiscardedByPlayer(ItemRoster roster)

Parameters

roster ItemRoster

OnItemsLooted(MobileParty, ItemRoster) 

public virtual void OnItemsLooted(MobileParty mobileParty, ItemRoster items)

Parameters

mobileParty MobileParty
items ItemRoster

OnItemsRefined(Hero, RefiningFormula) 

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

Parameters

hero Hero
refineFormula Crafting.RefiningFormula

OnKingdomCreated(Kingdom) 

public virtual void OnKingdomCreated(Kingdom createdKingdom)

Parameters

createdKingdom Kingdom

OnKingdomDecisionAdded(KingdomDecision, bool) 

public virtual void OnKingdomDecisionAdded(KingdomDecision decision, bool isPlayerInvolved)

Parameters

decision KingdomDecision
isPlayerInvolved bool

OnKingdomDecisionCancelled(KingdomDecision, bool) 

public virtual void OnKingdomDecisionCancelled(KingdomDecision decision, bool isPlayerInvolved)

Parameters

decision KingdomDecision
isPlayerInvolved bool

OnKingdomDecisionConcluded(KingdomDecision, DecisionOutcome, bool) 

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

Parameters

decision KingdomDecision
chosenOutcome DecisionOutcome
isPlayerInvolved bool

OnKingdomDestroyed(Kingdom) 

public virtual void OnKingdomDestroyed(Kingdom kingdom)

Parameters

kingdom Kingdom

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

public virtual void OnLootDistributedToParty(MapEvent mapEvent, PartyBase party, Dictionary<PartyBase, ItemRoster> loot)

Parameters

mapEvent MapEvent
party PartyBase
loot Dictionary<PartyBase, ItemRoster>

OnMainPartyPrisonerRecruited(FlattenedTroopRoster) 

public virtual void OnMainPartyPrisonerRecruited(FlattenedTroopRoster roster)

Parameters

roster FlattenedTroopRoster

OnMainPartyStarving() 

public virtual void OnMainPartyStarving()

OnMakePeace(IFaction, IFaction, MakePeaceDetail) 

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

Parameters

side1Faction IFaction
side2Faction IFaction
detail MakePeaceAction.MakePeaceDetail

OnMapEventContinuityNeedsUpdate(IFaction) 

public virtual void OnMapEventContinuityNeedsUpdate(IFaction faction)

Parameters

faction IFaction

OnMapEventEnded(MapEvent) 

public virtual void OnMapEventEnded(MapEvent mapEvent)

Parameters

mapEvent MapEvent

OnMapEventStarted(MapEvent, PartyBase, PartyBase) 

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

Parameters

mapEvent MapEvent
attackerParty PartyBase
defenderParty PartyBase

OnMarriageOfferCanceled(Hero, Hero) 

public virtual void OnMarriageOfferCanceled(Hero suitor, Hero maiden)

Parameters

suitor Hero
maiden Hero

OnMarriageOfferedToPlayer(Hero, Hero) 

public virtual void OnMarriageOfferedToPlayer(Hero suitor, Hero maiden)

Parameters

suitor Hero
maiden Hero

OnMercenaryNumberChangedInTown(Town, int, int) 

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

Parameters

town Town
oldNumber int
newNumber int

OnMercenaryTroopChangedInTown(Town, CharacterObject, CharacterObject) 

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

Parameters

town Town
oldTroopType CharacterObject
newTroopType CharacterObject

OnMissionEnded(IMission) 

public virtual void OnMissionEnded(IMission mission)

Parameters

mission IMission

OnMissionStarted(IMission) 

public virtual void OnMissionStarted(IMission mission)

Parameters

mission IMission

OnMobilePartyCreated(MobileParty) 

public virtual void OnMobilePartyCreated(MobileParty party)

Parameters

party MobileParty

OnMobilePartyDestroyed(MobileParty, PartyBase) 

public virtual void OnMobilePartyDestroyed(MobileParty mobileParty, PartyBase destroyerParty)

Parameters

mobileParty MobileParty
destroyerParty PartyBase

OnMobilePartyQuestStatusChanged(MobileParty, bool) 

public virtual void OnMobilePartyQuestStatusChanged(MobileParty party, bool isUsedByQuest)

Parameters

party MobileParty
isUsedByQuest bool

OnNearbyPartyAddedToPlayerMapEvent(MobileParty) 

public virtual void OnNearbyPartyAddedToPlayerMapEvent(MobileParty mobileParty)

Parameters

mobileParty MobileParty

OnNewCompanionAdded(Hero) 

public virtual void OnNewCompanionAdded(Hero newCompanion)

Parameters

newCompanion Hero

OnNewGameCreated(CampaignGameStarter) 

public virtual void OnNewGameCreated(CampaignGameStarter campaignGameStarter)

Parameters

campaignGameStarter CampaignGameStarter

OnNewIssueCreated(IssueBase) 

public virtual void OnNewIssueCreated(IssueBase issue)

Parameters

issue IssueBase

OnNewItemCrafted(ItemObject) 

public virtual void OnNewItemCrafted(ItemObject itemObject)

Parameters

itemObject ItemObject

OnNewItemCrafted(ItemObject, ItemModifier, bool) 

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

Parameters

itemObject ItemObject
overriddenItemModifier ItemModifier
isCraftingOrderItem bool

OnPartyAttachedAnotherParty(MobileParty) 

public virtual void OnPartyAttachedAnotherParty(MobileParty mobileParty)

Parameters

mobileParty MobileParty

OnPartyConsumedFood(MobileParty) 

public virtual void OnPartyConsumedFood(MobileParty party)

Parameters

party MobileParty

OnPartyDisbandCanceled(MobileParty) 

public virtual void OnPartyDisbandCanceled(MobileParty disbandParty)

Parameters

disbandParty MobileParty

OnPartyDisbandStarted(MobileParty) 

public virtual void OnPartyDisbandStarted(MobileParty disbandParty)

Parameters

disbandParty MobileParty

OnPartyDisbanded(MobileParty, Settlement) 

public virtual void OnPartyDisbanded(MobileParty disbandParty, Settlement relatedSettlement)

Parameters

disbandParty MobileParty
relatedSettlement Settlement

OnPartyJoinedArmy(MobileParty) 

public virtual void OnPartyJoinedArmy(MobileParty mobileParty)

Parameters

mobileParty MobileParty

OnPartyLeaderChangeOfferCanceled(MobileParty) 

public virtual void OnPartyLeaderChangeOfferCanceled(MobileParty party)

Parameters

party MobileParty

OnPartyRemoved(PartyBase) 

public virtual void OnPartyRemoved(PartyBase party)

Parameters

party PartyBase

OnPartyRemovedFromArmy(MobileParty) 

public virtual void OnPartyRemovedFromArmy(MobileParty mobileParty)

Parameters

mobileParty MobileParty

OnPartySizeChanged(PartyBase) 

public virtual void OnPartySizeChanged(PartyBase party)

Parameters

party PartyBase

OnPartyVisibilityChanged(PartyBase) 

public virtual void OnPartyVisibilityChanged(PartyBase party)

Parameters

party PartyBase

OnPeaceOfferCancelled(IFaction) 

public virtual void OnPeaceOfferCancelled(IFaction opponentFaction)

Parameters

opponentFaction IFaction

OnPeaceOfferedToPlayer(IFaction, int) 

public virtual void OnPeaceOfferedToPlayer(IFaction opponentFaction, int tributeAmount)

Parameters

opponentFaction IFaction
tributeAmount int

OnPerkOpened(Hero, PerkObject) 

public virtual void OnPerkOpened(Hero hero, PerkObject perk)

Parameters

hero Hero
perk PerkObject

OnPersuasionProgressCommitted(Tuple<PersuasionOptionArgs, PersuasionOptionResult>) 

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

Parameters

progress Tuple<PersuasionOptionArgs, PersuasionOptionResult>

OnPlayerBattleEnd(MapEvent) 

public virtual void OnPlayerBattleEnd(MapEvent mapEvent)

Parameters

mapEvent MapEvent

OnPlayerBoardGameOver(Hero, BoardGameState) 

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

Parameters

opposingHero Hero
state BoardGameHelper.BoardGameState

OnPlayerBodyPropertiesChanged() 

public virtual void OnPlayerBodyPropertiesChanged()

OnPlayerCharacterChanged(Hero, Hero, MobileParty, bool) 

public virtual void OnPlayerCharacterChanged(Hero oldPlayer, Hero newPlayer, MobileParty newMainParty, bool isMainPartyChanged)

Parameters

oldPlayer Hero
newPlayer Hero
newMainParty MobileParty
isMainPartyChanged bool

OnPlayerDesertedBattle(int) 

public virtual void OnPlayerDesertedBattle(int sacrificedMenCount)

Parameters

sacrificedMenCount int

OnPlayerEarnedGoldFromAsset(AssetIncomeType, int) 

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

Parameters

incomeType DefaultClanFinanceModel.AssetIncomeType
incomeAmount int

OnPlayerEliminatedFromTournament(int, Town) 

public virtual void OnPlayerEliminatedFromTournament(int round, Town town)

Parameters

round int
town Town

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

public virtual 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 virtual void OnPlayerJoinedTournament(Town town, bool isParticipant)

Parameters

town Town
isParticipant bool

OnPlayerLearnsAboutHero(Hero) 

public virtual void OnPlayerLearnsAboutHero(Hero hero)

Parameters

hero Hero

OnPlayerMetHero(Hero) 

public virtual void OnPlayerMetHero(Hero hero)

Parameters

hero Hero

OnPlayerPartyKnockedOrKilledTroop(CharacterObject) 

public virtual void OnPlayerPartyKnockedOrKilledTroop(CharacterObject strikedTroop)

Parameters

strikedTroop CharacterObject

OnPlayerSiegeStarted() 

public virtual void OnPlayerSiegeStarted()

OnPlayerStartRecruitment(CharacterObject) 

public virtual void OnPlayerStartRecruitment(CharacterObject recruitTroopCharacter)

Parameters

recruitTroopCharacter CharacterObject

OnPlayerStartTalkFromMenu(Hero) 

public virtual void OnPlayerStartTalkFromMenu(Hero hero)

Parameters

hero Hero

OnPlayerStartedTournamentMatch(Town) 

public virtual void OnPlayerStartedTournamentMatch(Town town)

Parameters

town Town

OnPlayerTradeProfit(int) 

public virtual void OnPlayerTradeProfit(int profit)

Parameters

profit int

OnPlayerTraitChanged(TraitObject, int) 

public virtual void OnPlayerTraitChanged(TraitObject trait, int previousLevel)

Parameters

trait TraitObject
previousLevel int

OnPlayerUpgradedTroops(CharacterObject, CharacterObject, int) 

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

Parameters

upgradeFromTroop CharacterObject
upgradeToTroop CharacterObject
number int

OnPrisonerDonatedToSettlement(MobileParty, FlattenedTroopRoster, Settlement) 

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

Parameters

donatingParty MobileParty
donatedPrisoners FlattenedTroopRoster
donatedSettlement Settlement

OnPrisonerReleased(FlattenedTroopRoster) 

public virtual void OnPrisonerReleased(FlattenedTroopRoster roster)

Parameters

roster FlattenedTroopRoster

OnPrisonerSold(PartyBase, PartyBase, TroopRoster) 

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

Parameters

sellerParty PartyBase
buyerParty PartyBase
prisoners TroopRoster

OnPrisonerTaken(FlattenedTroopRoster) 

public virtual void OnPrisonerTaken(FlattenedTroopRoster roster)

Parameters

roster FlattenedTroopRoster

OnPrisonersChangeInSettlement(Settlement, FlattenedTroopRoster, Hero, bool) 

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

Parameters

settlement Settlement
prisonerRoster FlattenedTroopRoster
prisonerHero Hero
takenFromDungeon bool

OnQuestCompleted(QuestBase, QuestCompleteDetails) 

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

Parameters

quest QuestBase
detail QuestBase.QuestCompleteDetails

OnQuestLogAdded(QuestBase, bool) 

public virtual void OnQuestLogAdded(QuestBase quest, bool hideInformation)

Parameters

quest QuestBase
hideInformation bool

OnQuestStarted(QuestBase) 

public virtual void OnQuestStarted(QuestBase quest)

Parameters

quest QuestBase

OnRansomOfferCancelled(Hero) 

public virtual void OnRansomOfferCancelled(Hero captiveHero)

Parameters

captiveHero Hero

OnRansomOfferedToPlayer(Hero) 

public virtual void OnRansomOfferedToPlayer(Hero captiveHero)

Parameters

captiveHero Hero

OnRebellionFinished(Settlement, Clan) 

public virtual void OnRebellionFinished(Settlement settlement, Clan oldOwnerClan)

Parameters

settlement Settlement
oldOwnerClan Clan

OnRebelliousClanDisbandedAtSettlement(Settlement, Clan) 

public virtual void OnRebelliousClanDisbandedAtSettlement(Settlement settlement, Clan clan)

Parameters

settlement Settlement
clan Clan

OnRenownGained(Hero, int, bool) 

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

Parameters

hero Hero
gainedRenown int
doNotNotify bool

OnRomanticStateChanged(Hero, Hero, RomanceLevelEnum) 

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

Parameters

hero1 Hero
hero2 Hero
romanceLevel Romance.RomanceLevelEnum

OnRulingClanChanged(Kingdom, Clan) 

public virtual void OnRulingClanChanged(Kingdom kingdom, Clan newRulingClan)

Parameters

kingdom Kingdom
newRulingClan Clan

OnSaveOver(bool, string) 

public virtual void OnSaveOver(bool isSuccessful, string saveName)

Parameters

isSuccessful bool
saveName string

OnSaveStarted() 

public virtual void OnSaveStarted()

OnSessionStart(CampaignGameStarter) 

public virtual void OnSessionStart(CampaignGameStarter campaignGameStarter)

Parameters

campaignGameStarter CampaignGameStarter

OnSettlementEntered(MobileParty, Settlement, Hero) 

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

Parameters

party MobileParty
settlement Settlement
hero Hero

OnSettlementLeft(MobileParty, Settlement) 

public virtual void OnSettlementLeft(MobileParty party, Settlement settlement)

Parameters

party MobileParty
settlement Settlement

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

public virtual 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 virtual 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 virtual 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 virtual 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 virtual void OnSiegeEngineDestroyed(MobileParty besiegerParty, Settlement besiegedSettlement, BattleSideEnum side, SiegeEngineType destroyedEngine)

Parameters

besiegerParty MobileParty
besiegedSettlement Settlement
side BattleSideEnum
destroyedEngine SiegeEngineType

OnSiegeEventEnded(SiegeEvent) 

public virtual void OnSiegeEventEnded(SiegeEvent siegeEvent)

Parameters

siegeEvent SiegeEvent

OnSiegeEventStarted(SiegeEvent) 

public virtual void OnSiegeEventStarted(SiegeEvent siegeEvent)

Parameters

siegeEvent SiegeEvent

OnStartBattle(PartyBase, PartyBase, object, bool) 

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

Parameters

attackerParty PartyBase
defenderParty PartyBase
subject object
showNotification bool

OnTournamentCancelled(Town) 

public virtual void OnTournamentCancelled(Town town)

Parameters

town Town

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

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

Parameters

winner CharacterObject
participants MBReadOnlyList<CharacterObject>
town Town
prize ItemObject

OnTournamentStarted(Town) 

public virtual void OnTournamentStarted(Town town)

Parameters

town Town

OnTradeRumorIsTaken(List<TradeRumor>, Settlement) 

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

Parameters

newRumors List<TradeRumor>
sourceSettlement Settlement

OnTroopGivenToSettlement(Hero, Settlement, TroopRoster) 

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

Parameters

giverHero Hero
recipientSettlement Settlement
roster TroopRoster

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

public virtual 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 virtual void OnTroopsDeserted(MobileParty mobileParty, TroopRoster desertedTroops)

Parameters

mobileParty MobileParty
desertedTroops TroopRoster

OnTutorialCompleted(string) 

public virtual void OnTutorialCompleted(string tutorial)

Parameters

tutorial string

OnUnitRecruited(CharacterObject, int) 

public virtual void OnUnitRecruited(CharacterObject character, int amount)

Parameters

character CharacterObject
amount int

OnVassalOrMercenaryServiceOfferCanceled(Kingdom) 

public virtual void OnVassalOrMercenaryServiceOfferCanceled(Kingdom offeredKingdom)

Parameters

offeredKingdom Kingdom

OnVassalOrMercenaryServiceOfferedToPlayer(Kingdom) 

public virtual void OnVassalOrMercenaryServiceOfferedToPlayer(Kingdom offeredKingdom)

Parameters

offeredKingdom Kingdom

OnVillageBecomeNormal(Village) 

public virtual void OnVillageBecomeNormal(Village village)

Parameters

village Village

OnVillageBeingRaided(Village) 

public virtual void OnVillageBeingRaided(Village village)

Parameters

village Village

OnVillageLooted(Village) 

public virtual void OnVillageLooted(Village village)

Parameters

village Village

OnVillageStateChanged(Village, VillageStates, VillageStates, MobileParty) 

public virtual 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 virtual void OnWarDeclared(IFaction faction1, IFaction faction2, DeclareWarAction.DeclareWarDetail declareWarDetail)

Parameters

faction1 IFaction
faction2 IFaction
declareWarDetail DeclareWarAction.DeclareWarDetail

OnWorkshopInitialized(Workshop) 

public virtual void OnWorkshopInitialized(Workshop workshop)

Parameters

workshop Workshop

OnWorkshopOwnerChanged(Workshop, Hero) 

public virtual void OnWorkshopOwnerChanged(Workshop workshop, Hero oldOwner)

Parameters

workshop Workshop
oldOwner Hero

OnWorkshopTypeChanged(Workshop) 

public virtual void OnWorkshopTypeChanged(Workshop workshop)

Parameters

workshop Workshop

QuarterDailyPartyTick(MobileParty) 

public virtual void QuarterDailyPartyTick(MobileParty party)

Parameters

party MobileParty

RaidCompleted(BattleSideEnum, RaidEventComponent) 

public virtual void RaidCompleted(BattleSideEnum winnerSide, RaidEventComponent raidEvent)

Parameters

winnerSide BattleSideEnum
raidEvent RaidEventComponent

RemoveListeners(object) 

public virtual void RemoveListeners(object o)

Parameters

o object

SiegeCompleted(Settlement, MobileParty, bool, BattleTypes) 

public virtual 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 virtual void SiegeEngineBuilt(SiegeEvent siegeEvent, BattleSideEnum side, SiegeEngineType siegeEngine)

Parameters

siegeEvent SiegeEvent
side BattleSideEnum
siegeEngine SiegeEngineType

Tick(float) 

public virtual void Tick(float dt)

Parameters

dt float

TickPartialHourlyAi(MobileParty) 

public virtual void TickPartialHourlyAi(MobileParty party)

Parameters

party MobileParty

TownRebelliousStateChanged(Town, bool) 

public virtual void TownRebelliousStateChanged(Town town, bool rebelliousState)

Parameters

town Town
rebelliousState bool

TrackDetected(Track) 

public virtual void TrackDetected(Track track)

Parameters

track Track

TrackLost(Track) 

public virtual void TrackLost(Track track)

Parameters

track Track

WeeklyTick() 

public virtual void WeeklyTick()

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