CharacterMeshEntityTemplate

Inheritance 3 ancestors · 35 siblings

MapPlaceableBase&0xd738f7c9
- GameEntityTemplate

Class Documentation

An entity template that places a character mesh: an animated character model that is not a unit, such as a decorative creature. It creates a CharacterMeshEntity. The CharacterMesh component builds the skinned mesh from the character and skin in Character when the entity activates, and plays its idle animation.

Properties

Animation

Embed<AnimationGeComponentDef> = {}

Type history (2 revisions)

15.21 - 15.21 Embed<0x385c323f>
since 15.22 Embed<AnimationGeComponentDef>

Documentation Edit documentation

Plays the animations that sequences request on the mesh.

Character

Pointer<SkinCharacterGeComponentDef> = null

16.1

Type history (2 revisions)

16.1 - 16.10 Embed<SkinCharacterGeComponentDef>
since 16.11 Pointer<SkinCharacterGeComponentDef>

Documentation Edit documentation

Character record and skin of the mesh. When null, the entity has no character component.

CharacterMesh

Embed<CharacterMeshGeComponentDef>

Default value

{
  "IdleAnimationName": "",
  "PlayIdleAnimation": false,
  "0xb887f6e9": 0
}

Type history (2 revisions)

15.21 - 15.21 Embed<0x385c323f>
since 15.22 Embed<CharacterMeshGeComponentDef>

Documentation Edit documentation

Builds and animates the mesh. See CharacterMeshGeComponentDef.

Icon

Pointer<NewIconGeComponentDef> = null

16.10

Documentation Edit documentation

Minimap and HUD icon of the entity. When null, the entity has no icon.

IsReplicated

Bool = true

16.1

Documentation Edit documentation

Whether the server controls the entity. When false, the client builds no networking component: the entity activates at map load if 0xbbe68da1 allows it, and it does not receive server updates. When true, the entity waits for the server to activate it.