Components
Every component an object can have, and every setting inside it. To learn what the settings mean, and which ones are easy to get wrong, see Components.
48 components are available.
| Type | Structure | Fields | Field names |
|---|---|---|---|
AnchorComponent | varies by type | 2 | type, …per variant |
AudioComponent | object | 7 | audio, volume, play, loop, muted, positional, … |
BoneComponent | object | 2 | index, inverse |
CameraComponent | varies by projection | 2 | projection, …per variant |
CameraViewComponent | object | 8 | target, x, y, width, height, size, … |
ColliderComponent | varies by type | 2 | type, …per variant |
ConnectorComponent | object | 9 | start, end, route, color, width, dash, … |
DivkitComponent | object | 6 | referal, render, anchorX, anchorY, enabled, persistVariables |
DrawingComponent | object | 8 | points, path, pressures, color, width, opacity, … |
EventsComponent | object | 1 | events |
ExtensionComponent | object | 1 | entries |
GeometryComponent | varies by type | 2 | type, …per variant |
GeometryModifiersComponent | object | 2 | modifiers, scope |
InitialVelocityComponent | object | 2 | velocity, angularVelocity |
InstancerComponent | varies by source | 2 | source, …per variant |
LightComponent | varies by type | 2 | type, …per variant |
LookAtComponent | varies by mode | 2 | mode, …per variant |
MaterialComponent | object | 1 | materials |
MetaComponent | object | 6 | name, type, sort, enabled, visible, isMain |
ModelRefComponent | object | 8 | referal, clip, speed, repeatMode, repeatCount, startFrame, … |
MorphComponent | object | 1 | weights |
ParentComponent | object | 3 | parent, order, lock |
ParticleEmitterComponent | object | 23 | emitting, count, lifetime, shape, radius, extents, … |
PatchGraphComponent | object | 3 | signature, nodes, edges |
PatchRefComponent | object | 2 | referal, inputs |
PathComponent | object | 19 | points, closed, curve, tension, radius, radialSegments, … |
PhysicsStateComponent | object | 4 | velocity, angularVelocity, speed, sleeping |
PlayerComponent | object | 0 | |
PlayerPartComponent | object | 3 | visibleTo, attach, tint |
PrefabComponent | object | 1 | resourceId |
PrefabContent | object | 1 | rootId |
RigidBodyComponent | object | 8 | type, mass, linearDamping, angularDamping, fixedRotation, friction, … |
ScriptComponent | object | 3 | referal, enabled, props |
ShaderGraphComponent | object | 5 | nodes, edges, output, order, source |
ShadowComponent | object | 2 | castShadow, receiveShadow |
SharedStateComponent | object | 0 | |
SkeletonComponent | object | 0 | |
SpawnPointComponent | object | 0 | |
SplatRefComponent | object | 2 | referal, lod |
StatesComponent | object | 2 | states, activeStateId |
StickerComponent | object | 6 | color, width, height, radius, opacity, showInBuilder |
TagsComponent | object | 1 | tags |
TemporalStateComponent | object | 2 | presets, activePresetId |
TerrainComponent | object | 11 | amplitude, frequency, octaves, persistence, lacunarity, seed, … |
Text3DComponent | object | 15 | text, font, fontWeight, fontSize, textAlign, verticalAlign, … |
TextComponent | object | 14 | font, fontStyle, text, fontWeight, fontSize, width, … |
TransformComponent | object | 4 | position, rotation, scale, lock |
VideoComponent | object | 7 | video, volume, play, loop, muted, positional, … |
All settings
AnchorComponent
The fields depend on the value of type.
type = image
| Field | Type | Notes |
|---|---|---|
isMain | bool — true or false | has a default |
preload | bool — true or false | has a default |
imageId | string — text | has a default |
physicalWidth | f64 — number | has a default, min 0 |
physicalHeight | f64 — number | has a default, min 0 |
showHints | bool — true or false | has a default |
holdOnLost | bool — true or false | has a default |
type = qr
| Field | Type | Notes |
|---|---|---|
isMain | bool — true or false | has a default |
preload | bool — true or false | has a default |
text | string — text | has a default |
imageId | string — text | has a default |
physicalSize | f64 — number | has a default, min 0 |
showHints | bool — true or false | has a default |
holdOnLost | bool — true or false | has a default |
type = geo
| Field | Type | Notes |
|---|---|---|
isMain | bool — true or false | has a default |
preload | bool — true or false | has a default |
latitude | f64 — number | has a default, min -90, max 90 |
longitude | f64 — number | has a default, min -180, max 180 |
showHints | bool — true or false | has a default |
type = face
| Field | Type | Notes |
|---|---|---|
isMain | bool — true or false | has a default |
preload | bool — true or false | has a default |
physicalSize | f64 — number | has a default, min 0 |
anchorPoint | enum(nose | forehead | chin | leftEye | rightEye | leftEyebrow | rightEyebrow | leftEar | rightEar | noseBase | bottomLip | origin) | has a default |
faceGrid | bool — true or false | has a default |
faceTextureId | string — text | has a default |
fillEyes | bool — true or false | has a default |
fillMouth | bool — true or false | has a default |
flipTexture | bool — true or false | has a default |
showHints | bool — true or false | has a default |
type = body
| Field | Type | Notes |
|---|---|---|
isMain | bool — true or false | has a default |
preload | bool — true or false | has a default |
bodyPoint | enum(chest | head | hips | leftHand | rightHand | leftFoot | rightFoot | nose | leftEyeInner | leftEye | leftEyeOuter | rightEyeInner | rightEye | rightEyeOuter | leftEar | rightEar | mouthLeft | mouthRight | leftShoulder | rightShoulder | leftElbow | rightElbow | leftWrist | rightWrist | leftPinky | rightPinky | leftIndex | rightIndex | leftThumb | rightThumb | leftHip | rightHip | leftKnee | rightKnee | leftAnkle | rightAnkle | leftHeel | rightHeel | leftFootIndex | rightFootIndex) | has a default |
poseModel | enum(lite | full | heavy) | has a default |
showHints | bool — true or false | has a default |
type = surface
| Field | Type | Notes |
|---|---|---|
isMain | bool — true or false | has a default |
preload | bool — true or false | has a default |
bindingType | enum(floor | wall | ceiling | table) | has a default |
recognitionAlgorithm | enum(plane_detection | hit_test) | has a default |
providerIos | enum(auto | webxr | 8thwall | arclip-webar) | has a default |
providerAndroid | enum(auto | webxr | 8thwall | arclip-webar) | has a default |
vps | bool — true or false | has a default |
locationIds | array — list | has a default |
placementMove | bool — true or false | has a default |
placementRotate | bool — true or false | has a default |
placementScale | bool — true or false | has a default |
showHints | bool — true or false | has a default |
type = panorama
| Field | Type | Notes |
|---|---|---|
isMain | bool — true or false | has a default |
preload | bool — true or false | has a default |
showHints | bool — true or false | has a default |
type = 3d
| Field | Type | Notes |
|---|---|---|
isMain | bool — true or false | has a default |
preload | bool — true or false | has a default |
cameraId | string — text | has a default |
vr | bool — true or false | has a default |
vrStereo | bool — true or false | has a default |
vrDistance | f64 — number | has a default, min 0 |
vrHeight | f64 — number | has a default |
vrScale | f64 — number | has a default, min 0.001 |
AudioComponent
| Field | Type | Notes |
|---|---|---|
audio | string — text | can be null, has a default |
volume | f64 — number | has a default |
play | bool — true or false | has a default |
loop | bool — true or false | has a default |
muted | bool — true or false | has a default |
positional | bool — true or false | has a default |
position | f64 — number | has a default |
BoneComponent
| Field | Type | Notes |
|---|---|---|
index | f64 — number | has a default |
inverse | mat4 — number[16] | has a default |
CameraComponent
The fields depend on the value of projection.
projection = perspective
| Field | Type | Notes |
|---|---|---|
fov | f64 — number | has a default, min 1, max 179 |
near | f64 — number | has a default, min 0.001 |
far | f64 — number | has a default, min 0.01 |
controls | enum(none | orbit | fly | firstPerson | lock) | has a default |
target | vec3 — {x, y, z} | has a default |
enableDamping | bool — true or false | has a default |
dampingFactor | f64 — number | has a default, min 0, max 1 |
enableRotate | bool — true or false | has a default |
enablePan | bool — true or false | has a default |
enableZoom | bool — true or false | has a default |
minDistance | f64 — number | has a default, min 0 |
maxDistance | f64 — number | has a default, min 0 |
minPolarAngle | f64 — number | has a default, min 0, max 3.141592653589793 |
maxPolarAngle | f64 — number | has a default, min 0, max 3.141592653589793 |
autoRotate | bool — true or false | has a default |
autoRotateSpeed | f64 — number | has a default |
moveSpeed | f64 — number | has a default, min 0 |
boost | f64 — number | has a default, min 1 |
lookSpeed | f64 — number | has a default, min 0.05 |
moveForward | array — list | has a default |
moveBack | array — list | has a default |
moveLeft | array — list | has a default |
moveRight | array — list | has a default |
moveUp | array — list | has a default |
moveDown | array — list | has a default |
moveBoost | array — list | has a default |
CameraViewComponent
| Field | Type | Notes |
|---|---|---|
target | enum(screen | texture) | has a default |
x | f64 — number | has a default, min 0, max 1 |
y | f64 — number | has a default, min 0, max 1 |
width | f64 — number | has a default, min 0, max 1 |
height | f64 — number | has a default, min 0, max 1 |
size | u32 — number | has a default, min 16, max 4096 |
order | i32 — number | has a default |
enabled | bool — true or false | has a default |
ColliderComponent
The fields depend on the value of type.
type = auto
| Field | Type | Notes |
|---|
type = box
| Field | Type | Notes |
|---|---|---|
halfExtents | vec3 — {x, y, z} | has a default |
type = sphere
| Field | Type | Notes |
|---|---|---|
radius | f64 — number | has a default, min 0 |
type = cylinder
| Field | Type | Notes |
|---|---|---|
radiusTop | f64 — number | has a default, min 0 |
radiusBottom | f64 — number | has a default, min 0 |
height | f64 — number | has a default, min 0 |
segments | u32 — number | has a default, min 3, max 64 |
type = capsule
| Field | Type | Notes |
|---|---|---|
radius | f64 — number | has a default, min 0 |
height | f64 — number | has a default, min 0 |
type = plane
| Field | Type | Notes |
|---|
ConnectorComponent
| Field | Type | Notes |
|---|---|---|
start | object — nested object | has a default |
end | object — nested object | has a default |
route | enum(straight | elbow | curved) | has a default |
color | union — one of several types | has a default |
width | f64 — number | has a default, min 0.0005, max 1 |
dash | enum(solid | dashed | dotted) | has a default |
rounded | bool — true or false | has a default |
opacity | f64 — number | has a default, min 0, max 1 |
showInBuilder | bool — true or false | has a default |
DivkitComponent
| Field | Type | Notes |
|---|---|---|
referal | string — text | can be null, has a default |
render | enum(overlay | anchored) | has a default |
anchorX | enum(left | center | right) | has a default |
anchorY | enum(top | center | bottom) | has a default |
enabled | bool — true or false | has a default |
persistVariables | bool — true or false | has a default |
DrawingComponent
| Field | Type | Notes |
|---|---|---|
points | array — list | has a default |
path | array — list | has a default |
pressures | array — list | has a default |
color | union — one of several types | has a default |
width | f64 — number | has a default, min 0.0005, max 1 |
opacity | f64 — number | has a default, min 0, max 1 |
strokes | array — list | has a default |
showInBuilder | bool — true or false | has a default |
EventsComponent
| Field | Type | Notes |
|---|---|---|
events | array — list | has a default |
ExtensionComponent
| Field | Type | Notes |
|---|---|---|
entries | record — map of keys to values | has a default |
GeometryComponent
The fields depend on the value of type.
type = box
| Field | Type | Notes |
|---|---|---|
width | f64 — number | has a default, min 0 |
height | f64 — number | has a default, min 0 |
depth | f64 — number | has a default, min 0 |
widthSegments | u32 — number | has a default, min 1, max 100 |
heightSegments | u32 — number | has a default, min 1, max 100 |
depthSegments | u32 — number | has a default, min 1, max 100 |
cornerRadius | f64 — number | has a default, min 0 |
cornerSegments | u32 — number | has a default, min 1, max 10 |
type = sphere
| Field | Type | Notes |
|---|---|---|
radius | f64 — number | has a default, min 0 |
widthSegments | u32 — number | has a default, min 3, max 256 |
heightSegments | u32 — number | has a default, min 2, max 256 |
phiStart | f64 — number | has a default |
phiLength | f64 — number | has a default |
thetaStart | f64 — number | has a default, min 0, max 6.283185307179586 |
thetaLength | f64 — number | has a default, min 0, max 6.283185307179586 |
type = cylinder
| Field | Type | Notes |
|---|---|---|
radiusTop | f64 — number | has a default, min 0 |
radiusBottom | f64 — number | has a default, min 0 |
height | f64 — number | has a default, min 0 |
radialSegments | u32 — number | has a default, min 3, max 256 |
heightSegments | u32 — number | has a default, min 1, max 100 |
openEnded | bool — true or false | has a default |
thetaStart | f64 — number | has a default, min 0, max 6.283185307179586 |
thetaLength | f64 — number | has a default, min 0, max 6.283185307179586 |
type = capsule
| Field | Type | Notes |
|---|---|---|
radius | f64 — number | has a default, min 0 |
height | f64 — number | has a default, min 0 |
capSegments | u32 — number | has a default, min 1, max 32 |
radialSegments | u32 — number | has a default, min 3, max 128 |
heightSegments | u32 — number | has a default, min 1, max 100 |
type = circle
| Field | Type | Notes |
|---|---|---|
radius | f64 — number | has a default, min 0 |
segments | u32 — number | has a default, min 3, max 256 |
thetaStart | f64 — number | has a default, min 0, max 6.283185307179586 |
thetaLength | f64 — number | has a default, min 0, max 6.283185307179586 |
type = cone
| Field | Type | Notes |
|---|---|---|
radius | f64 — number | has a default, min 0 |
height | f64 — number | has a default, min 0 |
radialSegments | u32 — number | has a default, min 3, max 256 |
heightSegments | u32 — number | has a default, min 1, max 100 |
openEnded | bool — true or false | has a default |
thetaStart | f64 — number | has a default, min 0, max 6.283185307179586 |
thetaLength | f64 — number | has a default, min 0, max 6.283185307179586 |
type = dodecahedron
| Field | Type | Notes |
|---|---|---|
radius | f64 — number | has a default, min 0 |
detail | u32 — number | has a default, max 5 |
type = icosahed
| Field | Type | Notes |
|---|---|---|
radius | f64 — number | has a default, min 0 |
detail | u32 — number | has a default, max 5 |
type = octahedron
| Field | Type | Notes |
|---|---|---|
radius | f64 — number | has a default, min 0 |
detail | u32 — number | has a default, max 5 |
type = plane
| Field | Type | Notes |
|---|---|---|
width | f64 — number | has a default, min 0 |
height | f64 — number | has a default, min 0 |
widthSegments | u32 — number | has a default, min 1, max 100 |
heightSegments | u32 — number | has a default, min 1, max 100 |
type = triangle
| Field | Type | Notes |
|---|---|---|
width | f64 — number | has a default, min 0 |
height | f64 — number | has a default, min 0 |
widthSegments | u32 — number | has a default, min 1, max 100 |
heightSegments | u32 — number | has a default, min 1, max 100 |
type = ring
| Field | Type | Notes |
|---|---|---|
innerRadius | f64 — number | has a default, min 0 |
outerRadius | f64 — number | has a default, min 0 |
thetaSegments | u32 — number | has a default, min 3, max 256 |
phiSegments | u32 — number | has a default, min 1, max 32 |
thetaStart | f64 — number | has a default, min 0, max 6.283185307179586 |
thetaLength | f64 — number | has a default, min 0, max 6.283185307179586 |
type = torus
| Field | Type | Notes |
|---|---|---|
radius | f64 — number | has a default |
tube | f64 — number | has a default |
radialSegments | u32 — number | has a default, min 1, max 128 |
tubularSegments | u32 — number | has a default, min 3, max 256 |
arc | f64 — number | has a default, min 0, max 6.283185307179586 |
type = extrude
| Field | Type | Notes |
|---|---|---|
points | array — list | has a default |
depth | f64 — number | has a default, min 0 |
bevelEnabled | bool — true or false | has a default |
bevelThickness | f64 — number | has a default, min 0 |
bevelSize | f64 — number | has a default, min 0 |
bevelSegments | u32 — number | has a default, min 1, max 16 |
type = lathe
| Field | Type | Notes |
|---|---|---|
points | array — list | has a default |
segments | u32 — number | has a default, min 3, max 256 |
phiStart | f64 — number | has a default, min 0, max 6.283185307179586 |
phiLength | f64 — number | has a default, min 0, max 6.283185307179586 |
type = ref
| Field | Type | Notes |
|---|---|---|
referal | string — text | can be null, has a default |
GeometryModifiersComponent
| Field | Type | Notes |
|---|---|---|
modifiers | array — list | has a default |
scope | enum(self | hierarchy) | has a default |
InitialVelocityComponent
| Field | Type | Notes |
|---|---|---|
velocity | vec3 — {x, y, z} | has a default |
angularVelocity | vec3 — {x, y, z} | has a default |
InstancerComponent
The fields depend on the value of source.
source = grid
| Field | Type | Notes |
|---|---|---|
maxCount | u32 — number | has a default, min 1, max 100000 |
seed | u32 — number | has a default |
scaleMin | f64 — number | has a default, min 0 |
scaleMax | f64 — number | has a default, min 0 |
rotationJitter | vec3 — {x, y, z} | has a default |
colorA | color — colour as a hex string | has a default |
colorB | color — colour as a hex string | has a default |
countX | u32 — number | has a default, min 1, max 1000 |
countY | u32 — number | has a default, min 1, max 1000 |
countZ | u32 — number | has a default, min 1, max 1000 |
spacing | vec3 — {x, y, z} | has a default |
jitter | f64 — number | has a default, min 0, max 1 |
source = scatter
| Field | Type | Notes |
|---|---|---|
maxCount | u32 — number | has a default, min 1, max 100000 |
seed | u32 — number | has a default |
scaleMin | f64 — number | has a default, min 0 |
scaleMax | f64 — number | has a default, min 0 |
rotationJitter | vec3 — {x, y, z} | has a default |
colorA | color — colour as a hex string | has a default |
colorB | color — colour as a hex string | has a default |
count | u32 — number | has a default, min 1, max 100000 |
shape | enum(box | sphere) | has a default |
extents | vec3 — {x, y, z} | has a default |
source = children
| Field | Type | Notes |
|---|---|---|
maxCount | u32 — number | has a default, min 1, max 100000 |
seed | u32 — number | has a default |
scaleMin | f64 — number | has a default, min 0 |
scaleMax | f64 — number | has a default, min 0 |
rotationJitter | vec3 — {x, y, z} | has a default |
colorA | color — colour as a hex string | has a default |
colorB | color — colour as a hex string | has a default |
LightComponent
The fields depend on the value of type.
type = ambient
| Field | Type | Notes |
|---|---|---|
color | color — colour as a hex string | has a default |
intensity | f64 — number | has a default, min 0 |
castShadow | bool — true or false | has a default |
visible | bool — true or false | has a default |
type = directional
| Field | Type | Notes |
|---|---|---|
color | color — colour as a hex string | has a default |
intensity | f64 — number | has a default, min 0 |
castShadow | bool — true or false | has a default |
visible | bool — true or false | has a default |
shadowMapSize | f64 — number | has a default, min 128, max 4096 |
shadowBias | f64 — number | has a default, min -0.1, max 0.1 |
shadowNormalBias | f64 — number | has a default, min 0, max 1 |
shadowSoftness | f64 — number | has a default, min 0, max 20 |
shadowIntensity | f64 — number | has a default, min 0, max 1 |
shadowArea | f64 — number | has a default, min 0.5, max 500 |
type = point
| Field | Type | Notes |
|---|---|---|
color | color — colour as a hex string | has a default |
intensity | f64 — number | has a default, min 0 |
castShadow | bool — true or false | has a default |
visible | bool — true or false | has a default |
shadowMapSize | f64 — number | has a default, min 128, max 4096 |
shadowBias | f64 — number | has a default, min -0.1, max 0.1 |
shadowNormalBias | f64 — number | has a default, min 0, max 1 |
shadowSoftness | f64 — number | has a default, min 0, max 20 |
shadowIntensity | f64 — number | has a default, min 0, max 1 |
distance | f64 — number | has a default, min 0 |
decay | f64 — number | has a default, min 0 |
type = spot
| Field | Type | Notes |
|---|---|---|
color | color — colour as a hex string | has a default |
intensity | f64 — number | has a default, min 0 |
castShadow | bool — true or false | has a default |
visible | bool — true or false | has a default |
shadowMapSize | f64 — number | has a default, min 128, max 4096 |
shadowBias | f64 — number | has a default, min -0.1, max 0.1 |
shadowNormalBias | f64 — number | has a default, min 0, max 1 |
shadowSoftness | f64 — number | has a default, min 0, max 20 |
shadowIntensity | f64 — number | has a default, min 0, max 1 |
distance | f64 — number | has a default, min 0 |
decay | f64 — number | has a default, min 0 |
angle | f64 — number | has a default, min 0, max 1.5707963267948966 |
penumbra | f64 — number | has a default, min 0, max 1 |
type = hemisphere
| Field | Type | Notes |
|---|---|---|
color | color — colour as a hex string | has a default |
intensity | f64 — number | has a default, min 0 |
castShadow | bool — true or false | has a default |
visible | bool — true or false | has a default |
groundColor | color — colour as a hex string | has a default |
LookAtComponent
The fields depend on the value of mode.
mode = world
| Field | Type | Notes |
|---|---|---|
target | vec3 — {x, y, z} | has a default |
mode = self
| Field | Type | Notes |
|---|---|---|
offset | vec3 — {x, y, z} | has a default |
MaterialComponent
| Field | Type | Notes |
|---|---|---|
materials | array — list | has a default, min 1 |
MetaComponent
| Field | Type | Notes |
|---|---|---|
name | string — text | has a default |
type | enum(object | model | plain | box | light) | has a default |
sort | f64 — number | has a default |
enabled | bool — true or false | has a default |
visible | bool — true or false | has a default |
isMain | bool — true or false | has a default |
ModelRefComponent
| Field | Type | Notes |
|---|---|---|
referal | string — text | can be null, has a default |
clip | string — text | can be null, has a default |
speed | f64 — number | has a default |
repeatMode | enum(none | count | permanent) | has a default |
repeatCount | f64 — number | has a default, whole number, min 1 |
startFrame | f64 — number | has a default, whole number, min 0 |
stopWhenPressed | bool — true or false | has a default |
playing | bool — true or false | has a default |
MorphComponent
| Field | Type | Notes |
|---|---|---|
weights | record — map of keys to values | has a default |
ParentComponent
| Field | Type | Notes |
|---|---|---|
parent | string — text | can be null, has a default |
order | f64 — number | can be null, has a default |
lock | bool — true or false | has a default |
ParticleEmitterComponent
| Field | Type | Notes |
|---|---|---|
emitting | bool — true or false | has a default |
count | u32 — number | has a default, min 1, max 65536 |
lifetime | f64 — number | has a default, min 0.05 |
shape | enum(point | sphere | box | cone) | has a default |
radius | f64 — number | has a default, min 0 |
extents | vec3 — {x, y, z} | has a default |
angle | f64 — number | has a default, min 0, max 180 |
speedMin | f64 — number | has a default, min 0 |
speedMax | f64 — number | has a default, min 0 |
gravity | vec3 — {x, y, z} | has a default |
drag | f64 — number | has a default, min 0 |
turbulence | f64 — number | has a default, min 0 |
sizeStart | f64 — number | has a default, min 0 |
sizeEnd | f64 — number | has a default, min 0 |
sizeJitter | f64 — number | has a default, min 0, max 1 |
spin | f64 — number | has a default |
colorStart | color — colour as a hex string | has a default |
colorEnd | color — colour as a hex string | has a default |
opacityStart | f64 — number | has a default, min 0, max 1 |
opacityEnd | f64 — number | has a default, min 0, max 1 |
sprite | string — text | can be null, has a default |
blending | enum(additive | normal) | has a default |
seed | u32 — number | has a default |
PatchGraphComponent
| Field | Type | Notes |
|---|---|---|
signature | object — nested object | has a default |
nodes | array — list | has a default |
edges | array — list | has a default |
PatchRefComponent
| Field | Type | Notes |
|---|---|---|
referal | string — text | can be null, has a default |
inputs | record — map of keys to values | has a default |
PathComponent
| Field | Type | Notes |
|---|---|---|
points | array — list | has a default |
closed | bool — true or false | has a default |
curve | enum(smooth | linear) | has a default |
tension | f64 — number | has a default, min 0, max 1 |
radius | f64 — number | has a default, min 0, max 10 |
radialSegments | u32 — number | has a default, min 3, max 64 |
tubularSegments | u32 — number | has a default, min 4, max 1024 |
profile | enum(none | circle | rectangle | star) | has a default |
profileSize | vec2 — {x, y} | has a default |
ring | f64 — number | has a default, min 0, max 1 |
arc | f64 — number | has a default, min 0, max 360 |
sides | u32 — number | has a default, min 3, max 64 |
depth | f64 — number | has a default, min 0, max 1 |
offset | f64 — number | has a default, min 0, max 1 |
rotation | f64 — number | has a default, min -360, max 360 |
twist | f64 — number | has a default, min -3600, max 3600 |
startScale | f64 — number | has a default, min 0, max 10 |
endScale | f64 — number | has a default, min 0, max 10 |
caps | enum(flat | round) | has a default |
PhysicsStateComponent
| Field | Type | Notes |
|---|---|---|
velocity | vec3 — {x, y, z} | has a default |
angularVelocity | vec3 — {x, y, z} | has a default |
speed | f64 — number | has a default |
sleeping | bool — true or false | has a default |
PlayerComponent
| Field | Type | Notes |
|---|
PlayerPartComponent
| Field | Type | Notes |
|---|---|---|
visibleTo | enum(all | me | others) | has a default |
attach | enum(body | camera) | has a default |
tint | bool — true or false | has a default |
PrefabComponent
| Field | Type | Notes |
|---|---|---|
resourceId | string — text | can be null, has a default |
PrefabContent
| Field | Type | Notes |
|---|---|---|
rootId | string — text | required |
RigidBodyComponent
| Field | Type | Notes |
|---|---|---|
type | enum(dynamic | static | kinematic | none) | has a default |
mass | f64 — number | has a default, min 0 |
linearDamping | f64 — number | has a default, min 0, max 1 |
angularDamping | f64 — number | has a default, min 0, max 1 |
fixedRotation | bool — true or false | has a default |
friction | f64 — number | can be null, has a default, min 0 |
restitution | f64 — number | can be null, has a default, min 0, max 1 |
network | enum(shared | local) | has a default |
ScriptComponent
| Field | Type | Notes |
|---|---|---|
referal | string — text | can be null, has a default |
enabled | bool — true or false | has a default |
props | record — map of keys to values | has a default |
ShaderGraphComponent
| Field | Type | Notes |
|---|---|---|
nodes | array — list | has a default |
edges | array — list | has a default |
output | string — text | has a default |
order | f64 — number | has a default, whole number |
source | string — text | has a default |
ShadowComponent
| Field | Type | Notes |
|---|---|---|
castShadow | bool — true or false | has a default |
receiveShadow | bool — true or false | has a default |
SharedStateComponent
| Field | Type | Notes |
|---|
SkeletonComponent
| Field | Type | Notes |
|---|
SpawnPointComponent
| Field | Type | Notes |
|---|
SplatRefComponent
| Field | Type | Notes |
|---|---|---|
referal | string — text | can be null, has a default |
lod | bool — true or false | has a default |
StatesComponent
| Field | Type | Notes |
|---|---|---|
states | array — list | has a default |
activeStateId | string — text | can be null, has a default |
StickerComponent
| Field | Type | Notes |
|---|---|---|
color | union — one of several types | has a default |
width | f64 — number | has a default, min 0.01 |
height | f64 — number | has a default, min 0.01 |
radius | f64 — number | has a default, min 0, max 0.5 |
opacity | f64 — number | has a default, min 0, max 1 |
showInBuilder | bool — true or false | has a default |
TagsComponent
| Field | Type | Notes |
|---|---|---|
tags | record — map of keys to values | required |
TemporalStateComponent
| Field | Type | Notes |
|---|---|---|
presets | array — list | has a default |
activePresetId | string — text | can be null, has a default |
TerrainComponent
| Field | Type | Notes |
|---|---|---|
amplitude | f64 — number | has a default, min 0, max 1000 |
frequency | f64 — number | has a default, min 0, max 1000 |
octaves | u32 — number | has a default, min 1, max 8 |
persistence | f64 — number | has a default, min 0, max 1 |
lacunarity | f64 — number | has a default, min 1, max 4 |
seed | f64 — number | has a default, min 0, max 1000000 |
ridged | bool — true or false | has a default |
sea | bool — true or false | has a default |
seaLevel | f64 — number | has a default, min -1, max 1 |
direction | enum(normal | radial | up) | has a default |
detail | u32 — number | has a default, max 6 |
Text3DComponent
| Field | Type | Notes |
|---|---|---|
text | string — text | has a default |
font | string — text | can be null, has a default |
fontWeight | enum(normal | bold) | has a default |
fontSize | f64 — number | has a default |
textAlign | enum(left | center | right | justify) | has a default |
verticalAlign | enum(top | middle | bottom) | has a default |
lineHeight | f64 — number | has a default, min 0.1, max 5 |
letterSpacing | f64 — number | has a default, min -0.5, max 2 |
curveSegments | u32 — number | has a default, min 1, max 32 |
depth | f64 — number | has a default, min 0, max 5 |
bevelEnabled | bool — true or false | has a default |
bevelThickness | f64 — number | has a default, min 0, max 1 |
bevelSize | f64 — number | has a default, min 0, max 1 |
bevelSegments | u32 — number | has a default, min 1, max 16 |
color | union — one of several types | has a default |
TextComponent
| Field | Type | Notes |
|---|---|---|
font | string — text | can be null, has a default |
fontStyle | enum(normal | italic) | has a default |
text | string — text | has a default |
fontWeight | enum(normal | bold) | has a default |
fontSize | f64 — number | has a default |
width | f64 — number | can be null, has a default |
height | f64 — number | can be null, has a default |
textAlign | enum(left | center | right | justify) | has a default |
verticalAlign | enum(top | middle | bottom) | has a default |
color | union — one of several types | has a default |
lineHeight | f64 — number | has a default, min 0.1, max 5 |
letterSpacing | f64 — number | has a default, min -0.5, max 2 |
anchorToAlign | bool — true or false | has a default |
ranges | array — list | has a default |
TransformComponent
| Field | Type | Notes |
|---|---|---|
position | vec3 — {x, y, z} | has a default |
rotation | vec3 — {x, y, z} | has a default |
scale | vec3 — {x, y, z} | has a default |
lock | bool — true or false | has a default |
VideoComponent
| Field | Type | Notes |
|---|---|---|
video | string — text | can be null, has a default |
volume | f64 — number | has a default |
play | bool — true or false | has a default |
loop | bool — true or false | has a default |
muted | bool — true or false | has a default |
positional | bool — true or false | has a default |
position | f64 — number | has a default |