TaleWorlds.CampaignSystem.Settlements.SettlementComponent Class Reference

Inherits TaleWorlds.ObjectSystem.MBObjectBase.

Inherited by StoryMode.TrainingField, TaleWorlds.CampaignSystem.Settlements.Fief, TaleWorlds.CampaignSystem.Settlements.Hideout, and TaleWorlds.CampaignSystem.Settlements.Village.

Public Types
enum	ProsperityLevel

Public Member Functions
virtual ProsperityLevel	GetProsperityLevel ()
virtual void	OnPartyEntered (MobileParty mobileParty)
virtual void	OnPartyLeft (MobileParty mobileParty)
virtual void	OnStart ()
virtual void	OnInit ()
void	ChangeGold (int changeAmount)
int	GetNumberOfTroops ()
override void	Deserialize (MBObjectManager objectManager, XmlNode node)
virtual int	GetItemPrice (ItemObject item, MobileParty tradingParty=null, bool isSelling=false)
virtual int	GetItemPrice (EquipmentElement itemRosterElement, MobileParty tradingParty=null, bool isSelling=false)
virtual void	OnRelatedPartyRemoved (MobileParty mobileParty)
List< CharacterObject >	GetPrisonerHeroes ()
Public Member Functions inherited from TaleWorlds.ObjectSystem.MBObjectBase
	MBObjectBase ()
	MBObjectBase (MBObjectBase other)
	MBObjectBase (string stringId)
void	AfterInitialized ()
virtual void	AfterRegister ()
virtual void	Initialize ()
virtual void	Deserialize (MBObjectManager objectManager, XmlNode node)
override int	GetHashCode ()
virtual TextObject	GetName ()
void	PreAfterLoadInternal ()
void	AfterLoadInternal ()
void	OnRegistered ()
void	OnUnregistered ()

Public Attributes
bool	IsTaken

Protected Member Functions
abstract void	OnInventoryUpdated (ItemRosterElement item, int count)
	SettlementComponent ()
Protected Member Functions inherited from TaleWorlds.ObjectSystem.MBObjectBase
virtual void	OnBeforeLoad ()
virtual void	PreAfterLoad ()
virtual void	AfterLoad ()

Properties
int	Gold [get]
float	BackgroundCropPosition [get, protected set]
string	BackgroundMeshName [get, protected set]
string	WaitMeshName [get, protected set]
string	CastleBackgroundMeshName [get, protected set]
PartyBase	Owner [get]
Settlement	Settlement [get]
TextObject	Name [get]
bool	IsOwnerUnassigned [get, set]
virtual bool	IsTown [get]
virtual bool	IsCastle [get]
Properties inherited from TaleWorlds.ObjectSystem.MBObjectBase
string	StringId [get, set]
MBGUID	Id [get, set]
bool	IsInitialized [get]
bool	IsReady [get, set]

Member Enumeration Documentation

ProsperityLevel

enum TaleWorlds.CampaignSystem.Settlements.SettlementComponent.ProsperityLevel

Constructor & Destructor Documentation

SettlementComponent()

TaleWorlds.CampaignSystem.Settlements.SettlementComponent.SettlementComponent ( )

protected

Member Function Documentation

GetProsperityLevel()

virtual ProsperityLevel TaleWorlds.CampaignSystem.Settlements.SettlementComponent.GetProsperityLevel ( )

virtual

Reimplemented in TaleWorlds.CampaignSystem.Settlements.Town, and TaleWorlds.CampaignSystem.Settlements.Village.

OnInventoryUpdated()

abstract void TaleWorlds.CampaignSystem.Settlements.SettlementComponent.OnInventoryUpdated ( ItemRosterElement  item, int  count  )

protectedpure virtual

Implemented in StoryMode.TrainingField, TaleWorlds.CampaignSystem.Settlements.Hideout, TaleWorlds.CampaignSystem.Settlements.Town, and TaleWorlds.CampaignSystem.Settlements.Village.

OnPartyEntered()

virtual void TaleWorlds.CampaignSystem.Settlements.SettlementComponent.OnPartyEntered ( MobileParty  mobileParty )

virtual

Reimplemented in TaleWorlds.CampaignSystem.Settlements.Hideout.

OnPartyLeft()

virtual void TaleWorlds.CampaignSystem.Settlements.SettlementComponent.OnPartyLeft ( MobileParty  mobileParty )

virtual

Reimplemented in TaleWorlds.CampaignSystem.Settlements.Hideout.

OnStart()

virtual void TaleWorlds.CampaignSystem.Settlements.SettlementComponent.OnStart ( )

virtual

Reimplemented in TaleWorlds.CampaignSystem.Settlements.Hideout, TaleWorlds.CampaignSystem.Settlements.Town, and TaleWorlds.CampaignSystem.Settlements.Village.

OnInit()

virtual void TaleWorlds.CampaignSystem.Settlements.SettlementComponent.OnInit ( )

virtual

Reimplemented in TaleWorlds.CampaignSystem.Settlements.Hideout, TaleWorlds.CampaignSystem.Settlements.Town, and TaleWorlds.CampaignSystem.Settlements.Village.

ChangeGold()

void TaleWorlds.CampaignSystem.Settlements.SettlementComponent.ChangeGold

(

int

changeAmount

)

GetNumberOfTroops()

int TaleWorlds.CampaignSystem.Settlements.SettlementComponent.GetNumberOfTroops

(

)

Deserialize()

override void TaleWorlds.CampaignSystem.Settlements.SettlementComponent.Deserialize ( MBObjectManager  objectManager, XmlNode  node  )

virtual

Reimplemented from TaleWorlds.ObjectSystem.MBObjectBase.

Reimplemented in TaleWorlds.CampaignSystem.Settlements.Town, and TaleWorlds.CampaignSystem.Settlements.Village.

GetItemPrice() [1/2]

virtual int TaleWorlds.CampaignSystem.Settlements.SettlementComponent.GetItemPrice ( ItemObject  item, MobileParty  tradingParty = null, bool  isSelling = false  )

virtual

Reimplemented in TaleWorlds.CampaignSystem.Settlements.Town, and TaleWorlds.CampaignSystem.Settlements.Village.

GetItemPrice() [2/2]

virtual int TaleWorlds.CampaignSystem.Settlements.SettlementComponent.GetItemPrice ( EquipmentElement  itemRosterElement, MobileParty  tradingParty = null, bool  isSelling = false  )

virtual

Reimplemented in TaleWorlds.CampaignSystem.Settlements.Town, and TaleWorlds.CampaignSystem.Settlements.Village.

OnRelatedPartyRemoved()

virtual void TaleWorlds.CampaignSystem.Settlements.SettlementComponent.OnRelatedPartyRemoved ( MobileParty  mobileParty )

virtual

Reimplemented in TaleWorlds.CampaignSystem.Settlements.Hideout.

GetPrisonerHeroes()

List< CharacterObject > TaleWorlds.CampaignSystem.Settlements.SettlementComponent.GetPrisonerHeroes

(

)

Member Data Documentation

IsTaken

bool TaleWorlds.CampaignSystem.Settlements.SettlementComponent.IsTaken

Property Documentation

Gold

int TaleWorlds.CampaignSystem.Settlements.SettlementComponent.Gold

get

BackgroundCropPosition

float TaleWorlds.CampaignSystem.Settlements.SettlementComponent.BackgroundCropPosition

getprotected set

BackgroundMeshName

string TaleWorlds.CampaignSystem.Settlements.SettlementComponent.BackgroundMeshName

getprotected set

WaitMeshName

string TaleWorlds.CampaignSystem.Settlements.SettlementComponent.WaitMeshName

getprotected set

CastleBackgroundMeshName

string TaleWorlds.CampaignSystem.Settlements.SettlementComponent.CastleBackgroundMeshName

getprotected set

Owner

PartyBase TaleWorlds.CampaignSystem.Settlements.SettlementComponent.Owner

get

Settlement

Settlement TaleWorlds.CampaignSystem.Settlements.SettlementComponent.Settlement

get

Name

TextObject TaleWorlds.CampaignSystem.Settlements.SettlementComponent.Name

get

IsOwnerUnassigned

bool TaleWorlds.CampaignSystem.Settlements.SettlementComponent.IsOwnerUnassigned

getset

IsTown

virtual bool TaleWorlds.CampaignSystem.Settlements.SettlementComponent.IsTown

get

IsCastle

virtual bool TaleWorlds.CampaignSystem.Settlements.SettlementComponent.IsCastle

get