Class: Entity

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:47

An entity in a scene.

An entity is a collection of components.

Components are accessed through explicit methods: getComponent() returns the current value of a component, while updateComponent() and updateComponents() mark the component as dirty and send its current value to the server on the next update. The deleteComponent() method marks the component as deleted and sends this information to the server.

All relevant modifications to entities are batched and automatically sent to the server and broadcasted to other clients if the auto_broadcast property is set to "on".

On top of providing direct access to the components, this class provides helper methods to retrieve the parent entity and the children entities.

This class cannot be instantiated directly. Use the SceneBase.newEntity or SceneBase.newEntities methods on an existing scene to create an entity.

Extends

EntityComponents

Accessors

euid

Get Signature

get euid(): Readonly<Euid>;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:103

Returns

Readonly<Euid>

Inherited from

EntityComponents.euid

animation_controller

Get Signature

get animation_controller():
  | AnimationController
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:110

Drives skeletal animation using an Animation Graph and Animation Set; animates descendant skinned meshes whose skeletons are compatible with the set.

Returns

| AnimationController | undefined

Set Signature

set animation_controller(value:
  | Partial<AnimationController>
  | "default"
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:114

Parameters

Parameter	Type
`value`	\| `Partial`<`AnimationController`> \| `"default"` \| `undefined`

Returns

void

Inherited from

EntityComponents.animation_controller

animation_sequence_controller

Get Signature

get animation_sequence_controller():
  | AnimationSequenceController
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:121

Controls playback of an Animation Sequence; assigns tracks to entities.

Returns

| AnimationSequenceController | undefined

Set Signature

set animation_sequence_controller(value:
  | "default"
  | Partial<AnimationSequenceController>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:125

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`AnimationSequenceController`> \| `undefined`

Returns

void

Inherited from

EntityComponents.animation_sequence_controller

bone

Get Signature

get bone():
  | Bone
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:132

Associates this entity with a bone in a skeleton (for attachments and transforms).

Returns

| Bone | undefined

Set Signature

set bone(value:
  | "default"
  | Partial<Bone>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:136

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Bone`> \| `undefined`

Returns

void

Inherited from

EntityComponents.bone

box_geometry

Get Signature

get box_geometry():
  | BoxGeometry
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:143

Box geometry.

Returns

| BoxGeometry | undefined

Set Signature

set box_geometry(value:
  | "default"
  | Partial<BoxGeometry>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:147

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`BoxGeometry`> \| `undefined`

Returns

void

Inherited from

EntityComponents.box_geometry

camera

Get Signature

get camera():
  | Camera
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:154

Virtual camera.

Returns

| Camera | undefined

Set Signature

set camera(value:
  | "default"
  | Partial<Camera>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:158

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Camera`> \| `undefined`

Returns

void

Inherited from

EntityComponents.camera

capsule_geometry

Get Signature

get capsule_geometry():
  | CapsuleGeometry
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:165

Capsule geometry.

Returns

| CapsuleGeometry | undefined

Set Signature

set capsule_geometry(value:
  | "default"
  | Partial<CapsuleGeometry>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:169

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`CapsuleGeometry`> \| `undefined`

Returns

void

Inherited from

EntityComponents.capsule_geometry

character_controller

Get Signature

get character_controller():
  | CharacterController
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:176

Kinematic character controller for collision-constrained movement without a rigid body. Uses tuned collision handling for responsive control.

Returns

| CharacterController | undefined

Set Signature

set character_controller(value:
  | "default"
  | Partial<CharacterController>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:180

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`CharacterController`> \| `undefined`

Returns

void

Inherited from

EntityComponents.character_controller

collision_geometry_ref

Get Signature

get collision_geometry_ref():
  | CollisionGeometryRef
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:187

Reference to a collision geometry asset used by physics.

Returns

| CollisionGeometryRef | undefined

Set Signature

set collision_geometry_ref(value:
  | "default"
  | Partial<CollisionGeometryRef>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:191

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`CollisionGeometryRef`> \| `undefined`

Returns

void

Inherited from

EntityComponents.collision_geometry_ref

constraint

Get Signature

get constraint():
  | Constraint
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:198

6-DoF constraint built on a Joint. Defaults to fixed; selectively unlock translation and rotation on X/Y/Z and configure limits and springs.

Returns

| Constraint | undefined

Set Signature

set constraint(value:
  | "default"
  | Partial<Constraint>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:202

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Constraint`> \| `undefined`

Returns

void

Inherited from

EntityComponents.constraint

constraint_actuator

Get Signature

get constraint_actuator():
  | ConstraintActuator
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:209

Drives a Constraint toward target position/orientation and velocities using configurable stiffness, damping, and force limits.

Returns

| ConstraintActuator | undefined

Set Signature

set constraint_actuator(value:
  | "default"
  | Partial<ConstraintActuator>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:213

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`ConstraintActuator`> \| `undefined`

Returns

void

Inherited from

EntityComponents.constraint_actuator

culling_geometry

Get Signature

get culling_geometry():
  | CullingGeometry
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:220

Enables culling using a simple analytic shape. Add alongside a geometry component (box, cylinder, plane, sphere).

Returns

| CullingGeometry | undefined

Set Signature

set culling_geometry(value:
  | "default"
  | Partial<CullingGeometry>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:224

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`CullingGeometry`> \| `undefined`

Returns

void

Inherited from

EntityComponents.culling_geometry

custom_lens

Get Signature

get custom_lens():
  | CustomLens
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:231

Custom projection lens using an explicit projection matrix.

Returns

| CustomLens | undefined

Set Signature

set custom_lens(value:
  | "default"
  | Partial<CustomLens>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:235

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`CustomLens`> \| `undefined`

Returns

void

Inherited from

EntityComponents.custom_lens

cylinder_geometry

Get Signature

get cylinder_geometry():
  | CylinderGeometry
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:242

Cylinder geometry.

Returns

| CylinderGeometry | undefined

Set Signature

set cylinder_geometry(value:
  | "default"
  | Partial<CylinderGeometry>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:246

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`CylinderGeometry`> \| `undefined`

Returns

void

Inherited from

EntityComponents.cylinder_geometry

debug_name

Get Signature

get debug_name():
  | DebugName
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:253

Human-readable name of the entity.

Returns

| DebugName | undefined

Set Signature

set debug_name(value:
  | "default"
  | Partial<DebugName>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:257

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`DebugName`> \| `undefined`

Returns

void

Inherited from

EntityComponents.debug_name

decal_projector

Get Signature

get decal_projector():
  | DecalProjector
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:264

Projects a material onto scene surfaces within the projector's box volume.

Returns

| DecalProjector | undefined

Set Signature

set decal_projector(value:
  | "default"
  | Partial<DecalProjector>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:268

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`DecalProjector`> \| `undefined`

Returns

void

Inherited from

EntityComponents.decal_projector

environment

Get Signature

get environment():
  | Environment
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:275

Scene environment settings, including skybox background and precomputed image-based lighting (IBL). This component is only applied in the scene where this entity lives, it is discarded for subscenes.

Returns

| Environment | undefined

Set Signature

set environment(value:
  | "default"
  | Partial<Environment>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:279

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Environment`> \| `undefined`

Returns

void

Inherited from

EntityComponents.environment

joint

Get Signature

get joint():
  | Joint
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:286

Base joint connecting two bodies. By default locks relative position and orientation between constrainer and constrainee.

Returns

| Joint | undefined

Set Signature

set joint(value:
  | "default"
  | Partial<Joint>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:290

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Joint`> \| `undefined`

Returns

void

Inherited from

EntityComponents.joint

label

Get Signature

get label():
  | Label
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:297

Displays an editor-only label in the 3D view.

Returns

| Label | undefined

Set Signature

set label(value:
  | "default"
  | Partial<Label>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:301

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Label`> \| `undefined`

Returns

void

Inherited from

EntityComponents.label

lineage

Get Signature

get lineage():
  | Lineage
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:308

Records the entity's lineage through linkers and parentage.

Returns

| Lineage | undefined

Set Signature

set lineage(value:
  | "default"
  | Partial<Lineage>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:312

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Lineage`> \| `undefined`

Returns

void

Inherited from

EntityComponents.lineage

local_aabb

Get Signature

get local_aabb():
  | LocalAabb
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:319

Local-space axis-aligned bounding box.

Returns

| LocalAabb | undefined

Set Signature

set local_aabb(value:
  | "default"
  | Partial<LocalAabb>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:323

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`LocalAabb`> \| `undefined`

Returns

void

Inherited from

EntityComponents.local_aabb

material

Get Signature

get material():
  | Material
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:330

Assigns a shader to the entity's mesh and provides its input values and specialization constants.

Returns

| Material | undefined

Set Signature

set material(value:
  | "default"
  | Partial<Material>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:334

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Material`> \| `undefined`

Returns

void

Inherited from

EntityComponents.material

material_ref

Get Signature

get material_ref():
  | MaterialRef
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:341

Reference to a material to use for rendering.

Returns

| MaterialRef | undefined

Set Signature

set material_ref(value:
  | "default"
  | Partial<MaterialRef>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:345

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`MaterialRef`> \| `undefined`

Returns

void

Inherited from

EntityComponents.material_ref

measure

Get Signature

get measure():
  | Measure
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:352

Displays editor-only measurement annotations in the 3D view.

Returns

| Measure | undefined

Set Signature

set measure(value:
  | "default"
  | Partial<Measure>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:356

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Measure`> \| `undefined`

Returns

void

Inherited from

EntityComponents.measure

mesh_ref

Get Signature

get mesh_ref():
  | MeshRef
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:363

Reference to a mesh to render (with submesh selection).

Returns

| MeshRef | undefined

Set Signature

set mesh_ref(value:
  | "default"
  | Partial<MeshRef>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:367

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`MeshRef`> \| `undefined`

Returns

void

Inherited from

EntityComponents.mesh_ref

morph_targets

Get Signature

get morph_targets():
  | MorphTargets
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:374

Contains weights assigned to morph targets of the mesh referred to by the entity's mesh_ref.

Returns

| MorphTargets | undefined

Set Signature

set morph_targets(value:
  | "default"
  | Partial<MorphTargets>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:378

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`MorphTargets`> \| `undefined`

Returns

void

Inherited from

EntityComponents.morph_targets

orthographic_lens

Get Signature

get orthographic_lens():
  | OrthographicLens
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:385

Orthographic projection lens with configurable zoom and depth range.

Returns

| OrthographicLens | undefined

Set Signature

set orthographic_lens(value:
  | "default"
  | Partial<OrthographicLens>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:389

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`OrthographicLens`> \| `undefined`

Returns

void

Inherited from

EntityComponents.orthographic_lens

overrider

Get Signature

get overrider():
  | Overrider
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:396

Overrides an entity from a subscene: mark for deletion, replace components, or detach specific components.

Returns

| Overrider | undefined

Set Signature

set overrider(value:
  | "default"
  | Partial<Overrider>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:400

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Overrider`> \| `undefined`

Returns

void

Inherited from

EntityComponents.overrider

perspective_lens

Get Signature

get perspective_lens():
  | PerspectiveLens
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:407

Perspective projection lens with vertical field of view and near/far clipping planes.

Returns

| PerspectiveLens | undefined

Set Signature

set perspective_lens(value:
  | "default"
  | Partial<PerspectiveLens>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:411

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`PerspectiveLens`> \| `undefined`

Returns

void

Inherited from

EntityComponents.perspective_lens

physics_material

Get Signature

get physics_material():
  | PhysicsMaterial
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:418

Physical surface properties used for contact: friction, restitution, optional contact modification, and trigger mode.

Returns

| PhysicsMaterial | undefined

Set Signature

set physics_material(value:
  | "default"
  | Partial<PhysicsMaterial>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:422

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`PhysicsMaterial`> \| `undefined`

Returns

void

Inherited from

EntityComponents.physics_material

plane_geometry

Get Signature

get plane_geometry():
  | PlaneGeometry
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:429

Infinite plane geometry.

Returns

| PlaneGeometry | undefined

Set Signature

set plane_geometry(value:
  | "default"
  | Partial<PlaneGeometry>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:433

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`PlaneGeometry`> \| `undefined`

Returns

void

Inherited from

EntityComponents.plane_geometry

point_cloud_ref

Get Signature

get point_cloud_ref():
  | PointCloudRef
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:440

Reference to a point cloud.

Returns

| PointCloudRef | undefined

Set Signature

set point_cloud_ref(value:
  | "default"
  | Partial<PointCloudRef>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:444

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`PointCloudRef`> \| `undefined`

Returns

void

Inherited from

EntityComponents.point_cloud_ref

point_light

Get Signature

get point_light():
  | PointLight
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:451

Omnidirectional light source with physically based intensity and falloff. Acts as a point light by default; enable isDirectional to emit parallel rays. Attach a Spot Light component to add a cone cutoff. Can optionally drive the atmosphere sun direction.

Returns

| PointLight | undefined

Set Signature

set point_light(value:
  | "default"
  | Partial<PointLight>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:455

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`PointLight`> \| `undefined`

Returns

void

Inherited from

EntityComponents.point_light

reflection_probe

Get Signature

get reflection_probe():
  | ReflectionProbe
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:462

Omnidirectional reflection probe that captures the local environment into a cubemap for specular reflections (IBL).

Returns

| ReflectionProbe | undefined

Set Signature

set reflection_probe(value:
  | "default"
  | Partial<ReflectionProbe>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:466

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`ReflectionProbe`> \| `undefined`

Returns

void

Inherited from

EntityComponents.reflection_probe

rigid_body

Get Signature

get rigid_body():
  | RigidBody
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:473

Rigid body parameters for dynamic simulation (mass, damping, limits, CCD, and kinematic/gravity behavior).

Returns

| RigidBody | undefined

Set Signature

set rigid_body(value:
  | "default"
  | Partial<RigidBody>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:477

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`RigidBody`> \| `undefined`

Returns

void

Inherited from

EntityComponents.rigid_body

rigid_body_actuator

Get Signature

get rigid_body_actuator():
  | RigidBodyActuator
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:484

Frame-by-frame actuator for rigid bodies. Sets velocities and applies forces/impulses/torques; values are reset each frame.

Returns

| RigidBodyActuator | undefined

Set Signature

set rigid_body_actuator(value:
  | "default"
  | Partial<RigidBodyActuator>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:488

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`RigidBodyActuator`> \| `undefined`

Returns

void

Inherited from

EntityComponents.rigid_body_actuator

scene_ref

Get Signature

get scene_ref():
  | SceneRef
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:495

Reference to a subscene (linker); used to compose scenes.

Returns

| SceneRef | undefined

Set Signature

set scene_ref(value:
  | "default"
  | Partial<SceneRef>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:499

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`SceneRef`> \| `undefined`

Returns

void

Inherited from

EntityComponents.scene_ref

script_map

Get Signature

get script_map():
  | ScriptMap
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:506

Holds a set of script elements keyed by UUID.

Returns

| ScriptMap | undefined

Set Signature

set script_map(value:
  | "default"
  | Partial<ScriptMap>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:510

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`ScriptMap`> \| `undefined`

Returns

void

Inherited from

EntityComponents.script_map

shadow_caster

Get Signature

get shadow_caster():
  | ShadowCaster
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:517

Enables a light to cast real-time shadows with configurable map resolution, depth range, and (for directional lights) cascades.

Returns

| ShadowCaster | undefined

Set Signature

set shadow_caster(value:
  | "default"
  | Partial<ShadowCaster>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:521

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`ShadowCaster`> \| `undefined`

Returns

void

Inherited from

EntityComponents.shadow_caster

skeleton_ref

Get Signature

get skeleton_ref():
  | SkeletonRef
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:528

Reference to a skeleton asset for skinning and animation.

Returns

| SkeletonRef | undefined

Set Signature

set skeleton_ref(value:
  | "default"
  | Partial<SkeletonRef>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:532

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`SkeletonRef`> \| `undefined`

Returns

void

Inherited from

EntityComponents.skeleton_ref

sound_ref

Get Signature

get sound_ref():
  | SoundRef
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:539

Reference to a sound asset with playback and spatialization controls.

Returns

| SoundRef | undefined

Set Signature

set sound_ref(value:
  | "default"
  | Partial<SoundRef>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:543

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`SoundRef`> \| `undefined`

Returns

void

Inherited from

EntityComponents.sound_ref

sphere_geometry

Get Signature

get sphere_geometry():
  | SphereGeometry
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:550

Sphere geometry.

Returns

| SphereGeometry | undefined

Set Signature

set sphere_geometry(value:
  | "default"
  | Partial<SphereGeometry>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:554

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`SphereGeometry`> \| `undefined`

Returns

void

Inherited from

EntityComponents.sphere_geometry

spline

Get Signature

get spline():
  | Spline
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:561

Displays an editor-only spline in the 3D view.

Returns

| Spline | undefined

Set Signature

set spline(value:
  | "default"
  | Partial<Spline>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:565

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Spline`> \| `undefined`

Returns

void

Inherited from

EntityComponents.spline

spot_light

Get Signature

get spot_light():
  | SpotLight
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:572

Adds a cone cutoff to a light, producing a spotlight. Requires a Point Light component for color/intensity and falloff.

Returns

| SpotLight | undefined

Set Signature

set spot_light(value:
  | "default"
  | Partial<SpotLight>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:576

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`SpotLight`> \| `undefined`

Returns

void

Inherited from

EntityComponents.spot_light

Parameter	Type
`value`	\| `"default"` \| `Partial`<`Tags`> \| `undefined`

vehicle_controller

Get Signature

get vehicle_controller():
  | VehicleController
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:594

Vehicle Controller parameters.

Returns

| VehicleController | undefined

Set Signature

set vehicle_controller(value:
  | "default"
  | Partial<VehicleController>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:598

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`VehicleController`> \| `undefined`

Returns

void

Inherited from

EntityComponents.vehicle_controller

volume_filter

Get Signature

get volume_filter():
  | VolumeFilter
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:605

View filtering and display controls applied to the referenced volume.

Returns

| VolumeFilter | undefined

Set Signature

set volume_filter(value:
  | "default"
  | Partial<VolumeFilter>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:609

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`VolumeFilter`> \| `undefined`

Returns

void

Inherited from

EntityComponents.volume_filter

volume_material_ref

Get Signature

get volume_material_ref():
  | VolumeMaterialRef
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:616

Reference to the volume material used for shading and transfer functions.

Returns

| VolumeMaterialRef | undefined

Set Signature

set volume_material_ref(value:
  | "default"
  | Partial<VolumeMaterialRef>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:620

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`VolumeMaterialRef`> \| `undefined`

Returns

void

Inherited from

EntityComponents.volume_material_ref

volume_ref

Get Signature

get volume_ref():
  | VolumeRef
  | undefined;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:627

Reference to a volumetric dataset stored as a 3D texture (voxels).

Returns

| VolumeRef | undefined

Set Signature

set volume_ref(value:
  | "default"
  | Partial<VolumeRef>
  | undefined): void;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:631

Parameters

Parameter	Type
`value`	\| `"default"` \| `Partial`<`VolumeRef`> \| `undefined`

Returns

void

Inherited from

EntityComponents.volume_ref

id

Get Signature

get id(): UUID;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:121

The UUID of the entity.

Note that multiple entities can share the same UUID if they are different instances of the same entity brought by multiple instances of the same scene.

Returns

UUID

name

Get Signature

get name(): string;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:128

The name of the entity.

Returns

string

auto_broadcast

Get Signature

get auto_broadcast(): boolean;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:136

Deprecated

Whether the entity has its components updates broadcasted to other clients.

Returns

boolean

Set Signature

set auto_broadcast(state: boolean): void;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:144

Deprecated

Set whether the entity has its components updates broadcasted to other clients.

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

is_visible

Get Signature

get is_visible(): boolean;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:154

Whether the entity is visible.

Returns

boolean

Set Signature

set is_visible(is_visible: boolean): void;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:161

Set whether the entity is visible.

Parameters

Parameter	Type
`is_visible`	`boolean`

Returns

void

parent

Get Signature

get parent(): Entity | null;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:170

The parent entity of this entity or null if it has no parent.

Returns

Entity | null

Set Signature

set parent(parent: Entity | null): void;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:177

Re-parent the entity by setting a parent entity.

Parameters

Parameter	Type
`parent`	`Entity` \| `null`

Returns

void

Methods

toJSON()

toJSON(): object;

Defined in: livelink.clients/livelink.base/_prebuild/EntityComponents.ts:646

Returns

object

Inherited from

EntityComponents.toJSON

addEventListener()

addEventListener<_EventName>(
   event_name: _EventName,
   listener: (event: EntityEvents[_EventName]) => void,
   options?: boolean | AddEventListenerOptions): void;

Defined in: livelink.clients/livelink.base/sources/TypedEventTarget.ts:10

Type Parameters

Type Parameter
`_EventName` extends `"on-entity-updated"` \| `"on-entity-visibility-changed"`

Parameters

Parameter	Type
`event_name`	`_EventName`
`listener`	(`event`: `EntityEvents`[`_EventName`]) => `void`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherited from

EntityComponents.addEventListener

removeEventListener()

removeEventListener<_EventName>(
   event_name: _EventName,
   listener: (event: EntityEvents[_EventName]) => void,
   options?: boolean | EventListenerOptions): void;

Defined in: livelink.clients/livelink.base/sources/TypedEventTarget.ts:21

Type Parameters

Type Parameter
`_EventName` extends `"on-entity-updated"` \| `"on-entity-visibility-changed"`

Parameters

Parameter	Type
`event_name`	`_EventName`
`listener`	(`event`: `EntityEvents`[`_EventName`]) => `void`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Inherited from

EntityComponents.removeEventListener

getChildren()

getChildren(): Promise<Entity[]>;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:252

Returns the children of this entity.

Returns

Promise<Entity[]>

addScriptEventListener()

addScriptEventListener(params: {
  event_map_id: UUID;
  event_name: string;
  onReceived?: (evt: ScriptEventReceived) => void;
  onEmitted?: (evt: ScriptEventEmitted) => void;
}): void;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:266

Add an event listener for a script event. Script events are triggered by the server when a script attached to an entity emits an event.

Parameters

Parameter	Type	Description
`params`	{ `event_map_id`: `UUID`; `event_name`: `string`; `onReceived?`: (`evt`: `ScriptEventReceived`) => `void`; `onEmitted?`: (`evt`: `ScriptEventEmitted`) => `void`; }	-
`params.event_map_id`	`UUID`	The ID of the event map.
`params.event_name`	`string`	The name of the event.
`params.onReceived?`	(`evt`: `ScriptEventReceived`) => `void`	The callback to be called when the current entity is targetted by the script event.
`params.onEmitted?`	(`evt`: `ScriptEventEmitted`) => `void`	The callback to be called when the current entity emits the script event.

Returns

void

removeScriptEventListener()

removeScriptEventListener(params: {
  event_map_id: UUID;
  event_name: string;
  onReceived?: (evt: ScriptEventReceived) => void;
  onEmitted?: (evt: ScriptEventEmitted) => void;
}): void;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:295

Remove an event listener for a script event.

Parameters

Parameter	Type	Description
`params`	{ `event_map_id`: `UUID`; `event_name`: `string`; `onReceived?`: (`evt`: `ScriptEventReceived`) => `void`; `onEmitted?`: (`evt`: `ScriptEventEmitted`) => `void`; }	-
`params.event_map_id`	`UUID`	The ID of the event map.
`params.event_name`	`string`	The name of the event.
`params.onReceived?`	(`evt`: `ScriptEventReceived`) => `void`	A previously registered callback.
`params.onEmitted?`	(`evt`: `ScriptEventEmitted`) => `void`	A previously registered callback.

Returns

void

assignClientToScripts()

assignClientToScripts(__namedParameters: {
  client_uuid: UUID;
}): Promise<void>;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:318

Experimental

Parameters

Parameter	Type
`__namedParameters`	{ `client_uuid`: `UUID`; }
`__namedParameters.client_uuid`	`UUID`

Returns

Promise<void>

getComponent()

getComponent<_ComponentName>(component_name: _ComponentName):
  | ComponentType<_ComponentName>
  | undefined;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:346

Get the live, mutable value of a component. Returns undefined if the component doesn't exist on this entity.

The returned object is the actual stored value: it may be mutated in place, but such mutations are not auto-detected. Flag them explicitly with Entity.updateComponent / Entity.updateComponents.

Type Parameters

Type Parameter
`_ComponentName` extends keyof `ComponentsRecord`

Parameters

Parameter	Type
`component_name`	`_ComponentName`

Returns

| ComponentType<_ComponentName> | undefined

Example

const transform = entity.getComponent("local_transform");
if (transform) {
  console.log(transform.position);
}

updateComponent()

updateComponent<_ComponentName>(component_name: _ComponentName, value?:
  | "default"
  | Partial<ComponentType<_ComponentName>>): void;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:378

Flag a component as dirty so its current value is sent to the server on the next update.

If a value is provided, it is applied first (partial update, creating the component if needed; "default" resets to default values). If value is omitted, the component's current stored value is flagged as-is — the intended pattern is to mutate the object returned by a getter, then call this to flag it.

Flagging local_transform re-synchronizes its two rotation representations: the representation the caller mutated (orientation or eulerOrientation) is detected and the other one is recomputed from it. When both were mutated, they are trusted as-is, like on the value-patch path.

Type Parameters

Type Parameter
`_ComponentName` extends keyof `ComponentsRecord`

Parameters

Parameter	Type
`component_name`	`_ComponentName`
`value?`	\| `"default"` \| `Partial`<`ComponentType`<`_ComponentName`>>

Returns

void

Example

// Mutate-then-flag
entity.local_transform!.position[1] = 1;
entity.updateComponent("local_transform");

// Apply a partial update and flag in one call
entity.updateComponent("local_transform", { position: [0, 1, 0] });

// Reset to defaults
entity.updateComponent("mesh_ref", "default");

updateComponents()

updateComponents(component_names: keyof ComponentsRecord[]): void;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:435

Flag several components as dirty at once, using their current stored values.

Parameters

Parameter	Type	Description
`component_names`	keyof `ComponentsRecord`[]	The components to flag.

Returns

void

Example

entity.local_transform!.position[1] = 1;
entity.debug_name!.value = "renamed";
entity.updateComponents(["local_transform", "debug_name"]);

deleteComponent()

deleteComponent(component_name: keyof ComponentsRecord): void;

Defined in: livelink.clients/livelink.base/sources/scene/Entity.ts:450

Delete a component from the entity. If the component doesn't exist, this is a no-op.

Parameters

Parameter	Type
`component_name`	keyof `ComponentsRecord`

Returns

void

Example

entity.deleteComponent("mesh_renderer");

Extends​

Accessors​

euid​

Get Signature​

Returns​

Inherited from​

animation_controller​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

animation_sequence_controller​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

bone​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

box_geometry​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

camera​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

capsule_geometry​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

character_controller​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

collision_geometry_ref​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

constraint​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

constraint_actuator​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Inherited from​

culling_geometry​

Get Signature​

Returns​

Set Signature​

Extends

Accessors

euid

Get Signature

Returns

Inherited from

animation_controller

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

animation_sequence_controller

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

bone

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

box_geometry

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

camera

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

capsule_geometry

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

character_controller

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

collision_geometry_ref

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

constraint

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

constraint_actuator

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

culling_geometry

Get Signature

Returns

Set Signature