nonstrict
platformer3dKit.finishes: the finish objects a player touches to end a
level, built from the engine's primitive meshes (via Trapline.parts). Ten
looks: checkeredFlag, goalRing, starPedestal, portal, trophy, finishArch,
pixelFlagpole, summitBell, timingGantry, cryptGate. Parts are local, temporary children of the root
you pass, so every machine builds its own and nothing is saved into a scene.
byId(id: string) → any
The look entry for `id`, or nil.
| arg | type | description |
|---|
| id | string | |
sfx(name: string, look: string) → void
| arg | type | description |
|---|
| name | string | |
| look | string | |
spin(h: any, key: string, speed: number, dt: number) → number
| arg | type | description |
|---|
| h | any | |
| key | string | |
| speed | number | |
| dt | number | |
since(h: any, t: number) → number
seconds since the celebration started (huge when it never did)
| arg | type | description |
|---|
| h | any | |
| t | number | |
makeConfetti(parent: any, n: number, origin: { number }, spread: number, seed: number, colors: { string }?, cube: boolean?) → any
| arg | type | description |
|---|
| parent | any | |
| n | number | |
| origin | { number } | |
| spread | number | |
| seed | number | |
| colors | { string }? | |
| cube | boolean? | |
animConfetti(cf: any, u: number, dur: number) → void
| arg | type | description |
|---|
| cf | any | |
| u | number | |
| dur | number | |
star(parent: any, name: string, coreR: number, pointLen: number, depth: number, color: { number }, opts: any) → any
a five-point star lying in the XY plane (faces +Z), under `parent`
| arg | type | description |
|---|
| parent | any | |
| name | string | |
| coreR | number | |
| pointLen | number | |
| depth | number | |
| color | { number } | |
| opts | any | |
hoop(parent: any, name: string, n: number, radius: number, thick: number, depth: number, opts: any) → void
a ring of `n` segments in the XY plane (faces +Z): the torus mesh's tube is
too fat for a thin hoop, so hoops are built from capsules or cubes.
| arg | type | description |
|---|
| parent | any | |
| name | string | |
| n | number | |
| radius | number | |
| thick | number | |
| depth | number | |
| opts | any | |
build(g: any, h: any) → void
| arg | type | description |
|---|
| g | any | |
| h | any | |
animate(h: any, t: number, dt: number) → void
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
build(g: any, h: any) → void
| arg | type | description |
|---|
| g | any | |
| h | any | |
animate(h: any, t: number, dt: number) → void
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
build(g: any, h: any) → void
| arg | type | description |
|---|
| g | any | |
| h | any | |
animate(h: any, t: number, dt: number) → void
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
build(g: any, h: any) → void
| arg | type | description |
|---|
| g | any | |
| h | any | |
animate(h: any, t: number, dt: number) → void
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
build(g: any, h: any) → void
| arg | type | description |
|---|
| g | any | |
| h | any | |
animate(h: any, t: number, dt: number) → void
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
build(g: any, h: any) → void
| arg | type | description |
|---|
| g | any | |
| h | any | |
animate(h: any, t: number, dt: number) → void
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
build(g: any, h: any) → void
| arg | type | description |
|---|
| g | any | |
| h | any | |
animate(h: any, t: number, dt: number) → void
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
build(g: any, h: any) → void
| arg | type | description |
|---|
| g | any | |
| h | any | |
animate(h: any, t: number, dt: number) → void
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
strut(parent: any, name: string, a: { number }, b: { number }, thick: number, opts: any) → any
a straight member from point a to point b (cylinder by default), any direction
| arg | type | description |
|---|
| parent | any | |
| name | string | |
| a | { number } | |
| b | { number } | |
| thick | number | |
| opts | any | |
makeMotes(parent: any, n: number, seed: number, cols: { string }, origin: { number }, spread: number, size: number, mesh: string) → any
rising, swirling glow motes (embers, wisps) that shrink out; hidden until a celebration
| arg | type | description |
|---|
| parent | any | |
| n | number | |
| seed | number | |
| cols | { string } | |
| origin | { number } | |
| spread | number | |
| size | number | |
| mesh | string | |
animMotes(m: any, u: number) → void
| arg | type | description |
|---|
| m | any | |
| u | number | |
build(g: any, h: any) → void
| arg | type | description |
|---|
| g | any | |
| h | any | |
animate(h: any, t: number, dt: number) → void
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
skull(parent: any, name: string, pos: { number }, s: number, yaw: number, eyes: { number }?, eyeGlow: number?) → void
| arg | type | description |
|---|
| parent | any | |
| name | string | |
| pos | { number } | |
| s | number | |
| yaw | number | |
| eyes | { number }? | |
| eyeGlow | number? | |
build(g: any, h: any) → void
| arg | type | description |
|---|
| g | any | |
| h | any | |
animate(h: any, t: number, dt: number) → void
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
build(root: any, id: string, opts: any?) → any
Build look `id` under `root` (local, temporary child entities). opts: seed (reserved).
Returns the handle animate / celebrate / destroy take.
| arg | type | description |
|---|
| root | any | |
| id | string | |
| opts | any? | |
animate(h: any, t: number, dt: number) → void
Idle motion, and the celebration once started. Call every frame with the same clock as celebrate.
| arg | type | description |
|---|
| h | any | |
| t | number | |
| dt | number | |
celebrate(h: any, t: number) → void
Start the "finished!" celebration at time `t`; animate plays it out.
| arg | type | description |
|---|
| h | any | |
| t | number | |
destroy(h: any) → void
Remove everything build made.