Skip to main content

Class: Entity

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:111

An entity in a scene.

The browser entity is the shared the shared core Entity plus transform handling. It specializes the scene/parent/children types to the browser flavour; all component storage, dirty tracking, scripts and visibility come from the shared base.

Components are read through getters returning the live, mutable value and flagged explicitly with updateComponent() / updateComponents(). The local_transform / global_transform setters are transform-aware and flag the entity for you.

It adds local/global transform handling on top of the browser EntityComponentsProxy.

The local_transform component lives in the shared storage core; this layer exposes proxied local_transform / global_transform views so that mutating a sub-property (entity.local_transform.position[0] = 5) recomputes and flags the entity, and derives & caches the global transform and the local/world matrices lazily on read.

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

Extends​

Accessors​

animation_controller​

Get Signature​

get animation_controller():
| AnimationController
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:33

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.js/_prebuild/EntityComponentsProxy.ts:37

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

Parameters​
ParameterType
value| Partial<AnimationController> | "default" | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.animation_controller


animation_sequence_controller​

Get Signature​

get animation_sequence_controller():
| AnimationSequenceController
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:44

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.js/_prebuild/EntityComponentsProxy.ts:48

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

Parameters​
ParameterType
value| "default" | Partial<AnimationSequenceController> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.animation_sequence_controller


bone​

Get Signature​

get bone():
| Bone
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:55

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.js/_prebuild/EntityComponentsProxy.ts:59

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

Parameters​
ParameterType
value| "default" | Partial<Bone> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.bone


box_geometry​

Get Signature​

get box_geometry():
| BoxGeometry
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:66

Box geometry.

Returns​

| BoxGeometry | undefined

Set Signature​

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

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:70

Box geometry.

Parameters​
ParameterType
value| "default" | Partial<BoxGeometry> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.box_geometry


camera​

Get Signature​

get camera():
| Camera
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:77

Virtual camera.

Returns​

| Camera | undefined

Set Signature​

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

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:81

Virtual camera.

Parameters​
ParameterType
value| "default" | Partial<Camera> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.camera


capsule_geometry​

Get Signature​

get capsule_geometry():
| CapsuleGeometry
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:88

Capsule geometry.

Returns​

| CapsuleGeometry | undefined

Set Signature​

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

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:92

Capsule geometry.

Parameters​
ParameterType
value| "default" | Partial<CapsuleGeometry> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.capsule_geometry


character_controller​

Get Signature​

get character_controller():
| CharacterController
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:99

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.js/_prebuild/EntityComponentsProxy.ts:103

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

Parameters​
ParameterType
value| "default" | Partial<CharacterController> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.character_controller


collision_geometry_ref​

Get Signature​

get collision_geometry_ref():
| CollisionGeometryRef
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:110

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.js/_prebuild/EntityComponentsProxy.ts:114

Reference to a collision geometry asset used by physics.

Parameters​
ParameterType
value| "default" | Partial<CollisionGeometryRef> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.collision_geometry_ref


constraint​

Get Signature​

get constraint():
| Constraint
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:121

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.js/_prebuild/EntityComponentsProxy.ts:125

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

Parameters​
ParameterType
value| "default" | Partial<Constraint> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.constraint


constraint_actuator​

Get Signature​

get constraint_actuator():
| ConstraintActuator
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:132

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.js/_prebuild/EntityComponentsProxy.ts:136

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

Parameters​
ParameterType
value| "default" | Partial<ConstraintActuator> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.constraint_actuator


culling_geometry​

Get Signature​

get culling_geometry():
| CullingGeometry
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:143

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.js/_prebuild/EntityComponentsProxy.ts:147

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

Parameters​
ParameterType
value| "default" | Partial<CullingGeometry> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.culling_geometry


custom_lens​

Get Signature​

get custom_lens():
| CustomLens
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:154

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.js/_prebuild/EntityComponentsProxy.ts:158

Custom projection lens using an explicit projection matrix.

Parameters​
ParameterType
value| "default" | Partial<CustomLens> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.custom_lens


cylinder_geometry​

Get Signature​

get cylinder_geometry():
| CylinderGeometry
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:165

Cylinder geometry.

Returns​

| CylinderGeometry | undefined

Set Signature​

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

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:169

Cylinder geometry.

Parameters​
ParameterType
value| "default" | Partial<CylinderGeometry> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.cylinder_geometry


debug_name​

Get Signature​

get debug_name():
| DebugName
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:176

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.js/_prebuild/EntityComponentsProxy.ts:180

Human-readable name of the entity.

Parameters​
ParameterType
value| "default" | Partial<DebugName> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.debug_name


decal_projector​

Get Signature​

get decal_projector():
| DecalProjector
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:187

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.js/_prebuild/EntityComponentsProxy.ts:191

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

Parameters​
ParameterType
value| "default" | Partial<DecalProjector> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.decal_projector


environment​

Get Signature​

get environment():
| Environment
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:198

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.js/_prebuild/EntityComponentsProxy.ts:202

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.

Parameters​
ParameterType
value| "default" | Partial<Environment> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.environment


joint​

Get Signature​

get joint():
| Joint
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:209

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.js/_prebuild/EntityComponentsProxy.ts:213

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

Parameters​
ParameterType
value| "default" | Partial<Joint> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.joint


label​

Get Signature​

get label():
| Label
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:220

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.js/_prebuild/EntityComponentsProxy.ts:224

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

Parameters​
ParameterType
value| "default" | Partial<Label> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.label


lineage​

Get Signature​

get lineage():
| Lineage
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:231

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.js/_prebuild/EntityComponentsProxy.ts:235

Records the entity's lineage through linkers and parentage.

Parameters​
ParameterType
value| "default" | Partial<Lineage> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.lineage


local_aabb​

Get Signature​

get local_aabb():
| LocalAabb
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:242

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.js/_prebuild/EntityComponentsProxy.ts:246

Local-space axis-aligned bounding box.

Parameters​
ParameterType
value| "default" | Partial<LocalAabb> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.local_aabb


material​

Get Signature​

get material():
| Material
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:253

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.js/_prebuild/EntityComponentsProxy.ts:257

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

Parameters​
ParameterType
value| "default" | Partial<Material> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.material


material_ref​

Get Signature​

get material_ref():
| MaterialRef
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:264

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.js/_prebuild/EntityComponentsProxy.ts:268

Reference to a material to use for rendering.

Parameters​
ParameterType
value| "default" | Partial<MaterialRef> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.material_ref


measure​

Get Signature​

get measure():
| Measure
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:275

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.js/_prebuild/EntityComponentsProxy.ts:279

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

Parameters​
ParameterType
value| "default" | Partial<Measure> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.measure


mesh_ref​

Get Signature​

get mesh_ref():
| MeshRef
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:286

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.js/_prebuild/EntityComponentsProxy.ts:290

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

Parameters​
ParameterType
value| "default" | Partial<MeshRef> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.mesh_ref


morph_targets​

Get Signature​

get morph_targets():
| MorphTargets
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:297

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.js/_prebuild/EntityComponentsProxy.ts:301

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

Parameters​
ParameterType
value| "default" | Partial<MorphTargets> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.morph_targets


orthographic_lens​

Get Signature​

get orthographic_lens():
| OrthographicLens
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:308

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.js/_prebuild/EntityComponentsProxy.ts:312

Orthographic projection lens with configurable zoom and depth range.

Parameters​
ParameterType
value| "default" | Partial<OrthographicLens> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.orthographic_lens


overrider​

Get Signature​

get overrider():
| Overrider
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:319

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.js/_prebuild/EntityComponentsProxy.ts:323

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

Parameters​
ParameterType
value| "default" | Partial<Overrider> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.overrider


perspective_lens​

Get Signature​

get perspective_lens():
| PerspectiveLens
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:330

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.js/_prebuild/EntityComponentsProxy.ts:334

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

Parameters​
ParameterType
value| "default" | Partial<PerspectiveLens> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.perspective_lens


physics_material​

Get Signature​

get physics_material():
| PhysicsMaterial
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:341

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.js/_prebuild/EntityComponentsProxy.ts:345

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

Parameters​
ParameterType
value| "default" | Partial<PhysicsMaterial> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.physics_material


plane_geometry​

Get Signature​

get plane_geometry():
| PlaneGeometry
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:352

Infinite plane geometry.

Returns​

| PlaneGeometry | undefined

Set Signature​

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

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:356

Infinite plane geometry.

Parameters​
ParameterType
value| "default" | Partial<PlaneGeometry> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.plane_geometry


point_cloud_ref​

Get Signature​

get point_cloud_ref():
| PointCloudRef
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:363

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.js/_prebuild/EntityComponentsProxy.ts:367

Reference to a point cloud.

Parameters​
ParameterType
value| "default" | Partial<PointCloudRef> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.point_cloud_ref


point_light​

Get Signature​

get point_light():
| PointLight
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:374

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.js/_prebuild/EntityComponentsProxy.ts:378

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.

Parameters​
ParameterType
value| "default" | Partial<PointLight> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.point_light


reflection_probe​

Get Signature​

get reflection_probe():
| ReflectionProbe
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:385

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.js/_prebuild/EntityComponentsProxy.ts:389

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

Parameters​
ParameterType
value| "default" | Partial<ReflectionProbe> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.reflection_probe


rigid_body​

Get Signature​

get rigid_body():
| RigidBody
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:396

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.js/_prebuild/EntityComponentsProxy.ts:400

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

Parameters​
ParameterType
value| "default" | Partial<RigidBody> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.rigid_body


rigid_body_actuator​

Get Signature​

get rigid_body_actuator():
| RigidBodyActuator
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:407

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.js/_prebuild/EntityComponentsProxy.ts:411

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

Parameters​
ParameterType
value| "default" | Partial<RigidBodyActuator> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.rigid_body_actuator


scene_ref​

Get Signature​

get scene_ref():
| SceneRef
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:418

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.js/_prebuild/EntityComponentsProxy.ts:422

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

Parameters​
ParameterType
value| "default" | Partial<SceneRef> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.scene_ref


script_map​

Get Signature​

get script_map():
| ScriptMap
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:429

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.js/_prebuild/EntityComponentsProxy.ts:433

Holds a set of script elements keyed by UUID.

Parameters​
ParameterType
value| "default" | Partial<ScriptMap> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.script_map


shadow_caster​

Get Signature​

get shadow_caster():
| ShadowCaster
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:440

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.js/_prebuild/EntityComponentsProxy.ts:444

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

Parameters​
ParameterType
value| "default" | Partial<ShadowCaster> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.shadow_caster


skeleton_ref​

Get Signature​

get skeleton_ref():
| SkeletonRef
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:451

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.js/_prebuild/EntityComponentsProxy.ts:455

Reference to a skeleton asset for skinning and animation.

Parameters​
ParameterType
value| "default" | Partial<SkeletonRef> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.skeleton_ref


sound_ref​

Get Signature​

get sound_ref():
| SoundRef
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:462

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.js/_prebuild/EntityComponentsProxy.ts:466

Reference to a sound asset with playback and spatialization controls.

Parameters​
ParameterType
value| "default" | Partial<SoundRef> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.sound_ref


sphere_geometry​

Get Signature​

get sphere_geometry():
| SphereGeometry
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:473

Sphere geometry.

Returns​

| SphereGeometry | undefined

Set Signature​

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

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:477

Sphere geometry.

Parameters​
ParameterType
value| "default" | Partial<SphereGeometry> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.sphere_geometry


spline​

Get Signature​

get spline():
| Spline
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:484

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.js/_prebuild/EntityComponentsProxy.ts:488

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

Parameters​
ParameterType
value| "default" | Partial<Spline> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.spline


spot_light​

Get Signature​

get spot_light():
| SpotLight
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:495

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.js/_prebuild/EntityComponentsProxy.ts:499

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

Parameters​
ParameterType
value| "default" | Partial<SpotLight> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.spot_light


tags​

Get Signature​

get tags():
| Tags
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:506

Free-form tags used to group and filter entities.

Returns​

| Tags | undefined

Set Signature​

set tags(value:
| "default"
| Partial<Tags>
| undefined): void;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:510

Free-form tags used to group and filter entities.

Parameters​
ParameterType
value| "default" | Partial<Tags> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.tags


vehicle_controller​

Get Signature​

get vehicle_controller():
| VehicleController
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:517

Vehicle Controller parameters.

Returns​

| VehicleController | undefined

Set Signature​

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

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:521

Vehicle Controller parameters.

Parameters​
ParameterType
value| "default" | Partial<VehicleController> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.vehicle_controller


volume_filter​

Get Signature​

get volume_filter():
| VolumeFilter
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:528

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.js/_prebuild/EntityComponentsProxy.ts:532

View filtering and display controls applied to the referenced volume.

Parameters​
ParameterType
value| "default" | Partial<VolumeFilter> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.volume_filter


volume_material_ref​

Get Signature​

get volume_material_ref():
| VolumeMaterialRef
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:539

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.js/_prebuild/EntityComponentsProxy.ts:543

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

Parameters​
ParameterType
value| "default" | Partial<VolumeMaterialRef> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.volume_material_ref


volume_ref​

Get Signature​

get volume_ref():
| VolumeRef
| undefined;

Defined in: livelink.clients/livelink.js/_prebuild/EntityComponentsProxy.ts:550

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.js/_prebuild/EntityComponentsProxy.ts:554

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

Parameters​
ParameterType
value| "default" | Partial<VolumeRef> | undefined
Returns​

void

Inherited from​

EntityComponentsProxy.volume_ref


global_transform​

Get Signature​

get global_transform(): Transform;

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:224

The global transform of the entity.

Returns​

Transform

Set Signature​

set global_transform(value: Partial<Transform>): void;

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:231

The global transform of the entity.

Parameters​
ParameterType
valuePartial<Transform>
Returns​

void


local_transform​

Get Signature​

get local_transform(): Transform;

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:239

The local transform of the entity.

Returns​

Transform

Set Signature​

set local_transform(value: Partial<Transform>): void;

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:246

The local transform of the entity.

Parameters​
ParameterType
valuePartial<Transform>
Returns​

void


global_aabb​

Get Signature​

get global_aabb(): Aabb;

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:253

The global bounding box (aabb) of the entity.

Returns​

Aabb


parent​

Get Signature​

get parent(): Entity | null;

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:308

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.js/sources/scene/Entity.ts:315

Re-parent the entity by setting a parent entity.

Parameters​
ParameterType
parentEntity | null
Returns​

void

Overrides​

EntityComponentsProxy.parent


ls_to_ws​

Get Signature​

get ls_to_ws(): readonly [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number];

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:653

The local space to world space matrix of the entity.

Returns​

readonly [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]


ws_to_ls​

Get Signature​

get ws_to_ls(): readonly [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number];

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:661

The world space to local space matrix of the entity.

Returns​

readonly [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]


euid​

Get Signature​

get euid(): Readonly<Euid>;

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

Returns​

Readonly<Euid>

Inherited from​

EntityComponentsProxy.euid


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

Inherited from​

EntityComponentsProxy.id


name​

Get Signature​

get name(): string;

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

The name of the entity.

Returns​

string

Inherited from​

EntityComponentsProxy.name


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​
ParameterType
stateboolean
Returns​

void

Inherited from​

EntityComponentsProxy.auto_broadcast


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​
ParameterType
is_visibleboolean
Returns​

void

Inherited from​

EntityComponentsProxy.is_visible

Methods​

updateComponent()​

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

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:351

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​

ParameterType
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");

Overrides​

EntityComponentsProxy.updateComponent


_setGlobalEulerOrientation()​

_setGlobalEulerOrientation(value: Vec3): void;

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:615

Set the global euler orientation of the entity. Also update the quat orientation. Does not mark the local transform as dirty.

Parameters​

ParameterType
valueVec3

Returns​

void


getChildren()​

getChildren(): Promise<Entity[]>;

Defined in: livelink.clients/livelink.js/sources/scene/Entity.ts:669

Returns the children of this entity.

Returns​

Promise<Entity[]>

Overrides​

EntityComponentsProxy.getChildren


toJSON()​

toJSON(): object;

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

Returns​

object

Inherited from​

EntityComponentsProxy.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​

ParameterType
event_name_EventName
listener(event: EntityEvents[_EventName]) => void
options?boolean | AddEventListenerOptions

Returns​

void

Inherited from​

EntityComponentsProxy.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​

ParameterType
event_name_EventName
listener(event: EntityEvents[_EventName]) => void
options?boolean | EventListenerOptions

Returns​

void

Inherited from​

EntityComponentsProxy.removeEventListener


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​

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

Returns​

void

Inherited from​

EntityComponentsProxy.addScriptEventListener


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​

ParameterTypeDescription
params{ event_map_id: UUID; event_name: string; onReceived?: (evt: ScriptEventReceived) => void; onEmitted?: (evt: ScriptEventEmitted) => void; }-
params.event_map_idUUIDThe ID of the event map.
params.event_namestringThe name of the event.
params.onReceived?(evt: ScriptEventReceived) => voidA previously registered callback.
params.onEmitted?(evt: ScriptEventEmitted) => voidA previously registered callback.

Returns​

void

Inherited from​

EntityComponentsProxy.removeScriptEventListener


assignClientToScripts()​

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

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

Experimental

Parameters​

ParameterType
__namedParameters{ client_uuid: UUID; }
__namedParameters.client_uuidUUID

Returns​

Promise<void>

Inherited from​

EntityComponentsProxy.assignClientToScripts


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​

ParameterType
component_name_ComponentName

Returns​

| ComponentType<_ComponentName> | undefined

Example​

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

Inherited from​

EntityComponentsProxy.getComponent


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​

ParameterTypeDescription
component_nameskeyof 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"]);

Inherited from​

EntityComponentsProxy.updateComponents


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​

ParameterType
component_namekeyof ComponentsRecord

Returns​

void

Example​

entity.deleteComponent("mesh_renderer");

Inherited from​

EntityComponentsProxy.deleteComponent