Table of Contents

Class UsableMissionObject

Namespace
TaleWorlds.MountAndBlade
Assembly
TaleWorlds.MountAndBlade.dll
public abstract class UsableMissionObject : SynchedMissionObject, IFocusable, IUsable, IVisible
Inheritance
UsableMissionObject
Implements
Derived
Inherited Members

Constructors

UsableMissionObject(bool)

protected UsableMissionObject(bool isInstantUse = false)

Parameters

isInstantUse bool

Fields

ActionMessage

[EditableScriptComponentVariable(false)]
public TextObject ActionMessage

Field Value

TextObject

DescriptionMessage

[EditableScriptComponentVariable(false)]
public TextObject DescriptionMessage

Field Value

TextObject

Properties

DefendingAgents

public List<Agent> DefendingAgents { get; }

Property Value

List<Agent>

DisableCombatActionsOnUse

public virtual bool DisableCombatActionsOnUse { get; }

Property Value

bool

FocusableObjectType

public virtual FocusableObjectType FocusableObjectType { get; }

Property Value

FocusableObjectType

GameEntityWithWorldPosition

public GameEntityWithWorldPosition GameEntityWithWorldPosition { get; }

Property Value

GameEntityWithWorldPosition

HasAIMovingTo

public virtual bool HasAIMovingTo { get; }

Property Value

bool

HasAIUser

public bool HasAIUser { get; }

Property Value

bool

HasDefendingAgent

public bool HasDefendingAgent { get; }

Property Value

bool

HasUser

public bool HasUser { get; }

Property Value

bool

InteractionEntity

public virtual GameEntity InteractionEntity { get; }

Property Value

GameEntity

IsDeactivated

public bool IsDeactivated { get; set; }

Property Value

bool

IsDisabledForPlayers

public bool IsDisabledForPlayers { get; set; }

Property Value

bool

IsInstantUse

public bool IsInstantUse { get; protected set; }

Property Value

bool

IsVisible

public bool IsVisible { get; set; }

Property Value

bool

LockUserFrames

protected virtual bool LockUserFrames { get; set; }

Property Value

bool

LockUserPositions

protected virtual bool LockUserPositions { get; set; }

Property Value

bool

MovingAgent

public virtual Agent MovingAgent { get; }

Property Value

Agent

PreviousUserAgent

public Agent PreviousUserAgent { get; }

Property Value

Agent

UserAgent

public Agent UserAgent { get; }

Property Value

Agent

Methods

AddComponent(UsableMissionObjectComponent)

public void AddComponent(UsableMissionObjectComponent component)

Parameters

component UsableMissionObjectComponent

AddDefendingAgent(Agent)

public void AddDefendingAgent(Agent agent)

Parameters

agent Agent

AddMovingAgent(Agent)

public virtual void AddMovingAgent(Agent movingAgent)

Parameters

movingAgent Agent

CollectChildEntity(GameEntity)

protected virtual void CollectChildEntity(GameEntity childEntity)

Parameters

childEntity GameEntity

GetComponent<T>()

public T GetComponent<T>() where T : UsableMissionObjectComponent

Returns

T

Type Parameters

T

GetDefendingAgentCount()

public int GetDefendingAgentCount()

Returns

int

GetDescriptionText(GameEntity)

public abstract string GetDescriptionText(GameEntity gameEntity = null)

Parameters

gameEntity GameEntity

Returns

string

GetInfoTextForBeingNotInteractable(Agent)

public virtual TextObject GetInfoTextForBeingNotInteractable(Agent userAgent)

Parameters

userAgent Agent

Returns

TextObject

GetMovingAgentCount()

public virtual int GetMovingAgentCount()

Returns

int

GetMovingAgentWithIndex(int)

public virtual Agent GetMovingAgentWithIndex(int index)

Parameters

index int

Returns

Agent

GetTickRequirement()

public override ScriptComponentBehavior.TickRequirement GetTickRequirement()

Returns

ScriptComponentBehavior.TickRequirement

GetUserFrameForAgent(Agent)

public virtual WorldFrame GetUserFrameForAgent(Agent agent)

Parameters

agent Agent

Returns

WorldFrame

HasUserPositionsChanged(Agent)

public virtual bool HasUserPositionsChanged(Agent agent)

Parameters

agent Agent

Returns

bool

InitializeDefendingAgents()

public void InitializeDefendingAgents()

IsAIMovingTo(Agent)

public virtual bool IsAIMovingTo(Agent agent)

Parameters

agent Agent

Returns

bool

IsAgentDefending(Agent)

public bool IsAgentDefending(Agent agent)

Parameters

agent Agent

Returns

bool

IsDisabledForAgent(Agent)

public virtual bool IsDisabledForAgent(Agent agent)

Parameters

agent Agent

Returns

bool

IsUsableByAgent(Agent)

public virtual bool IsUsableByAgent(Agent userAgent)

Parameters

userAgent Agent

Returns

bool

OnAIDefendBegin(Agent, IDetachment)

public void OnAIDefendBegin(Agent agent, IDetachment detachment)

Parameters

agent Agent
detachment IDetachment

OnAIDefendEnd(Agent)

public void OnAIDefendEnd(Agent agent)

Parameters

agent Agent

OnAIMoveToUse(Agent, IDetachment)

public virtual void OnAIMoveToUse(Agent userAgent, IDetachment detachment)

Parameters

userAgent Agent
detachment IDetachment

OnAfterReadFromNetwork((BaseSynchedMissionObjectReadableRecord, ISynchedMissionObjectReadableRecord))

public override void OnAfterReadFromNetwork((BaseSynchedMissionObjectReadableRecord, ISynchedMissionObjectReadableRecord) synchedMissionObjectReadableRecord)

Parameters

synchedMissionObjectReadableRecord (BaseSynchedMissionObjectReadableRecord, ISynchedMissionObjectReadableRecord)

OnEditorInit()

protected override void OnEditorInit()

OnEditorTick(float)

protected override void OnEditorTick(float dt)

Parameters

dt float

OnEditorValidate()

protected override void OnEditorValidate()

OnEndMission()

public override void OnEndMission()

OnFocusGain(Agent)

public virtual void OnFocusGain(Agent userAgent)

Parameters

userAgent Agent

OnFocusLose(Agent)

public virtual void OnFocusLose(Agent userAgent)

Parameters

userAgent Agent

OnInit()

protected override void OnInit()

OnMissionReset()

protected override void OnMissionReset()

OnMoveToStopped(Agent)

public virtual void OnMoveToStopped(Agent movingAgent)

Parameters

movingAgent Agent

OnRemoved(int)

protected override void OnRemoved(int removeReason)

Parameters

removeReason int

OnTick(float)

protected override void OnTick(float dt)

Parameters

dt float

OnTickParallel2(float)

protected override void OnTickParallel2(float dt)

Parameters

dt float

OnUse(Agent)

public virtual void OnUse(Agent userAgent)

Parameters

userAgent Agent

OnUseStopped(Agent, bool, int)

public virtual void OnUseStopped(Agent userAgent, bool isSuccessful, int preferenceIndex)

Parameters

userAgent Agent
isSuccessful bool
preferenceIndex int

OnUserConversationEnd()

public virtual void OnUserConversationEnd()

OnUserConversationStart()

public virtual void OnUserConversationStart()

RefreshGameEntityWithWorldPosition()

public void RefreshGameEntityWithWorldPosition()

RemoveComponent(UsableMissionObjectComponent)

public void RemoveComponent(UsableMissionObjectComponent component)

Parameters

component UsableMissionObjectComponent

RemoveDefendingAgent(Agent)

public void RemoveDefendingAgent(Agent agent)

Parameters

agent Agent

RemoveMovingAgent(Agent)

public virtual void RemoveMovingAgent(Agent movingAgent)

Parameters

movingAgent Agent

SetIsDeactivatedSynched(bool)

public void SetIsDeactivatedSynched(bool value)

Parameters

value bool

SetIsDisabledForPlayersSynched(bool)

public void SetIsDisabledForPlayersSynched(bool value)

Parameters

value bool

SetUserForClient(Agent)

public virtual void SetUserForClient(Agent userAgent)

Parameters

userAgent Agent

SimulateTick(float)

public virtual void SimulateTick(float dt)

Parameters

dt float

ToString()

public override string ToString()

Returns

string

VerifyChildEntities(ref string)

protected virtual bool VerifyChildEntities(ref string errorMessage)

Parameters

errorMessage string

Returns

bool

WriteToNetwork()

public override void WriteToNetwork()

This page was last modified at 09/01/2024 16:12:00 +00:00 (UTC).