Sounds

object Sounds

Generates Gdx Sound objects from UncivSound ones on demand, only once per key (two UncivSound custom instances with the same filename are considered equal).

Gdx asks Sound usage to respect the Disposable contract, but since we're only caching a handful of them in memory we should be able to get away with keeping them alive for the app lifetime - and we do dispose them when the app is disposed.

Types

GetSoundResult

private data class GetSoundResult(resource: Sound, isFresh: Boolean)

Holds a Gdx Sound and a flag indicating the sound is freshly loaded and not from cache

SupportedExtensions

private enum SupportedExtensions : Enum<Sounds.SupportedExtensions>

Functions

checkCache

private fun checkCache()

Ensure cache is not outdated

clearCache

fun clearCache()

Release cached Sound resources

equals

open operator fun equals(other: Any?): Boolean

get

private fun get(sound: UncivSound): Sounds.GetSoundResult?

Retrieve (if not cached create from resources) a Gdx Sound from an UncivSound

getFolders

private fun getFolders(): Sequence<String>

Build list of folders to look for sounds

hashCode

open fun hashCode(): Int

play

fun play(sound: UncivSound)

Find, cache and play a Sound

toString

open fun toString(): String

Properties

debugMessages

private const val debugMessages: Boolean = false

modListHash

private var modListHash: Int

separator

private val separator: String

soundMap

private val soundMap: HashMap<UncivSound, Sound?>

Sources

jvm source