pieces
The six piece kinds a platformer course is made of, built from courseKit.parts: climbs (`steps`, `switchback`, plus `stairs`), ledges (`ledge` beam walks, `wallLedges`), bridges, slides (`slide`: a walled chute or open slope with courseKit.Slide), gaps (`gaps`: landing pads or pi…
courseKit.pieces
The six piece kinds a platformer course is made of, built from courseKit.parts: climbs (steps, switchback, plus stairs), ledges (ledge beam walks, wallLedges), bridges, slides (slide: a walled chute or open slope with courseKit.Slide), gaps (gaps: landing pads or pillars spaced so no gap exceeds 1.8 m by default and 2.2 m at most, padsFor), arenas (arena: round or square, rim, gates, posts) and place, which builds any kind and variant at a standard size from a start point and heading and answers { exit, yaw, tops } so pieces chain. KINDS, KIND_ORDER and JUMP (the jump limits) describe them. Re-exported by courseKit.api.
Interface
What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.
conforms to
zero/source-extract/v2strict courseKit.pieces: the six piece kinds a 3D platformer course is made of, each with its variants, built from courseKit.parts in the course look: climbs (stairs, floating steps, switchback stairs), ledges (narrow beam ledges, ledges sticking out of a wall), bridges (plank, rope, stone arch), slides (walled chutes and open slopes the player slides down, courseKit.Slide), gaps (jump-gap sets whose pads keep every gap safe for a running jump) and arenas (round or square pads with a rim and gates). `place` builds any kind at a start point and heading and answers where it ends, so pieces chain into a course.
steps(name: string, a: { number }, b: { number }, opts: any?) → void
Floating steps from `a` to `b` (top surfaces of the first and last step): `count` blocks (default: one per 1.6 m), `size` across (1.4), each a short pillar in the course look. Returns the root and the list of step tops.
| arg | type | description |
|---|---|---|
| name | string | |
| a | { number } | |
| b | { number } | |
| opts | any? |
switchback(name: string, foot: { number }, yaw: number, opts: any?) → void
Switchback stairs climbing from `foot` heading `yaw`: `flights` flights (3) of stairs, each rising `rise` (1.8 m) over `run` (4 m), joined by landings (`landing` m deep, 2.6) that turn the climb back the other way. opts: width (2.4), turn ("right" or "left"), look. Returns the root and the top landing's far-edge point (where the climb exits, heading `yaw` or back against it).
| arg | type | description |
|---|---|---|
| name | string | |
| foot | { number } | |
| yaw | number | |
| opts | any? |
rel(pt: { number }) → void
| arg | type | description |
|---|---|---|
| pt | { number } |
ledge(name: string, a: { number }, b: { number }, w: number?, opts: any?) → any
A narrow ledge (a beam walk) from `a` to `b`, `w` wide (default 0.8 m, no rims). opts: look, depth.
| arg | type | description |
|---|---|---|
| name | string | |
| a | { number } | |
| b | { number } | |
| w | number? | |
| opts | any? |
wallLedges(name: string, p: { number }, yaw: number, opts: any?) → void
Wall ledges: a wall running from `p` along `yaw` for `len` metres (default 10), `height` tall (4 m above p), with `count` ledges (5) sticking out of its right face, each `rise` (0.5 m) higher than the last and `size` (1.5 m) wide, so the player hops along the wall. Returns the root and the list of ledge tops.
| arg | type | description |
|---|---|---|
| name | string | |
| p | { number } | |
| yaw | number | |
| opts | any? |
slide(name: string, top: { number }, bottom: { number }, w: number, opts: any?) → any
A slide from `top` down to `bottom` (points on its surface), `w` wide: a sloped chute the player slides down, gathering speed (courseKit.Slide pushes this machine's own player along it through platformsKit's rider). opts: walls (true: a walled chute; false: an open slope with low rims), wallHeight (1.1), speed (top speed, 11 m/s), accel (14 m/s^2), look, top, rim, post.
| arg | type | description |
|---|---|---|
| name | string | |
| top | { number } | |
| bottom | { number } | |
| w | number | |
| opts | any? |
padsFor(span: number, pad: number, gap: number) → number
How many pads a gap set from `a` to `b` needs so no gap is wider than `gap` (pads `pad` across).
| arg | type | description |
|---|---|---|
| span | number | |
| pad | number | |
| gap | number |
gaps(name: string, a: { number }, b: { number }, opts: any?) → void
A jump-gap set from takeoff edge `a` to landing edge `b`: landing pads in between so that no gap is wider than `gap` (default 1.8 m, at most 2.2: a running jump carries ~2.5 m) and no pad is more than 0.9 m higher than the one before. opts: gap, pad (2.2 m across), round (cylinder pads), shaft (how far the pads reach down, 3 m), look. Returns the root, the pad tops and the gap width used.
| arg | type | description |
|---|---|---|
| name | string | |
| a | { number } | |
| b | { number } | |
| opts | any? |
arena(name: string, p: { number }, opts: any?) → any
An arena: a round or square pad for a fight or a challenge, its floor top at `p`, `size` across (16 m), with a rim (`rim` m high, 0.7; walkable on top) broken by gates at the yaws in `gates` (degrees, default { 0, 180 }), posts round the edge and a pier under it. opts: shape ("round" or "square"), size, rim, gates, gateWidth (3), depth, look, yaw.
| arg | type | description |
|---|---|---|
| name | string | |
| p | { number } | |
| opts | any? |
inGate(deg: number, halfDeg: number) → boolean
| arg | type | description |
|---|---|---|
| deg | number | |
| halfDeg | number |
deckName(o: any) → string
| arg | type | description |
|---|---|---|
| o | any |
lintelMats(look: any) → void
The lintel and its trim strip for a deck look: timber for board rims, masonry for stone rims, frosting for candy, steel with a glow strip for sci-fi.
| arg | type | description |
|---|---|---|
| look | any |
hangLantern(parent: any, tag: string, hook: { number }, drop: number, rec: any, s: number, light: boolean) → void
A lantern hanging from a hook at local `hook` under `parent`, `drop` metres of chain, in a lantern look record; `light` adds a point light.
| arg | type | description |
|---|---|---|
| parent | any | |
| tag | string | |
| hook | { number } | |
| drop | number | |
| rec | any | |
| s | number | |
| light | boolean |
gatePost(root: any, tag: string, look: any, x: number, h: number, ps: number) → void
A gate post in the look: candy canes are striped, sci-fi struts carry glow bands, stone looks get a plinth and capital, wood looks a timber post on a stone footing.
| arg | type | description |
|---|---|---|
| root | any | |
| tag | string | |
| look | any | |
| x | number | |
| h | number | |
| ps | number |
spiral(name: string, at: { number }, yaw: number, opts: any?) → void
A spiral climb winding round a central column from `at` (a point on the walking surface) heading `yaw`: the column stands to the right (or left, `turn = "left"`) and the climb turns `turns` times (1) round it, rising `rise` metres a turn, so with whole turns it ends straight above where it started, heading `yaw` again. opts.style: "stair" (solid steps cantilevered from a pillar, 0.25 m each so they walk), "ledges" (separate ledges a short hop apart, 8 a turn) or "tree" (plank steps round a great trunk under a leafy crown). opts: radius, width, rise, turns, turn, depth (how far the column reaches down), look. Returns the root, the exit point, the heading out and step tops for coins.
| arg | type | description |
|---|---|---|
| name | string | |
| at | { number } | |
| yaw | number | |
| opts | any? |
lp(phi: number, rad: number, y: number) → void
| arg | type | description |
|---|---|---|
| phi | number | |
| rad | number | |
| y | number |
wp(phi: number, y: number) → void
| arg | type | description |
|---|---|---|
| phi | number | |
| y | number |
gate(name: string, p: { number }, yaw: number, opts: any?) → any
A lantern gate: a checkpoint archway on its own deck, its floor top at `p`, facing `yaw` (walk through along yaw). Two posts and a lintel in the course look with lanterns hanging from it in the theme's lantern style. opts.style: "arch" (one lintel, two lanterns), "grand" (wider and taller, a tie beam and a top lintel, three lanterns and a plaque) or "festoon" (a string of small lanterns sagging between the posts). opts: width (clear opening, 3.2; grand 4.4), height (3.6; grand 4.4), length (deck, 4), depth, look, lantern (a lantern style), checkpoint (true: a Trapline.Checkpoint just past the gate; false: none), checkpointLook, order, label. Returns the root.
| arg | type | description |
|---|---|---|
| name | string | |
| p | { number } | |
| yaw | number | |
| opts | any? |
crumbleStair(name: string, a: { number }, yaw: number, opts: any?) → void
Crumbling steps from `a` heading `yaw`: platformsKit crumble platforms (they shake when you land, break `wait` seconds later and come back after `respawn`) in the theme's platform look, held in a frame of the course look. opts.style: "stairs" (a rising flight, `count` 6 steps, `rise` 0.4 m each), "run" (a level row of tiles over a gap) or "zigzag" (steps alternating left and right as they rise). opts: count, rise, width, wait (0.9, enough to hop on to the next step), respawn (2.5), platformLook, look. Returns the root, the exit point and the step tops.
| arg | type | description |
|---|---|---|
| name | string | |
| a | { number } | |
| yaw | number | |
| opts | any? |
windGap(name: string, a: { number }, yaw: number, opts: any?) → void
A wind gap from takeoff edge `a` heading `yaw`, too wide to jump, that the wind carries you across. opts.style: "updraft" (one platformsKit fan in a well below the gap lifts you to a landing `rise` (2) metres higher), "fans" (two fans, hop from one air column to the next) or "crosswind" (a courseKit.Wind tunnel: fans on the takeoff edge blow along the gap and hold you up while you glide `length` (9) metres across). opts: rise, length, speed (crosswind, 7 m/s), lift (crosswind gravity share, 0.3), width, look, platformLook. Returns the root, the landing edge (exit) and points to put coins on.
| arg | type | description |
|---|---|---|
| name | string | |
| a | { number } | |
| yaw | number | |
| opts | any? |
fan(tag: string, s: number, lift: number, size: number) → void
| arg | type | description |
|---|---|---|
| tag | string | |
| s | number | |
| lift | number | |
| size | number |
place(kind: string, variant: string?, name: string, at: { number }, yaw: number, opts: any?) → void
Build one piece of `kind` ("climb", "ledge", "bridge", "slide", "gap", "arena") and `variant` (see X.KINDS) starting at `at` (a point on the walking surface) heading `yaw`, at a standard size (opts override: length, rise, width, ...). Answers the root and { exit = the point where the piece ends (start the next piece there), yaw = the heading out, tops = points to put coins on }.
| arg | type | description |
|---|---|---|
| kind | string | |
| variant | string? | |
| name | string | |
| at | { number } | |
| yaw | number | |
| opts | any? |
net(e: any, out: any) → void
opts.net: a Trapline safety net sized under just this piece (true, or killUnder opts)
| arg | type | description |
|---|---|---|
| e | any | |
| out | any |
Sub-parts
Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.
Showing up to 3 levels deep. Open a part to see what it holds further down.
Problems
Everything affecting this asset right now: its own problems, anything wrong inside it, and problems on its direct dependencies.
agent_score is exposed.+ quality × 0.35
+ performance × 0.25
± compat factor
Usability ratings
Did the part work as advertised when consumers tried to drop it in. Separate from upvotes: those are taste; this is "did it function".
Scoped to this part · feeds back into the world's score.