Skip to main content

<billboard>

All rendered children of this element will face the camera.

Props

PropTypeDescriptionDefault
positionArrayPosition of the billboard.[0,0,0]
rotationArrayRotation of the billboard.[0,0,0]
axisStringThe axis to lock rotation to: x, y or znull
onHoverEnterFunctionCalled when an avatar hovers over the billboard. Provides an Event
onHoverLeaveFunctionCalled when an avatar hovers out of the billboard. Provides an Event
onPointerDownFunctionCalled when avatar presses the pointer down over this object.
onPointerDownHintStringText displayed when hovering over this object when onPointerDown is defined.
onPointerUpFunctionCalled when avatar releases the pointer over this object.
onPointerUpHintStringText displayed when hovering over this object with the pointer down and onPointerUp is defined.
hitDistanceNumberMaximum distance to interact with this node.3

Ref

FieldDescription
getPosition(vec3)Get position
setPosition(vec3)Update position
getPosition(eul)Get rotation
setRotation(eul)Update rotation
getAxis()Get the current axis
setAxis(value)Set the axis