Components Reference
Animation Controller
animation_controller
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 Controller
animation_controller
animationGraphRef
Asset UUID
UUID of the referenced animation graph.
animationSetRef
Asset UUID
UUID of the referenced animation set.
dataJSON
JSON
Input values as described in the referenced animation graph in their original JSON format.
rootBoneEntityRef
Entity Reference
{linkage,
originalEUID,
}
Reference to the entity with the bone component that corresponds the root bone of the skeleton.
rootMotionEnabled
Boolean
Default: false
Whether or not root motion is enabled.
Animation Sequence Controller
animation_sequence_controller
Animation sequence controller with reference to an animation sequence and assigned entities.
Animation Sequence Controller
animation_sequence_controller
animationSequenceRef
Asset UUID
A reference to an animation sequence.
entities
Map Entity Reference
Track to entity map. Key is track uuid, value is the entity to assign to it.
loop
Boolean
Default: false
Whether or not the animation loops when it reaches the end of the sequence.
playbackSpeed
Float
Default: 1
The speed at which to play the animation sequence. The sequence will go in reverse if set to a value lower than 0.
startOffset
Float
Default: 0
The normalized offset at which to start the playback.
stopOffset
Float
Default: 1
The normalized offset at which to stop the playback (or loop back to start offset).
Bone
bone
Links entity to bone in skeleton.
Bone
bone
boneIndex
Unsigned Integer
Index of bone in skeleton.
Box Geometry
box_geometry
Box geometry.
Box Geometry
box_geometry
dimension
Vector3
Default: [1,1,1]
Width, height and depth of the box.
offset
Vector3
Default: [0,0,0]
Geometry offset.
Camera
camera
Virtual camera.
Camera
camera
dataJSON
JSON
Input values as described in the referenced render graph in their original JSON format.
renderGraphRef
Asset UUID
UUID of the referenced render graph this camera should use.
renderTargetIndex
Integer
Default: -1
Index of the render target to blit.
Capsule Geometry
capsule_geometry
Capsule geometry.
Capsule Geometry
capsule_geometry
axis
Integer
Default: 1
Alignment axis. 0 for X, 1 for Y, 2 for Z.
height
Float
Default: 1
Height of the cylindrical part of the capsule.
offset
Vector3
Default: [0,0,0]
Geometry offset.
radius
Float
Default: 0.5
Radius of the spheres at each end of the capsule.
Character Controller
character_controller
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.
Character Controller
character_controller
skinWidth
Float
Default: 0
The character's collision skin width.
slopeLimit
Float
Default: 45
Slope limit in degrees. A slope steeper than the slopeLimit will not be walkable by the controller.
stepOffset
Float
Default: 0
Step offset. If the height of a step is greater than stepOffset, the controller cannot climb automatically and gets stuck.
Collision Geometry Reference
collision_geometry_ref
Reference to a collision geometry.
Collision Geometry Reference
collision_geometry_ref
collisionGeometryRef
Asset UUID
UUID of the referenced collision geometry.
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.
Constraint
constraint
motionLimitSpringDamping
Vector3
Default: [0,0,0]
If greater than zero, this is the damping of the limit spring.
motionLimitSpringStiffness
Vector3
Default: [0,0,0]
If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
motionLowerLimit
Vector3
Default: [0,0,0]
The lower distance of the limit.
motionUpperLimit
Vector3
Default: [0,0,0]
The upper distance of the limit.
swingLimitAngle
Vector2
Default: [0,0]
The limit angle from the Y-axis and the Z-axis of the constraint frame. The cone limit is used if either or both swing axes are limited. The extents are symmetrical and measured in the frame of the parent. If only one swing degree of freedom is limited, the corresponding value from the cone limit defines the limit range. An angle of 0° will not restrict the rotation around the axis. The maximum value for each angle is 180°.
swingSpringDamping
Float
Default: 0
If greater than zero, this is the damping of the limit spring.
swingSpringStiffness
Float
Default: 0
If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
twistLimitAngle
Vector2
Default: [0,0]
The twist limit controls the range of motion around the twist axis. The limit angle range is (-360, 360).
twistSpringDamping
Float
Default: 0
If greater than zero, this is the damping of the limit spring.
twistSpringStiffness
Float
Default: 0
If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
unlockedMotion
Unsigned Integer
Default: 0
Unlock motion along/around the specified axis.
Constraint Actuator
constraint_actuator
Constraint Actuator
constraint_actuator
angularDamping
Vector3
Default: [0,0,0]
If greater than zero, this is the damping of the limit spring.
angularForceLimit
Vector3
Default: [-1,-1,-1]
The maximum impulse or force that can be exerted by the drive. -1 for no limit.
angularStiffness
Vector3
Default: [0,0,0]
If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
angularVelocity
Vector3
Default: [0,0,0]
The goal velocity for angular drive.
goalOrientation
Quaternion
Default: [0,0,0,1]
The goal orientation for angular drive.
goalPosition
Vector3
Default: [0,0,0]
The goal position for linear drive.
linearDamping
Vector3
Default: [0,0,0]
If greater than zero, this is the damping of the limit spring.
linearForceLimit
Vector3
Default: [-1,-1,-1]
The maximum impulse or force that can be exerted by the drive. -1 for no limit.
linearStiffness
Vector3
Default: [0,0,0]
If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
linearVelocity
Vector3
Default: [0,0,0]
The goal velocity for linear drive.
type
Integer
Default: 1
The drive type
Culling Geometry
culling_geometry
Culling geometry. Add this component in addition to another geometry component (e.g. box geometry, sphere geometry, etc.) to enable culling geometry.
Culling Geometry
culling_geometry
isAdditive
Boolean
Default: true
Additive geometry will only display elements (vertices or voxels) inside the geometry. Subtractive will only display elements outside the geometry.
Cylinder Geometry
cylinder_geometry
Cylinder geometry.
Cylinder Geometry
cylinder_geometry
axis
Integer
Default: 1
Alignment axis. 0 for X, 1 for Y, 2 for Z.
height
Float
Default: 1
Height of the cylinder.
offset
Vector3
Default: [0,0,0]
Geometry offset.
radius
Float
Default: 0.5
Radius of the cylinder.
Name
debug_name
Name of the entity.
Name
debug_name
value
String
Entity name.
Decal Projector
decal_projector
Decal Projector.
Decal Projector
decal_projector
zIndex
Integer
Default: 0
Z-Index order of the decal projection. The higher index will render on top of the lower ones.
Environment
environment
The environment of a scene. Used to give a scene a skybox.
Environment
environment
irradianceUUID
Asset UUID
Reference to the irradiance cubemap.
radianceUUID
Asset UUID
Reference to the radiance cubemap.
skyboxUUID
Asset UUID
UUID of the skybox cubemap.
Entity UID
euid
Unique identifier for an entity.
Entity UID
euid
value
Entity Unique Identifier
Unique identifier value.
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.
Joint
joint
breakForce
Float
Default: 10
The force that needs to be applied for this joint to break.
breakTorque
Float
Default: 10
The torque that needs to be applied for this joint to break.
constrainee
Entity Reference
{linkage,
originalEUID,
}
An entity that is a rigid body.
constrainer
Entity Reference
{linkage,
originalEUID,
}
An entity that is a rigid or static body, or simply null.
enableCollision
Boolean
Default: false
Whether to enable collision between constrainer and constrainee.
Label
label
Display a label in the 3d view.
Label
label
camera
Default: [0,0,0,0,0,0,1]
Camera distance from the label.
description
String
Description of the label.
speed
Float
Default: 15
Travel speed in units per second.
title
String
Title of the label.
Lineage
lineage
Lineage of the entity through linkers.
Lineage
lineage
ordinal
Integer
Default: 0
Ordinal number of this entity in respect of its siblings.
parentUUID
Entity Unique Identifier
UUID of the parent of this entity (default is root).
Local Axis Aligned Bounding Box
local_aabb
Local Axis Aligned Bounding Box of the entity.
Local Axis Aligned Bounding Box
local_aabb
max
Vector3
Maximum point of the box.
min
Vector3
Minimum point of the box.
Transform
local_transform
Local transform of the entity.
Transform
local_transform
eulerOrientation
Vector3
Default: [0,0,0]
Orientation of the entity expressed as euler angles.
globalEulerOrientation
Vector3
Default: [0,0,0]
Last global orientation of the entity expressed as euler angles submitted by a user. This value may not be valid, and should be checked.
orientation
Quaternion
Default: [0,0,0,1]
Orientation of the entity expressed as a quaternion.
position
Vector3
Default: [0,0,0]
x, y, z position of the entity.
scale
Vector3
Default: [1,1,1]
x, y, z scale of the entity.
Material
material
References a shader and specifies input values if needed.
Material
material
constantsJSON
JSON
Specialization constants values as described in the referenced shader in their original JSON format.
dataJSON
JSON
Input values as described in the referenced shader in their original JSON format.
isDoubleSided
Boolean
Default: false
Whether the material is double sided or not.
shaderRef
Asset UUID
UUID of the referenced shader.
Material Reference
material_ref
Reference to a material.
Material Reference
material_ref
faceCulling
Integer
Default: 0
Face culling mode. 0 to inherit from material, 1 for single sided, 2 for double sided.
value
Asset UUID
UUID of the referenced material.
Measure
measure
Display a measure in the 3d view.
Measure
measure
color
Vector3
Default: [1,1,1]
Color of the measure
type
Unsigned Integer
Default: 0
Define the type of the measure.
Mesh Reference
mesh_ref
Reference to a mesh.
Mesh Reference
mesh_ref
shadowCastingMode
Unsigned Byte
Default: 1
Whether or not this mesh casts shadows.
submeshIndex
Integer
Default: 0
Index of the submesh inside the mesh's submesh array.
value
Asset UUID
UUID of the referenced mesh.
Orthographic Lens
orthographic_lens
A lens that applies an orthographic projection.
Orthographic Lens
orthographic_lens
zFar
Float
Default: 100
Far plane.
zNear
Float
Default: 0
Near plane.
zoomFactor
Vector2
Default: [1,1]
Zoom factor to apply to the projection.
Overrider
overrider
Overrides a given entity in a sub scene.
Overrider
overrider
componentsToDetach
Hashes of the components to detach from the overridden entity.
deleter
Boolean
Default: false
Mark the overridden entity as deleted.
entityRef
Entity Reference
{linkage,
originalEUID,
}
Entity to override.
Perspective Lens
perspective_lens
A lens that applies a perspective projection.
Perspective Lens
perspective_lens
farPlane
Float
Default: 0
Distance from the viewer to the far clipping plane.
fovy
Float
Default: 60
Field of view angle in the y direction.
nearPlane
Float
Default: 0.01
Distance from the viewer to the near clipping plane.
offset
Vector2
Default: [0,0]
Offset of the projection for stereoscopic rendering.
Physics Material
physics_material
Physics material which represents a set of physical surface properties.
Physics Material
physics_material
contactVelocity
Vector3
Default: [0,0,0]
The velocity applied to the contact between this physics body and another body. Only applies if modifyContact is true.
dynamicFriction
Float
Default: 0.5
The friction coefficient applied between this surface and another surface if they are moving relative to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. If set to greater than staticFriction, the effective value of staticFriction will be increased to match. Resulting dynamic friction of a physics body colliding with another is determined by the average of both bodies' dynamic friction coefficient.
isTrigger
Boolean
Default: false
Whether to consider the geometry associated to this physics material as a trigger or not.
modifyContact
Boolean
Default: false
Whether to modify the contact when this physics body collides with another body.
restitution
Float
Default: 0
Restitution coefficient, or bounciness of surface. A coefficient of 0 indicates as little bounce as possible, higher values up to 1.0 result in more bounce. Should be in the range [0,1]. Resulting bounciness of a physics body colliding with another is determined by the average of both bodies' restitution.
staticFriction
Float
Default: 0.5
The friction coefficient applied between this surface and another surface if they are not moving lateral to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. Resulting static friction of a physics body colliding with another is determined by the average of both bodies' static friction coefficient.
Plane Geometry
plane_geometry
Plane geometry.
Plane Geometry
plane_geometry
distance
Float
Default: 0
Distance from the origin in the plane's normal direction.
normal
Vector3
Default: [0,1,0]
Normal of the plane.
Point Cloud Reference
point_cloud_ref
Reference to a point cloud.
Point Cloud Reference
point_cloud_ref
value
Asset UUID
UUID of the referenced point cloud.
Light
point_light
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.
Light
point_light
color
Vector3
Default: [1,1,1]
Light color.
intensity
Float
Default: 1
Light intensity.
isDirectional
Boolean
Default: false
Make this light directional, position is ignored in this case.
isSun
Boolean
Default: false
Make this light direction control the atmosphere sun direction. If more than one light is marked to be a sun results are undefined.
range
Float
Default: 0
The range for the point light. If the range is 0, then physically correct point light attenuation function is used.
Reflection probe
reflection_probe
Omni directional reflection probe parameters, used for local cubemap reflection generation.
Reflection probe
reflection_probe
farDist
Float
Default: 100
Distance to the far plane.
nearDist
Float
Default: 0.1
Distance to the near plane.
offset
Vector3
Default: [0,0,0]
x, y, z offset of the probe reflection origin.
quality
Integer
Default: 128
Resolution of the reflection map.
Rigid Body
rigid_body
Rigid body parameters.
Rigid Body
rigid_body
angularDamping
Float
Default: 0.05
Angular damping coefficient. Used to slow down the rigid body's angular velocity, i.e. how much it rotates. Zero represents no damping. Must be non-negative.
centerOfMass
Vector3
Default: [0,0,0]
Center of mass. Relative to the entity's transform.
collisionDetection
Unsigned Byte
Default: 0
The type of collision detection to use for this rigid body.
isKinematic
Boolean
Default: false
Specifies if rigid body is kinematic. Kinematic rigid bodies are not affected by forces such as gravity.
linearDamping
Float
Default: 0
Linear damping coefficient. Used to slow down the rigid body's linear velocity. Zero represents no damping. Must be non-negative.
lockedAxis
Unsigned Byte
Default: 0
Lock motion along/around the specified axis.
mass
Float
Default: 1
Mass of the rigid body. A value of 0 is interpreted as infinite mass.
maxAngularVelocity
Float
Default: 100
The maximum angular velocity permitted for this body in rad/s. Must be non-negative.
maxLinearVelocity
Float
Default: 10000000000000000
The maximum linear velocity permitted for this body in m/s. Must be non-negative.
useGravity
Boolean
Default: true
Controls whether rigid body is affected by gravity.
Scene Reference
scene_ref
Reference to a scene.
Scene Reference
scene_ref
maxRecursionCount
Unsigned Integer
Default: 1
Maximum number of times a scene appears when it references itself.
value
Asset UUID
UUID of the referenced scene.
Script Element
script_element
References a script and specifies input values if needed.
Script Element
script_element
dataJSON
JSON
Input values as described in the referenced script in their original JSON format.
scriptRef
Asset UUID
UUID of the referenced script.
Script Map
script_map
References multiple scripts.
Script Map
script_map
elements
Map Script Element
List of scripts.
Shadow caster
shadow_caster
Enables a light to cast shadows.
Shadow caster
shadow_caster
accumulateShadowCascades
Boolean
Default: true
For directional lights, accumulate all shadow cascades.
bias
Float
Default: 0.002
Bias to apply to avoid self shadowing artifacts.
cascadeCount
Byte
Default: 4
For directional lights, number of cascades.
cascadeSplitLambda
Float
Default: 0.94
For directional lights, adjusts the distribution of cascade splits in Cascaded Shadow Mapping for directional lights. A value of 0 results in uniform (linear) splits across the view frustum, while a value of 1 skews the splits toward the camera, providing higher shadow resolution near the viewer and lower resolution in the distance. Intermediate values blend linear and logarithmic distributions for a balanced result. The value ranges from 0 to 1.
farDist
Float
Default: 100
Distance to the far plane.
nearDist
Float
Default: 0.1
Distance to the near plane.
quality
Integer
Default: 1024
Resolution of the shadow map.
Skeleton Reference
skeleton_ref
Reference to a skeleton.
Skeleton Reference
skeleton_ref
value
Asset UUID
UUID of the referenced skeleton.
Sound Reference
sound_ref
Reference to a sound.
Sound Reference
sound_ref
attenuationModel
Unsigned Byte
Default: 0
Attenuation Model.
attenuationRolloffFactor
Float
Default: 1
Attenuation rolloff factor.
autoPlayOnStart
Boolean
Default: false
Whether or not the sound plays automatically when the simulation starts.
dopplerFactor
Float
Default: 1
Reduce or enhance the doppler effect.
inaudibleBehavior
Unsigned Byte
Default: 0
Behavior of a sound when it becomes inaudible.
looping
Boolean
Default: false
Whether or not the sound loops.
maxDistance
Float
Default: 50
If distance from audio souce is >= maxDistance, audio is inaudible.
minDistance
Float
Default: 5
If distance from audio souce is < minDistance, audio is at max volume.
pan
Float
Default: 0
Pan. -1.0 is left, 1.0 is right.
playSpeed
Float
Default: 1
The speed at which the sound will play. 1.0 is normal.
value
Asset UUID
UUID of the referenced sound.
volume
Float
Default: 1
Volume from 0.0f to 1.0.
Sphere Geometry
sphere_geometry
Sphere geometry.
Sphere Geometry
sphere_geometry
offset
Vector3
Default: [0,0,0]
Geometry offset.
radius
Float
Default: 0.5
Radius of the sphere.
Spline
spline
Display a spline in the 3d view.
Spline
spline
color
Vector3
Default: [1,1,1]
Color of the curve.
tension
Float
Default: 0.5
When type is catmullrom, defines catmullrom's tension.
type
Unsigned Integer
Default: 0
Define the type of the curve.
Spot Light
spot_light
Adds a cutoff to a point light to simulate a spot light.
Spot Light
spot_light
IESProfile
Asset UUID
Reference to a IES 2d texture.
cutoff
Float
Default: 30
Cutoff angle.
Stereoscopic Perspective Lens
stereoscopic_lens
A lens that applies a custom projection.
Stereoscopic Perspective Lens
stereoscopic_lens
cs_from_vs
Matrix4
Projection matrix.
Vehicle Controller
vehicle_controller
Vehicle Controller parameters.
Vehicle Controller
vehicle_controller
chassis
Entity Reference
{linkage,
originalEUID,
}
The chassis.
frontLeftWheel
Entity Reference
{linkage,
originalEUID,
}
The front left wheel.
frontRightWheel
Entity Reference
{linkage,
originalEUID,
}
The front right wheel.
rearLeftWheel
Entity Reference
{linkage,
originalEUID,
}
The rear left wheel.
rearRightWheel
Entity Reference
{linkage,
originalEUID,
}
The rear right wheel.
Volume Filter
volume_filter
Filtering properties applied to the volume.
Volume Filter
volume_filter
applyGaussianFiltering
Boolean
Default: false
Apply gaussian filtering on voxels.
enable3D
Boolean
Default: true
Whether or not this volume is visible in the 3D view.
enableMPR
Boolean
Default: true
Whether or not this volume is visible in the MPR view.
range
Vector2
Default: [0,1]
Voxel intensity range displayed, not applicable if outside volume material range.
sampleUnfiltered
Boolean
Default: false
Are texel values from the voxel texture sampled unfiltered.
Volume Material Reference
volume_material_ref
Reference to a material to use with a volume.
Volume Material Reference
volume_material_ref
value
Asset UUID
UUID of the referenced volume material.
Volume Reference
volume_ref
Reference to a volume made of voxels.
Volume Reference
volume_ref
texture3dRef
Asset UUID
UUID of the referenced 3D texture.