Skip to main content

ComponentsRecord

@3dverse/livelink v0.8.10


@3dverse/livelink / ComponentsRecord

Type Alias: ComponentsRecord

ComponentsRecord: object

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/ComponentsRecord.d.ts:34

Type declaration

animation_controller

animation_controller: AnimationController

Animation controller with reference to an animation graph and an animation set. Enables skeletal animation on its skinned mesh descendents whose skeleton is compatible with the animations in the animation set.

animation_sequence_controller

animation_sequence_controller: AnimationSequenceController

Animation sequence controller with reference to an animation sequence and assigned entities.

bone

bone: Bone

Links entity to bone in skeleton.

box_geometry

box_geometry: BoxGeometry

Box geometry.

camera

camera: Camera

Virtual camera.

capsule_geometry

capsule_geometry: CapsuleGeometry

Capsule geometry.

character_controller

character_controller: CharacterController

Character controller used for movement constrained by collisions without having to deal with a rigid body. A character controller is kinematic, and so is not affected by forces. It uses its own tweaked collision algorithm to give a good feeling while controlling the character.

collision_geometry_ref

collision_geometry_ref: CollisionGeometryRef

Reference to a collision geometry.

constraint

constraint: Constraint

A physics constraint that can be configured along 6 degrees of freedom. In its default state it behaves as a fixed constraint - that is, it rigidly fixes the constraint frames of its two entities. However, individual degrees of freedom may be unlocked to permit any combination of rotation around the x-, y- and z- axes, and translation along these axes.

culling_geometry

culling_geometry: CullingGeometry

Culling geometry. Add this component in addition to another geometry component (e.g. box geometry, sphere geometry, etc.) to enable culling geometry.

cylinder_geometry

cylinder_geometry: CylinderGeometry

Cylinder geometry.

debug_name

debug_name: DebugName

Name of the entity.

decal_projector

decal_projector: DecalProjector

Decal Projector.

environment

environment: Environment

The environment of a scene. Used to give a scene a skybox.

joint

joint: Joint

Base component of all the other joint components (revolute_joint, etc.). By itself it will lock the orientations and distances of the constrainer and constrainee.

lineage

lineage: Lineage

Lineage of the entity through linkers.

local_aabb

local_aabb: LocalAabb

Local Axis Aligned Bounding Box of the entity.

local_transform

local_transform: LocalTransform

Local transform of the entity.

material

material: Material

References a shader and specifies input values if needed.

material_ref

material_ref: MaterialRef

Reference to a material.

mesh_ref

mesh_ref: MeshRef

Reference to a mesh.

orthographic_lens

orthographic_lens: OrthographicLens

A lens that applies an orthographic projection.

overrider

overrider: Overrider

Overrides a given entity in a sub scene.

perspective_lens

perspective_lens: PerspectiveLens

A lens that applies a perspective projection.

physics_material

physics_material: PhysicsMaterial

Physics material which represents a set of physical surface properties.

plane_geometry

plane_geometry: PlaneGeometry

Plane geometry.

point_cloud_ref

point_cloud_ref: PointCloudRef

Reference to a point cloud.

point_light

point_light: PointLight

A light with color and intensity. A point light by default, add a spot light component to add a cutoff. Can be parameterized to simulate the atmosphere sun.

reflection_probe

reflection_probe: ReflectionProbe

Omni directional reflection probe parameters, used for local cubemap reflection generation.

rigid_body

rigid_body: RigidBody

Rigid body parameters.

scene_ref

scene_ref: SceneRef

Reference to a scene.

script_map

script_map: ScriptMap

References multiple scripts.

shadow_caster

shadow_caster: ShadowCaster

Enables a light to cast shadows.

skeleton_ref

skeleton_ref: SkeletonRef

Reference to a skeleton.

sound_ref

sound_ref: SoundRef

Reference to a sound.

sphere_geometry

sphere_geometry: SphereGeometry

Sphere geometry.

spot_light

spot_light: SpotLight

Adds a cutoff to a point light to simulate a spot light.

stereoscopic_lens

stereoscopic_lens: StereoscopicLens

A lens that applies a custom projection.

tags

tags: Tags

Tags used to filter entities.

vehicle_controller

vehicle_controller: VehicleController

Vehicle Controller parameters.

volume_filter

volume_filter: VolumeFilter

Filtering properties applied to the volume.

volume_material_ref

volume_material_ref: VolumeMaterialRef

Reference to a material to use with a volume.

volume_ref

volume_ref: VolumeRef

Reference to a volume made of voxels.