voxolith

Crowd

A crowd of animated entities, from makeCrowd.

Defined in: engine/src/animation/crowd.ts:128

Properties

PropertyModifierTypeDescriptionDefined in
cachereadonlyPoseCache<BakedPose>The pose cache; drop(variant + ".") frees one variant's poses.engine/src/animation/crowd.ts:142

Methods

last()

last(id: number): BakedPose | undefined;

Defined in: engine/src/animation/crowd.ts:138

The pose each member was last stamped with (for hit tests).

Parameters

ParameterType
idnumber

Returns

BakedPose | undefined


remove()

remove(id: number): void;

Defined in: engine/src/animation/crowd.ts:140

Forget a member and, when stamping, erase it from the world on the next commit.

Parameters

ParameterType
idnumber

Returns

void


update()

update(members: readonly CrowdMember[], camera: [number, number, number]): CrowdStats;

Defined in: engine/src/animation/crowd.ts:136

Pose, bake (within budgetMs) and place every member, then commit the stamper or instance layer. Call once per frame after moving the members and advancing their animators. Members left out of the list are not removed; call remove for those.

Parameters

ParameterTypeDescription
membersreadonly CrowdMember[]-
camera[number, number, number]Camera position in world voxels, for the distance LOD.

Returns

CrowdStats

On this page