Table of Contents

Class SettlementComponent

Namespace
TaleWorlds.CampaignSystem.Settlements
Assembly
TaleWorlds.CampaignSystem.dll
public abstract class SettlementComponent : MBObjectBase
Inheritance
SettlementComponent
Derived
Inherited Members

Constructors

SettlementComponent()

protected SettlementComponent()

Properties

BackgroundCropPosition

public float BackgroundCropPosition { get; protected set; }

Property Value

float

BackgroundMeshName

public string BackgroundMeshName { get; protected set; }

Property Value

string

CastleBackgroundMeshName

public string CastleBackgroundMeshName { get; protected set; }

Property Value

string

Gold

[SaveableProperty(50)]
public int Gold { get; }

Property Value

int

IsCastle

public virtual bool IsCastle { get; }

Property Value

bool

IsOwnerUnassigned

[SaveableProperty(80)]
public bool IsOwnerUnassigned { get; set; }

Property Value

bool

IsTown

public virtual bool IsTown { get; }

Property Value

bool

Name

public TextObject Name { get; }

Property Value

TextObject

Owner

public PartyBase Owner { get; }

Property Value

PartyBase

Settlement

public Settlement Settlement { get; }

Property Value

Settlement

WaitMeshName

public string WaitMeshName { get; protected set; }

Property Value

string

Methods

AutoGeneratedInstanceCollectObjects(List<object>)

protected override void AutoGeneratedInstanceCollectObjects(List<object> collectedObjects)

Parameters

collectedObjects List<object>

ChangeGold(int)

public void ChangeGold(int changeAmount)

Parameters

changeAmount int

Deserialize(MBObjectManager, XmlNode)

public override void Deserialize(MBObjectManager objectManager, XmlNode node)

Parameters

objectManager MBObjectManager
node XmlNode

GetItemPrice(EquipmentElement, MobileParty, bool)

public virtual int GetItemPrice(EquipmentElement itemRosterElement, MobileParty tradingParty = null, bool isSelling = false)

Parameters

itemRosterElement EquipmentElement
tradingParty MobileParty
isSelling bool

Returns

int

GetItemPrice(ItemObject, MobileParty, bool)

public virtual int GetItemPrice(ItemObject item, MobileParty tradingParty = null, bool isSelling = false)

Parameters

item ItemObject
tradingParty MobileParty
isSelling bool

Returns

int

GetNumberOfTroops()

public int GetNumberOfTroops()

Returns

int

GetPrisonerHeroes()

public List<CharacterObject> GetPrisonerHeroes()

Returns

List<CharacterObject>

GetProsperityLevel()

public virtual SettlementComponent.ProsperityLevel GetProsperityLevel()

Returns

SettlementComponent.ProsperityLevel

OnInit()

public virtual void OnInit()

OnInventoryUpdated(ItemRosterElement, int)

protected abstract void OnInventoryUpdated(ItemRosterElement item, int count)

Parameters

item ItemRosterElement
count int

OnPartyEntered(MobileParty)

public virtual void OnPartyEntered(MobileParty mobileParty)

Parameters

mobileParty MobileParty

OnPartyLeft(MobileParty)

public virtual void OnPartyLeft(MobileParty mobileParty)

Parameters

mobileParty MobileParty

OnRelatedPartyRemoved(MobileParty)

public virtual void OnRelatedPartyRemoved(MobileParty mobileParty)

Parameters

mobileParty MobileParty

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