TaleWorlds.Engine.GameEntity Class Reference

Game Entity class.

Inherits NativeObject.

Public Types
enum	ComponentType : UInt32 {   MetaMesh = 0 ,   Light ,   CompositeComponent ,   ClothSimulator ,   ParticleSystemInstanced ,   TownIcon ,   CustomType1 ,   Decal }
enum	Mobility {   stationary ,   dynamic ,   dynamic_forced }
enum	UpgradeLevelMask {   None = 0x000 ,   Level0 = 0x001 ,   Level1 = 0x002 ,   Level2 = 0x004 ,   Level3 = 0x008 ,   LevelAll = 0x00F }

Public Member Functions
UIntPtr	GetScenePointer ()
override string	ToString ()
void	ClearEntityComponents (bool resetAll, bool removeScripts, bool deleteChildEntities)
void	ClearComponents ()
void	ClearOnlyOwnComponents ()
bool	CheckResources (bool addToQueue, bool checkFaceResources)
void	SetMobility (Mobility mobility)
void	AddMesh (Mesh mesh, bool recomputeBoundingBox=true)
void	AddMultiMeshToSkeleton (MetaMesh metaMesh)
void	AddMultiMeshToSkeletonBone (MetaMesh metaMesh, sbyte boneIndex)
IEnumerable< Mesh >	GetAllMeshesWithTag (string tag)
void	SetColor (uint color1, uint color2, string meshTag)
uint	GetFactorColor ()
void	SetFactorColor (uint color)
void	SetAsReplayEntity ()
void	SetClothMaxDistanceMultiplier (float multiplier)
void	RemoveMultiMeshFromSkeleton (MetaMesh metaMesh)
void	RemoveMultiMeshFromSkeletonBone (MetaMesh metaMesh, sbyte boneIndex)
bool	RemoveComponentWithMesh (Mesh mesh)
void	AddComponent (GameEntityComponent component)
bool	HasComponent (GameEntityComponent component)
bool	RemoveComponent (GameEntityComponent component)
string	GetGuid ()
bool	IsGuidValid ()
void	SetEnforcedMaximumLodLevel (int lodLevel)
float	GetLodLevelForDistanceSq (float distSq)
void	GetQuickBoneEntitialFrame (sbyte index, ref MatrixFrame frame)
void	UpdateVisibilityMask ()
void	CallScriptCallbacks ()
bool	IsGhostObject ()
void	CreateAndAddScriptComponent (string name)
void	RemoveScriptComponent (UIntPtr scriptComponent, int removeReason)
void	SetEntityEnvMapVisibility (bool value)
bool	HasScene ()
bool	HasScriptComponent (string scName)
IEnumerable< ScriptComponentBehavior >	GetScriptComponents ()
IEnumerable< T >	GetScriptComponents< T > ()
bool	HasScriptOfType< T > ()
bool	HasScriptOfType (Type t)
T	GetFirstScriptOfTypeInFamily< T > ()
T	GetFirstScriptOfType< T > ()
void	SetAlpha (float alpha)
void	SetVisibilityExcludeParents (bool visible)
void	SetReadyToRender (bool ready)
bool	GetVisibilityExcludeParents ()
bool	IsVisibleIncludeParents ()
UInt32	GetVisibilityLevelMaskIncludingParents ()
bool	GetEditModeLevelVisibility ()
void	Remove (int removeReason)
void	SetUpgradeLevelMask (UpgradeLevelMask mask)
UpgradeLevelMask	GetUpgradeLevelMask ()
UpgradeLevelMask	GetUpgradeLevelMaskCumulative ()
int	GetUpgradeLevelOfEntity ()
string	GetOldPrefabName ()
string	GetPrefabName ()
void	CopyScriptComponentFromAnotherEntity (GameEntity otherEntity, string scriptName)
void	SetFrame (ref MatrixFrame frame)
void	SetClothComponentKeepState (MetaMesh metaMesh, bool state)
void	SetClothComponentKeepStateOfAllMeshes (bool state)
void	SetPreviousFrameInvalid ()
MatrixFrame	GetFrame ()
void	GetFrame (out MatrixFrame frame)
void	UpdateTriadFrameForEditor ()
void	UpdateTriadFrameForEditorForAllChildren ()
MatrixFrame	GetGlobalFrame ()
void	SetGlobalFrame (in MatrixFrame frame)
void	SetGlobalFrameMT (in MatrixFrame frame)
MatrixFrame	GetPreviousGlobalFrame ()
bool	HasPhysicsBody ()
void	SetLocalPosition (Vec3 position)
void	SetBodyFlags (BodyFlags bodyFlags)
void	SetBodyFlagsRecursive (BodyFlags bodyFlags)
void	AddBodyFlags (BodyFlags bodyFlags, bool applyToChildren=true)
void	RemoveBodyFlags (BodyFlags bodyFlags, bool applyToChildren=true)
Vec3	GetGlobalScale ()
Vec3	GetLocalScale ()
void	SetAnimationSoundActivation (bool activate)
void	CopyComponentsToSkeleton ()
void	AddMeshToBone (sbyte boneIndex, Mesh mesh)
void	ActivateRagdoll ()
void	PauseSkeletonAnimation ()
void	ResumeSkeletonAnimation ()
bool	IsSkeletonAnimationPaused ()
sbyte	GetBoneCount ()
MatrixFrame	GetBoneEntitialFrameWithIndex (sbyte boneIndex)
MatrixFrame	GetBoneEntitialFrameWithName (string boneName)
void	AddTag (string tag)
void	RemoveTag (string tag)
bool	HasTag (string tag)
void	AddChild (GameEntity gameEntity, bool autoLocalizeFrame=false)
	Adds the child.
void	RemoveChild (GameEntity childEntity, bool keepPhysics, bool keepScenePointer, bool callScriptCallbacks, int removeReason)
void	BreakPrefab ()
GameEntity	GetChild (int index)
bool	HasComplexAnimTree ()
void	AddMultiMesh (MetaMesh metaMesh, bool updateVisMask=true)
bool	RemoveMultiMesh (MetaMesh metaMesh)
int	GetComponentCount (ComponentType componentType)
void	AddAllMeshesOfGameEntity (GameEntity gameEntity)
void	SetFrameChanged ()
GameEntityComponent	GetComponentAtIndex (int index, ComponentType componentType)
MetaMesh	GetMetaMesh (int metaMeshIndex)
ClothSimulatorComponent	GetClothSimulator (int clothSimulatorIndex)
void	SetVectorArgument (float vectorArgument0, float vectorArgument1, float vectorArgument2, float vectorArgument3)
void	SetMaterialForAllMeshes (Material material)
bool	AddLight (Light light)
Light	GetLight ()
void	AddParticleSystemComponent (string particleid)
void	RemoveAllParticleSystems ()
bool	CheckPointWithOrientedBoundingBox (Vec3 point)
void	PauseParticleSystem (bool doChildren)
void	ResumeParticleSystem (bool doChildren)
void	BurstEntityParticle (bool doChildren)
void	SetRuntimeEmissionRateMultiplier (float emissionRateMultiplier)
Vec3	GetBoundingBoxMin ()
float	GetBoundingBoxRadius ()
Vec3	GetBoundingBoxMax ()
Vec3	GetPhysicsBoundingBoxMax ()
Vec3	GetPhysicsBoundingBoxMin ()
void	UpdateGlobalBounds ()
void	RecomputeBoundingBox ()
void	ValidateBoundingBox ()
bool	GetHasFrameChanged ()
void	SetBoundingboxDirty ()
Mesh	GetFirstMesh ()
void	SetContourColor (uint? color, bool alwaysVisible=true)
void	SetExternalReferencesUsage (bool value)
void	SetMorphFrameOfComponents (float value)
void	AddEditDataUserToAllMeshes (bool entityComponents, bool skeletonComponents)
void	ReleaseEditDataUserToAllMeshes (bool entityComponents, bool skeletonComponents)
void	GetCameraParamsFromCameraScript (Camera cam, ref Vec3 dofParams)
void	GetMeshBendedFrame (MatrixFrame worldSpacePosition, ref MatrixFrame output)
void	ComputeTrajectoryVolume (float missileSpeed, float verticalAngleMaxInDegrees, float verticalAngleMinInDegrees, float horizontalAngleRangeInDegrees, float airFrictionConstant)
void	SetAnimTreeChannelParameterForceUpdate (float phase, int channelNo)
void	ChangeMetaMeshOrRemoveItIfNotExists (MetaMesh entityMetaMesh, MetaMesh newMetaMesh)
void	AttachNavigationMeshFaces (int faceGroupId, bool isConnected, bool isBlocker=false, bool autoLocalize=false)
void	RemoveSkeleton ()
void	RemoveAllChildren ()
IEnumerable< GameEntity >	GetChildren ()
IEnumerable< GameEntity >	GetEntityAndChildren ()
void	GetChildrenRecursive (ref List< GameEntity > children)
bool	IsSelectedOnEditor ()
void	SelectEntityOnEditor ()
void	DeselectEntityOnEditor ()
void	SetAsPredisplayEntity ()
void	RemoveFromPredisplayEntity ()
void	GetPhysicsMinMax (bool includeChildren, out Vec3 bbmin, out Vec3 bbmax, bool returnLocal)
	Parameters returnLocal Determines the result if it is local or global.
void	SetCullMode (MBMeshCullingMode cullMode)

Static Public Member Functions
static GameEntity	CreateEmpty (Scene scene, bool isModifiableFromEditor=true)
static GameEntity	CreateEmptyDynamic (Scene scene, bool isModifiableFromEditor=true)
static GameEntity	CreateEmptyWithoutScene ()
static GameEntity	CopyFrom (Scene scene, GameEntity entity)
static GameEntity	Instantiate (Scene scene, string prefabName, bool callScriptCallbacks)
	Instantiates a new instance of GameEntity constructed from the given prefab.
static GameEntity	Instantiate (Scene scene, string prefabName, MatrixFrame frame)
	Instantiates a new instance of GameEntity constructed from the given prefab.
static bool	PrefabExists (string name)
static GameEntity	CopyFromPrefab (GameEntity prefab)

Properties
Scene	Scene [get]
string	Name [get, set]
EntityFlags	EntityFlags [get, set]
EntityVisibilityFlags	EntityVisibilityFlags [get, set]
BodyFlags	BodyFlag [get, set]
BodyFlags	PhysicsDescBodyFlag [get]
float	Mass [get]
Vec3	CenterOfMass [get]
Vec3	GlobalPosition [get]
string[]	Tags [get]
	Gets the tags of the entity, which can only be set in the edit mode.
int	ChildCount [get]
GameEntity	Parent [get]
GameEntity	Root [get]
	Gets the top most parent of this entity.
int	MultiMeshComponentCount [get]
int	ClothSimulatorComponentCount [get]
Vec3	GlobalBoxMax [get]
Vec3	PhysicsGlobalBoxMax [get]
Vec3	PhysicsGlobalBoxMin [get]
Vec3	GlobalBoxMin [get]
Skeleton	Skeleton [get, set]

Member Enumeration Documentation

ComponentType

enum TaleWorlds.Engine.GameEntity.ComponentType : UInt32

Enumerator
MetaMesh
Light
CompositeComponent
ClothSimulator
ParticleSystemInstanced
TownIcon
CustomType1
Decal

Mobility

enum TaleWorlds.Engine.GameEntity.Mobility

Enumerator
stationary
dynamic
dynamic_forced

UpgradeLevelMask

enum TaleWorlds.Engine.GameEntity.UpgradeLevelMask

Enumerator
None
Level0
Level1
Level2
Level3
LevelAll

Member Function Documentation

GetScenePointer()

UIntPtr TaleWorlds.Engine.GameEntity.GetScenePointer

(

)

ToString()

override string TaleWorlds.Engine.GameEntity.ToString

(

)

ClearEntityComponents()

void TaleWorlds.Engine.GameEntity.ClearEntityComponents	(	bool	resetAll,
		bool	removeScripts,
		bool	deleteChildEntities
	)

ClearComponents()

void TaleWorlds.Engine.GameEntity.ClearComponents

(

)

ClearOnlyOwnComponents()

void TaleWorlds.Engine.GameEntity.ClearOnlyOwnComponents

(

)

CheckResources()

bool TaleWorlds.Engine.GameEntity.CheckResources	(	bool	addToQueue,
		bool	checkFaceResources
	)

SetMobility()

void TaleWorlds.Engine.GameEntity.SetMobility

(

Mobility

mobility

)

AddMesh()

void TaleWorlds.Engine.GameEntity.AddMesh	(	Mesh	mesh,
		bool	recomputeBoundingBox = true
	)

AddMultiMeshToSkeleton()

void TaleWorlds.Engine.GameEntity.AddMultiMeshToSkeleton

(

MetaMesh

metaMesh

)

AddMultiMeshToSkeletonBone()

void TaleWorlds.Engine.GameEntity.AddMultiMeshToSkeletonBone	(	MetaMesh	metaMesh,
		sbyte	boneIndex
	)

GetAllMeshesWithTag()

IEnumerable< Mesh > TaleWorlds.Engine.GameEntity.GetAllMeshesWithTag

(

string

tag

)

SetColor()

void TaleWorlds.Engine.GameEntity.SetColor	(	uint	color1,
		uint	color2,
		string	meshTag
	)

GetFactorColor()

uint TaleWorlds.Engine.GameEntity.GetFactorColor

(

)

SetFactorColor()

void TaleWorlds.Engine.GameEntity.SetFactorColor

(

uint

color

)

SetAsReplayEntity()

void TaleWorlds.Engine.GameEntity.SetAsReplayEntity

(

)

SetClothMaxDistanceMultiplier()

void TaleWorlds.Engine.GameEntity.SetClothMaxDistanceMultiplier

(

float

multiplier

)

RemoveMultiMeshFromSkeleton()

void TaleWorlds.Engine.GameEntity.RemoveMultiMeshFromSkeleton

(

MetaMesh

metaMesh

)

RemoveMultiMeshFromSkeletonBone()

void TaleWorlds.Engine.GameEntity.RemoveMultiMeshFromSkeletonBone	(	MetaMesh	metaMesh,
		sbyte	boneIndex
	)

RemoveComponentWithMesh()

bool TaleWorlds.Engine.GameEntity.RemoveComponentWithMesh

(

Mesh

mesh

)

AddComponent()

void TaleWorlds.Engine.GameEntity.AddComponent

(

GameEntityComponent

component

)

HasComponent()

bool TaleWorlds.Engine.GameEntity.HasComponent

(

GameEntityComponent

component

)

RemoveComponent()

bool TaleWorlds.Engine.GameEntity.RemoveComponent

(

GameEntityComponent

component

)

GetGuid()

string TaleWorlds.Engine.GameEntity.GetGuid

(

)

IsGuidValid()

bool TaleWorlds.Engine.GameEntity.IsGuidValid

(

)

SetEnforcedMaximumLodLevel()

void TaleWorlds.Engine.GameEntity.SetEnforcedMaximumLodLevel

(

int

lodLevel

)

GetLodLevelForDistanceSq()

float TaleWorlds.Engine.GameEntity.GetLodLevelForDistanceSq

(

float

distSq

)

GetQuickBoneEntitialFrame()

void TaleWorlds.Engine.GameEntity.GetQuickBoneEntitialFrame	(	sbyte	index,
		ref MatrixFrame	frame
	)

UpdateVisibilityMask()

void TaleWorlds.Engine.GameEntity.UpdateVisibilityMask

(

)

CreateEmpty()

static GameEntity TaleWorlds.Engine.GameEntity.CreateEmpty ( Scene  scene, bool  isModifiableFromEditor = true  )

static

CreateEmptyDynamic()

static GameEntity TaleWorlds.Engine.GameEntity.CreateEmptyDynamic ( Scene  scene, bool  isModifiableFromEditor = true  )

static

CreateEmptyWithoutScene()

static GameEntity TaleWorlds.Engine.GameEntity.CreateEmptyWithoutScene ( )

static

CopyFrom()

static GameEntity TaleWorlds.Engine.GameEntity.CopyFrom ( Scene  scene, GameEntity  entity  )

static

Instantiate() [1/2]

static GameEntity TaleWorlds.Engine.GameEntity.Instantiate ( Scene  scene, string  prefabName, bool  callScriptCallbacks  )

static

Parameters

prefabName

Name of the prefab

Returns

The newly created Game Entity

CallScriptCallbacks()

void TaleWorlds.Engine.GameEntity.CallScriptCallbacks

(

)

Instantiate() [2/2]

static GameEntity TaleWorlds.Engine.GameEntity.Instantiate ( Scene  scene, string  prefabName, MatrixFrame  frame  )

static

Parameters

prefabName	Name of the prefab
frame	Initial frame of created entity

Returns

The newly created Game Entity

IsGhostObject()

bool TaleWorlds.Engine.GameEntity.IsGhostObject

(

)

CreateAndAddScriptComponent()

void TaleWorlds.Engine.GameEntity.CreateAndAddScriptComponent

(

string

name

)

PrefabExists()

static bool TaleWorlds.Engine.GameEntity.PrefabExists ( string  name )

static

RemoveScriptComponent()

void TaleWorlds.Engine.GameEntity.RemoveScriptComponent	(	UIntPtr	scriptComponent,
		int	removeReason
	)

SetEntityEnvMapVisibility()

void TaleWorlds.Engine.GameEntity.SetEntityEnvMapVisibility

(

bool

value

)

HasScene()

bool TaleWorlds.Engine.GameEntity.HasScene

(

)

HasScriptComponent()

bool TaleWorlds.Engine.GameEntity.HasScriptComponent

(

string

scName

)

GetScriptComponents()

IEnumerable< ScriptComponentBehavior > TaleWorlds.Engine.GameEntity.GetScriptComponents

(

)

GetScriptComponents< T >()

IEnumerable< T > TaleWorlds.Engine.GameEntity.GetScriptComponents< T >

(

)

Type Constraints

T

:

ScriptComponentBehavior

HasScriptOfType< T >()

bool TaleWorlds.Engine.GameEntity.HasScriptOfType< T >

(

)

Type Constraints

T

:

ScriptComponentBehavior

HasScriptOfType()

bool TaleWorlds.Engine.GameEntity.HasScriptOfType

(

Type

t

)

GetFirstScriptOfTypeInFamily< T >()

T TaleWorlds.Engine.GameEntity.GetFirstScriptOfTypeInFamily< T >

(

)

Type Constraints

T

:

ScriptComponentBehavior

GetFirstScriptOfType< T >()

T TaleWorlds.Engine.GameEntity.GetFirstScriptOfType< T >

(

)

Type Constraints

T

:

ScriptComponentBehavior

SetAlpha()

void TaleWorlds.Engine.GameEntity.SetAlpha

(

float

alpha

)

SetVisibilityExcludeParents()

void TaleWorlds.Engine.GameEntity.SetVisibilityExcludeParents

(

bool

visible

)

SetReadyToRender()

void TaleWorlds.Engine.GameEntity.SetReadyToRender

(

bool

ready

)

GetVisibilityExcludeParents()

bool TaleWorlds.Engine.GameEntity.GetVisibilityExcludeParents

(

)

IsVisibleIncludeParents()

bool TaleWorlds.Engine.GameEntity.IsVisibleIncludeParents

(

)

GetVisibilityLevelMaskIncludingParents()

UInt32 TaleWorlds.Engine.GameEntity.GetVisibilityLevelMaskIncludingParents

(

)

GetEditModeLevelVisibility()

bool TaleWorlds.Engine.GameEntity.GetEditModeLevelVisibility

(

)

Remove()

void TaleWorlds.Engine.GameEntity.Remove

(

int

removeReason

)

CopyFromPrefab()

static GameEntity TaleWorlds.Engine.GameEntity.CopyFromPrefab ( GameEntity  prefab )

static

SetUpgradeLevelMask()

void TaleWorlds.Engine.GameEntity.SetUpgradeLevelMask

(

UpgradeLevelMask

mask

)

GetUpgradeLevelMask()

UpgradeLevelMask TaleWorlds.Engine.GameEntity.GetUpgradeLevelMask

(

)

GetUpgradeLevelMaskCumulative()

UpgradeLevelMask TaleWorlds.Engine.GameEntity.GetUpgradeLevelMaskCumulative

(

)

GetUpgradeLevelOfEntity()

int TaleWorlds.Engine.GameEntity.GetUpgradeLevelOfEntity

(

)

GetOldPrefabName()

string TaleWorlds.Engine.GameEntity.GetOldPrefabName

(

)

GetPrefabName()

string TaleWorlds.Engine.GameEntity.GetPrefabName

(

)

CopyScriptComponentFromAnotherEntity()

void TaleWorlds.Engine.GameEntity.CopyScriptComponentFromAnotherEntity	(	GameEntity	otherEntity,
		string	scriptName
	)

SetFrame()

void TaleWorlds.Engine.GameEntity.SetFrame

(

ref MatrixFrame

frame

)

SetClothComponentKeepState()

void TaleWorlds.Engine.GameEntity.SetClothComponentKeepState	(	MetaMesh	metaMesh,
		bool	state
	)

SetClothComponentKeepStateOfAllMeshes()

void TaleWorlds.Engine.GameEntity.SetClothComponentKeepStateOfAllMeshes

(

bool

state

)

SetPreviousFrameInvalid()

void TaleWorlds.Engine.GameEntity.SetPreviousFrameInvalid

(

)

GetFrame() [1/2]

MatrixFrame TaleWorlds.Engine.GameEntity.GetFrame

(

)

GetFrame() [2/2]

void TaleWorlds.Engine.GameEntity.GetFrame

(

out MatrixFrame

frame

)

UpdateTriadFrameForEditor()

void TaleWorlds.Engine.GameEntity.UpdateTriadFrameForEditor

(

)

UpdateTriadFrameForEditorForAllChildren()

void TaleWorlds.Engine.GameEntity.UpdateTriadFrameForEditorForAllChildren

(

)

GetGlobalFrame()

MatrixFrame TaleWorlds.Engine.GameEntity.GetGlobalFrame

(

)

SetGlobalFrame()

void TaleWorlds.Engine.GameEntity.SetGlobalFrame

(

in MatrixFrame

frame

)

SetGlobalFrameMT()

void TaleWorlds.Engine.GameEntity.SetGlobalFrameMT

(

in MatrixFrame

frame

)

GetPreviousGlobalFrame()

MatrixFrame TaleWorlds.Engine.GameEntity.GetPreviousGlobalFrame

(

)

HasPhysicsBody()

bool TaleWorlds.Engine.GameEntity.HasPhysicsBody

(

)

SetLocalPosition()

void TaleWorlds.Engine.GameEntity.SetLocalPosition

(

Vec3

position

)

SetBodyFlags()

void TaleWorlds.Engine.GameEntity.SetBodyFlags

(

BodyFlags

bodyFlags

)

SetBodyFlagsRecursive()

void TaleWorlds.Engine.GameEntity.SetBodyFlagsRecursive

(

BodyFlags

bodyFlags

)

AddBodyFlags()

void TaleWorlds.Engine.GameEntity.AddBodyFlags	(	BodyFlags	bodyFlags,
		bool	applyToChildren = true
	)

RemoveBodyFlags()

void TaleWorlds.Engine.GameEntity.RemoveBodyFlags	(	BodyFlags	bodyFlags,
		bool	applyToChildren = true
	)

GetGlobalScale()

Vec3 TaleWorlds.Engine.GameEntity.GetGlobalScale

(

)

GetLocalScale()

Vec3 TaleWorlds.Engine.GameEntity.GetLocalScale

(

)

SetAnimationSoundActivation()

void TaleWorlds.Engine.GameEntity.SetAnimationSoundActivation

(

bool

activate

)

CopyComponentsToSkeleton()

void TaleWorlds.Engine.GameEntity.CopyComponentsToSkeleton

(

)

AddMeshToBone()

void TaleWorlds.Engine.GameEntity.AddMeshToBone	(	sbyte	boneIndex,
		Mesh	mesh
	)

ActivateRagdoll()

void TaleWorlds.Engine.GameEntity.ActivateRagdoll

(

)

PauseSkeletonAnimation()

void TaleWorlds.Engine.GameEntity.PauseSkeletonAnimation

(

)

ResumeSkeletonAnimation()

void TaleWorlds.Engine.GameEntity.ResumeSkeletonAnimation

(

)

IsSkeletonAnimationPaused()

bool TaleWorlds.Engine.GameEntity.IsSkeletonAnimationPaused

(

)

GetBoneCount()

sbyte TaleWorlds.Engine.GameEntity.GetBoneCount

(

)

GetBoneEntitialFrameWithIndex()

MatrixFrame TaleWorlds.Engine.GameEntity.GetBoneEntitialFrameWithIndex

(

sbyte

boneIndex

)

GetBoneEntitialFrameWithName()

MatrixFrame TaleWorlds.Engine.GameEntity.GetBoneEntitialFrameWithName

(

string

boneName

)

AddTag()

void TaleWorlds.Engine.GameEntity.AddTag

(

string

tag

)

RemoveTag()

void TaleWorlds.Engine.GameEntity.RemoveTag

(

string

tag

)

HasTag()

bool TaleWorlds.Engine.GameEntity.HasTag

(

string

tag

)

AddChild()

void TaleWorlds.Engine.GameEntity.AddChild	(	GameEntity	gameEntity,
		bool	autoLocalizeFrame = false
	)

Parameters

GameEntity

The entity to be added.

RemoveChild()

void TaleWorlds.Engine.GameEntity.RemoveChild	(	GameEntity	childEntity,
		bool	keepPhysics,
		bool	keepScenePointer,
		bool	callScriptCallbacks,
		int	removeReason
	)

BreakPrefab()

void TaleWorlds.Engine.GameEntity.BreakPrefab

(

)

GetChild()

GameEntity TaleWorlds.Engine.GameEntity.GetChild

(

int

index

)

HasComplexAnimTree()

bool TaleWorlds.Engine.GameEntity.HasComplexAnimTree

(

)

AddMultiMesh()

void TaleWorlds.Engine.GameEntity.AddMultiMesh	(	MetaMesh	metaMesh,
		bool	updateVisMask = true
	)

RemoveMultiMesh()

bool TaleWorlds.Engine.GameEntity.RemoveMultiMesh

(

MetaMesh

metaMesh

)

GetComponentCount()

int TaleWorlds.Engine.GameEntity.GetComponentCount

(

ComponentType

componentType

)

AddAllMeshesOfGameEntity()

void TaleWorlds.Engine.GameEntity.AddAllMeshesOfGameEntity

(

GameEntity

gameEntity

)

SetFrameChanged()

void TaleWorlds.Engine.GameEntity.SetFrameChanged

(

)

GetComponentAtIndex()

GameEntityComponent TaleWorlds.Engine.GameEntity.GetComponentAtIndex	(	int	index,
		ComponentType	componentType
	)

GetMetaMesh()

MetaMesh TaleWorlds.Engine.GameEntity.GetMetaMesh

(

int

metaMeshIndex

)

GetClothSimulator()

ClothSimulatorComponent TaleWorlds.Engine.GameEntity.GetClothSimulator

(

int

clothSimulatorIndex

)

SetVectorArgument()

void TaleWorlds.Engine.GameEntity.SetVectorArgument	(	float	vectorArgument0,
		float	vectorArgument1,
		float	vectorArgument2,
		float	vectorArgument3
	)

SetMaterialForAllMeshes()

void TaleWorlds.Engine.GameEntity.SetMaterialForAllMeshes

(

Material

material

)

AddLight()

bool TaleWorlds.Engine.GameEntity.AddLight

(

Light

light

)

GetLight()

Light TaleWorlds.Engine.GameEntity.GetLight

(

)

AddParticleSystemComponent()

void TaleWorlds.Engine.GameEntity.AddParticleSystemComponent

(

string

particleid

)

RemoveAllParticleSystems()

void TaleWorlds.Engine.GameEntity.RemoveAllParticleSystems

(

)

CheckPointWithOrientedBoundingBox()

bool TaleWorlds.Engine.GameEntity.CheckPointWithOrientedBoundingBox

(

Vec3

point

)

PauseParticleSystem()

void TaleWorlds.Engine.GameEntity.PauseParticleSystem

(

bool

doChildren

)

ResumeParticleSystem()

void TaleWorlds.Engine.GameEntity.ResumeParticleSystem

(

bool

doChildren

)

BurstEntityParticle()

void TaleWorlds.Engine.GameEntity.BurstEntityParticle

(

bool

doChildren

)

SetRuntimeEmissionRateMultiplier()

void TaleWorlds.Engine.GameEntity.SetRuntimeEmissionRateMultiplier

(

float

emissionRateMultiplier

)

GetBoundingBoxMin()

Vec3 TaleWorlds.Engine.GameEntity.GetBoundingBoxMin

(

)

GetBoundingBoxRadius()

float TaleWorlds.Engine.GameEntity.GetBoundingBoxRadius

(

)

GetBoundingBoxMax()

Vec3 TaleWorlds.Engine.GameEntity.GetBoundingBoxMax

(

)

GetPhysicsBoundingBoxMax()

Vec3 TaleWorlds.Engine.GameEntity.GetPhysicsBoundingBoxMax

(

)

GetPhysicsBoundingBoxMin()

Vec3 TaleWorlds.Engine.GameEntity.GetPhysicsBoundingBoxMin

(

)

UpdateGlobalBounds()

void TaleWorlds.Engine.GameEntity.UpdateGlobalBounds

(

)

RecomputeBoundingBox()

void TaleWorlds.Engine.GameEntity.RecomputeBoundingBox

(

)

ValidateBoundingBox()

void TaleWorlds.Engine.GameEntity.ValidateBoundingBox

(

)

GetHasFrameChanged()

bool TaleWorlds.Engine.GameEntity.GetHasFrameChanged

(

)

SetBoundingboxDirty()

void TaleWorlds.Engine.GameEntity.SetBoundingboxDirty

(

)

GetFirstMesh()

Mesh TaleWorlds.Engine.GameEntity.GetFirstMesh

(

)

SetContourColor()

void TaleWorlds.Engine.GameEntity.SetContourColor	(	uint?	color,
		bool	alwaysVisible = true
	)

SetExternalReferencesUsage()

void TaleWorlds.Engine.GameEntity.SetExternalReferencesUsage

(

bool

value

)

SetMorphFrameOfComponents()

void TaleWorlds.Engine.GameEntity.SetMorphFrameOfComponents

(

float

value

)

AddEditDataUserToAllMeshes()

void TaleWorlds.Engine.GameEntity.AddEditDataUserToAllMeshes	(	bool	entityComponents,
		bool	skeletonComponents
	)

ReleaseEditDataUserToAllMeshes()

void TaleWorlds.Engine.GameEntity.ReleaseEditDataUserToAllMeshes	(	bool	entityComponents,
		bool	skeletonComponents
	)

GetCameraParamsFromCameraScript()

void TaleWorlds.Engine.GameEntity.GetCameraParamsFromCameraScript	(	Camera	cam,
		ref Vec3	dofParams
	)

GetMeshBendedFrame()

void TaleWorlds.Engine.GameEntity.GetMeshBendedFrame	(	MatrixFrame	worldSpacePosition,
		ref MatrixFrame	output
	)

ComputeTrajectoryVolume()

void TaleWorlds.Engine.GameEntity.ComputeTrajectoryVolume	(	float	missileSpeed,
		float	verticalAngleMaxInDegrees,
		float	verticalAngleMinInDegrees,
		float	horizontalAngleRangeInDegrees,
		float	airFrictionConstant
	)

SetAnimTreeChannelParameterForceUpdate()

void TaleWorlds.Engine.GameEntity.SetAnimTreeChannelParameterForceUpdate	(	float	phase,
		int	channelNo
	)

ChangeMetaMeshOrRemoveItIfNotExists()

void TaleWorlds.Engine.GameEntity.ChangeMetaMeshOrRemoveItIfNotExists	(	MetaMesh	entityMetaMesh,
		MetaMesh	newMetaMesh
	)

AttachNavigationMeshFaces()

void TaleWorlds.Engine.GameEntity.AttachNavigationMeshFaces	(	int	faceGroupId,
		bool	isConnected,
		bool	isBlocker = false,
		bool	autoLocalize = false
	)

RemoveSkeleton()

void TaleWorlds.Engine.GameEntity.RemoveSkeleton

(

)

RemoveAllChildren()

void TaleWorlds.Engine.GameEntity.RemoveAllChildren

(

)

GetChildren()

IEnumerable< GameEntity > TaleWorlds.Engine.GameEntity.GetChildren

(

)

GetEntityAndChildren()

IEnumerable< GameEntity > TaleWorlds.Engine.GameEntity.GetEntityAndChildren

(

)

GetChildrenRecursive()

void TaleWorlds.Engine.GameEntity.GetChildrenRecursive

(

ref List< GameEntity >

children

)

IsSelectedOnEditor()

bool TaleWorlds.Engine.GameEntity.IsSelectedOnEditor

(

)

SelectEntityOnEditor()

void TaleWorlds.Engine.GameEntity.SelectEntityOnEditor

(

)

DeselectEntityOnEditor()

void TaleWorlds.Engine.GameEntity.DeselectEntityOnEditor

(

)

SetAsPredisplayEntity()

void TaleWorlds.Engine.GameEntity.SetAsPredisplayEntity

(

)

RemoveFromPredisplayEntity()

void TaleWorlds.Engine.GameEntity.RemoveFromPredisplayEntity

(

)

GetPhysicsMinMax()

void TaleWorlds.Engine.GameEntity.GetPhysicsMinMax	(	bool	includeChildren,
		out Vec3	bbmin,
		out Vec3	bbmax,
		bool	returnLocal
	)

SetCullMode()

void TaleWorlds.Engine.GameEntity.SetCullMode

(

MBMeshCullingMode

cullMode

)

Property Documentation

Scene

Scene TaleWorlds.Engine.GameEntity.Scene

get

Name

string TaleWorlds.Engine.GameEntity.Name

getset

EntityFlags

EntityFlags TaleWorlds.Engine.GameEntity.EntityFlags

getset

EntityVisibilityFlags

EntityVisibilityFlags TaleWorlds.Engine.GameEntity.EntityVisibilityFlags

getset

BodyFlag

BodyFlags TaleWorlds.Engine.GameEntity.BodyFlag

getset

PhysicsDescBodyFlag

BodyFlags TaleWorlds.Engine.GameEntity.PhysicsDescBodyFlag

get

Mass

float TaleWorlds.Engine.GameEntity.Mass

get

CenterOfMass

Vec3 TaleWorlds.Engine.GameEntity.CenterOfMass

get

GlobalPosition

Vec3 TaleWorlds.Engine.GameEntity.GlobalPosition

get

Tags

string [] TaleWorlds.Engine.GameEntity.Tags

get

See also

AddTag, HasTag

ChildCount

int TaleWorlds.Engine.GameEntity.ChildCount

get

Parent

GameEntity TaleWorlds.Engine.GameEntity.Parent

get

Root

GameEntity TaleWorlds.Engine.GameEntity.Root

get

MultiMeshComponentCount

int TaleWorlds.Engine.GameEntity.MultiMeshComponentCount

get

ClothSimulatorComponentCount

int TaleWorlds.Engine.GameEntity.ClothSimulatorComponentCount

get

GlobalBoxMax

Vec3 TaleWorlds.Engine.GameEntity.GlobalBoxMax

get

PhysicsGlobalBoxMax

Vec3 TaleWorlds.Engine.GameEntity.PhysicsGlobalBoxMax

get

PhysicsGlobalBoxMin

Vec3 TaleWorlds.Engine.GameEntity.PhysicsGlobalBoxMin

get

GlobalBoxMin

Vec3 TaleWorlds.Engine.GameEntity.GlobalBoxMin

get

Skeleton

Skeleton TaleWorlds.Engine.GameEntity.Skeleton

getset