sounds
The campaign's sound for the local player. Music per screen and per level through soundstage with `shared = false`, so two friends on different levels hear their own piece (`config.sounds.music = { title, select, finale, credits, levels = { [id] = clip } }`). Nine campaign sounds…
sounds
The campaign's sound for the local player. Music per screen and per level through soundstage with shared = false, so two friends on different levels hear their own piece (config.sounds.music = { title, select, finale, credits, levels = { [id] = clip } }). Nine campaign sounds (jump, land, checkpoint, death, select, unlock, medal, clear, start) in four sets swapped by one setting, sounds.set: storybook, cartoon, retro (chipSfx 8-bit) and scifi, or none. extra adds the game's own stingers, volume sets loudness per sound, and jump / land are read from the local body's CharacterController each frame.
Interface
What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.
conforms to
zero/source-extract/v2nonstrict
jump( ) → void
land( ) → void
checkpoint( ) → void
death( ) → void
select( ) → void
unlock( ) → void
medal( ) → void
clear( ) → void
start( ) → void
jump( ) → void
land( ) → void
checkpoint( ) → void
death( ) → void
select( ) → void
unlock( ) → void
medal( ) → void
clear( ) → void
start( ) → void
jump( ) → void
land( ) → void
checkpoint( ) → void
death( ) → void
select( ) → void
unlock( ) → void
medal( ) → void
clear( ) → void
start( ) → void
jump( ) → void
land( ) → void
checkpoint( ) → void
death( ) → void
select( ) → void
unlock( ) → void
medal( ) → void
clear( ) → void
start( ) → void
bankName(set: string, name: string) → string return
| arg | type | description |
|---|---|---|
| set | string | |
| name | string |
resolveClip(c: any) → any
| arg | type | description |
|---|---|---|
| c | any |
defineSet(set: string) → void
| arg | type | description |
|---|---|---|
| set | string |
configure(opts: any?) → void
Configure sound: `{ set = "storybook"|"cartoon"|"retro"|"scifi"|"none", extra = { name = clip }, volume = { name = 0..1 }, feedback = true }`. `extra` overrides a set's sound or adds one of the game's own.
| arg | type | description |
|---|---|---|
| opts | any? |
setSet(set: string) → void
Switch the sound set on this machine.
| arg | type | description |
|---|---|---|
| set | string |
set( ) → string return S
The sound set in use.
sting(name: string, opts: any?) → void
Play a campaign sound for the local player: a set sound (jump, land, checkpoint, death, select, unlock, medal, clear, start) or one of the game's `extra` sounds. opts go to soundstage (volume, jitter...).
| arg | type | description |
|---|---|---|
| name | string | |
| opts | any? |
music(spec: any?) → void
Give the campaign its music: `{ title = clip, select = clip, finale = clip, credits = clip, levels = { [levelId] = clip } }` (clips are soundClip assets or ids). Music is local to each player.
| arg | type | description |
|---|---|---|
| spec | any? |
add(piece: string, c: any) → void
| arg | type | description |
|---|---|---|
| piece | string | |
| c | any |
want(piece: string) → void
The piece to play now: "title", "select", "finale", "credits" or "level:<id>" (falls back to "title" when it has none).
| arg | type | description |
|---|---|---|
| piece | string |
wanted( ) → string
The piece wanted now.
tickMusic(force: boolean?) → void
Keep the wanted piece playing (cheap; the director calls it every frame).
| arg | type | description |
|---|---|---|
| force | boolean? |
duck(amount: number?) → any
Duck the music under a moment; returns a handle for Sounds.release.
| arg | type | description |
|---|---|---|
| amount | number? |
release(h: any) → void
| arg | type | description |
|---|---|---|
| h | any |
tickMoves(body: any) → void
Jump and land sounds for the local player's body (read from its CharacterController). Call every frame with the body entity.
| arg | type | description |
|---|---|---|
| body | 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.