Playback

Playback

S3maphore invokes validity callbacks as isValidCallback(playback). Playlist files receive the same context as the injected Playback binding from the PlaylistEnvironment, so they normally declare function() and close over Playback. Programmatically registered playlists can use the callback argument directly. The context contains the current state and built-in rule functions; do not assume a particular callback cadence. See PlaylistState for every state field and PlaylistRules for the complete rule inventory.

Example

isValidCallback = function()
    return Playback.state.cellIsExterior
        and not Playback.state.isInCombat
        and Playback.rules.timeOfDay(6, 18)
end

state includes values such as cellName, cellIsExterior, isInCombat, weather, nearestRegion, and currentGrid. See PlaylistState for the complete field list and PlaylistEnvironment for every binding available to playlist files.