M&B: Bannerlord 1.0.3
The horns sound, the ravens gather.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
TaleWorlds.CampaignSystem.Encounters.PlayerEncounter Class Reference

PlayerEncounter keeps track of information about encounters player faced.

Public Member Functions

void OnLoad ()
 
void SetupFields (PartyBase attackerParty, PartyBase defenderParty)
 
void SetPlayerSiegeInterruptedByEnemyDefection ()
 
void SetPlayerEncounterInterruptedByPeace ()
 
void ResetPlayerEncounterInterruptedByPeace ()
 
void RemoveRandomTroops (int num, TroopRoster sacrifiedTroops)
 
bool CheckIfBattleShouldContinueAfterBattleMission ()
 
void FinalizeBattle ()
 
void FindNonAttachedNpcPartiesWhoWillJoinEvent (ref List< MobileParty > partiesToJoinPlayerSide, ref List< MobileParty > partiesToJoinEnemySide)
 Populates the lists for each side only with base mobile parties - excluding their attached parties. Nearby party search does not include main party.
 
void FindAllNpcPartiesWhoWillJoinEvent (ref List< MobileParty > partiesToJoinPlayerSide, ref List< MobileParty > partiesToJoinEnemySide)
 Populates the lists for each side with the mobile parties in the area and their attached parties. Nearby party search does not include main party.
 
void InterruptEncounter (string encounterInterrupedType)
 
void FinishRaid ()
 
float GetPlayerStrengthRatioInEncounter ()
 

Static Public Member Functions

static void RestartPlayerEncounter (PartyBase defenderParty, PartyBase attackerParty, bool forcePlayerOutFromSettlement=true)
 
static void Init ()
 
static string GetBattleSceneForMapPatch (MapPatchData mapPatch)
 
static string GetConversationSceneForMapPosition (Vec2 position2D)
 
static MapEvent StartBattle ()
 
static void JoinBattle (BattleSideEnum side)
 
static void Start ()
 
static void ProtectPlayerSide (float hoursToProtect=1.0f)
 
static void Finish (bool forcePlayerOutFromSettlement=true)
 
static void EndBattleByCheat (bool playerWon)
 
static void Update ()
 
static void DoMeeting ()
 
static void SetMeetingDone ()
 
static bool CheckIfLeadingAvaliable ()
 
static Hero GetLeadingHero ()
 
static void SetPlayerVictorious ()
 Set player side as winner of map event. Sometimes, this may be needed if all enemies are not dispatched (battle is too big, etc.)
 
static void SetPlayerSiegeContinueWithDefenderPullBack ()
 
static void StartAttackMission ()
 
static void SacrificeTroops (int num, out TroopRoster losses, out ItemRoster lostBaggage)
 
static void EnterSettlement ()
 
static void LeaveBattle ()
 
static void LeaveSettlement ()
 
static void InitSimulation ()
 
static void StartVillageBattleMission ()
 
static void StartAlleyFightMission ()
 
static void StartCombatMissionWithDialogueInTownCenter (CharacterObject characterToTalkTo, CharacterObject allyTroopsWithFixedTeam)
 
static void StartHostileAction ()
 
static void GetBattleRewards (out float renownChange, out float influenceChange, out float moraleChange, out float goldChange, out float playerEarnedLootPercentage, ref ExplainedNumber renownExplainedNumber, ref ExplainedNumber influenceExplainedNumber, ref ExplainedNumber moraleExplainedNumber)
 

Public Attributes

bool FirstInit = true
 
bool IsEnemy
 
float PlayerPartyInitialStrength
 
float PartiesStrengthRatioBeforePlayerJoin = 0.0f
 
bool ForceRaid
 
bool ForceSallyOut
 
bool ForceAlleyFight
 
bool ForceVolunteers
 
bool ForceSupplies
 
BattleSimulation BattleSimulation
 

Static Public Attributes

static bool EncounteredPartySurrendered = false
 
const float JoiningRadius = 3.0f
 

Properties

static PlayerEncounter Current [get]
 
static LocationEncounter LocationEncounter [get, set]
 
static MapEvent Battle [get]
 
static PartyBase EncounteredParty [get]
 
static MobileParty EncounteredMobileParty [get]
 
static MapEvent EncounteredBattle [get]
 
static BattleState BattleState [get]
 
static BattleSideEnum WinningSide [get]
 
static bool BattleChallenge [get, set]
 
static bool PlayerIsDefender [get]
 
static bool PlayerIsAttacker [get]
 
static bool LeaveEncounter [get, set]
 
static bool MeetingDone [get]
 
static bool PlayerSurrender [get, set]
 
static bool EnemySurrender [get, set]
 
static bool IsActive [get]
 
BattleSideEnum OpponentSide [get]
 
BattleSideEnum PlayerSide [get]
 
bool IsJoinedBattle [get]
 
static bool InsideSettlement [get]
 
static CampaignBattleResult CampaignBattleResult [get, set]
 
bool IsPlayerEncounterInterruptedByPeace [get]
 
static BattleSimulation CurrentBattleSimulation [get]
 
PlayerEncounterState EncounterState [get]
 
ItemRoster RosterToReceiveLootItems [get]
 
TroopRoster RosterToReceiveLootPrisoners [get]
 
TroopRoster RosterToReceiveLootMembers [get]
 
static Settlement EncounterSettlement [get]
 
Settlement EncounterSettlementAux [get]
 
bool IsPlayerWaiting [get, set]
 

Member Function Documentation

◆ OnLoad()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.OnLoad ( )

◆ RestartPlayerEncounter()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.RestartPlayerEncounter ( PartyBase  defenderParty,
PartyBase  attackerParty,
bool  forcePlayerOutFromSettlement = true 
)
static

◆ Init()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.Init ( )
static

◆ SetupFields()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.SetupFields ( PartyBase  attackerParty,
PartyBase  defenderParty 
)

◆ GetBattleSceneForMapPatch()

static string TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.GetBattleSceneForMapPatch ( MapPatchData  mapPatch)
static

◆ GetConversationSceneForMapPosition()

static string TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.GetConversationSceneForMapPosition ( Vec2  position2D)
static

◆ StartBattle()

static MapEvent TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.StartBattle ( )
static

◆ JoinBattle()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.JoinBattle ( BattleSideEnum  side)
static

◆ Start()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.Start ( )
static

◆ ProtectPlayerSide()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.ProtectPlayerSide ( float  hoursToProtect = 1::0f)
static

◆ Finish()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.Finish ( bool  forcePlayerOutFromSettlement = true)
static

◆ EndBattleByCheat()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.EndBattleByCheat ( bool  playerWon)
static

◆ Update()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.Update ( )
static

◆ DoMeeting()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.DoMeeting ( )
static

◆ SetMeetingDone()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.SetMeetingDone ( )
static

◆ CheckIfLeadingAvaliable()

static bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.CheckIfLeadingAvaliable ( )
static

◆ GetLeadingHero()

static Hero TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.GetLeadingHero ( )
static

◆ SetPlayerVictorious()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.SetPlayerVictorious ( )
static

◆ SetPlayerSiegeInterruptedByEnemyDefection()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.SetPlayerSiegeInterruptedByEnemyDefection ( )

◆ SetPlayerEncounterInterruptedByPeace()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.SetPlayerEncounterInterruptedByPeace ( )

◆ ResetPlayerEncounterInterruptedByPeace()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.ResetPlayerEncounterInterruptedByPeace ( )

◆ SetPlayerSiegeContinueWithDefenderPullBack()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.SetPlayerSiegeContinueWithDefenderPullBack ( )
static

◆ StartAttackMission()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.StartAttackMission ( )
static

◆ SacrificeTroops()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.SacrificeTroops ( int  num,
out TroopRoster  losses,
out ItemRoster  lostBaggage 
)
static

◆ RemoveRandomTroops()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.RemoveRandomTroops ( int  num,
TroopRoster  sacrifiedTroops 
)

◆ CheckIfBattleShouldContinueAfterBattleMission()

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.CheckIfBattleShouldContinueAfterBattleMission ( )

◆ FinalizeBattle()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.FinalizeBattle ( )

◆ FindNonAttachedNpcPartiesWhoWillJoinEvent()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.FindNonAttachedNpcPartiesWhoWillJoinEvent ( ref List< MobileParty >  partiesToJoinPlayerSide,
ref List< MobileParty >  partiesToJoinEnemySide 
)
Parameters
partiesToJoinPlayerSideReturns all non-attached ally parties in map event including nearby ones that will join
partiesToJoinEnemySideReturns all non-attached enemy parties in map event including nearby ones that will join

◆ FindAllNpcPartiesWhoWillJoinEvent()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.FindAllNpcPartiesWhoWillJoinEvent ( ref List< MobileParty >  partiesToJoinPlayerSide,
ref List< MobileParty >  partiesToJoinEnemySide 
)
Parameters
partiesToJoinPlayerSideReturns all ally parties in map event including attached parties and nearby ones that will join
partiesToJoinEnemySideReturns all enemy parties in map event including attached parties and nearby ones that will join

◆ EnterSettlement()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.EnterSettlement ( )
static

◆ LeaveBattle()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.LeaveBattle ( )
static

◆ LeaveSettlement()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.LeaveSettlement ( )
static

◆ InitSimulation()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.InitSimulation ( )
static

◆ InterruptEncounter()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.InterruptEncounter ( string  encounterInterrupedType)

◆ StartVillageBattleMission()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.StartVillageBattleMission ( )
static

◆ StartAlleyFightMission()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.StartAlleyFightMission ( )
static

◆ StartCombatMissionWithDialogueInTownCenter()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.StartCombatMissionWithDialogueInTownCenter ( CharacterObject  characterToTalkTo,
CharacterObject  allyTroopsWithFixedTeam 
)
static

◆ StartHostileAction()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.StartHostileAction ( )
static

◆ FinishRaid()

void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.FinishRaid ( )

◆ GetBattleRewards()

static void TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.GetBattleRewards ( out float  renownChange,
out float  influenceChange,
out float  moraleChange,
out float  goldChange,
out float  playerEarnedLootPercentage,
ref ExplainedNumber  renownExplainedNumber,
ref ExplainedNumber  influenceExplainedNumber,
ref ExplainedNumber  moraleExplainedNumber 
)
static

◆ GetPlayerStrengthRatioInEncounter()

float TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.GetPlayerStrengthRatioInEncounter ( )

Member Data Documentation

◆ EncounteredPartySurrendered

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.EncounteredPartySurrendered = false
static

◆ FirstInit

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.FirstInit = true

◆ JoiningRadius

const float TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.JoiningRadius = 3.0f
static

◆ IsEnemy

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.IsEnemy

◆ PlayerPartyInitialStrength

float TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.PlayerPartyInitialStrength

◆ PartiesStrengthRatioBeforePlayerJoin

float TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.PartiesStrengthRatioBeforePlayerJoin = 0.0f

◆ ForceRaid

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.ForceRaid

◆ ForceSallyOut

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.ForceSallyOut

◆ ForceAlleyFight

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.ForceAlleyFight

◆ ForceVolunteers

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.ForceVolunteers

◆ ForceSupplies

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.ForceSupplies

◆ BattleSimulation

BattleSimulation TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.BattleSimulation

Property Documentation

◆ Current

PlayerEncounter TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.Current
staticget

◆ LocationEncounter

LocationEncounter TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.LocationEncounter
staticgetset

◆ Battle

MapEvent TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.Battle
staticget

◆ EncounteredParty

PartyBase TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.EncounteredParty
staticget

◆ EncounteredMobileParty

MobileParty TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.EncounteredMobileParty
staticget

◆ EncounteredBattle

MapEvent TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.EncounteredBattle
staticget

◆ BattleState

BattleState TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.BattleState
staticget

◆ WinningSide

BattleSideEnum TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.WinningSide
staticget

◆ BattleChallenge

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.BattleChallenge
staticgetset

◆ PlayerIsDefender

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.PlayerIsDefender
staticget

◆ PlayerIsAttacker

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.PlayerIsAttacker
staticget

◆ LeaveEncounter

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.LeaveEncounter
staticgetset

◆ MeetingDone

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.MeetingDone
staticget

◆ PlayerSurrender

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.PlayerSurrender
staticgetset

◆ EnemySurrender

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.EnemySurrender
staticgetset

◆ IsActive

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.IsActive
staticget

◆ OpponentSide

BattleSideEnum TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.OpponentSide
get

◆ PlayerSide

BattleSideEnum TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.PlayerSide
get

◆ IsJoinedBattle

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.IsJoinedBattle
get

◆ InsideSettlement

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.InsideSettlement
staticget

◆ CampaignBattleResult

CampaignBattleResult TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.CampaignBattleResult
staticgetset

◆ IsPlayerEncounterInterruptedByPeace

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.IsPlayerEncounterInterruptedByPeace
get

◆ CurrentBattleSimulation

BattleSimulation TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.CurrentBattleSimulation
staticget

◆ EncounterState

PlayerEncounterState TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.EncounterState
get

◆ RosterToReceiveLootItems

ItemRoster TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.RosterToReceiveLootItems
get

◆ RosterToReceiveLootPrisoners

TroopRoster TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.RosterToReceiveLootPrisoners
get

◆ RosterToReceiveLootMembers

TroopRoster TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.RosterToReceiveLootMembers
get

◆ EncounterSettlement

Settlement TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.EncounterSettlement
staticget

◆ EncounterSettlementAux

Settlement TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.EncounterSettlementAux
get

◆ IsPlayerWaiting

bool TaleWorlds.CampaignSystem.Encounters.PlayerEncounter.IsPlayerWaiting
getset