TaleWorlds.MountAndBlade.StrategicArea Class Reference

Inherits TaleWorlds.MountAndBlade.MissionObject, and TaleWorlds.MountAndBlade.IDetachment.

Public Member Functions
Vec3	GetGroundPosition ()
void	DetermineAssociatedDestructibleComponents (IEnumerable< DestructableComponent > destructibleComponents)
void	OnParentGameEntityVisibilityChanged (bool isVisible)
void	InitializeAutogenerated (float width, int capacity, BattleSideEnum side)
void	AddAgent (Agent agent, int slotIndex)
void	AddAgentAtSlotIndex (Agent agent, int slotIndex)
bool	IsUsedByFormation (Formation formation)
bool	IsAgentEligible (Agent agent)
bool	IsStandingPointAvailableForAgent (Agent agent)
float[]	GetTemplateCostsOfAgent (Agent candidate, float[] oldValue)
float	GetTemplateWeightOfAgent (Agent candidate)
float?	GetWeightOfAgentAtNextSlot (IEnumerable< Agent > newAgents, out Agent match)
float?	GetWeightOfAgentAtNextSlot (IEnumerable< AgentValuePair< float > > agentTemplateScores, out Agent match)
float?	GetWeightOfAgentAtOccupiedSlot (Agent detachedAgent, IEnumerable< Agent > newAgents, out Agent match)
void	RemoveAgent (Agent agent)
WorldFrame?	GetAgentFrame (Agent agent)
	Returns null for siege weapons and other detachments that sets scripted frame for the agent. Returns a frame otherwise. More...
float?	GetWeightOfNextSlot (BattleSideEnum side)
	Null if there is no vacancy left. Otherwise it is a positive number. More...
float	GetWeightOfOccupiedSlot (Agent agent)
bool	IsUsableBy (BattleSideEnum side)
Public Member Functions inherited from TaleWorlds.MountAndBlade.MissionObject
	MissionObject ()
virtual void	SetAbilityOfFaces (bool enabled)
override int	GetHashCode ()
virtual void	AfterMissionStart ()
void	SetDisabled (bool isParentObject=false)
	Only disables the mission object script and removes it from active mission objects list but the object entity remains visible with active physics More...
void	SetDisabledAndMakeInvisible (bool isParentObject=false)
	Mission object is disabled and removed from active mission objects list, its entity is made invisible and therefore its physics is turned off More...
virtual void	OnEndMission ()
virtual void	AddStuckMissile (GameEntity missileEntity)
Public Member Functions inherited from TaleWorlds.Engine.ScriptComponentBehavior
void	SetScriptComponentToTick (TickRequirement value)
void	SetScriptComponentToTickMT (TickRequirement value)
virtual TickRequirement	GetTickRequirement ()
bool	IsAgentUsingOrMovingTo (Agent agent)
float?	GetWeightOfNextSlot (BattleSideEnum side)
	Null if there is no vacancy left. Otherwise it is a positive number. More...
float	GetDetachmentWeight (BattleSideEnum side)
float	ComputeAndCacheDetachmentWeight (BattleSideEnum side)
float	GetDetachmentWeightFromCache ()
List< ValueTuple< int, float > >	GetSlotIndexWeightTuples ()
bool	IsSlotAtIndexAvailableForAgent (int slotIndex, Agent agent)
bool	IsAgentEligible (Agent agent)
void	AddAgentAtSlotIndex (Agent agent, int slotIndex)
Agent	GetMovingAgentAtSlotIndex (int slotIndex)
void	MarkSlotAtIndex (int slotIndex)
bool	IsDetachmentRecentlyEvaluated ()
void	UnmarkDetachment ()
float?	GetWeightOfAgentAtNextSlot (IEnumerable< Agent > candidates, out Agent match)
float?	GetWeightOfAgentAtNextSlot (IEnumerable< AgentValuePair< float > > agentTemplateScores, out Agent match)
float	GetTemplateWeightOfAgent (Agent candidate)
float[]	GetTemplateCostsOfAgent (Agent candidate, float[] oldValue)
float	GetExactCostOfAgentAtSlot (Agent candidate, int slotIndex)
float	GetWeightOfOccupiedSlot (Agent detachedAgent)
float?	GetWeightOfAgentAtOccupiedSlot (Agent detachedAgent, IEnumerable< Agent > candidates, out Agent match)
bool	IsStandingPointAvailableForAgent (Agent agent)
void	AddAgent (Agent agent, int slotIndex=-1)
void	RemoveAgent (Agent detachedAgent)
void	FormationStartUsing (Formation formation)
void	FormationStopUsing (Formation formation)
bool	IsUsedByFormation (Formation formation)
WorldFrame?	GetAgentFrame (Agent detachedAgent)
	Returns null for siege weapons and other detachments that sets scripted frame for the agent. Returns a frame otherwise. More...
void	ResetEvaluation ()
bool	IsEvaluated ()
void	SetAsEvaluated ()
void	OnFormationLeave (Formation formation)

Protected Member Functions
override void	OnRemoved (int removeReason)
Protected Member Functions inherited from TaleWorlds.MountAndBlade.MissionObject
virtual void	AttachDynamicNavmeshToEntity ()
virtual GameEntity	GetEntityToAttachNavMeshFaces ()
override void	OnRemoved (int removeReason)
Protected Member Functions inherited from TaleWorlds.Engine.ScriptComponentBehavior
void	InvalidateWeakPointersIfValid ()
	ScriptComponentBehavior ()
virtual void	OnRemoved (int removeReason)

Properties
IEnumerable< Agent >	Agents [get]
	Detached agents of this detachment More...
bool	IsLoose [get]
IReadOnlyList< Formation >	UserFormations [get]
float	DistanceToCheck [get]
bool	IgnoreHeight [get]
bool	IsActive [get, set]
Properties inherited from TaleWorlds.MountAndBlade.MissionObject
MissionObjectId	Id [get, set]
bool	IsDisabled [get]
bool	CreatedAtRuntime [get]
Properties inherited from TaleWorlds.Engine.ScriptComponentBehavior
GameEntity	GameEntity [get]
ManagedScriptComponent	ScriptComponent [get]
ManagedScriptHolder	ManagedScriptHolder [get]
Scene	Scene [get]
Properties inherited from TaleWorlds.MountAndBlade.IDetachment
IEnumerable< Agent >	Agents [get]
	Detached agents of this detachment More...
IReadOnlyList< Formation >	UserFormations [get]
bool	IsLoose [get]

Additional Inherited Members
Public Types inherited from TaleWorlds.Engine.ScriptComponentBehavior
enum	TickRequirement : uint
Protected Attributes inherited from TaleWorlds.MountAndBlade.MissionObject
string	NavMeshPrefabName = ""
int	DynamicNavmeshIdStart = 0
Static Protected Attributes inherited from TaleWorlds.MountAndBlade.MissionObject
const int	InsideNavMeshIdLocal = 1
const int	EnterNavMeshIdLocal = 2
const int	ExitNavMeshIdLocal = 3
const int	BlockerNavMeshIdLocal = 4
const int	ExtraNavMesh1IdLocal = 5
const int	ExtraNavMesh2IdLocal = 6
const int	ExtraNavMesh3IdLocal = 7

Member Function Documentation

GetGroundPosition()

Vec3 TaleWorlds.MountAndBlade.StrategicArea.GetGroundPosition

(

)

DetermineAssociatedDestructibleComponents()

void TaleWorlds.MountAndBlade.StrategicArea.DetermineAssociatedDestructibleComponents

(

IEnumerable< DestructableComponent >

destructibleComponents

)

OnParentGameEntityVisibilityChanged()

void TaleWorlds.MountAndBlade.StrategicArea.OnParentGameEntityVisibilityChanged

(

bool

isVisible

)

OnRemoved()

override void TaleWorlds.MountAndBlade.StrategicArea.OnRemoved ( int  removeReason )

protectedvirtual

Reimplemented from TaleWorlds.Engine.ScriptComponentBehavior.

InitializeAutogenerated()

void TaleWorlds.MountAndBlade.StrategicArea.InitializeAutogenerated	(	float	width,
		int	capacity,
		BattleSideEnum	side
	)

AddAgent()

void TaleWorlds.MountAndBlade.StrategicArea.AddAgent	(	Agent	agent,
		int	slotIndex
	)

Implements TaleWorlds.MountAndBlade.IDetachment.

AddAgentAtSlotIndex()

void TaleWorlds.MountAndBlade.StrategicArea.AddAgentAtSlotIndex	(	Agent	agent,
		int	slotIndex
	)

Implements TaleWorlds.MountAndBlade.IDetachment.

IsUsedByFormation()

bool TaleWorlds.MountAndBlade.StrategicArea.IsUsedByFormation

(

Formation

formation

)

Implements TaleWorlds.MountAndBlade.IDetachment.

IsAgentEligible()

bool TaleWorlds.MountAndBlade.StrategicArea.IsAgentEligible

(

Agent

agent

)

Implements TaleWorlds.MountAndBlade.IDetachment.

IsStandingPointAvailableForAgent()

bool TaleWorlds.MountAndBlade.StrategicArea.IsStandingPointAvailableForAgent

(

Agent

agent

)

Implements TaleWorlds.MountAndBlade.IDetachment.

GetTemplateCostsOfAgent()

float[] TaleWorlds.MountAndBlade.StrategicArea.GetTemplateCostsOfAgent	(	Agent	candidate,
		float[]	oldValue
	)

Implements TaleWorlds.MountAndBlade.IDetachment.

GetTemplateWeightOfAgent()

float TaleWorlds.MountAndBlade.StrategicArea.GetTemplateWeightOfAgent

(

Agent

candidate

)

Implements TaleWorlds.MountAndBlade.IDetachment.

GetWeightOfAgentAtNextSlot() [1/2]

float? TaleWorlds.MountAndBlade.StrategicArea.GetWeightOfAgentAtNextSlot	(	IEnumerable< Agent >	newAgents,
		out Agent	match
	)

Implements TaleWorlds.MountAndBlade.IDetachment.

GetWeightOfAgentAtNextSlot() [2/2]

float? TaleWorlds.MountAndBlade.StrategicArea.GetWeightOfAgentAtNextSlot	(	IEnumerable< AgentValuePair< float > >	agentTemplateScores,
		out Agent	match
	)

Implements TaleWorlds.MountAndBlade.IDetachment.

GetWeightOfAgentAtOccupiedSlot()

float? TaleWorlds.MountAndBlade.StrategicArea.GetWeightOfAgentAtOccupiedSlot	(	Agent	detachedAgent,
		IEnumerable< Agent >	newAgents,
		out Agent	match
	)

Implements TaleWorlds.MountAndBlade.IDetachment.

RemoveAgent()

void TaleWorlds.MountAndBlade.StrategicArea.RemoveAgent

(

Agent

agent

)

Implements TaleWorlds.MountAndBlade.IDetachment.

GetAgentFrame()

WorldFrame? TaleWorlds.MountAndBlade.StrategicArea.GetAgentFrame

(

Agent

detachedAgent

)

Parameters

detachedAgent

Returns

Implements TaleWorlds.MountAndBlade.IDetachment.

GetWeightOfNextSlot()

float? TaleWorlds.MountAndBlade.StrategicArea.GetWeightOfNextSlot

(

BattleSideEnum

side

)

Implements TaleWorlds.MountAndBlade.IDetachment.

GetWeightOfOccupiedSlot()

float TaleWorlds.MountAndBlade.StrategicArea.GetWeightOfOccupiedSlot

(

Agent

agent

)

Implements TaleWorlds.MountAndBlade.IDetachment.

IsUsableBy()

bool TaleWorlds.MountAndBlade.StrategicArea.IsUsableBy

(

BattleSideEnum

side

)

Property Documentation

Agents

IEnumerable<Agent> TaleWorlds.MountAndBlade.StrategicArea.Agents

get

Implements TaleWorlds.MountAndBlade.IDetachment.

IsLoose

bool TaleWorlds.MountAndBlade.StrategicArea.IsLoose

get

Implements TaleWorlds.MountAndBlade.IDetachment.

UserFormations

IReadOnlyList<Formation> TaleWorlds.MountAndBlade.StrategicArea.UserFormations

get

Implements TaleWorlds.MountAndBlade.IDetachment.

DistanceToCheck

float TaleWorlds.MountAndBlade.StrategicArea.DistanceToCheck

get

IgnoreHeight

bool TaleWorlds.MountAndBlade.StrategicArea.IgnoreHeight

get

IsActive

bool TaleWorlds.MountAndBlade.StrategicArea.IsActive

getset