Package-level declarations

Types

Link copied to clipboard
class MidiJingle : OutgoingGameMessage

Midi jingle packet is used to play a short midi song, typically when the player accomplishes something. The normal song that was playing will be resumed after the jingle finishes playing. In the old days, the lengthInMillis property was used to tell the client how long the jingle lasts, so it knows when to resume the normal midi song. It has long since been removed, however - while the client expects a 24-bit integer for the length, it does not use this value in any way.

Link copied to clipboard
typealias MidiSong = MidiSongV2
Link copied to clipboard
Link copied to clipboard
class MidiSongStop : OutgoingGameMessage

Midi song stop is used to stop playing an existing midi song.

Link copied to clipboard
class MidiSongV1(val id: Int) : OutgoingGameMessage

Midi song V1 packet is used to play a midi song, in the old format. This is equal to playing MidiSongV2 with the arguments of id, 0, 60, 60, 0.

Link copied to clipboard
class MidiSongV2 : OutgoingGameMessage

Midi song packets are used to play songs through the music player.

Link copied to clipboard
class MidiSongWithSecondary : OutgoingGameMessage

Midi song packets are used to play songs through the music player. This packet pre-queues a secondary song which can be hot-swapped at any point. The intended use case here is to swap the song out mid-playing between identical songs that have different tones playing, e.g. a more up-beat vs a more somber song, while letting the song play on from where it was, rather than re-starting the song.

Link copied to clipboard
class MidiSwap : OutgoingGameMessage

Midi swap packet allows one to hot-swap a song mid-playing with a different one that was pre-queued with the MidiSongWithSecondary packet. This hot-swapping only works if the secondary packet was used, as that defines the id of the secondary song to swap to.

Link copied to clipboard
class SynthSound : OutgoingGameMessage

Synth sound is used to play a short sound effect locally for the given player.