Skip to main content

entities

Query and manipulate Bevy ECS entities by name. Entities are the building blocks of the 3D scene -- VRM characters, cameras, webviews, and spawned objects are all entities with a numeric ID, an optional name, and a transform (position, rotation, scale).

Import

import { entities } from "@hmcs/sdk";

Functions

FunctionDescription
findByNameLook up an entity by its human-readable name
nameRetrieve the name attached to an entity ID
transformRead an entity's position, rotation, and scale
setTransformWrite a (partial) transform to an entity
moveReposition an entity using world or viewport coordinates
tweenPositionSmoothly animate an entity's position
tweenRotationSmoothly animate an entity's rotation
tweenScaleSmoothly animate an entity's scale