Abstract Class: EntityComponents

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

Storage core shared by every livelink client SDK entity with generated component accessor layer.

It owns the raw component record (EntityCore) and exposes the minimal protected primitives to read/write it. It intentionally does NOT impose a component-access paradigm nor any entity behaviour: the concrete Entity builds the public API (component accessors, dirty tracking, scripts, …) on top of these primitives.

The generated component layer exposes one getter per component returning the live, mutable component object stored on the paradigm-neutral. Reading a component returns the actual stored value, so it may be mutated in place; mutations are not auto-detected — flag them explicitly with Entity.updateComponent / Entity.updateComponents. Use Entity.deleteComponent to remove a component. The generated layer also exposes one setter per component that delegates to the core's Entity.updateComponent & Entity.deleteComponent.

Extends

TypedEventTarget<EntityEvents>

Extended by

Entity

Constructors

Constructor

new EntityComponents(__namedParameters: {
  euid: Euid;
}): EntityComponents;

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

Parameters

Parameter	Type
`__namedParameters`	{ `euid`: `Euid`; }
`__namedParameters.euid`	`Euid`

Returns

EntityComponents

Overrides

TypedEventTarget.constructor

Accessors

euid

Get Signature

get euid(): Readonly<Euid>;

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

Returns

Readonly<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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Methods

toJSON()

toJSON(): object;

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

Returns

object

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

TypedEventTarget.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

TypedEventTarget.removeEventListener

Extends​

Extended by​

Constructors​

Constructor​

Parameters​

Returns​

Overrides​

Accessors​

euid​

Get Signature​

Returns​

animation_controller​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

animation_sequence_controller​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

bone​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

box_geometry​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

camera​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

capsule_geometry​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

character_controller​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

collision_geometry_ref​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

constraint​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

constraint_actuator​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

culling_geometry​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

custom_lens​

Get Signature​

Returns​

Extends

Extended by

Constructors

Constructor

Parameters

Returns

Overrides

Accessors

euid

Get Signature

Returns

animation_controller

Get Signature

Returns

Set Signature

Parameters

Returns

animation_sequence_controller

Get Signature

Returns

Set Signature

Parameters

Returns

bone

Get Signature

Returns

Set Signature

Parameters

Returns

box_geometry

Get Signature

Returns

Set Signature

Parameters

Returns

camera

Get Signature

Returns

Set Signature

Parameters

Returns

capsule_geometry

Get Signature

Returns

Set Signature

Parameters

Returns

character_controller

Get Signature

Returns

Set Signature

Parameters

Returns

collision_geometry_ref

Get Signature

Returns

Set Signature

Parameters

Returns

constraint

Get Signature

Returns

Set Signature

Parameters

Returns

constraint_actuator

Get Signature

Returns

Set Signature

Parameters

Returns

culling_geometry

Get Signature

Returns

Set Signature

Parameters

Returns

custom_lens

Get Signature

Returns