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

Inherits TaleWorlds.MountAndBlade.UsableMachine.

Public Types

enum  SittableType {
  Chair ,
  Log ,
  Sofa ,
  Ground
}
 
- 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
}
 

Public Member Functions

bool IsAgentFullySitting (Agent usingAgent)
 
override UsableMachineAIBase CreateAIBehaviorObject ()
 
override TextObject GetActionTextForStandingPoint (UsableMissionObject usableGameObject)
 
override TextObject GetDescriptionText (WeakGameEntity gameEntity)
 
override StandingPoint GetBestPointAlternativeTo (StandingPoint standingPoint, Agent agent)
 
override OrderType GetOrder (BattleSideEnum side)
 
- Public Member Functions inherited from TaleWorlds.MountAndBlade.UsableMachine
void AddComponent (UsableMissionObjectComponent component)
 
void RemoveComponent (UsableMissionObjectComponent component)
 
GetComponent< T > ()
 
WeakGameEntity GetValidStandingPointForAgent (Agent agent)
 
void SetAI (UsableMachineAIBase ai)
 
WeakGameEntity GetValidStandingPointForAgentWithoutDistanceCheck (Agent agent)
 
StandingPoint GetVacantStandingPointForAI (Agent agent)
 
StandingPoint GetTargetStandingPointOfAIAgent (Agent agent)
 
override void OnMissionEnded ()
 
override void SetVisibleSynched (bool value, bool forceChildrenVisible=false)
 The user agent who controls this object.
 
override void SetPhysicsStateSynched (bool value, bool setChildren=true)
 
override TickRequirement GetTickRequirement ()
 
virtual void OnFocusGain (Agent userAgent)
 
virtual void OnFocusLose (Agent userAgent)
 
virtual void OnPilotAssignedDuringSpawn ()
 
virtual TextObject GetInfoTextForBeingNotInteractable (Agent userAgent)
 
void Deactivate ()
 
void Activate ()
 
virtual bool IsDisabledForBattleSide (BattleSideEnum sideEnum)
 
virtual bool IsDisabledForBattleSideAI (BattleSideEnum sideEnum)
 
virtual bool ShouldAutoLeaveDetachmentWhenDisabled (BattleSideEnum sideEnum)
 
virtual bool AutoAttachUserToFormation (BattleSideEnum sideEnum)
 
virtual bool HasToBeDefendedByUser (BattleSideEnum sideEnum)
 
virtual void Disable ()
 
override string ToString ()
 
TextObject GetActionTextForStandingPoint (UsableMissionObject usableGameObject)
 
virtual bool IsInRangeToCheckAlternativePoints (Agent agent)
 
void AddAgentAtSlotIndex (Agent agent, int slotIndex)
 
void SetIsDisabledForAI (bool isDisabledForAI)
 
int GetNumberOfUsableSlots ()
 
bool IsStandingPointAvailableForAgent (Agent agent)
 
bool IsUsedByFormation (Formation formation)
 
TextObject GetDescriptionText (WeakGameEntity gameEntity)
 
void SetEnemyRangeToStopUsing (float value)
 
- Public Member Functions inherited from TaleWorlds.MountAndBlade.SynchedMissionObject
void SetLocalPositionSmoothStep (ref Vec3 targetPosition)
 
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 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 OnEndMission ()
 
virtual void AddStuckMissile (GameEntity missileEntity)
 
- Public Member Functions inherited from TaleWorlds.Engine.ScriptComponentBehavior
void SetScriptComponentToTick (TickRequirement tickReq)
 
void SetScriptComponentToTickMT (TickRequirement value)
 

Public Attributes

SittableType ChairType = SittableType.Chair
 
- Public Attributes inherited from TaleWorlds.MountAndBlade.UsableMachine
string PilotStandingPointTag = "Pilot"
 
string AmmoPickUpTag = "ammopickup"
 
string WaitStandingPointTag = "Wait"
 

Protected Member Functions

override void OnInit ()
 This callback method is called when the object is constructed.
 
- Protected Member Functions inherited from TaleWorlds.MountAndBlade.UsableMachine
 UsableMachine ()
 
virtual void DebugTick (float dt)
 
bool IsDisabledDueToEnemyInRange (BattleSideEnum sideEnum)
 
override void OnRemoved (int removeReason)
 
virtual float GetWeightOfStandingPoint (StandingPoint sp)
 
virtual float GetDetachmentWeightAux (BattleSideEnum side)
 
virtual bool IsAgentOnInconvenientNavmesh (Agent agent, StandingPoint standingPoint)
 
virtual StandingPoint GetSuitableStandingPointFor (BattleSideEnum side, Agent agent=null, List< Agent > agents=null, List< ValueTuple< Agent, float > > agentValuePairs=null)
 
virtual bool ShouldDisableTickIfMachineDisabled ()
 
- 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 ()
 

Additional Inherited Members

- Static Public Attributes inherited from TaleWorlds.MountAndBlade.UsableMachine
const string UsableMachineParentTag = "machine_parent"
 
- 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.UsableMachine
GameEntity ActiveWaitStandingPoint
 
bool _areUsableStandingPointsVacant = true
 
List< ValueTuple< int, StandingPoint > > _usableStandingPoints
 
bool _isDetachmentRecentlyEvaluated = false
 
float EnemyRangeToStopUsing = 0.0f
 
Vec2 MachinePositionOffsetToStopUsingLocal = Vec2.Zero
 
bool MakeVisibilityCheck = true
 
QueryData< bool > IsDisabledForAttackerAIDueToEnemyInRange
 
QueryData< bool > IsDisabledForDefenderAIDueToEnemyInRange
 
MBList< Formation_userFormations
 
- Protected Attributes inherited from TaleWorlds.MountAndBlade.MissionObject
string NavMeshPrefabName = ""
 
int DynamicNavmeshIdStart = 0
 
- Properties inherited from TaleWorlds.MountAndBlade.UsableMachine
MBList< StandingPointStandingPoints [get]
 
StandingPoint PilotStandingPoint [get]
 
int PilotStandingPointSlotIndex [get]
 
List< GameEntityWaitStandingPoints [get]
 
DestructableComponent DestructionComponent [get]
 
bool IsDestructible [get]
 
bool IsDestroyed [get]
 
Agent PilotAgent [get]
 
bool IsLoose [get]
 
virtual float SinkingReferenceOffset [get]
 
UsableMachineAIBase Ai [get]
 
virtual FocusableObjectType FocusableObjectType [get]
 
virtual bool IsFocusable [get]
 
StandingPoint CurrentlyUsedAmmoPickUpPoint [get, set]
 
bool HasAIPickingUpAmmo [get]
 
bool IsDisabledForAI [get, protected set]
 
MBReadOnlyList< FormationUserFormations [get]
 
int UserCountNotInStruckAction [get]
 
int UserCountIncludingInStruckAction [get]
 
virtual int MaxUserCount [get]
 
virtual bool HasWaitFrame [get]
 
MatrixFrame WaitFrame [get]
 
GameEntity WaitEntity [get]
 
virtual bool IsDeactivated [get]
 
- 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.IDetachment

Member Enumeration Documentation

◆ SittableType

Enumerator
Chair 
Log 
Sofa 
Ground 

Member Function Documentation

◆ OnInit()

override void SandBox.Objects.Usables.Chair.OnInit ( )
protectedvirtual

◆ IsAgentFullySitting()

bool SandBox.Objects.Usables.Chair.IsAgentFullySitting ( Agent usingAgent)

◆ CreateAIBehaviorObject()

override UsableMachineAIBase SandBox.Objects.Usables.Chair.CreateAIBehaviorObject ( )
virtual

◆ GetActionTextForStandingPoint()

override TextObject SandBox.Objects.Usables.Chair.GetActionTextForStandingPoint ( UsableMissionObject usableGameObject)

◆ GetDescriptionText()

override TextObject SandBox.Objects.Usables.Chair.GetDescriptionText ( WeakGameEntity gameEntity)

◆ GetBestPointAlternativeTo()

override StandingPoint SandBox.Objects.Usables.Chair.GetBestPointAlternativeTo ( StandingPoint standingPoint,
Agent agent )
virtual

◆ GetOrder()

override OrderType SandBox.Objects.Usables.Chair.GetOrder ( BattleSideEnum side)
virtual

Member Data Documentation

◆ ChairType

SittableType SandBox.Objects.Usables.Chair.ChairType = SittableType.Chair