Module AudioFuncs

Sound and music functions

Sound effect functions

Audio.playSound (soundID) Play sound by ID of registered sound effects in the config pack
Audio.playSoundByRole (role) Play sound by embedded role of game engine

Enums

SoundRoles Built-in sound roles of game engine enumeration


Sound effect functions

Audio.playSound (soundID)
Play sound by ID of registered sound effects in the config pack

Parameters:

  • soundID ulong ID of sound registered in the config pack
Audio.playSoundByRole (role)
Play sound by embedded role of game engine

Parameters:

Enums

SoundRoles
Built-in sound roles of game engine enumeration

Constants:

  • Greeting Starts on initial game loading
  • MenuDo Menu action sound
  • MenuScroll Menu scrolling sound
  • MenuMessageBox Message box pop-up sound
  • MenuPause Pause menu show and hide sound
  • CameraSwitch Camera mode switch sound
  • PlayerJump Player jump sound
  • PlayerStomp Player's stomp sound
  • PlayerKick Player's kick sound
  • PlayerShrink Player's shrink sound
  • PlayerHarm Player's harm sound
  • PlayerGrow Player's growl sound
  • PlayerDied Player's death sound
  • PlayerDropItem Player's item drop sound
  • PlayerTakeItem Player's item taking sound
  • PlayerSlide Player's sliding sound
  • PlayerGrab1 Player's grab sound 1
  • PlayerGrab2 Player's grab sound 2
  • PlayerSpring Spring sound
  • PlayerClimb Player's climbing sound
  • PlayerTail Player's whip sound
  • PlayerMagic Player's magic spell sound
  • PlayerWaterSwim Player's swimming sound
  • BonusCoin Coin taking sound
  • Bonus1up Got a new live/attempt sound
  • WeaponHammer Hammer attack sound
  • WeaponFire Fire shoot sound
  • WeaponCannon Cannon shoot sound
  • WeaponExplosion Explosion sound
  • WeaponBigFire Big fire shoot sound
  • NpcLavaBurn Lava birning sound
  • NpcStoneFall Stone fall sound
  • NpcHit NPC's standard hit sound
  • NpcDeath NPC's standard death sound
  • WarpPipe Pipe enter/exit sound
  • WarpDoor Door enter/exit sound
  • WarpTeleport Teleport sound
  • LevelFailed Failed level passing (all playable characters are dead)
  • PlayersDead Alias to LevelFailed
  • LevelCheckPoint Checkpoint save sound
  • WorldMove Moving on world map sound
  • WorldDeny Denied move sound
  • WorldOpenPath Opened path cell sound
  • WorldEnterLevel Level entering sound
  • LevelExit01 Level exit of code 1 sound
  • LevelExit02 Level exit of code 2 sound
  • LevelExit03 Level exit of code 3 sound
  • LevelExit04 Level exit of code 4 sound
  • LevelExit05 Level exit of code 5 sound
  • LevelExit06 Level exit of code 6 sound
  • LevelExit07 Level exit of code 7 sound
  • LevelExit08 Level exit of code 8 sound
  • LevelExit09 Level exit of code 9 sound
  • LevelExit10 Level exit of code 10 sound
  • GameCompleted Game completion theme sound
  • BlockHit Block hit/beat sound
  • BlockOpen Open contents of block
  • BlockSmashed Smashed/broken block sound
  • BlockSwitch Switch toggle sound
generated by LDoc 1.4.6 Last updated 2017-08-21 02:20:32