TaleWorlds.MountAndBlade.UsableMissionObject Class Reference

Inherits TaleWorlds.MountAndBlade.SynchedMissionObject, TaleWorlds.MountAndBlade.IFocusable, TaleWorlds.MountAndBlade.IUsable, and TaleWorlds.MountAndBlade.IVisible.

Inherited by TaleWorlds.MountAndBlade.SpawnedItemEntity, and TaleWorlds.MountAndBlade.StandingPoint.

Public Member Functions
virtual void	OnUserConversationStart ()
virtual void	OnUserConversationEnd ()
void	SetIsDeactivatedSynched (bool value)
void	SetIsDisabledForPlayersSynched (bool value)
virtual bool	IsDisabledForAgent (Agent agent)
void	AddComponent (UsableMissionObjectComponent component)
void	RemoveComponent (UsableMissionObjectComponent component)
T	GetComponent< T > ()
void	RefreshGameEntityWithWorldPosition ()
virtual void	OnFocusGain (Agent userAgent)
virtual void	OnFocusLose (Agent userAgent)
virtual TextObject	GetInfoTextForBeingNotInteractable (Agent userAgent)
virtual void	SetUserForClient (Agent userAgent)
virtual void	OnUse (Agent userAgent)
virtual void	OnAIMoveToUse (Agent userAgent, IDetachment detachment)
virtual void	OnUseStopped (Agent userAgent, bool isSuccessful, int preferenceIndex)
virtual void	OnMoveToStopped (Agent movingAgent)
virtual int	GetMovingAgentCount ()
virtual Agent	GetMovingAgentWithIndex (int index)
virtual void	RemoveMovingAgent (Agent movingAgent)
virtual void	AddMovingAgent (Agent movingAgent)
virtual void	SimulateTick (float dt)
override TickRequirement	GetTickRequirement ()
virtual WorldFrame	GetUserFrameForAgent (Agent agent)
override string	ToString ()
virtual bool	IsAIMovingTo (Agent agent)
virtual bool	HasUserPositionsChanged (Agent agent)
override void	WriteToNetwork ()
	Sends object's data to synchronize it to clients. More...
override bool	ReadFromNetwork ()
	Receives object's data to synchronize it from the server. More...
virtual bool	IsUsableByAgent (Agent userAgent)
override void	OnEndMission ()
abstract string	GetDescriptionText (GameEntity gameEntity=null)
Public Member Functions inherited from TaleWorlds.MountAndBlade.SynchedMissionObject
override TickRequirement	GetTickRequirement ()
void	SetLocalPositionSmoothStep (ref Vec3 targetPosition)
virtual void	SetVisibleSynched (bool value, bool forceChildrenVisible=false)
virtual void	SetPhysicsStateSynched (bool value, bool setChildren=true)
virtual void	SetDisabledSynched ()
void	SetFrameSynched (ref MatrixFrame frame, bool isClient=false)
void	SetGlobalFrameSynched (ref MatrixFrame frame, bool isClient=false)
void	SetFrameSynchedOverTime (ref MatrixFrame frame, float duration, bool isClient=false)
void	SetGlobalFrameSynchedOverTime (ref MatrixFrame frame, float duration, bool isClient=false)
void	SetAnimationAtChannelSynched (string animationName, int channelNo, float animationSpeed=1.0f)
void	SetAnimationAtChannelSynched (int animationIndex, int channelNo, float animationSpeed=1.0f)
void	SetAnimationChannelParameterSynched (int channelNo, float parameter)
void	PauseSkeletonAnimationSynched ()
void	ResumeSkeletonAnimationSynched ()
void	BurstParticlesSynched (bool doChildren=true)
void	ApplyImpulseSynched (Vec3 localPosition, Vec3 impulse)
void	AddBodyFlagsSynched (BodyFlags flags, bool applyToChildren=true)
void	RemoveBodyFlagsSynched (BodyFlags flags, bool applyToChildren=true)
void	SetTeamColors (uint color, uint color2)
virtual void	SetTeamColorsSynched (uint color, uint color2)
virtual bool	ReadFromNetwork ()
virtual void	WriteToNetwork ()
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 ()
void	OnFocusGain (Agent userAgent)
void	OnFocusLose (Agent userAgent)
TextObject	GetInfoTextForBeingNotInteractable (Agent userAgent)
string	GetDescriptionText (GameEntity gameEntity=null)
void	OnUse (Agent userAgent)
void	OnUseStopped (Agent userAgent, bool isSuccessful, int preferenceIndex)

Public Attributes
TextObject	DescriptionMessage = TextObject.Empty
TextObject	ActionMessage = TextObject.Empty

Protected Member Functions
	UsableMissionObject (bool isInstantUse=false)
virtual void	CollectChildEntity (GameEntity childEntity)
virtual bool	VerifyChildEntities (ref string errorMessage)
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
virtual FocusableObjectType	FocusableObjectType [get]
Agent	UserAgent [get]
GameEntityWithWorldPosition	GameEntityWithWorldPosition [get]
virtual Agent	MovingAgent [get]
bool	IsInstantUse [get, protected set]
	Whether this object is used instantly or is used continuously over some time. More...
bool	IsDeactivated [get, set]
bool	IsDisabledForPlayers [get, set]
virtual GameEntity	InteractionEntity [get]
bool	HasAIUser [get]
bool	HasUser [get]
virtual bool	HasAIMovingTo [get]
virtual bool	DisableCombatActionsOnUse [get]
	If user agent's combat actions will be disabled while using this object or not. More...
bool	IsVisible [get, set]
Properties inherited from TaleWorlds.MountAndBlade.SynchedMissionObject
uint	Color [get]
uint	Color2 [get]
bool	SynchronizeCompleted [get]
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.IFocusable
FocusableObjectType	FocusableObjectType [get]
Properties inherited from TaleWorlds.MountAndBlade.IVisible
bool	IsVisible [get, set]

Additional Inherited Members
Public Types inherited from TaleWorlds.MountAndBlade.SynchedMissionObject
enum	SynchFlags : uint
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

Constructor & Destructor Documentation

UsableMissionObject()

TaleWorlds.MountAndBlade.UsableMissionObject.UsableMissionObject ( bool  isInstantUse = false )

protected

Member Function Documentation

OnUserConversationStart()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.OnUserConversationStart ( )

virtual

Reimplemented in SandBox.Objects.AnimationPoints.AnimationPoint.

OnUserConversationEnd()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.OnUserConversationEnd ( )

virtual

Reimplemented in SandBox.Objects.AnimationPoints.AnimationPoint.

SetIsDeactivatedSynched()

void TaleWorlds.MountAndBlade.UsableMissionObject.SetIsDeactivatedSynched

(

bool

value

)

SetIsDisabledForPlayersSynched()

void TaleWorlds.MountAndBlade.UsableMissionObject.SetIsDisabledForPlayersSynched

(

bool

value

)

IsDisabledForAgent()

virtual bool TaleWorlds.MountAndBlade.UsableMissionObject.IsDisabledForAgent ( Agent  agent )

virtual

Reimplemented in SandBox.Objects.AnimationPoints.AnimationPoint, SandBox.Objects.PassageUsePoint, TaleWorlds.MountAndBlade.StandingPoint, TaleWorlds.MountAndBlade.StandingPointForRangedArea, TaleWorlds.MountAndBlade.StandingPointWithAgentLimit, TaleWorlds.MountAndBlade.StandingPointWithTeamLimit, TaleWorlds.MountAndBlade.StandingPointWithVolumeBox, TaleWorlds.MountAndBlade.StandingPointWithWeaponRequirement, and TaleWorlds.MountAndBlade.SpawnedItemEntity.

AddComponent()

void TaleWorlds.MountAndBlade.UsableMissionObject.AddComponent

(

UsableMissionObjectComponent

component

)

RemoveComponent()

void TaleWorlds.MountAndBlade.UsableMissionObject.RemoveComponent

(

UsableMissionObjectComponent

component

)

GetComponent< T >()

T TaleWorlds.MountAndBlade.UsableMissionObject.GetComponent< T >

(

)

Type Constraints

T

:

UsableMissionObjectComponent

RefreshGameEntityWithWorldPosition()

void TaleWorlds.MountAndBlade.UsableMissionObject.RefreshGameEntityWithWorldPosition

(

)

CollectChildEntity()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.CollectChildEntity ( GameEntity  childEntity )

protectedvirtual

VerifyChildEntities()

virtual bool TaleWorlds.MountAndBlade.UsableMissionObject.VerifyChildEntities ( ref string  errorMessage )

protectedvirtual

OnFocusGain()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.OnFocusGain ( Agent  userAgent )

virtual

Implements TaleWorlds.MountAndBlade.IFocusable.

OnFocusLose()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.OnFocusLose ( Agent  userAgent )

virtual

Implements TaleWorlds.MountAndBlade.IFocusable.

GetInfoTextForBeingNotInteractable()

virtual TextObject TaleWorlds.MountAndBlade.UsableMissionObject.GetInfoTextForBeingNotInteractable ( Agent  userAgent )

virtual

Implements TaleWorlds.MountAndBlade.IFocusable.

Reimplemented in TaleWorlds.MountAndBlade.SpawnedItemEntity.

SetUserForClient()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.SetUserForClient ( Agent  userAgent )

virtual

OnUse()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.OnUse ( Agent  userAgent )

virtual

Implements TaleWorlds.MountAndBlade.IUsable.

Reimplemented in SandBox.Objects.AnimationPoints.AnimationPoint, SandBox.Objects.AnimationPoints.ChairUsePoint, SandBox.Objects.PassageUsePoint, TaleWorlds.MountAndBlade.StandingPoint, and TaleWorlds.MountAndBlade.SpawnedItemEntity.

OnAIMoveToUse()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.OnAIMoveToUse ( Agent  userAgent, IDetachment  detachment  )

virtual

OnUseStopped()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.OnUseStopped ( Agent  userAgent, bool  isSuccessful, int  preferenceIndex  )

virtual

Implements TaleWorlds.MountAndBlade.IUsable.

Reimplemented in SandBox.Objects.AnimationPoints.AnimationPoint, SandBox.Objects.AnimationPoints.PlayMusicPoint, SandBox.Objects.PassageUsePoint, TaleWorlds.MountAndBlade.StandingPoint, and TaleWorlds.MountAndBlade.SpawnedItemEntity.

OnMoveToStopped()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.OnMoveToStopped ( Agent  movingAgent )

virtual

GetMovingAgentCount()

virtual int TaleWorlds.MountAndBlade.UsableMissionObject.GetMovingAgentCount ( )

virtual

Reimplemented in SandBox.Objects.PassageUsePoint.

GetMovingAgentWithIndex()

virtual Agent TaleWorlds.MountAndBlade.UsableMissionObject.GetMovingAgentWithIndex ( int  index )

virtual

Reimplemented in SandBox.Objects.PassageUsePoint.

RemoveMovingAgent()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.RemoveMovingAgent ( Agent  movingAgent )

virtual

Reimplemented in SandBox.Objects.PassageUsePoint.

AddMovingAgent()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.AddMovingAgent ( Agent  movingAgent )

virtual

Reimplemented in SandBox.Objects.PassageUsePoint.

SimulateTick()

virtual void TaleWorlds.MountAndBlade.UsableMissionObject.SimulateTick ( float  dt )

virtual

Reimplemented in SandBox.Objects.AnimationPoints.AnimationPoint.

GetTickRequirement()

override TickRequirement TaleWorlds.MountAndBlade.UsableMissionObject.GetTickRequirement ( )

virtual

Reimplemented from TaleWorlds.MountAndBlade.SynchedMissionObject.

OnRemoved()

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

protectedvirtual

Reimplemented from TaleWorlds.MountAndBlade.MissionObject.

GetUserFrameForAgent()

virtual WorldFrame TaleWorlds.MountAndBlade.UsableMissionObject.GetUserFrameForAgent ( Agent  agent )

virtual

Reimplemented in SandBox.Objects.AnimationPoints.AnimationPoint, and TaleWorlds.MountAndBlade.StandingPoint.

ToString()

override string TaleWorlds.MountAndBlade.UsableMissionObject.ToString

(

)

IsAIMovingTo()

virtual bool TaleWorlds.MountAndBlade.UsableMissionObject.IsAIMovingTo ( Agent  agent )

virtual

Reimplemented in SandBox.Objects.PassageUsePoint.

HasUserPositionsChanged()

virtual bool TaleWorlds.MountAndBlade.UsableMissionObject.HasUserPositionsChanged ( Agent  agent )

virtual

WriteToNetwork()

override void TaleWorlds.MountAndBlade.UsableMissionObject.WriteToNetwork ( )

virtual

Reimplemented from TaleWorlds.MountAndBlade.SynchedMissionObject.

ReadFromNetwork()

override bool TaleWorlds.MountAndBlade.UsableMissionObject.ReadFromNetwork ( )

virtual

Reimplemented from TaleWorlds.MountAndBlade.SynchedMissionObject.

IsUsableByAgent()

virtual bool TaleWorlds.MountAndBlade.UsableMissionObject.IsUsableByAgent ( Agent  userAgent )

virtual

Reimplemented in SandBox.Objects.AnimationPoints.AnimationPoint, and SandBox.Objects.PassageUsePoint.

OnEndMission()

override void TaleWorlds.MountAndBlade.UsableMissionObject.OnEndMission ( )

virtual

Reimplemented from TaleWorlds.MountAndBlade.MissionObject.

GetDescriptionText()

abstract string TaleWorlds.MountAndBlade.UsableMissionObject.GetDescriptionText ( GameEntity  gameEntity = null )

pure virtual

Implements TaleWorlds.MountAndBlade.IFocusable.

Implemented in TaleWorlds.MountAndBlade.StandingPoint, and TaleWorlds.MountAndBlade.SpawnedItemEntity.

Member Data Documentation

DescriptionMessage

TextObject TaleWorlds.MountAndBlade.UsableMissionObject.DescriptionMessage = TextObject.Empty

ActionMessage

TextObject TaleWorlds.MountAndBlade.UsableMissionObject.ActionMessage = TextObject.Empty

Property Documentation

FocusableObjectType

virtual FocusableObjectType TaleWorlds.MountAndBlade.UsableMissionObject.FocusableObjectType

get

Implements TaleWorlds.MountAndBlade.IFocusable.

UserAgent

Agent TaleWorlds.MountAndBlade.UsableMissionObject.UserAgent

get

GameEntityWithWorldPosition

GameEntityWithWorldPosition TaleWorlds.MountAndBlade.UsableMissionObject.GameEntityWithWorldPosition

get

MovingAgent

virtual Agent TaleWorlds.MountAndBlade.UsableMissionObject.MovingAgent

get

IsInstantUse

bool TaleWorlds.MountAndBlade.UsableMissionObject.IsInstantUse

getprotected set

IsDeactivated

bool TaleWorlds.MountAndBlade.UsableMissionObject.IsDeactivated

getset

IsDisabledForPlayers

bool TaleWorlds.MountAndBlade.UsableMissionObject.IsDisabledForPlayers

getset

InteractionEntity

virtual GameEntity TaleWorlds.MountAndBlade.UsableMissionObject.InteractionEntity

get

HasAIUser

bool TaleWorlds.MountAndBlade.UsableMissionObject.HasAIUser

get

HasUser

bool TaleWorlds.MountAndBlade.UsableMissionObject.HasUser

get

HasAIMovingTo

virtual bool TaleWorlds.MountAndBlade.UsableMissionObject.HasAIMovingTo

get

DisableCombatActionsOnUse

virtual bool TaleWorlds.MountAndBlade.UsableMissionObject.DisableCombatActionsOnUse

get

IsVisible

bool TaleWorlds.MountAndBlade.UsableMissionObject.IsVisible

getset

Implements TaleWorlds.MountAndBlade.IVisible.