Skip to main content

ComponentsRecord

type ComponentsRecord = {
animation_controller: AnimationController;
animation_sequence_controller: AnimationSequenceController;
bone: Bone;
box_geometry: BoxGeometry;
camera: Camera;
capsule_geometry: CapsuleGeometry;
character_controller: CharacterController;
collision_geometry_ref: CollisionGeometryRef;
constraint: Constraint;
culling_geometry: CullingGeometry;
cylinder_geometry: CylinderGeometry;
debug_name: DebugName;
decal_projector: DecalProjector;
environment: Environment;
joint: Joint;
label: Label;
lineage: Lineage;
local_aabb: LocalAabb;
local_transform: LocalTransform;
material: Material;
material_ref: MaterialRef;
measure: Measure;
mesh_ref: MeshRef;
orthographic_lens: OrthographicLens;
overrider: Overrider;
perspective_lens: PerspectiveLens;
physics_material: PhysicsMaterial;
plane_geometry: PlaneGeometry;
point_cloud_ref: PointCloudRef;
point_light: PointLight;
reflection_probe: ReflectionProbe;
rigid_body: RigidBody;
scene_ref: SceneRef;
script_map: ScriptMap;
shadow_caster: ShadowCaster;
skeleton_ref: SkeletonRef;
sound_ref: SoundRef;
sphere_geometry: SphereGeometry;
spline: Spline;
spot_light: SpotLight;
stereoscopic_lens: StereoscopicLens;
tags: Tags;
vehicle_controller: VehicleController;
volume_filter: VolumeFilter;
volume_material_ref: VolumeMaterialRef;
volume_ref: VolumeRef;
};

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

Type declaration

NameTypeDescription
animation_controllerAnimationControllerAnimation 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_controllerAnimationSequenceControllerAnimation sequence controller with reference to an animation sequence and assigned entities.
boneBoneLinks entity to bone in skeleton.
box_geometryBoxGeometryBox geometry.
cameraCameraVirtual camera.
capsule_geometryCapsuleGeometryCapsule geometry.
character_controllerCharacterControllerCharacter 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_refCollisionGeometryRefReference to a collision geometry.
constraintConstraintA 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_geometryCullingGeometryCulling geometry. Add this component in addition to another geometry component (e.g. box geometry, sphere geometry, etc.) to enable culling geometry.
cylinder_geometryCylinderGeometryCylinder geometry.
debug_nameDebugNameName of the entity.
decal_projectorDecalProjectorDecal Projector.
environmentEnvironmentThe environment of a scene. Used to give a scene a skybox.
jointJointBase component of all the other joint components (revolute_joint, etc.). By itself it will lock the orientations and distances of the constrainer and constrainee.
labelLabelDisplay a label in the 3d view.
lineageLineageLineage of the entity through linkers.
local_aabbLocalAabbLocal Axis Aligned Bounding Box of the entity.
local_transformLocalTransformLocal transform of the entity.
materialMaterialReferences a shader and specifies input values if needed.
material_refMaterialRefReference to a material.
measureMeasureDisplay a measure in the 3d view.
mesh_refMeshRefReference to a mesh.
orthographic_lensOrthographicLensA lens that applies an orthographic projection.
overriderOverriderOverrides a given entity in a sub scene.
perspective_lensPerspectiveLensA lens that applies a perspective projection.
physics_materialPhysicsMaterialPhysics material which represents a set of physical surface properties.
plane_geometryPlaneGeometryPlane geometry.
point_cloud_refPointCloudRefReference to a point cloud.
point_lightPointLightA 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_probeReflectionProbeOmni directional reflection probe parameters, used for local cubemap reflection generation.
rigid_bodyRigidBodyRigid body parameters.
scene_refSceneRefReference to a scene.
script_mapScriptMapReferences multiple scripts.
shadow_casterShadowCasterEnables a light to cast shadows.
skeleton_refSkeletonRefReference to a skeleton.
sound_refSoundRefReference to a sound.
sphere_geometrySphereGeometrySphere geometry.
splineSplineDisplay a spline in the 3d view.
spot_lightSpotLightAdds a cutoff to a point light to simulate a spot light.
stereoscopic_lensStereoscopicLensA lens that applies a custom projection.
tagsTagsTags used to filter entities.
vehicle_controllerVehicleControllerVehicle Controller parameters.
volume_filterVolumeFilterFiltering properties applied to the volume.
volume_material_refVolumeMaterialRefReference to a material to use with a volume.
volume_refVolumeRefReference to a volume made of voxels.