Table of Contents

Class MapEvent

Namespace
TaleWorlds.CampaignSystem.MapEvents
Assembly
TaleWorlds.CampaignSystem.dll
public sealed class MapEvent : MBObjectBase, IMapEntity
Inheritance
MapEvent
Implements
Inherited Members

Fields

DiplomaticallyFinished

public bool DiplomaticallyFinished

Field Value

bool

MapEventVisual

[CachedData]
public IMapEventVisual MapEventVisual

Field Value

IMapEventVisual

SiegeAdvantage

public const float SiegeAdvantage = 1.5

Field Value

float

StrengthOfSide

[SaveableField(125)]
public float[] StrengthOfSide

Field Value

float[]

Properties

AttackerSide

public MapEventSide AttackerSide { get; }

Property Value

MapEventSide

BattleResultExplainers

public MapEventResultExplainer BattleResultExplainers { get; }

Property Value

MapEventResultExplainer

BattleStartTime

public CampaignTime BattleStartTime { get; }

Property Value

CampaignTime

BattleState

public BattleState BattleState { get; }

Property Value

BattleState

Component

[SaveableProperty(105)]
public MapEventComponent Component { get; }

Property Value

MapEventComponent

DefeatedSide

public BattleSideEnum DefeatedSide { get; }

Property Value

BattleSideEnum

DefenderSide

public MapEventSide DefenderSide { get; }

Property Value

MapEventSide

EventTerrainType

public TerrainType EventTerrainType { get; }

Property Value

TerrainType

EventType

public MapEvent.BattleTypes EventType { get; }

Property Value

MapEvent.BattleTypes

HasWinner

public bool HasWinner { get; }

Property Value

bool

InvolvedParties

public IEnumerable<PartyBase> InvolvedParties { get; }

Property Value

IEnumerable<PartyBase>

IsFieldBattle

public bool IsFieldBattle { get; }

Property Value

bool

IsFinalized

public bool IsFinalized { get; }

Property Value

bool

IsFinished

public bool IsFinished { get; }

Property Value

bool

IsForcingSupplies

public bool IsForcingSupplies { get; }

Property Value

bool

IsForcingVolunteers

public bool IsForcingVolunteers { get; }

Property Value

bool

IsHideoutBattle

public bool IsHideoutBattle { get; }

Property Value

bool

IsInvulnerable

[SaveableProperty(113)]
public bool IsInvulnerable { get; set; }

Property Value

bool

IsPlayerMapEvent

public bool IsPlayerMapEvent { get; }

Property Value

bool

IsPlayerSimulation

[SaveableProperty(123)]
public bool IsPlayerSimulation { get; set; }

Property Value

bool

IsRaid

public bool IsRaid { get; }

Property Value

bool

IsSallyOut

public bool IsSallyOut { get; }

Property Value

bool

IsSiegeAmbush

public bool IsSiegeAmbush { get; }

Property Value

bool

IsSiegeAssault

public bool IsSiegeAssault { get; }

Property Value

bool

IsSiegeOutside

public bool IsSiegeOutside { get; }

Property Value

bool

IsVisible

public bool IsVisible { get; }

Property Value

bool

MapEventSettlement

[SaveableProperty(103)]
public Settlement MapEventSettlement { get; }

Property Value

Settlement

PlayerMapEvent

public static MapEvent PlayerMapEvent { get; }

Property Value

MapEvent

PlayerSide

public BattleSideEnum PlayerSide { get; }

Property Value

BattleSideEnum

Position

[SaveableProperty(111)]
public Vec2 Position { get; }

Property Value

Vec2

State

public MapEventState State { get; }

Property Value

MapEventState

Winner

public MapEventSide Winner { get; }

Property Value

MapEventSide

WinningSide

public BattleSideEnum WinningSide { get; }

Property Value

BattleSideEnum

Methods

AutoGeneratedInstanceCollectObjects(List<object>)

protected override void AutoGeneratedInstanceCollectObjects(List<object> collectedObjects)

Parameters

collectedObjects List<object>

BeginWait()

public void BeginWait()

CanPartyJoinBattle(PartyBase, BattleSideEnum)

public bool CanPartyJoinBattle(PartyBase party, BattleSideEnum side)

Parameters

party PartyBase
side BattleSideEnum

Returns

bool

CheckIfBattleShouldContinueAfterBattleMission(CampaignBattleResult)

public bool CheckIfBattleShouldContinueAfterBattleMission(CampaignBattleResult campaignBattleResult)

Parameters

campaignBattleResult CampaignBattleResult

Returns

bool

DoSurrender(BattleSideEnum)

public void DoSurrender(BattleSideEnum side)

Parameters

side BattleSideEnum

FinalizeEvent()

public void FinalizeEvent()

FinishBattleAndKeepSiegeEvent()

public void FinishBattleAndKeepSiegeEvent()

GetBattleRewards(PartyBase, out float, out float, out float, out float, out float)

public void GetBattleRewards(PartyBase party, out float renownChange, out float influenceChange, out float moraleChange, out float goldChange, out float playerEarnedLootPercentage)

Parameters

party PartyBase
renownChange float
influenceChange float
moraleChange float
goldChange float
playerEarnedLootPercentage float

GetLeaderParty(BattleSideEnum)

public PartyBase GetLeaderParty(BattleSideEnum side)

Parameters

side BattleSideEnum

Returns

PartyBase

GetMapEventSide(BattleSideEnum)

public MapEventSide GetMapEventSide(BattleSideEnum side)

Parameters

side BattleSideEnum

Returns

MapEventSide

GetMountAndHarnessVisualIdsForPartyIcon(out string, out string)

public void GetMountAndHarnessVisualIdsForPartyIcon(out string mountStringId, out string harnessStringId)

Parameters

mountStringId string
harnessStringId string

GetNumberOfInvolvedMen()

public int GetNumberOfInvolvedMen()

Returns

int

GetNumberOfInvolvedMen(BattleSideEnum)

public int GetNumberOfInvolvedMen(BattleSideEnum side)

Parameters

side BattleSideEnum

Returns

int

GetRenownValue(BattleSideEnum)

public float GetRenownValue(BattleSideEnum side)

Parameters

side BattleSideEnum

Returns

float

GetRenownValueAtMapEventEnd(BattleSideEnum)

public float GetRenownValueAtMapEventEnd(BattleSideEnum side)

Parameters

side BattleSideEnum

Returns

float

GetStrengthsRelativeToParty(BattleSideEnum, out float, out float)

public void GetStrengthsRelativeToParty(BattleSideEnum partySide, out float partySideStrength, out float opposingSideStrength)

Parameters

partySide BattleSideEnum
partySideStrength float
opposingSideStrength float

HasTroopsOnBothSides()

public bool HasTroopsOnBothSides()

Returns

bool

IsPlayerSergeant()

public bool IsPlayerSergeant()

Returns

bool

PartiesOnSide(BattleSideEnum)

public MBReadOnlyList<MapEventParty> PartiesOnSide(BattleSideEnum side)

Parameters

side BattleSideEnum

Returns

MBReadOnlyList<MapEventParty>

RecalculateRenownAndInfluenceValues(PartyBase)

public void RecalculateRenownAndInfluenceValues(PartyBase party)

Parameters

party PartyBase

RecalculateStrengthOfSides()

public void RecalculateStrengthOfSides()

ResetBattleState()

public void ResetBattleState()

SetDefenderPulledBack()

public void SetDefenderPulledBack()

SetOverrideWinner(BattleSideEnum)

public void SetOverrideWinner(BattleSideEnum winner)

Parameters

winner BattleSideEnum

SimulateBattleForRounds(int, int)

public void SimulateBattleForRounds(int simulationRoundsDefender, int simulationRoundsAttacker)

Parameters

simulationRoundsDefender int
simulationRoundsAttacker int

SimulateBattleSetup(FlattenedTroopRoster[])

public void SimulateBattleSetup(FlattenedTroopRoster[] priorTroops)

Parameters

priorTroops FlattenedTroopRoster[]

ToString()

public override string ToString()

Returns

string

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