Module necro.audio.Sound

Functions

getActiveSoundsForTurn (turnID)
getDeduplicationID ()
getFilter ()
getSoundVolume ()
isAsyncLoadingEnabled ()
isPlaying (soundRefID)
play (soundGroupOrFile, x, y, soundData)
playFile (soundFile, x, y, soundData)
playFromEntity (soundGroup, entity, soundData)
playUI (soundGroup, soundData)
resetGameSounds ()
scaleVolume (value)
setAsyncLoadingEnabled (async)
setDeduplicationID (id) Each sound group can be played at most once per turn per deduplication ID
setFilter (filter)
setPosition (soundRefID, x, y)
setSoundVolume (vol)
setVolume (soundRefID, volume)
startRollback ()
startSuppression (suppressionType)
stop (soundRefID)
stopLoopingSounds ()
stopRollback ()
stopSuppression (suppressionType)

Tables

Suppression


Functions

getActiveSoundsForTurn (turnID)

Parameters:

  • turnID
getDeduplicationID ()
getFilter ()
getSoundVolume ()
isAsyncLoadingEnabled ()
isPlaying (soundRefID)

Parameters:

  • soundRefID
play (soundGroupOrFile, x, y, soundData)

Parameters:

  • soundGroupOrFile
  • x
  • y
  • soundData
playFile (soundFile, x, y, soundData)

Parameters:

  • soundFile
  • x
  • y
  • soundData
playFromEntity (soundGroup, entity, soundData)

Parameters:

  • soundGroup
  • entity
  • soundData
playUI (soundGroup, soundData)

Parameters:

  • soundGroup
  • soundData
resetGameSounds ()
scaleVolume (value)

Parameters:

  • value
setAsyncLoadingEnabled (async)

Parameters:

  • async
setDeduplicationID (id)
Each sound group can be played at most once per turn per deduplication ID

Parameters:

  • id
setFilter (filter)

Parameters:

  • filter
setPosition (soundRefID, x, y)

Parameters:

  • soundRefID
  • x
  • y
setSoundVolume (vol)

Parameters:

  • vol
setVolume (soundRefID, volume)

Parameters:

  • soundRefID
  • volume
startRollback ()
startSuppression (suppressionType)

Parameters:

  • suppressionType
stop (soundRefID)

Parameters:

  • soundRefID
stopLoopingSounds ()
stopRollback ()
stopSuppression (suppressionType)

Parameters:

  • suppressionType

Tables

Suppression

Fields:

  • DEFAULT 1
  • SEEK 2
  • INSTANT_REPLAY 4
  • GAME_STATE_RESET 8
generated by LDoc 1.4.6