TaleWorlds.MountAndBlade.BannerBearerLogic Class Reference

Primary logic for the banner bearers feature. This should be added to all missions that support banner bearers.

Inherits TaleWorlds.MountAndBlade.MissionLogic.

Public Member Functions
	BannerBearerLogic ()
bool	IsFormationBanner (Formation formation, SpawnedItemEntity spawnedItem)
bool	HasBannerOnGround (Formation formation)
BannerComponent	GetActiveBanner (Formation formation)
List< Agent >	GetFormationBannerBearers (Formation formation)
ItemObject	GetFormationBanner (Formation formation)
bool	IsBannerSearchingAgent (Agent agent)
int	GetMissingBannerCount (Formation formation)
Formation	GetFormationFromBanner (SpawnedItemEntity spawnedItem)
void	SetFormationBanner (Formation formation, ItemObject newBanner)
override void	OnBehaviorInitialize ()
override void	OnMissionTick (float dt)
override void	OnItemPickup (Agent agent, SpawnedItemEntity spawnedItem)
override void	OnItemDrop (Agent agent, SpawnedItemEntity spawnedItem)
override void	OnAgentRemoved (Agent affectedAgent, Agent affectorAgent, AgentState agentState, KillingBlow blow)
override void	OnAgentPanicked (Agent affectedAgent)
Agent	SpawnBannerBearer (IAgentOriginBase troopOrigin, bool isPlayerSide, Formation formation, bool spawnWithHorse, bool isReinforcement, int formationTroopCount, int formationTroopIndex, bool isAlarmed, bool wieldInitialWeapons, bool forceDismounted, Vec3? initialPosition, Vec2? initialDirection, string specialActionSetSuffix=null)
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)

Static Public Member Functions
static bool	IsBannerItem (ItemObject item)

Static Public Attributes
const float	DefaultBannerBearerAgentDefensiveness = 1f
const float	BannerSearcherUpdatePeriod = 3f

Protected Member Functions
override void	OnEndMission ()
virtual void	OnEndMission ()

Events
Action< Formation >	OnBannerBearersUpdated

Additional Inherited Members
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]

Constructor & Destructor Documentation

BannerBearerLogic()

TaleWorlds.MountAndBlade.BannerBearerLogic.BannerBearerLogic

(

)

Member Function Documentation

IsFormationBanner()

bool TaleWorlds.MountAndBlade.BannerBearerLogic.IsFormationBanner	(	Formation	formation,
		SpawnedItemEntity	spawnedItem
	)

HasBannerOnGround()

bool TaleWorlds.MountAndBlade.BannerBearerLogic.HasBannerOnGround

(

Formation

formation

)

GetActiveBanner()

BannerComponent TaleWorlds.MountAndBlade.BannerBearerLogic.GetActiveBanner

(

Formation

formation

)

GetFormationBannerBearers()

List< Agent > TaleWorlds.MountAndBlade.BannerBearerLogic.GetFormationBannerBearers

(

Formation

formation

)

GetFormationBanner()

ItemObject TaleWorlds.MountAndBlade.BannerBearerLogic.GetFormationBanner

(

Formation

formation

)

IsBannerSearchingAgent()

bool TaleWorlds.MountAndBlade.BannerBearerLogic.IsBannerSearchingAgent

(

Agent

agent

)

GetMissingBannerCount()

int TaleWorlds.MountAndBlade.BannerBearerLogic.GetMissingBannerCount

(

Formation

formation

)

GetFormationFromBanner()

Formation TaleWorlds.MountAndBlade.BannerBearerLogic.GetFormationFromBanner

(

SpawnedItemEntity

spawnedItem

)

SetFormationBanner()

void TaleWorlds.MountAndBlade.BannerBearerLogic.SetFormationBanner	(	Formation	formation,
		ItemObject	newBanner
	)

OnBehaviorInitialize()

override void TaleWorlds.MountAndBlade.BannerBearerLogic.OnBehaviorInitialize ( )

virtual

Reimplemented from TaleWorlds.MountAndBlade.MissionBehavior.

OnEndMission()

override void TaleWorlds.MountAndBlade.BannerBearerLogic.OnEndMission ( )

protectedvirtual

Reimplemented from TaleWorlds.MountAndBlade.MissionBehavior.

OnMissionTick()

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

virtual

Reimplemented from TaleWorlds.MountAndBlade.MissionBehavior.

OnItemPickup()

override void TaleWorlds.MountAndBlade.BannerBearerLogic.OnItemPickup ( Agent  agent, SpawnedItemEntity  spawnedItem  )

virtual

Reimplemented from TaleWorlds.MountAndBlade.MissionBehavior.

OnItemDrop()

override void TaleWorlds.MountAndBlade.BannerBearerLogic.OnItemDrop ( Agent  agent, SpawnedItemEntity  spawnedItem  )

virtual

Reimplemented from TaleWorlds.MountAndBlade.MissionBehavior.

OnAgentRemoved()

override void TaleWorlds.MountAndBlade.BannerBearerLogic.OnAgentRemoved ( Agent  affectedAgent, Agent  affectorAgent, AgentState  agentState, KillingBlow  blow  )

virtual

Reimplemented from TaleWorlds.MountAndBlade.MissionBehavior.

OnAgentPanicked()

override void TaleWorlds.MountAndBlade.BannerBearerLogic.OnAgentPanicked ( Agent  affectedAgent )

virtual

Reimplemented from TaleWorlds.MountAndBlade.MissionBehavior.

SpawnBannerBearer()

Agent TaleWorlds.MountAndBlade.BannerBearerLogic.SpawnBannerBearer	(	IAgentOriginBase	troopOrigin,
		bool	isPlayerSide,
		Formation	formation,
		bool	spawnWithHorse,
		bool	isReinforcement,
		int	formationTroopCount,
		int	formationTroopIndex,
		bool	isAlarmed,
		bool	wieldInitialWeapons,
		bool	forceDismounted,
		Vec3?	initialPosition,
		Vec2?	initialDirection,
		string	specialActionSetSuffix = null
	)

IsBannerItem()

static bool TaleWorlds.MountAndBlade.BannerBearerLogic.IsBannerItem ( ItemObject  item )

static

Member Data Documentation

DefaultBannerBearerAgentDefensiveness

const float TaleWorlds.MountAndBlade.BannerBearerLogic.DefaultBannerBearerAgentDefensiveness = 1f

static

BannerSearcherUpdatePeriod

const float TaleWorlds.MountAndBlade.BannerBearerLogic.BannerSearcherUpdatePeriod = 3f

static

Event Documentation

OnBannerBearersUpdated

Action<Formation> TaleWorlds.MountAndBlade.BannerBearerLogic.OnBannerBearersUpdated