M&B: Bannerlord 1.2.7
The horns sound, the ravens gather.
Loading...
Searching...
No Matches
SandBox.Objects.PassageUsePoint Class Reference

Inherits TaleWorlds.MountAndBlade.StandingPoint.

Public Member Functions

 PassageUsePoint ()
 
override bool IsDisabledForAgent (Agent agent)
 
override void AfterMissionStart ()
 
override void OnUse (Agent userAgent)
 
override void OnUseStopped (Agent userAgent, bool isSuccessful, int preferenceIndex)
 
override bool IsUsableByAgent (Agent userAgent)
 
override int GetMovingAgentCount ()
 
override Agent GetMovingAgentWithIndex (int index)
 
override void AddMovingAgent (Agent movingAgent)
 
override void RemoveMovingAgent (Agent movingAgent)
 
override bool IsAIMovingTo (Agent agent)
 
- Public Member Functions inherited from TaleWorlds.MountAndBlade.StandingPoint
 StandingPoint ()
 
void OnParentMachinePhysicsStateChanged ()
 
override bool IsDisabledForAgent (Agent agent)
 
override TickRequirement GetTickRequirement ()
 
override void OnUse (Agent userAgent)
 
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 string GetDescriptionText (GameEntity gameEntity=null)
 
- Public Member Functions inherited from TaleWorlds.MountAndBlade.UsableMissionObject
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)
 
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)
 
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 ()
 
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.
 
virtual bool IsUsableByAgent (Agent userAgent)
 
override void OnEndMission ()
 
override void OnAfterReadFromNetwork ((BaseSynchedMissionObjectReadableRecord, ISynchedMissionObjectReadableRecord) synchedMissionObjectReadableRecord)
 
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 void WriteToNetwork ()
 
virtual void OnAfterReadFromNetwork ((BaseSynchedMissionObjectReadableRecord, ISynchedMissionObjectReadableRecord) synchedMissionObjectReadableRecord)
 
- Public Member Functions inherited from TaleWorlds.MountAndBlade.MissionObject
 MissionObject ()
 
virtual void SetAbilityOfFaces (bool enabled)
 
override int GetHashCode ()
 
virtual void AfterMissionStart ()
 
virtual void OnMissionEnded ()
 
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)
 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 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

string ToLocationId = ""
 
- Public Attributes inherited from TaleWorlds.MountAndBlade.StandingPoint
bool AutoSheathWeapons
 
bool AutoEquipWeaponsOnUseStopped
 
bool AutoWieldWeapons
 
readonly bool TranslateUser
 
bool HasRecentlyBeenRechecked = false
 
- Public Attributes inherited from TaleWorlds.MountAndBlade.UsableMissionObject
TextObject DescriptionMessage = TextObject.Empty
 
TextObject ActionMessage = TextObject.Empty
 

Protected Member Functions

override void OnInit ()
 This callback method is called when the object is constructed.
 
- 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 (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

MBReadOnlyList< AgentMovingAgents [get]
 
override Agent MovingAgent [get]
 
Location ToLocation [get]
 
override bool HasAIMovingTo [get]
 
override FocusableObjectType FocusableObjectType [get]
 
override bool DisableCombatActionsOnUse [get]
 
- Properties inherited from TaleWorlds.MountAndBlade.StandingPoint
virtual Agent.AIScriptedFrameFlags DisableScriptedFrameFlags [get]
 
override bool DisableCombatActionsOnUse [get]
 
Agent FavoredUser [get, set]
 
virtual bool PlayerStopsUsingWhenInteractsWithOther [get]
 
- Properties inherited from TaleWorlds.MountAndBlade.UsableMissionObject
virtual FocusableObjectType FocusableObjectType [get]
 
Agent UserAgent [get]
 
Agent PreviousUserAgent [get]
 
GameEntityWithWorldPosition GameEntityWithWorldPosition [get]
 
virtual Agent MovingAgent [get]
 
List< AgentDefendingAgents [get]
 
bool HasDefendingAgent [get]
 
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 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.
 
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 {
  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
}
 
- Static Public Attributes inherited from TaleWorlds.MountAndBlade.MissionObject
const int MaxNavMeshPerDynamicObject = (int) DynamicNavmeshLocalIds.Count
 
- 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 = 8 ,
  Reserved2 = 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
 

Constructor & Destructor Documentation

◆ PassageUsePoint()

SandBox.Objects.PassageUsePoint.PassageUsePoint ( )

Member Function Documentation

◆ IsDisabledForAgent()

override bool SandBox.Objects.PassageUsePoint.IsDisabledForAgent ( Agent  agent)
virtual

◆ AfterMissionStart()

override void SandBox.Objects.PassageUsePoint.AfterMissionStart ( )
virtual

◆ OnInit()

override void SandBox.Objects.PassageUsePoint.OnInit ( )
protectedvirtual

◆ OnUse()

override void SandBox.Objects.PassageUsePoint.OnUse ( Agent  userAgent)
virtual

◆ OnUseStopped()

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

◆ IsUsableByAgent()

override bool SandBox.Objects.PassageUsePoint.IsUsableByAgent ( Agent  userAgent)
virtual

◆ GetMovingAgentCount()

override int SandBox.Objects.PassageUsePoint.GetMovingAgentCount ( )
virtual

◆ GetMovingAgentWithIndex()

override Agent SandBox.Objects.PassageUsePoint.GetMovingAgentWithIndex ( int  index)
virtual

◆ AddMovingAgent()

override void SandBox.Objects.PassageUsePoint.AddMovingAgent ( Agent  movingAgent)
virtual

◆ RemoveMovingAgent()

override void SandBox.Objects.PassageUsePoint.RemoveMovingAgent ( Agent  movingAgent)
virtual

◆ IsAIMovingTo()

override bool SandBox.Objects.PassageUsePoint.IsAIMovingTo ( Agent  agent)
virtual

Member Data Documentation

◆ ToLocationId

string SandBox.Objects.PassageUsePoint.ToLocationId = ""

Property Documentation

◆ MovingAgents

MBReadOnlyList<Agent> SandBox.Objects.PassageUsePoint.MovingAgents
get

◆ MovingAgent

override Agent SandBox.Objects.PassageUsePoint.MovingAgent
get

◆ ToLocation

Location SandBox.Objects.PassageUsePoint.ToLocation
get

◆ HasAIMovingTo

override bool SandBox.Objects.PassageUsePoint.HasAIMovingTo
get

◆ FocusableObjectType

override FocusableObjectType SandBox.Objects.PassageUsePoint.FocusableObjectType
get

◆ DisableCombatActionsOnUse

override bool SandBox.Objects.PassageUsePoint.DisableCombatActionsOnUse
get