Skip to main content

README

All the components that can be attached to an entity.

Type Aliases

Type aliasDescription
EuidUnique identifier for an entity.
AnimationControllerAnimation 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.
AnimationSequenceControllerAnimation sequence controller with reference to an animation sequence and assigned entities.
BoneLinks entity to bone in skeleton.
BoxGeometryBox geometry.
CameraVirtual camera.
CapsuleGeometryCapsule geometry.
CharacterControllerCharacter 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.
CollisionGeometryRefReference to a collision geometry.
ConstraintA 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.
CullingGeometryCulling geometry. Add this component in addition to another geometry component (e.g. box geometry, sphere geometry, etc.) to enable culling geometry.
CylinderGeometryCylinder geometry.
DebugNameName of the entity.
DecalProjectorDecal Projector.
EnvironmentThe environment of a scene. Used to give a scene a skybox.
JointBase component of all the other joint components (revolute_joint, etc.). By itself it will lock the orientations and distances of the constrainer and constrainee.
LabelDisplay a label in the 3d view.
LineageLineage of the entity through linkers.
LocalAabbLocal Axis Aligned Bounding Box of the entity.
LocalTransformLocal transform of the entity.
MaterialReferences a shader and specifies input values if needed.
MaterialRefReference to a material.
MeasureDisplay a measure in the 3d view.
MeshRefReference to a mesh.
OrthographicLensA lens that applies an orthographic projection.
OverriderOverrides a given entity in a sub scene.
PerspectiveLensA lens that applies a perspective projection.
PhysicsMaterialPhysics material which represents a set of physical surface properties.
PlaneGeometryPlane geometry.
PointCloudRefReference to a point cloud.
PointLightA 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.
ReflectionProbeOmni directional reflection probe parameters, used for local cubemap reflection generation.
RigidBodyRigid body parameters.
SceneRefReference to a scene.
ScriptElementReferences a script and specifies input values if needed.
ScriptMapReferences multiple scripts.
ShadowCasterEnables a light to cast shadows.
SkeletonRefReference to a skeleton.
SoundRefReference to a sound.
SphereGeometrySphere geometry.
SplineDisplay a spline in the 3d view.
SpotLightAdds a cutoff to a point light to simulate a spot light.
StereoscopicLensA lens that applies a custom projection.
TagsTags used to filter entities.
VehicleControllerVehicle Controller parameters.
VolumeFilterFiltering properties applied to the volume.
VolumeMaterialRefReference to a material to use with a volume.
VolumeRefReference to a volume made of voxels.