Swarm.Game.State.Runtime

Runtime state and utility functions

Documentation

data RuntimeState

Lenses

webPort :: Lens' RuntimeState (Maybe Port)

The port on which the HTTP debug service is running.

upstreamRelease :: Lens' RuntimeState (Either NewReleaseFailure String)

The upstream release version.

eventLog :: Lens' RuntimeState (Notifications LogEntry)

A log of runtime events.

This logging is separate from the logging done during game-play. If some error happens before a game is even selected, this is the place to log it.

scenarios :: Lens' RuntimeState ScenarioCollection

The collection of scenarios that comes with the game.

appData :: Lens' RuntimeState (Map Text Text)

Free-form data loaded from the data directory, for things like the logo, about page, tutorial story, etc.

stdGameConfigInputs :: Lens' RuntimeState GameStateConfig

Built-in resources for loading games

Utility

initScenarioInputs :: (Has (Throw SystemFailure) sig m, Has (Accum (Seq SystemFailure)) sig m, Has (Lift IO) sig m) => m ScenarioInputs

initRuntimeState :: (Has (Throw SystemFailure) sig m, Has (Accum (Seq SystemFailure)) sig m, Has (Lift IO) sig m) => m RuntimeState

initGameStateConfig :: (Has (Throw SystemFailure) sig m, Has (Accum (Seq SystemFailure)) sig m, Has (Lift IO) sig m) => m GameStateConfig