TaleWorlds.MountAndBlade.SiegeWeapon Class Reference

Inherits TaleWorlds.MountAndBlade.UsableMachine, and TaleWorlds.MountAndBlade.ITargetable.

Inherited by TaleWorlds.MountAndBlade.BatteringRam, TaleWorlds.MountAndBlade.RangedSiegeWeapon, TaleWorlds.MountAndBlade.SiegeLadder, and TaleWorlds.MountAndBlade.SiegeTower.

Public Member Functions
abstract SiegeEngineType	GetSiegeEngineType ()
override TickRequirement	GetTickRequirement ()
GameEntity	GetTargetEntity ()
BattleSideEnum	GetSide ()
GameEntity	Entity ()
abstract TargetFlags	GetTargetFlags ()
abstract float	GetTargetValue (List< Vec3 > weaponPos)
Public Member Functions inherited from TaleWorlds.MountAndBlade.UsableMachine
void	AddComponent (UsableMissionObjectComponent component)
void	RemoveComponent (UsableMissionObjectComponent component)
T	GetComponent< T > ()
virtual OrderType	GetOrder (BattleSideEnum side)
virtual UsableMachineAIBase	CreateAIBehaviorObject ()
GameEntity	GetValidStandingPointForAgent (Agent agent)
GameEntity	GetValidStandingPointForAgentWithoutDistanceCheck (Agent agent)
StandingPoint	GetVacantStandingPointForAI (Agent agent)
StandingPoint	GetTargetStandingPointOfAIAgent (Agent agent)
override void	SetVisibleSynched (bool value, bool forceChildrenVisible=false)
	The user agent who controls this object More...
override void	SetPhysicsStateSynched (bool value, bool setChildren=true)
override TickRequirement	GetTickRequirement ()
virtual void	OnFocusGain (Agent userAgent)
virtual void	OnFocusLose (Agent userAgent)
virtual TextObject	GetInfoTextForBeingNotInteractable (Agent userAgent)
void	Deactivate ()
void	Activate ()
virtual bool	IsDisabledForBattleSide (BattleSideEnum sideEnum)
virtual bool	IsDisabledForBattleSideAI (BattleSideEnum sideEnum)
virtual void	Disable ()
override bool	ReadFromNetwork ()
override void	WriteToNetwork ()
override string	ToString ()
abstract TextObject	GetActionTextForStandingPoint (UsableMissionObject usableGameObject)
virtual StandingPoint	GetBestPointAlternativeTo (StandingPoint standingPoint, Agent agent)
virtual bool	IsInRangeToCheckAlternativePoints (Agent agent)
void	AddAgentAtSlotIndex (Agent agent, int slotIndex)
bool	IsStandingPointAvailableForAgent (Agent agent)
bool	IsUsedByFormation (Formation formation)
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)
OrderType	GetOrder (BattleSideEnum side)
bool	IsAgentUsingOrMovingTo (Agent agent)
float?	GetWeightOfNextSlot (BattleSideEnum side)
	Null if there is no vacancy left. Otherwise it is a positive number. More...
float	GetDetachmentWeight (BattleSideEnum side)
float	ComputeAndCacheDetachmentWeight (BattleSideEnum side)
float	GetDetachmentWeightFromCache ()
List< ValueTuple< int, float > >	GetSlotIndexWeightTuples ()
bool	IsSlotAtIndexAvailableForAgent (int slotIndex, Agent agent)
bool	IsAgentEligible (Agent agent)
void	AddAgentAtSlotIndex (Agent agent, int slotIndex)
Agent	GetMovingAgentAtSlotIndex (int slotIndex)
void	MarkSlotAtIndex (int slotIndex)
bool	IsDetachmentRecentlyEvaluated ()
void	UnmarkDetachment ()
float?	GetWeightOfAgentAtNextSlot (IEnumerable< Agent > candidates, out Agent match)
float?	GetWeightOfAgentAtNextSlot (IEnumerable< AgentValuePair< float > > agentTemplateScores, out Agent match)
float	GetTemplateWeightOfAgent (Agent candidate)
float[]	GetTemplateCostsOfAgent (Agent candidate, float[] oldValue)
float	GetExactCostOfAgentAtSlot (Agent candidate, int slotIndex)
float	GetWeightOfOccupiedSlot (Agent detachedAgent)
float?	GetWeightOfAgentAtOccupiedSlot (Agent detachedAgent, IEnumerable< Agent > candidates, out Agent match)
bool	IsStandingPointAvailableForAgent (Agent agent)
void	AddAgent (Agent agent, int slotIndex=-1)
void	RemoveAgent (Agent detachedAgent)
void	FormationStartUsing (Formation formation)
void	FormationStopUsing (Formation formation)
bool	IsUsedByFormation (Formation formation)
WorldFrame?	GetAgentFrame (Agent detachedAgent)
	Returns null for siege weapons and other detachments that sets scripted frame for the agent. Returns a frame otherwise. More...
void	ResetEvaluation ()
bool	IsEvaluated ()
void	SetAsEvaluated ()
void	OnFormationLeave (Formation formation)
TargetFlags	GetTargetFlags ()
float	GetTargetValue (List< Vec3 > referencePositions)
GameEntity	GetTargetEntity ()
BattleSideEnum	GetSide ()
GameEntity	Entity ()

Public Attributes
bool	ForcedUse
Public Attributes inherited from TaleWorlds.MountAndBlade.UsableMachine
string	PilotStandingPointTag = "Pilot"
string	AmmoPickUpTag = "ammopickup"
string	WaitStandingPointTag = "Wait"

Protected Member Functions
float	GetUserMultiplierOfWeapon ()
virtual float	GetDistanceMultiplierOfWeapon (Vec3 weaponPos)
virtual float	GetMinimumDistanceBetweenPositions (Vec3 position)
float	GetHitPointMultiplierOfWeapon ()
Protected Member Functions inherited from TaleWorlds.MountAndBlade.UsableMachine
	UsableMachine ()
virtual void	DebugTick (float dt)
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, IEnumerable< Agent > agents=null, IEnumerable< AgentValuePair< float > > agentValuePairs=null)
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)

Protected Attributes
bool	_spawnedFromSpawner = false
Protected Attributes inherited from TaleWorlds.MountAndBlade.UsableMachine
GameEntity	ActiveWaitStandingPoint
bool	_areUsableStandingPointsVacant = true
List< ValueTuple< int, StandingPoint > >	_usableStandingPoints
bool	_isDetachmentRecentlyEvaluated = false
float	EnemyRangeToStopUsing = 0.0f
bool	MakeVisibilityCheck = true
bool	_isDisabledForAI = false
List< Formation >	_userFormations
Protected Attributes inherited from TaleWorlds.MountAndBlade.MissionObject
string	NavMeshPrefabName = ""
int	DynamicNavmeshIdStart = 0

Properties
bool	IsUsed [get]
virtual BattleSideEnum	Side [get]
override bool	HasWaitFrame [get]
override bool	IsDeactivated [get]
Properties inherited from TaleWorlds.MountAndBlade.UsableMachine
List< StandingPoint >	StandingPoints [get]
StandingPoint	PilotStandingPoint [get]
List< GameEntity >	WaitStandingPoints [get]
DestructableComponent	DestructionComponent [get]
bool	IsDestructible [get]
bool	IsDestroyed [get]
Agent	PilotAgent [get]
bool	IsLoose [get]
UsableMachineAIBase	Ai [get]
virtual FocusableObjectType	FocusableObjectType [get]
StandingPoint	CurrentlyUsedAmmoPickUpPoint [get, set]
bool	HasAIPickingUpAmmo [get]
IReadOnlyList< Formation >	UserFormations [get]
IEnumerable< Agent >	Users [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]
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.IDetachment
IEnumerable< Agent >	Agents [get]
	Detached agents of this detachment More...
IReadOnlyList< Formation >	UserFormations [get]
bool	IsLoose [get]

Additional Inherited Members
Public Types inherited from TaleWorlds.MountAndBlade.SynchedMissionObject
enum	SynchFlags : uint
Public Types inherited from TaleWorlds.Engine.ScriptComponentBehavior
enum	TickRequirement : uint
Static Public Attributes inherited from TaleWorlds.MountAndBlade.UsableMachine
const string	UsableMachineParentTag = "machine_parent"
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

Member Function Documentation

GetSiegeEngineType()

abstract SiegeEngineType TaleWorlds.MountAndBlade.SiegeWeapon.GetSiegeEngineType ( )

pure virtual

Implemented in TaleWorlds.MountAndBlade.Ballista, TaleWorlds.MountAndBlade.BatteringRam, TaleWorlds.MountAndBlade.FireBallista, TaleWorlds.MountAndBlade.FireMangonel, TaleWorlds.MountAndBlade.Objects.Siege.FireTrebuchet, TaleWorlds.MountAndBlade.Mangonel, TaleWorlds.MountAndBlade.RangedSiegeWeapon, TaleWorlds.MountAndBlade.SiegeLadder, TaleWorlds.MountAndBlade.SiegeTower, and TaleWorlds.MountAndBlade.Trebuchet.

GetTickRequirement()

override TickRequirement TaleWorlds.MountAndBlade.SiegeWeapon.GetTickRequirement ( )

virtual

Reimplemented from TaleWorlds.Engine.ScriptComponentBehavior.

Reimplemented in TaleWorlds.MountAndBlade.Trebuchet.

GetUserMultiplierOfWeapon()

float TaleWorlds.MountAndBlade.SiegeWeapon.GetUserMultiplierOfWeapon ( )

protected

GetDistanceMultiplierOfWeapon()

virtual float TaleWorlds.MountAndBlade.SiegeWeapon.GetDistanceMultiplierOfWeapon ( Vec3  weaponPos )

protectedvirtual

Reimplemented in TaleWorlds.MountAndBlade.BatteringRam, TaleWorlds.MountAndBlade.SiegeLadder, and TaleWorlds.MountAndBlade.SiegeTower.

GetMinimumDistanceBetweenPositions()

virtual float TaleWorlds.MountAndBlade.SiegeWeapon.GetMinimumDistanceBetweenPositions ( Vec3  position )

protectedvirtual

GetHitPointMultiplierOfWeapon()

float TaleWorlds.MountAndBlade.SiegeWeapon.GetHitPointMultiplierOfWeapon ( )

protected

GetTargetEntity()

GameEntity TaleWorlds.MountAndBlade.SiegeWeapon.GetTargetEntity

(

)

Implements TaleWorlds.MountAndBlade.ITargetable.

GetSide()

BattleSideEnum TaleWorlds.MountAndBlade.SiegeWeapon.GetSide

(

)

Implements TaleWorlds.MountAndBlade.ITargetable.

Entity()

GameEntity TaleWorlds.MountAndBlade.SiegeWeapon.Entity

(

)

Implements TaleWorlds.MountAndBlade.ITargetable.

GetTargetFlags()

abstract TargetFlags TaleWorlds.MountAndBlade.SiegeWeapon.GetTargetFlags ( )

pure virtual

Implements TaleWorlds.MountAndBlade.ITargetable.

Implemented in TaleWorlds.MountAndBlade.Ballista, TaleWorlds.MountAndBlade.BatteringRam, TaleWorlds.MountAndBlade.Mangonel, TaleWorlds.MountAndBlade.SiegeLadder, TaleWorlds.MountAndBlade.SiegeTower, and TaleWorlds.MountAndBlade.Trebuchet.

GetTargetValue()

abstract float TaleWorlds.MountAndBlade.SiegeWeapon.GetTargetValue ( List< Vec3 >  weaponPos )

pure virtual

Implements TaleWorlds.MountAndBlade.ITargetable.

Implemented in TaleWorlds.MountAndBlade.Ballista, TaleWorlds.MountAndBlade.BatteringRam, TaleWorlds.MountAndBlade.Mangonel, TaleWorlds.MountAndBlade.SiegeLadder, TaleWorlds.MountAndBlade.SiegeTower, and TaleWorlds.MountAndBlade.Trebuchet.

Member Data Documentation

_spawnedFromSpawner

bool TaleWorlds.MountAndBlade.SiegeWeapon._spawnedFromSpawner = false

protected

ForcedUse

bool TaleWorlds.MountAndBlade.SiegeWeapon.ForcedUse

Property Documentation

IsUsed

bool TaleWorlds.MountAndBlade.SiegeWeapon.IsUsed

get

Side

virtual BattleSideEnum TaleWorlds.MountAndBlade.SiegeWeapon.Side

get

HasWaitFrame

override bool TaleWorlds.MountAndBlade.SiegeWeapon.HasWaitFrame

get

IsDeactivated

override bool TaleWorlds.MountAndBlade.SiegeWeapon.IsDeactivated

get