Inherits TaleWorlds.MountAndBlade.StandingPoint.

Public Member Functions
void	SetAgentItemsVisibility (bool isVisible)

override void	OnUse (Agent userAgent, sbyte agentBoneIndex)

override void	OnUseStopped (Agent userAgent, bool isSuccessful, int preferenceIndex)

override TextObject	GetDescriptionText (WeakGameEntity gameEntity)

Public Member Functions inherited from TaleWorlds.MountAndBlade.StandingPoint
void	OnParentMachinePhysicsStateChanged ()

override bool	IsDisabledForAgent (Agent agent)

override TickRequirement	GetTickRequirement ()

override void	OnUse (Agent userAgent, sbyte agentBoneIndex)

override void	OnUseStopped (Agent userAgent, bool isSuccessful, int preferenceIndex)

override WorldFrame	GetUserFrameForAgent (Agent agent)

virtual bool	HasAlternative ()

virtual float	GetUsageScoreForAgent (Agent agent)

virtual float	GetUsageScoreForAgent (ValueTuple< Agent, float > agentPair)

void	SetupOnUsingStoppedBehavior (bool autoAttach, Action< Agent, bool > action)

override void	OnEndMission ()

override TextObject	GetDescriptionText (WeakGameEntity gameEntity)

override bool	IsUsableByAgent (Agent userAgent)

void	SetUsableByAIOnly ()

void	SetUsableByPlayerOnly ()

void	SetUsableByPlayerOrAI ()

Public Member Functions inherited from TaleWorlds.MountAndBlade.UsableMissionObject
virtual void	OnUserConversationStart ()

virtual void	OnUserConversationEnd ()

void	SetAreUserPositionsUpdatedInTheMachineTick (bool value)

bool	GetIsUserPositionsUpdatedInTheMachineTick ()

void	SetIsDeactivatedSynched (bool value)

void	SetIsDisabledForPlayersSynched (bool value)

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	OnAIMoveToUse (Agent userAgent, IDetachment detachment)

virtual void	OnMoveToStopped (Agent movingAgent)

virtual int	GetMovingAgentCount ()

virtual Agent	GetMovingAgentWithIndex (int index)

virtual void	RemoveMovingAgent (Agent movingAgent)

virtual void	AddMovingAgent (Agent movingAgent)

void	OnAIDefendBegin (Agent agent, IDetachment detachment)

void	OnAIDefendEnd (Agent agent)

void	InitializeDefendingAgents ()

int	GetDefendingAgentCount ()

void	AddDefendingAgent (Agent agent)

void	RemoveDefendingAgent (Agent agent)

bool	IsAgentDefending (Agent agent)

virtual void	SimulateTick (float dt)

override TickRequirement	GetTickRequirement ()

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.

void	SetCustomLocalFrame (in MatrixFrame customLocalFrame)

override void	OnEndMission ()

override void	OnAfterReadFromNetwork ((BaseSynchedMissionObjectReadableRecord, ISynchedMissionObjectReadableRecord) synchedMissionObjectReadableRecord)

TextObject	GetDescriptionText (WeakGameEntity gameEntity)

Public Member Functions inherited from TaleWorlds.MountAndBlade.SynchedMissionObject
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)

Public Member Functions inherited from TaleWorlds.MountAndBlade.MissionObject
	MissionObject ()

virtual void	SetAbilityOfFaces (bool enabled)

override int	GetHashCode ()

virtual void	AfterMissionStart ()

virtual void	OnMissionEnded ()

virtual void	OnDeploymentFinished ()

void	SetEnabled (bool isParentObject=false)
	Enables the mission object script and adds it to active mission objects.

void	SetEnabledAndMakeVisible (bool isParentObject=false, bool enableFaces=false)
	Mission object is enabled and added to active mission objects list, its entity is made visible and therefore its physics is turned on.

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.

void	SetDisabledAndMakeInvisible (bool isParentObject=false, bool disableFaces=false)
	Mission object is disabled and removed from active mission objects list, its entity is made invisible and therefore its physics is turned off.

virtual void	AddStuckMissile (GameEntity missileEntity)

Public Member Functions inherited from TaleWorlds.Engine.ScriptComponentBehavior
void	SetScriptComponentToTick (TickRequirement tickReq)

void	SetScriptComponentToTickMT (TickRequirement value)

Public Attributes
readonly int	WaitDuration

readonly int	WaitDeviation

readonly int	Index

readonly string	SpawnGroupTag

readonly bool	IsInfiniteWaitPoint

readonly float	PatrollingSpeed = -1.0f

string	LoopAction = ""

string	RightHandItem = ""

HumanBone	RightHandItemBone = HumanBone.ItemR

string	LeftHandItem = ""

HumanBone	LeftHandItemBone = HumanBone.ItemL

Public Attributes inherited from TaleWorlds.MountAndBlade.StandingPoint
bool	AutoSheathWeapons = true

bool	AutoEquipWeaponsOnUseStopped

bool	AutoWieldWeapons

readonly bool	TranslateUser = true

bool	HasRecentlyBeenRechecked = false

Public Attributes inherited from TaleWorlds.MountAndBlade.UsableMissionObject
TextObject	DescriptionMessage = TextObject.GetEmpty()

TextObject	ActionMessage = TextObject.GetEmpty()

Protected Member Functions
void	AssignItemToBone (AnimationPoint.ItemForBone newItem)

override void	OnInit ()
	This callback method is called when the object is constructed.

override void	OnEditorTick (float dt)

Protected Member Functions inherited from TaleWorlds.MountAndBlade.StandingPoint
virtual bool	DoesActionTypeStopUsingGameObject (Agent.ActionCodeType actionType)

Protected Member Functions inherited from TaleWorlds.MountAndBlade.UsableMissionObject
	UsableMissionObject (bool isInstantUse=false)

virtual void	CollectChildEntity (WeakGameEntity childEntity)

virtual bool	VerifyChildEntities (ref string errorMessage)

override void	OnRemoved (int removeReason)

Protected Member Functions inherited from TaleWorlds.MountAndBlade.MissionObject
virtual void	AttachDynamicNavmeshToEntity ()

virtual WeakGameEntity	GetEntityToAttachNavMeshFaces ()

Protected Member Functions inherited from TaleWorlds.Engine.ScriptComponentBehavior
void	InvalidateWeakPointersIfValid ()

	ScriptComponentBehavior ()

Properties
string	SelectedRightHandItem `[get, set]`

string	SelectedLeftHandItem `[get, set]`

Properties inherited from TaleWorlds.MountAndBlade.StandingPoint
virtual Agent.AIScriptedFrameFlags	DisableScriptedFrameFlags `[get]`

override bool	DisableCombatActionsOnUse `[get]`

Agent	FavoredUser `[get, set]`

virtual bool	PlayerStopsUsingWhenInteractsWithOther `[get]`

bool	UseOwnPositionInsteadOfWorldPosition `[get]`

float	CustomPlayerInteractionDistance `[get]`

Properties inherited from TaleWorlds.MountAndBlade.UsableMissionObject
virtual FocusableObjectType	FocusableObjectType `[get]`

virtual bool	IsFocusable `[get]`

Agent	UserAgent `[get]`

Agent	PreviousUserAgent `[get]`

GameEntityWithWorldPosition	GameEntityWithWorldPosition `[get]`

virtual Agent	MovingAgent `[get]`

List< Agent >	DefendingAgents `[get]`

bool	HasDefendingAgent `[get]`

virtual bool	DisableCombatActionsOnUse `[get]`
	If user agent's combat actions will be disabled while using this object or not.

virtual bool	LockUserFrames `[get, set]`
	If user agents' frames will stay constant or not.

virtual bool	LockUserPositions `[get, set]`
	If user agents' positions will stay constant or not.

bool	IsInstantUse `[get, protected set]`
	Whether this object is used instantly or is used continuously over some time.

bool	IsDeactivated `[get, set]`

bool	IsDisabledForPlayers `[get, set]`

virtual WeakGameEntity	InteractionEntity `[get]`

bool	HasAIUser `[get]`

bool	HasUser `[get]`

virtual bool	HasAIMovingTo `[get]`

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]`

virtual TextObject	HitObjectName `[get]`

bool	CreatedAtRuntime `[get]`

Properties inherited from TaleWorlds.Engine.ScriptComponentBehavior
WeakGameEntity	GameEntity `[get]`

ManagedScriptComponent	ScriptComponent `[get]`

ManagedScriptHolder	ManagedScriptHolder `[get]`

Scene	Scene `[get]`

Properties inherited from TaleWorlds.MountAndBlade.IFocusable
Properties inherited from TaleWorlds.MountAndBlade.IVisible

Additional Inherited Members
Public Types inherited from TaleWorlds.MountAndBlade.SynchedMissionObject
enum	SynchFlags : uint { SynchNone = 0x00000000 , SynchTransform = 0x00000001 , SynchAnimation = 0x00000002 , SynchBodyFlags = 0x00000004 , SyncColors = 0x00000008 , SynchAll = 0xffffffff }

Public Types inherited from TaleWorlds.Engine.ScriptComponentBehavior
enum	TickRequirement : uint { None = 0x00000000 , TickOccasionally = 0x00000001 , Tick = 0x00000002 , TickParallel = 0x00000004 , TickParallel2 = 0x00000008 , FixedTick = 0x00000010 , FixedParallelTick = 0x00000020 , TickParallel3 = 0x00000040 }

Static Public Attributes inherited from TaleWorlds.MountAndBlade.MissionObject
const int	MaxNavMeshPerDynamicObject = 50

Protected Types inherited from TaleWorlds.MountAndBlade.MissionObject
enum	DynamicNavmeshLocalIds : int { Inside = 1 , Enter = 2 , Exit = 3 , Blocker = 4 , Extra1 = 5 , Extra2 = 6 , Extra3 = 7 , Reserved1 = 9 , Count }

Protected Attributes inherited from TaleWorlds.MountAndBlade.StandingPoint
BattleSideEnum	StandingPointSide = BattleSideEnum.None

Protected Attributes inherited from TaleWorlds.MountAndBlade.MissionObject
string	NavMeshPrefabName = ""

int	DynamicNavmeshIdStart = 0

Member Function Documentation

◆ AssignItemToBone()

void SandBox.Objects.PatrolPoint.AssignItemToBone ( AnimationPoint.ItemForBone newItem )

protected

◆ SetAgentItemsVisibility()

void SandBox.Objects.PatrolPoint.SetAgentItemsVisibility ( bool isVisible )

◆ OnUse()

override void SandBox.Objects.PatrolPoint.OnUse	(	Agent	userAgent,
		sbyte	agentBoneIndex )

virtual

Reimplemented from TaleWorlds.MountAndBlade.UsableMissionObject.

◆ OnUseStopped()

override void SandBox.Objects.PatrolPoint.OnUseStopped	(	Agent	userAgent,
		bool	isSuccessful,
		int	preferenceIndex )

virtual

Reimplemented from TaleWorlds.MountAndBlade.UsableMissionObject.

◆ OnInit()

override void SandBox.Objects.PatrolPoint.OnInit ( )

protectedvirtual

Reimplemented from TaleWorlds.MountAndBlade.MissionObject.

◆ OnEditorTick()

override void SandBox.Objects.PatrolPoint.OnEditorTick ( float dt )

protectedvirtual

Reimplemented from TaleWorlds.Engine.ScriptComponentBehavior.

◆ GetDescriptionText()

override TextObject SandBox.Objects.PatrolPoint.GetDescriptionText ( WeakGameEntity gameEntity )

Implements TaleWorlds.MountAndBlade.IFocusable.

Member Data Documentation

◆ WaitDuration

readonly int SandBox.Objects.PatrolPoint.WaitDuration

◆ WaitDeviation

readonly int SandBox.Objects.PatrolPoint.WaitDeviation

◆ Index

readonly int SandBox.Objects.PatrolPoint.Index

◆ SpawnGroupTag

readonly string SandBox.Objects.PatrolPoint.SpawnGroupTag

◆ IsInfiniteWaitPoint

readonly bool SandBox.Objects.PatrolPoint.IsInfiniteWaitPoint

◆ PatrollingSpeed

readonly float SandBox.Objects.PatrolPoint.PatrollingSpeed = -1.0f

◆ LoopAction

string SandBox.Objects.PatrolPoint.LoopAction = ""

◆ RightHandItem

string SandBox.Objects.PatrolPoint.RightHandItem = ""

◆ RightHandItemBone

HumanBone SandBox.Objects.PatrolPoint.RightHandItemBone = HumanBone.ItemR

◆ LeftHandItem

string SandBox.Objects.PatrolPoint.LeftHandItem = ""

◆ LeftHandItemBone

HumanBone SandBox.Objects.PatrolPoint.LeftHandItemBone = HumanBone.ItemL

Property Documentation

◆ SelectedRightHandItem

string SandBox.Objects.PatrolPoint.SelectedRightHandItem

getsetprotected

◆ SelectedLeftHandItem

string SandBox.Objects.PatrolPoint.SelectedLeftHandItem