Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

useEntityRef

useEntityRef(entity, trait?): (object) => void

A ref callback that holds the object on the entity under trait while it is mounted: its Ref, unless it draws something else apart.

Parameter Type Default value
entity Entity undefined
trait Trait<{ object: () => Object3D<Object3DEventMap> | null; }> RefTrait

(object) => void