Jazz2/Scripting/Legacy/Sound.h file

Namespaces

namespace Jazz2
Root namespace of Jazz² Resurrection.
namespace Jazz2::Scripting
Scripting-related classes, compiled only if WITH_ANGELSCRIPT.

Functions

void playSample(float xPixel, float yPixel, std::int32_t sample, std::int32_t volume, std::int32_t frequency)
Plays a sound sample at a position in the level.
auto playLoopedSample(float xPixel, float yPixel, std::int32_t sample, std::int32_t channel, std::int32_t volume, std::int32_t frequency) -> std::int32_t
Plays a looping sound sample at a position in the level and returns its channel.
void playPrioritySample(std::int32_t sample)
Plays a sound sample at full volume regardless of where the players are.
auto isSampleLoaded(std::int32_t sample) -> bool
Returns whether a sound sample is available to play.
auto loadSample(std::int32_t sample, const String& filename) -> bool
Loads a sound sample from a file and returns whether it succeeded.
void jjSetModPosition(std::int32_t order, std::int32_t row, bool reset) partially supported
Jumps to a row of a position in the order list of the playing module music.
void jjSlideModChannelVolume(std::int32_t channel, float volume, std::int32_t milliseconds) partially supported
Gradually changes the volume of a channel of the playing module music.
auto jjGetModOrder() -> std::int32_t
Returns the current position in the order list of the playing module music.
auto jjGetModRow() -> std::int32_t
Returns the current row of the playing module music.
auto jjGetModTempo() -> std::int32_t
Returns the tempo of the playing module music, in beats per minute.
void jjSetModTempo(std::uint8_t tempo) partially supported
Sets the tempo of the playing module music, until the module sets another one.
auto jjGetModSpeed() -> std::int32_t
Returns the speed (ticks per row) of the playing module music.
void jjSetModSpeed(std::uint8_t speed) partially supported
Sets the speed (ticks per row) of the playing module music, until the module sets another one.