Swarm.Game.State

Definition of the record holding all the game-related state, and various related utility functions.

Game state record and related types

data ViewCenterRule

The ViewCenterRule specifies how to determine the center of the world viewport.

Constructors

VCLocation (V2 Int64)

The view should be centered on an absolute position.

VCRobot RID

The view should be centered on a certain robot.

Instances

FromJSON ViewCenterRule

Defined in Swarm.Game.State

Methods

parseJSON :: Value -> Parser ViewCenterRule

parseJSONList :: Value -> Parser [ViewCenterRule]

ToJSON ViewCenterRule

Defined in Swarm.Game.State

Methods

toJSON :: ViewCenterRule -> Value

toEncoding :: ViewCenterRule -> Encoding

toJSONList :: [ViewCenterRule] -> Value

toEncodingList :: [ViewCenterRule] -> Encoding

Generic ViewCenterRule

Defined in Swarm.Game.State

Associated Types

type Rep ViewCenterRule :: Type -> Type

Methods

from :: ViewCenterRule -> Rep ViewCenterRule x

to :: Rep ViewCenterRule x -> ViewCenterRule

Show ViewCenterRule

Defined in Swarm.Game.State

Methods

showsPrec :: Int -> ViewCenterRule -> ShowS

show :: ViewCenterRule -> String

showList :: [ViewCenterRule] -> ShowS

Eq ViewCenterRule

Defined in Swarm.Game.State

Methods

(==) :: ViewCenterRule -> ViewCenterRule -> Bool

(/=) :: ViewCenterRule -> ViewCenterRule -> Bool

Ord ViewCenterRule

Defined in Swarm.Game.State

Methods

compare :: ViewCenterRule -> ViewCenterRule -> Ordering

(<) :: ViewCenterRule -> ViewCenterRule -> Bool

(<=) :: ViewCenterRule -> ViewCenterRule -> Bool

(>) :: ViewCenterRule -> ViewCenterRule -> Bool

(>=) :: ViewCenterRule -> ViewCenterRule -> Bool

max :: ViewCenterRule -> ViewCenterRule -> ViewCenterRule

min :: ViewCenterRule -> ViewCenterRule -> ViewCenterRule

type Rep ViewCenterRule

Defined in Swarm.Game.State

type Rep ViewCenterRule = D1 ('MetaData "ViewCenterRule" "Swarm.Game.State" "swarm-0.2.0.0-D1mAmWsUEjoFqpCaq9DHG0" 'False) (C1 ('MetaCons "VCLocation" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (V2 Int64))) :+: C1 ('MetaCons "VCRobot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RID)))

data REPLStatus

A data type to represent the current status of the REPL.

Constructors

REPLDone (Maybe (Typed Value))

The REPL is not doing anything actively at the moment. We persist the last value and its type though.

REPLWorking (Typed (Maybe Value))

A command entered at the REPL is currently being run. The Polytype represents the type of the expression that was entered. The Maybe Value starts out as Nothing and gets filled in with a result once the command completes.

Instances

FromJSON REPLStatus

Defined in Swarm.Game.State

Methods

parseJSON :: Value -> Parser REPLStatus

parseJSONList :: Value -> Parser [REPLStatus]

ToJSON REPLStatus

Defined in Swarm.Game.State

Methods

toJSON :: REPLStatus -> Value

toEncoding :: REPLStatus -> Encoding

toJSONList :: [REPLStatus] -> Value

toEncodingList :: [REPLStatus] -> Encoding

Generic REPLStatus

Defined in Swarm.Game.State

Associated Types

type Rep REPLStatus :: Type -> Type

Methods

from :: REPLStatus -> Rep REPLStatus x

to :: Rep REPLStatus x -> REPLStatus

Show REPLStatus

Defined in Swarm.Game.State

Methods

showsPrec :: Int -> REPLStatus -> ShowS

show :: REPLStatus -> String

showList :: [REPLStatus] -> ShowS

Eq REPLStatus

Defined in Swarm.Game.State

Methods

(==) :: REPLStatus -> REPLStatus -> Bool

(/=) :: REPLStatus -> REPLStatus -> Bool

type Rep REPLStatus

Defined in Swarm.Game.State

type Rep REPLStatus = D1 ('MetaData "REPLStatus" "Swarm.Game.State" "swarm-0.2.0.0-D1mAmWsUEjoFqpCaq9DHG0" 'False) (C1 ('MetaCons "REPLDone" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Typed Value)))) :+: C1 ('MetaCons "REPLWorking" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Typed (Maybe Value)))))

data WinCondition

Constructors

NoWinCondition

There is no winning condition.

WinConditions (NonEmpty Objective)

There are one or more objectives remaining that the player has not yet accomplished.

Won Bool

The player has won. The boolean indicates whether they have already been congratulated.

Instances

FromJSON WinCondition

Defined in Swarm.Game.State

Methods

parseJSON :: Value -> Parser WinCondition

parseJSONList :: Value -> Parser [WinCondition]

ToJSON WinCondition

Defined in Swarm.Game.State

Methods

toJSON :: WinCondition -> Value

toEncoding :: WinCondition -> Encoding

toJSONList :: [WinCondition] -> Value

toEncodingList :: [WinCondition] -> Encoding

Generic WinCondition

Defined in Swarm.Game.State

Associated Types

type Rep WinCondition :: Type -> Type

Methods

from :: WinCondition -> Rep WinCondition x

to :: Rep WinCondition x -> WinCondition

Show WinCondition

Defined in Swarm.Game.State

Methods

showsPrec :: Int -> WinCondition -> ShowS

show :: WinCondition -> String

showList :: [WinCondition] -> ShowS

type Rep WinCondition

Defined in Swarm.Game.State

type Rep WinCondition = D1 ('MetaData "WinCondition" "Swarm.Game.State" "swarm-0.2.0.0-D1mAmWsUEjoFqpCaq9DHG0" 'False) (C1 ('MetaCons "NoWinCondition" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "WinConditions" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Objective))) :+: C1 ('MetaCons "Won" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

_NoWinCondition :: Prism' WinCondition ()

_WinConditions :: Prism' WinCondition (NonEmpty Objective)

_Won :: Prism' WinCondition Bool

data RunStatus

A data type to keep track of the pause mode.

Constructors

Running

The game is running.

ManualPause

The user paused the game, and it should stay pause after visiting the help.

AutoPause

The game got paused while visiting the help, and it should unpause after returning back to the game.

Instances

FromJSON RunStatus

Defined in Swarm.Game.State

Methods

parseJSON :: Value -> Parser RunStatus

parseJSONList :: Value -> Parser [RunStatus]

ToJSON RunStatus

Defined in Swarm.Game.State

Methods

toJSON :: RunStatus -> Value

toEncoding :: RunStatus -> Encoding

toJSONList :: [RunStatus] -> Value

toEncodingList :: [RunStatus] -> Encoding

Generic RunStatus

Defined in Swarm.Game.State

Associated Types

type Rep RunStatus :: Type -> Type

Methods

from :: RunStatus -> Rep RunStatus x

to :: Rep RunStatus x -> RunStatus

Show RunStatus

Defined in Swarm.Game.State

Methods

showsPrec :: Int -> RunStatus -> ShowS

show :: RunStatus -> String

showList :: [RunStatus] -> ShowS

Eq RunStatus

Defined in Swarm.Game.State

Methods

(==) :: RunStatus -> RunStatus -> Bool

(/=) :: RunStatus -> RunStatus -> Bool

type Rep RunStatus

Defined in Swarm.Game.State

type Rep RunStatus = D1 ('MetaData "RunStatus" "Swarm.Game.State" "swarm-0.2.0.0-D1mAmWsUEjoFqpCaq9DHG0" 'False) (C1 ('MetaCons "Running" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ManualPause" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AutoPause" 'PrefixI 'False) (U1 :: Type -> Type)))

type Seed = Int

data GameState

The main record holding the state for the game itself (as distinct from the UI). See the lenses below for access to its fields.

GameState fields

creativeMode :: Lens' GameState Bool

Is the user in creative mode (i.e. able to do anything without restriction)?

winCondition :: Lens' GameState WinCondition

How to determine whether the player has won.

winSolution :: Lens' GameState (Maybe ProcessedTerm)

How to win (if possible). This is useful for automated testing and to show help to cheaters (or testers).

runStatus :: Lens' GameState RunStatus

The current RunStatus.

paused :: Getter GameState Bool

Whether the game is currently paused.

robotMap :: Lens' GameState (IntMap Robot)

All the robots that currently exist in the game, indexed by name.

robotsByLocation :: Lens' GameState (Map (V2 Int64) IntSet)

The names of all robots that currently exist in the game, indexed by location (which we need both for e.g. the Salvage command as well as for actually drawing the world). Unfortunately there is no good way to automatically keep this up to date, since we don't just want to completely rebuild it every time the robotMap changes. Instead, we just make sure to update it every time the location of a robot changes, or a robot is created or destroyed. Fortunately, there are relatively few ways for these things to happen.

robotsAtLocation :: V2 Int64 -> GameState -> [Robot]

Get a list of all the robots at a particular location.

robotsInArea :: V2 Int64 -> Int64 -> GameState -> [Robot]

Get robots in manhattan distastance from location.

baseRobot :: Traversal' GameState Robot

The base robot, if it exists.

activeRobots :: Getter GameState IntSet

The names of the robots that are currently not sleeping.

waitingRobots :: Getter GameState (Map Integer [RID])

The names of the robots that are currently sleeping, indexed by wake up time. Note that this may not include all sleeping robots, particularly those that are only taking a short nap (e.g. wait 1).

availableRecipes :: Lens' GameState (Notifications (Recipe Entity))

The list of available recipes.

availableCommands :: Lens' GameState (Notifications Const)

The list of available commands.

messageNotifications :: Getter GameState (Notifications LogEntry)

Get the notification list of messages from the point of view of focused robot.

allDiscoveredEntities :: Lens' GameState Inventory

The list of entities that have been discovered.

gensym :: Lens' GameState Int

A counter used to generate globally unique IDs.

seed :: Lens' GameState Seed

The initial seed that was used for the random number generator, and world generation.

randGen :: Lens' GameState StdGen

Pseudorandom generator initialized at start.

adjList :: Getter GameState (Array Int Text)

Read-only list of words, for use in building random robot names.

nameList :: Getter GameState (Array Int Text)

Read-only list of words, for use in building random robot names.

entityMap :: Lens' GameState EntityMap

The catalog of all entities that the game knows about.

recipesOut :: Lens' GameState (IntMap [Recipe Entity])

All recipes the game knows about, indexed by outputs.

recipesIn :: Lens' GameState (IntMap [Recipe Entity])

All recipes the game knows about, indexed by inputs.

recipesReq :: Lens' GameState (IntMap [Recipe Entity])

All recipes the game knows about, indexed by requirement/catalyst.

scenarios :: Lens' GameState ScenarioCollection

The collection of scenarios that comes with the game.

currentScenarioPath :: Lens' GameState (Maybe FilePath)

The filepath of the currently running scenario.

This is useful as an index to scenarios collection, see scenarioItemByPath.

knownEntities :: Lens' GameState [Text]

The names of entities that should be considered "known", that is, robots know what they are without having to scan them.

world :: Lens' GameState (World Int Entity)

The current state of the world (terrain and entities only; robots are stored in the robotMap). Int is used instead of TerrainType because we need to be able to store terrain values in unboxed tile arrays.

viewCenterRule :: Lens' GameState ViewCenterRule

The current rule for determining the center of the world view. It updates also, viewCenter and focusedRobotName to keep everything synchronize.

viewCenter :: Getter GameState (V2 Int64)

The current center of the world view. Note that this cannot be modified directly, since it is calculated automatically from the viewCenterRule. To modify the view center, either set the viewCenterRule, or use modifyViewCenter.

needsRedraw :: Lens' GameState Bool

Whether the world view needs to be redrawn.

replStatus :: Lens' GameState REPLStatus

The current status of the REPL.

replNextValueIndex :: Lens' GameState Integer

The index of the next it{index} value

replWorking :: Getter GameState Bool

Whether the repl is currently working.

replActiveType :: Getter REPLStatus (Maybe Polytype)

Either the type of the command being executed, or of the last command

messageQueue :: Lens' GameState (Seq LogEntry)

A queue of global messages.

Note that we put the newest entry to the right.

lastSeenMessageTime :: Lens' GameState Integer

Last time message queue has been viewed (used for notification).

focusedRobotID :: Getter GameState RID

The current robot in focus.

It is only a Getter because this value should be updated only when the viewCenterRule is specified to be a robot.

Technically it's the last robot ID specified by viewCenterRule, but that robot may not be alive anymore - to be safe use focusedRobot.

ticks :: Lens' GameState Integer

The number of ticks elapsed since the game started.

robotStepsPerTick :: Lens' GameState Int

The maximum number of CESK machine steps a robot may take during a single tick.

Notifications

data Notifications a

A data type to keep track of discovered recipes and commands

Constructors

Notifications

Fields

• _notificationsCount :: Int
• _notificationsContent :: [a]

Instances

FromJSON a => FromJSON (Notifications a)

Defined in Swarm.Game.State

Methods

parseJSON :: Value -> Parser (Notifications a)

parseJSONList :: Value -> Parser [Notifications a]

ToJSON a => ToJSON (Notifications a)

Defined in Swarm.Game.State

Methods

toJSON :: Notifications a -> Value

toEncoding :: Notifications a -> Encoding

toJSONList :: [Notifications a] -> Value

toEncodingList :: [Notifications a] -> Encoding

Monoid (Notifications a)

Defined in Swarm.Game.State

Methods

mempty :: Notifications a

mappend :: Notifications a -> Notifications a -> Notifications a

mconcat :: [Notifications a] -> Notifications a

Semigroup (Notifications a)

Defined in Swarm.Game.State

Methods

(<>) :: Notifications a -> Notifications a -> Notifications a

sconcat :: NonEmpty (Notifications a) -> Notifications a

stimes :: Integral b => b -> Notifications a -> Notifications a

Generic (Notifications a)

Defined in Swarm.Game.State

Associated Types

type Rep (Notifications a) :: Type -> Type

Methods

from :: Notifications a -> Rep (Notifications a) x

to :: Rep (Notifications a) x -> Notifications a

Show a => Show (Notifications a)

Defined in Swarm.Game.State

Methods

showsPrec :: Int -> Notifications a -> ShowS

show :: Notifications a -> String

showList :: [Notifications a] -> ShowS

Eq a => Eq (Notifications a)

Defined in Swarm.Game.State

Methods

(==) :: Notifications a -> Notifications a -> Bool

(/=) :: Notifications a -> Notifications a -> Bool

type Rep (Notifications a)

Defined in Swarm.Game.State

type Rep (Notifications a) = D1 ('MetaData "Notifications" "Swarm.Game.State" "swarm-0.2.0.0-D1mAmWsUEjoFqpCaq9DHG0" 'False) (C1 ('MetaCons "Notifications" 'PrefixI 'True) (S1 ('MetaSel ('Just "_notificationsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "_notificationsContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [a])))

notificationsCount :: forall a. Lens' (Notifications a) Int

notificationsContent :: forall a a. Lens (Notifications a) (Notifications a) [a] [a]

GameState initialization

initGameState :: ExceptT Text IO GameState

Create an initial game state record, first loading entities and recipies from disk.

scenarioToGameState :: Scenario -> Maybe Seed -> Maybe CodeToRun -> GameState -> IO GameState

Set a given scenario as the currently loaded scenario in the game state.

initGameStateForScenario :: String -> Maybe Seed -> Maybe FilePath -> ExceptT Text IO GameState

Create an initial game state for a specific scenario. Note that this function is used only for unit tests, integration tests, and benchmarks.

In normal play, the code path that gets executed is scenarioToAppState.

classicGame0 :: ExceptT Text IO GameState

For convenience, the GameState corresponding to the classic game with seed 0. This is used only for benchmarks and unit tests.

data CodeToRun

Constructors

SuggestedSolution ProcessedTerm

ScriptPath FilePath

Utilities

applyViewCenterRule :: ViewCenterRule -> IntMap Robot -> Maybe (V2 Int64)

Given a current mapping from robot names to robots, apply a ViewCenterRule to derive the location it refers to. The result is Maybe because the rule may refer to a robot which does not exist.

recalcViewCenter :: GameState -> GameState

Recalculate the veiw center (and cache the result in the viewCenter field) based on the current viewCenterRule. If the viewCenterRule specifies a robot which does not exist, simply leave the current viewCenter as it is. Set needsRedraw if the view center changes.

modifyViewCenter :: (V2 Int64 -> V2 Int64) -> GameState -> GameState

Modify the viewCenter by applying an arbitrary function to the current value. Note that this also modifies the viewCenterRule to match. After calling this function the viewCenterRule will specify a particular location, not a robot.

viewingRegion :: GameState -> (Int64, Int64) -> (Coords, Coords)

Given a width and height, compute the region, centered on the viewCenter, that should currently be in view.

focusedRobot :: GameState -> Maybe Robot

Find out which robot has been last specified by the viewCenterRule, if any.

clearFocusedRobotLogUpdated :: Has (State GameState) sig m => m ()

Clear the robotLogUpdated flag of the focused robot.

addRobot :: Has (State GameState) sig m => Robot -> m ()

Add a robot to the game state, adding it to the main robot map, the active robot set, and to to the index of robots by location.

addTRobot :: Has (State GameState) sig m => TRobot -> m Robot

Add a concrete instance of a robot template to the game state: first, generate a unique ID number for it. Then, add it to the main robot map, the active robot set, and to to the index of robots by location. Return the updated robot.

emitMessage :: Has (State GameState) sig m => LogEntry -> m ()

Add a message to the message queue.

sleepUntil :: Has (State GameState) sig m => RID -> Integer -> m ()

Takes a robot out of the activeRobots set and puts it in the waitingRobots queue.

sleepForever :: Has (State GameState) sig m => RID -> m ()

Takes a robot out of the activeRobots set.

wakeUpRobotsDoneSleeping :: Has (State GameState) sig m => m ()

Removes robots whose wake up time matches the current game ticks count from the waitingRobots queue and put them back in the activeRobots set if they still exist in the keys of robotMap.

deleteRobot :: Has (State GameState) sig m => RID -> m ()

activateRobot :: Has (State GameState) sig m => RID -> m ()

Adds a robot to the activeRobots set.

toggleRunStatus :: RunStatus -> RunStatus

Switch (auto or manually) paused game to running and running to manually paused.

Note that this function is not safe to use in the app directly, because the UI also tracks time between ticks - use safeTogglePause instead.

messageIsRecent :: GameState -> LogEntry -> Bool

messageIsFromNearby :: V2 Int64 -> LogEntry -> Bool