TaleWorlds.MountAndBlade.MissionAgentSpawnLogic Class Reference

Inherits TaleWorlds.MountAndBlade.MissionLogic, and TaleWorlds.MountAndBlade.IMissionAgentSpawnLogic.

Classes
struct	SpawnNotificationData

Public Member Functions
delegate void	OnPhaseChangedDelegate ()
int	GetNumberOfPlayerControllableTroops ()
void	InitWithSinglePhase (int defenderTotalSpawn, int attackerTotalSpawn, int defenderInitialSpawn, int attackerInitialSpawn, bool spawnDefenders, bool spawnAttackers, in MissionSpawnSettings spawnSettings)
	Initializes a single phase mission spawn logic. More...
IEnumerable< IAgentOriginBase >	GetAllTroopsForSide (BattleSideEnum side)
	MissionAgentSpawnLogic (IMissionTroopSupplier[] suppliers, BattleSideEnum playerSide, Mission.BattleSizeType battleSizeType)
void	SetSpawnTroops (BattleSideEnum side, bool spawnTroops, bool enforceSpawning=false)
void	SetSpawnHorses (BattleSideEnum side, bool spawnHorses)
override void	AfterStart ()
void	StartSpawner (BattleSideEnum side)
void	StopSpawner (BattleSideEnum side)
bool	IsSideSpawnEnabled (BattleSideEnum side)
void	OnInitialSpawnForSideEnded (BattleSideEnum side)
override void	OnMissionTick (float dt)
float	GetReinforcementInterval ()
void	SetReinforcementsSpawnTimerEnabled (bool value, bool resetTimer=true)
int	GetTotalNumberOfTroopsForSide (BattleSideEnum side)
BasicCharacterObject	GetGeneralCharacterOfSide (BattleSideEnum side)
bool	GetSpawnHorses (BattleSideEnum side)
bool	IsSideDepleted (BattleSideEnum side)
void	AddPhaseChangeAction (BattleSideEnum side, OnPhaseChangedDelegate onPhaseChanged)
Public Member Functions inherited from TaleWorlds.MountAndBlade.MissionLogic
virtual InquiryData	OnEndMissionRequest (out bool canLeave)
virtual bool	MissionEnded (ref MissionResult missionResult)
virtual void	OnBattleEnded ()
virtual void	ShowBattleResults ()
virtual void	AccelerateHorseKeyPressAnswer ()
virtual void	OnRetreatMission ()
virtual void	OnSurrenderMission ()
virtual void	OnAutoDeployTeam (Team team)
virtual bool	IsAgentInteractionAllowed ()
virtual bool	IsOrderShoutingAllowed ()
virtual List< EquipmentElement >	GetExtraEquipmentElementsForCharacter (BasicCharacterObject character, bool getAllEquipments=false)
virtual void	OnMissionResultReady (MissionResult missionResult)
Public Member Functions inherited from TaleWorlds.MountAndBlade.MissionBehavior
virtual void	OnAfterMissionCreated ()
virtual void	OnBehaviorInitialize ()
virtual void	OnCreated ()
virtual void	EarlyStart ()
virtual void	AfterStart ()
virtual void	OnMissileHit (Agent attacker, Agent victim, bool isCanceled)
virtual void	OnMissileCollisionReaction (Mission.MissileCollisionReaction collisionReaction, Agent attackerAgent, Agent attachedAgent, sbyte attachedBoneIndex)
virtual void	OnMissionScreenPreLoad ()
virtual void	OnAgentCreated (Agent agent)
virtual void	OnAgentBuild (Agent agent, Banner banner)
virtual void	OnAgentTeamChanged (Team prevTeam, Team newTeam, Agent agent)
virtual void	OnAgentHit (Agent affectedAgent, Agent affectorAgent, in MissionWeapon affectorWeapon, in Blow blow, in AttackCollisionData attackCollisionData)
virtual void	OnScoreHit (Agent affectedAgent, Agent affectorAgent, WeaponComponentData attackerWeapon, bool isBlocked, bool isSiegeEngineHit, in Blow blow, in AttackCollisionData collisionData, float damagedHp, float hitDistance, float shotDifficulty)
virtual void	OnEarlyAgentRemoved (Agent affectedAgent, Agent affectorAgent, AgentState agentState, KillingBlow blow)
virtual void	OnAgentRemoved (Agent affectedAgent, Agent affectorAgent, AgentState agentState, KillingBlow blow)
virtual void	OnAgentDeleted (Agent affectedAgent)
virtual void	OnAgentFleeing (Agent affectedAgent)
virtual void	OnAgentPanicked (Agent affectedAgent)
virtual void	OnFocusGained (Agent agent, IFocusable focusableObject, bool isInteractable)
virtual void	OnFocusLost (Agent agent, IFocusable focusableObject)
virtual void	OnAddTeam (Team team)
virtual void	AfterAddTeam (Team team)
virtual void	OnAgentInteraction (Agent userAgent, Agent agent)
virtual void	OnClearScene ()
virtual void	HandleOnCloseMission ()
virtual void	OnRemoveBehavior ()
virtual void	OnPreMissionTick (float dt)
virtual void	OnPreDisplayMissionTick (float dt)
virtual void	OnMissionTick (float dt)
virtual void	OnAgentMount (Agent agent)
virtual void	OnAgentDismount (Agent agent)
virtual bool	IsThereAgentAction (Agent userAgent, Agent otherAgent)
virtual void	OnEntityRemoved (GameEntity entity)
virtual void	OnObjectUsed (Agent userAgent, UsableMissionObject usedObject)
virtual void	OnObjectStoppedBeingUsed (Agent userAgent, UsableMissionObject usedObject)
virtual void	OnRenderingStarted ()
virtual void	OnMissionActivate ()
	This function is called only after mission is deactivated. More...
virtual void	OnMissionDeactivate ()
virtual void	OnMissionRestart ()
virtual List< CompassItemUpdateParams >	GetCompassTargets ()
virtual void	OnAssignPlayerAsSergeantOfFormation (Agent agent)
virtual void	OnFormationUnitsSpawned (Team team)
virtual void	OnAgentAlarmedStateChanged (Agent agent, Agent.AIStateFlag flag)
virtual void	OnMissionModeChange (MissionMode oldMissionMode, bool atStart)
virtual void	OnItemPickup (Agent agent, SpawnedItemEntity item)
virtual void	OnItemDrop (Agent agent, SpawnedItemEntity item)
virtual void	OnRegisterBlow (Agent attacker, Agent victim, GameEntity realHitEntity, Blow b, ref AttackCollisionData collisionData, in MissionWeapon attackerWeapon)
virtual void	OnAgentShootMissile (Agent shooterAgent, EquipmentIndex weaponIndex, Vec3 position, Vec3 velocity, Mat3 orientation, bool hasRigidBody, int forcedMissileIndex)
void	StartSpawner (BattleSideEnum side)
void	StopSpawner (BattleSideEnum side)
bool	IsSideSpawnEnabled (BattleSideEnum side)
bool	IsSideDepleted (BattleSideEnum side)
float	GetReinforcementInterval ()

Properties
static int	MaxNumberOfAgentsForMission [get]
int	NumberOfAgents [get]
int	NumberOfRemainingTroops [get]
int	NumberOfActiveDefenderTroops [get]
int	NumberOfActiveAttackerTroops [get]
int	BattleSize [get]
bool	IsInitialSpawnOver [get]
ref readonly MissionSpawnSettings	ReinforcementSpawnSettings [get]
Properties inherited from TaleWorlds.MountAndBlade.MissionLogic
override MissionBehaviorType	BehaviorType [get]
Properties inherited from TaleWorlds.MountAndBlade.MissionBehavior
Mission	Mission [get]
IInputContext	DebugInput [get]
abstract MissionBehaviorType	BehaviorType [get]

Events
Action< SpawnNotificationData >	OnNotifyReinforcementsSpawned
Action< SpawnNotificationData >	OnNotifyInitialTroopsSpawned

Additional Inherited Members
Protected Member Functions inherited from TaleWorlds.MountAndBlade.MissionBehavior
virtual void	OnEndMission ()

Constructor & Destructor Documentation

MissionAgentSpawnLogic()

TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.MissionAgentSpawnLogic	(	IMissionTroopSupplier[]	suppliers,
		BattleSideEnum	playerSide,
		Mission.BattleSizeType	battleSizeType
	)

Member Function Documentation

OnPhaseChangedDelegate()

delegate void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.OnPhaseChangedDelegate

(

)

GetNumberOfPlayerControllableTroops()

int TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.GetNumberOfPlayerControllableTroops

(

)

InitWithSinglePhase()

void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.InitWithSinglePhase	(	int	defenderTotalSpawn,
		int	attackerTotalSpawn,
		int	defenderInitialSpawn,
		int	attackerInitialSpawn,
		bool	spawnDefenders,
		bool	spawnAttackers,
		in MissionSpawnSettings	spawnSettings
	)

Parameters

defenderTotalSpawn	Total number of defenders to spawn
attackerTotalSpawn	Total number of attackers to spawn
defenderInitialSpawn	Number of initial defenders to spawn. Remainders will spawn as reinforcements
attackerInitialSpawn	Number of initial attackers to spawn. Remainders will spawn as reinforcements
spawnDefenders	Immediately spawn initial defenders within this method. If set to false mission logics will decide when to spawn them
spawnAttackers	Immediately spawn attacker defenders within this method. If set to false mission logics will decide when to spawn them
spawnSettings	Configuration to decide number of reinforcements and reinforcement spawn intervals

GetAllTroopsForSide()

IEnumerable< IAgentOriginBase > TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.GetAllTroopsForSide

(

BattleSideEnum

side

)

SetSpawnTroops()

void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.SetSpawnTroops	(	BattleSideEnum	side,
		bool	spawnTroops,
		bool	enforceSpawning = false
	)

SetSpawnHorses()

void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.SetSpawnHorses	(	BattleSideEnum	side,
		bool	spawnHorses
	)

AfterStart()

override void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.AfterStart ( )

virtual

Reimplemented from TaleWorlds.MountAndBlade.MissionBehavior.

StartSpawner()

void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.StartSpawner

(

BattleSideEnum

side

)

Implements TaleWorlds.MountAndBlade.IMissionAgentSpawnLogic.

StopSpawner()

void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.StopSpawner

(

BattleSideEnum

side

)

Implements TaleWorlds.MountAndBlade.IMissionAgentSpawnLogic.

IsSideSpawnEnabled()

bool TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.IsSideSpawnEnabled

(

BattleSideEnum

side

)

Implements TaleWorlds.MountAndBlade.IMissionAgentSpawnLogic.

OnInitialSpawnForSideEnded()

void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.OnInitialSpawnForSideEnded

(

BattleSideEnum

side

)

OnMissionTick()

override void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.OnMissionTick ( float  dt )

virtual

Reimplemented from TaleWorlds.MountAndBlade.MissionBehavior.

GetReinforcementInterval()

float TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.GetReinforcementInterval

(

)

Implements TaleWorlds.MountAndBlade.IMissionAgentSpawnLogic.

SetReinforcementsSpawnTimerEnabled()

void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.SetReinforcementsSpawnTimerEnabled	(	bool	value,
		bool	resetTimer = true
	)

GetTotalNumberOfTroopsForSide()

int TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.GetTotalNumberOfTroopsForSide

(

BattleSideEnum

side

)

GetGeneralCharacterOfSide()

BasicCharacterObject TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.GetGeneralCharacterOfSide

(

BattleSideEnum

side

)

GetSpawnHorses()

bool TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.GetSpawnHorses

(

BattleSideEnum

side

)

IsSideDepleted()

bool TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.IsSideDepleted

(

BattleSideEnum

side

)

Implements TaleWorlds.MountAndBlade.IMissionAgentSpawnLogic.

AddPhaseChangeAction()

void TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.AddPhaseChangeAction	(	BattleSideEnum	side,
		OnPhaseChangedDelegate	onPhaseChanged
	)

Property Documentation

MaxNumberOfAgentsForMission

int TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.MaxNumberOfAgentsForMission

staticget

NumberOfAgents

int TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.NumberOfAgents

get

NumberOfRemainingTroops

int TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.NumberOfRemainingTroops

get

NumberOfActiveDefenderTroops

int TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.NumberOfActiveDefenderTroops

get

NumberOfActiveAttackerTroops

int TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.NumberOfActiveAttackerTroops

get

BattleSize

int TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.BattleSize

get

IsInitialSpawnOver

bool TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.IsInitialSpawnOver

get

ReinforcementSpawnSettings

ref readonly MissionSpawnSettings TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.ReinforcementSpawnSettings

get

Event Documentation

OnNotifyReinforcementsSpawned

Action<SpawnNotificationData> TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.OnNotifyReinforcementsSpawned

OnNotifyInitialTroopsSpawned

Action<SpawnNotificationData> TaleWorlds.MountAndBlade.MissionAgentSpawnLogic.OnNotifyInitialTroopsSpawned