TaleWorlds.CampaignSystem.Settlements.CommonArea Class Reference

Inherits TaleWorlds.CampaignSystem.Settlements.SettlementArea, and TaleWorlds.CampaignSystem.ITrackableCampaignObject.

Public Types
enum	CommonAreaType
enum	AreaState

Public Member Functions
int	GetSpawnNumber ()
	CommonArea (Settlement settlement, string tag, CommonAreaType commonAreaType, TextObject name)
void	Initialize (Settlement settlement, string tag, CommonAreaType commonAreaType, TextObject name)
bool	IsForbidden (TraitObject trait)
void	OnStreetFightWon (Hero attackerHero)
void	ClearArea (bool byOwnerDeath=false)
void	RestoreAlleyOwnerStateAfterBattle (Hero previousOwner)
void	OnBattleStarted ()
void	StartWaitingBeforeBattle ()
int	CalculateIdealNumberOfTroops (Hero owner)
TextObject	GetName ()
Vec3	GetPosition ()
float	GetTrackDistanceToMainAgent ()
bool	CheckTracked (BasicCharacterObject basicCharacter)
TextObject	GetName ()
Vec3	GetPosition ()
float	GetTrackDistanceToMainAgent ()
bool	CheckTracked (BasicCharacterObject basicCharacter)

Public Attributes
bool	StopPlayerPassage

Static Public Attributes
const int	MinVisibleTroopNumber = 2
const int	MaxVisibleTroopNumber = 10
const int	AreaMaxTroopNum = 30
const int	AreaMinTroopNum = 6

Properties
override Settlement	Settlement [get]
override TextObject	Name [get]
override string	Tag [get]
override Hero	Owner [get]
AreaState	State [get, set]
CommonAreaType	AreaType [get]
int	RemainingFightCount [get, set]
CommonAreaPartyComponent	CommonAreaPartyComponent [get, set]
Properties inherited from TaleWorlds.CampaignSystem.Settlements.SettlementArea
abstract Settlement	Settlement [get]
abstract TextObject	Name [get]
abstract string	Tag [get]
abstract Hero	Owner [get]

Member Enumeration Documentation

CommonAreaType

enum TaleWorlds.CampaignSystem.Settlements.CommonArea.CommonAreaType

AreaState

enum TaleWorlds.CampaignSystem.Settlements.CommonArea.AreaState

Constructor & Destructor Documentation

CommonArea()

TaleWorlds.CampaignSystem.Settlements.CommonArea.CommonArea	(	Settlement	settlement,
		string	tag,
		CommonAreaType	commonAreaType,
		TextObject	name
	)

Member Function Documentation

GetSpawnNumber()

int TaleWorlds.CampaignSystem.Settlements.CommonArea.GetSpawnNumber

(

)

Initialize()

void TaleWorlds.CampaignSystem.Settlements.CommonArea.Initialize	(	Settlement	settlement,
		string	tag,
		CommonAreaType	commonAreaType,
		TextObject	name
	)

IsForbidden()

bool TaleWorlds.CampaignSystem.Settlements.CommonArea.IsForbidden

(

TraitObject

trait

)

OnStreetFightWon()

void TaleWorlds.CampaignSystem.Settlements.CommonArea.OnStreetFightWon

(

Hero

attackerHero

)

ClearArea()

void TaleWorlds.CampaignSystem.Settlements.CommonArea.ClearArea

(

bool

byOwnerDeath = false

)

RestoreAlleyOwnerStateAfterBattle()

void TaleWorlds.CampaignSystem.Settlements.CommonArea.RestoreAlleyOwnerStateAfterBattle

(

Hero

previousOwner

)

OnBattleStarted()

void TaleWorlds.CampaignSystem.Settlements.CommonArea.OnBattleStarted

(

)

StartWaitingBeforeBattle()

void TaleWorlds.CampaignSystem.Settlements.CommonArea.StartWaitingBeforeBattle

(

)

CalculateIdealNumberOfTroops()

int TaleWorlds.CampaignSystem.Settlements.CommonArea.CalculateIdealNumberOfTroops

(

Hero

owner

)

GetName()

TextObject TaleWorlds.CampaignSystem.Settlements.CommonArea.GetName

(

)

Implements TaleWorlds.Core.ITrackableBase.

GetPosition()

Vec3 TaleWorlds.CampaignSystem.Settlements.CommonArea.GetPosition

(

)

Implements TaleWorlds.Core.ITrackableBase.

GetTrackDistanceToMainAgent()

float TaleWorlds.CampaignSystem.Settlements.CommonArea.GetTrackDistanceToMainAgent

(

)

Implements TaleWorlds.Core.ITrackableBase.

CheckTracked()

bool TaleWorlds.CampaignSystem.Settlements.CommonArea.CheckTracked

(

BasicCharacterObject

basicCharacter

)

Implements TaleWorlds.Core.ITrackableBase.

Member Data Documentation

StopPlayerPassage

bool TaleWorlds.CampaignSystem.Settlements.CommonArea.StopPlayerPassage

MinVisibleTroopNumber

const int TaleWorlds.CampaignSystem.Settlements.CommonArea.MinVisibleTroopNumber = 2

static

MaxVisibleTroopNumber

const int TaleWorlds.CampaignSystem.Settlements.CommonArea.MaxVisibleTroopNumber = 10

static

AreaMaxTroopNum

const int TaleWorlds.CampaignSystem.Settlements.CommonArea.AreaMaxTroopNum = 30

static

AreaMinTroopNum

const int TaleWorlds.CampaignSystem.Settlements.CommonArea.AreaMinTroopNum = 6

static

Property Documentation

Settlement

override Settlement TaleWorlds.CampaignSystem.Settlements.CommonArea.Settlement

get

Name

override TextObject TaleWorlds.CampaignSystem.Settlements.CommonArea.Name

get

Tag

override string TaleWorlds.CampaignSystem.Settlements.CommonArea.Tag

get

Owner

override Hero TaleWorlds.CampaignSystem.Settlements.CommonArea.Owner

get

State

AreaState TaleWorlds.CampaignSystem.Settlements.CommonArea.State

getset

AreaType

CommonAreaType TaleWorlds.CampaignSystem.Settlements.CommonArea.AreaType

get

RemainingFightCount

int TaleWorlds.CampaignSystem.Settlements.CommonArea.RemainingFightCount

getset

CommonAreaPartyComponent

CommonAreaPartyComponent TaleWorlds.CampaignSystem.Settlements.CommonArea.CommonAreaPartyComponent

getset