Swarm.Game.State

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

Game state record

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.

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 TSyntax)

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

Launch parameters

type LaunchParams a = ParameterizableLaunchParams CodeToRun a

type ValidatedLaunchParams = LaunchParams Identity

In this stage in the UI pipeline, both fields have already been validated, and Nothing means that the field is simply absent.

Subrecord accessors

temporal :: Lens' GameState TemporalState

Aspects of the temporal state of the game

robotNaming :: Lens' Robots RobotNaming

State and data for assigning identifiers to robots

recipesInfo :: Lens' GameState Recipes

Collection of recipe info

messageInfo :: Lens' GameState Messages

Message info

gameControls :: Lens' GameState GameControls

Controls, including REPL and key mapping

randomness :: Lens' GameState Randomness

Inputs for randomness

discovery :: Lens' GameState Discovery

Discovery state of entities, commands, recipes

landscape :: Lens' GameState Landscape

Info about the lay of the land

robotInfo :: Lens' GameState Robots

Info about robots

pathCaching :: Lens' GameState PathCaching

Registry for caching output of the path command

GameState initialization

initGameState :: GameStateConfig -> GameState

Create an initial, fresh game state record when starting a new scenario.

data CodeToRun

Constructors

CodeToRun SolutionSource TSyntax

newtype Sha1

Constructors

Sha1 String

Instances

ToJSON Sha1

Defined in Swarm.Game.State

Methods

toJSON :: Sha1 -> Value

toEncoding :: Sha1 -> Encoding

toJSONList :: [Sha1] -> Value

toEncodingList :: [Sha1] -> Encoding

omitField :: Sha1 -> Bool

Generic Sha1

Defined in Swarm.Game.State

Associated Types

type Rep Sha1 :: Type -> Type

Methods

from :: Sha1 -> Rep Sha1 x

to :: Rep Sha1 x -> Sha1

Show Sha1

Defined in Swarm.Game.State

Methods

showsPrec :: Int -> Sha1 -> ShowS

show :: Sha1 -> String

showList :: [Sha1] -> ShowS

Eq Sha1

Defined in Swarm.Game.State

Methods

(==) :: Sha1 -> Sha1 -> Bool

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

Ord Sha1

Defined in Swarm.Game.State

Methods

compare :: Sha1 -> Sha1 -> Ordering

(<) :: Sha1 -> Sha1 -> Bool

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

(>) :: Sha1 -> Sha1 -> Bool

(>=) :: Sha1 -> Sha1 -> Bool

max :: Sha1 -> Sha1 -> Sha1

min :: Sha1 -> Sha1 -> Sha1

type Rep Sha1

Defined in Swarm.Game.State

type Rep Sha1 = D1 ('MetaData "Sha1" "Swarm.Game.State" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-engine" 'True) (C1 ('MetaCons "Sha1" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

data SolutionSource

Constructors

ScenarioSuggested

PlayerAuthored FilePath Sha1

Includes the SHA1 of the program text for the purpose of corroborating solutions on a leaderboard.

parseCodeFile :: (Has (Throw SystemFailure) sig m, Has (Lift IO) sig m) => FilePath -> m CodeToRun

Utilities

robotsAtLocation :: Cosmic Location -> GameState -> [Robot]

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

robotsInArea :: Cosmic Location -> Int32 -> Robots -> [Robot]

Get all the robots within a given Manhattan distance from a location.

baseRobot :: Traversal' GameState Robot

The base robot, if it exists.

baseEnv :: Traversal' GameState Env

The base robot environment.

baseStore :: Getter GameState Store

The base robot store, or the empty store if there is no base robot.

messageNotifications :: Getter GameState (Notifications LogEntry)

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

currentScenarioPath :: Lens' GameState (Maybe FilePath)

The filepath of the currently running scenario.

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

needsRedraw :: Lens' GameState Bool

Whether the world view needs to be redrawn.

replWorking :: Getter GameControls Bool

Whether the repl is currently working.

recalcViewCenterAndRedraw :: GameState -> GameState

Recalculate the view 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.

viewingRegion :: Cosmic Location -> (Int32, Int32) -> Cosmic BoundsRectangle

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.

data RobotRange

Type for describing how far away a robot is from the base, which determines what kind of communication can take place.

Constructors

Close

Close; communication is perfect.

MidRange Double

Mid-range; communication is possible but lossy.

Far

Far; communication is not possible.

Instances

Eq RobotRange

Defined in Swarm.Game.State

Methods

(==) :: RobotRange -> RobotRange -> Bool

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

Ord RobotRange

Defined in Swarm.Game.State

Methods

compare :: RobotRange -> RobotRange -> Ordering

(<) :: RobotRange -> RobotRange -> Bool

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

(>) :: RobotRange -> RobotRange -> Bool

(>=) :: RobotRange -> RobotRange -> Bool

max :: RobotRange -> RobotRange -> RobotRange

min :: RobotRange -> RobotRange -> RobotRange

focusedRange :: GameState -> Maybe RobotRange

Check how far away the focused robot is from the base. Nothing is returned if there is no focused robot; otherwise, return a RobotRange value as follows.

• If we are in creative or scroll-enabled mode, the focused robot is always considered Close.

• Otherwise, there is a "minimum radius" and "maximum radius".

  • If the robot is within the minimum radius, it is Close.
  • If the robot is between the minimum and maximum radii, it is MidRange, with a Double value ranging linearly from 0 to 1 proportional to the distance from the minimum to maximum radius. For example, MidRange 0.5 would indicate a robot exactly halfway between the minimum and maximum radii.
  • If the robot is beyond the maximum radius, it is Far.
• By default, the minimum radius is 16, and maximum is 64.

• Device augmentations

  • If the focused robot has an antenna installed, it doubles both radii.
  • If the base has an antenna installed, it also doubles both radii.

getRadioRange :: Maybe Robot -> Maybe Robot -> (Double, Double)

Get the min/max communication radii given possible augmentations on each end

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

Clear the robotLogUpdated flag of the focused robot.

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

Add a message to the message queue.

messageIsRecent :: GameState -> LogEntry -> Bool

messageIsFromNearby :: Cosmic Location -> LogEntry -> Bool

Reconciles the possibilities of log messages being omnipresent and robots being in different worlds

getRunCodePath :: CodeToRun -> Maybe FilePath

buildWorldTuples :: ScenarioLandscape -> NonEmpty SubworldDescription

genMultiWorld :: NonEmpty SubworldDescription -> Seed -> MultiWorld Int Entity

genRobotTemplates :: ScenarioLandscape -> NonEmpty (a, ([(Int, TRobot)], b)) -> [TRobot]

Returns a list of robots, ordered by decreasing preference to serve as the "base".

Rules for selecting the "base" robot:

What follows is a thorough description of how the base choice is made as of the most recent study of the code. This level of detail is not meant to be public-facing.

For an abbreviated explanation, see the "Base robot" section of the Scenario Authoring Guide.

Precedence rules

1. Prefer those robots defined with a loc (robotLocation) in the scenario file

   1. If multiple robots define a loc, use the robot that is defined first within the scenario file.
   2. Note that if a robot is both given a loc AND is specified in the world map, then two instances of the robot shall be created. The instance with the loc shall be preferred as the base.

2. Fall back to robots generated from templates via the map and palette.

   1. If multiple robots are specified in the map, prefer the one that is defined first within the scenario file.
   2. If multiple robots are instantiated from the same template, then prefer the one with a lower-indexed subworld. Note that the root subworld is always first.
   3. If multiple robots instantiated from the same template are in the same subworld, then prefer the one closest to the upper-left of the screen, with higher rows given precedence over columns (i.e. first in row-major order).

entityAt :: Has (State GameState) sig m => Cosmic Location -> m (Maybe Entity)

Get the entity (if any) at a given location.

contentAt :: Has (State GameState) sig m => Cosmic Location -> m (TerrainType, Maybe Entity)

zoomWorld :: Has (State GameState) sig m => SubworldName -> StateC (World Int Entity) Identity b -> m (Maybe b)

Perform an action requiring a World state component in a larger context with a GameState.

zoomRobots :: Has (State GameState) sig m => StateC Robots Identity b -> m b

Perform an action requiring a Robots state component in a larger context with a GameState.