generateCreature()

function generateCreature(
   params: CreatureParams, 
   rng: () => number, 
   id?: string
): object;

Defined in: index.ts:58

Generate a rigged, animated creature: the rest-pose body built bone by bone, layered inside by depth (fur, fat, flesh, muscle) with bones and organs below the surface, painted, bound to a 26-bone rig, and given walk, turn, run, idle, sniff and death clips at 12 fps. The rig's cover table draws flesh a pose uncovers as fur, so only damage shows the inside. Pure and deterministic in its params and rng.

Coarse only: there is no finer-scale context. For a world at a fixed voxels-per-metre, size the params with atScale first.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

object

The entity (kind creature, with rig and clips, nose towards +z, anchored on the ground under the middle of the body) and stats.

entityCopy Anchor Link

entity: Entity;

statsCopy Anchor Link

stats: CreatureStats;

ExampleCopy Anchor Link

import { seededRandom } from "@voxolith/renderer/core";
import { makeAnimator } from "@voxolith/engine/animation";
import { generateCreature, PRESETS } from "@voxolith/gen-creature";

const { entity } = generateCreature(PRESETS["grey rat"], seededRandom(9));
const anim = makeAnimator(entity, "walk");
for (const e of anim.update(dt)) if (e.name.startsWith("foot.")) footstep();