Swarm.Game.Log

A data type to represent in-game logs by robots.

Because of the use of system robots, we sometimes want to use special kinds of logs that will be shown to the player.

TODO: #1039 Currently we abuse this system for system logs, which is fun, but we should eventually make a dedicated SystemLogEntry type for RuntimeState message queue.

Documentation

data LogSource

Source of the robot log.

Constructors

Said

Log produced by Say

Logged

Log produced by Log

ErrorTrace ErrorLevel

Log produced by an exception or system.

Instances

FromJSON LogSource

Defined in Swarm.Game.Log

Methods

parseJSON :: Value -> Parser LogSource

parseJSONList :: Value -> Parser [LogSource]

ToJSON LogSource

Defined in Swarm.Game.Log

Methods

toJSON :: LogSource -> Value

toEncoding :: LogSource -> Encoding

toJSONList :: [LogSource] -> Value

toEncodingList :: [LogSource] -> Encoding

Generic LogSource

Defined in Swarm.Game.Log

Associated Types

type Rep LogSource :: Type -> Type

Methods

from :: LogSource -> Rep LogSource x

to :: Rep LogSource x -> LogSource

Show LogSource

Defined in Swarm.Game.Log

Methods

showsPrec :: Int -> LogSource -> ShowS

show :: LogSource -> String

showList :: [LogSource] -> ShowS

Eq LogSource

Defined in Swarm.Game.Log

Methods

(==) :: LogSource -> LogSource -> Bool

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

Ord LogSource

Defined in Swarm.Game.Log

Methods

compare :: LogSource -> LogSource -> Ordering

(<) :: LogSource -> LogSource -> Bool

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

(>) :: LogSource -> LogSource -> Bool

(>=) :: LogSource -> LogSource -> Bool

max :: LogSource -> LogSource -> LogSource

min :: LogSource -> LogSource -> LogSource

type Rep LogSource

Defined in Swarm.Game.Log

type Rep LogSource = D1 ('MetaData "LogSource" "Swarm.Game.Log" "swarm-0.3.0.0-DptGDjHvXlqJcJyQcOsuxZ" 'False) (C1 ('MetaCons "Said" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Logged" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ErrorTrace" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ErrorLevel))))

data ErrorLevel

Severity of the error - critical errors are bugs and should be reported as Issues.

Constructors

Debug

Warning

Error

Critical

Instances

FromJSON ErrorLevel

Defined in Swarm.Game.Log

Methods

parseJSON :: Value -> Parser ErrorLevel

parseJSONList :: Value -> Parser [ErrorLevel]

ToJSON ErrorLevel

Defined in Swarm.Game.Log

Methods

toJSON :: ErrorLevel -> Value

toEncoding :: ErrorLevel -> Encoding

toJSONList :: [ErrorLevel] -> Value

toEncodingList :: [ErrorLevel] -> Encoding

Generic ErrorLevel

Defined in Swarm.Game.Log

Associated Types

type Rep ErrorLevel :: Type -> Type

Methods

from :: ErrorLevel -> Rep ErrorLevel x

to :: Rep ErrorLevel x -> ErrorLevel

Show ErrorLevel

Defined in Swarm.Game.Log

Methods

showsPrec :: Int -> ErrorLevel -> ShowS

show :: ErrorLevel -> String

showList :: [ErrorLevel] -> ShowS

Eq ErrorLevel

Defined in Swarm.Game.Log

Methods

(==) :: ErrorLevel -> ErrorLevel -> Bool

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

Ord ErrorLevel

Defined in Swarm.Game.Log

Methods

compare :: ErrorLevel -> ErrorLevel -> Ordering

(<) :: ErrorLevel -> ErrorLevel -> Bool

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

(>) :: ErrorLevel -> ErrorLevel -> Bool

(>=) :: ErrorLevel -> ErrorLevel -> Bool

max :: ErrorLevel -> ErrorLevel -> ErrorLevel

min :: ErrorLevel -> ErrorLevel -> ErrorLevel

type Rep ErrorLevel

Defined in Swarm.Game.Log

type Rep ErrorLevel = D1 ('MetaData "ErrorLevel" "Swarm.Game.Log" "swarm-0.3.0.0-DptGDjHvXlqJcJyQcOsuxZ" 'False) ((C1 ('MetaCons "Debug" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Warning" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Error" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Critical" 'PrefixI 'False) (U1 :: Type -> Type)))

Robot log entries

data LogEntry

An entry in a robot's log.

Constructors

LogEntry

Fields

• _leTime :: Integer

  The time at which the entry was created. Note that this is the first field we sort on.

• _leSource :: LogSource

  Whether this log records a said message.

• _leRobotName :: Text

  The name of the robot that generated the entry.

• _leRobotID :: Int

  The ID of the robot that generated the entry.

• _leLocation :: Location

  Location of the robot at log entry creation.

• _leText :: Text

  The text of the log entry.

Instances

FromJSON LogEntry

Defined in Swarm.Game.Log

Methods

parseJSON :: Value -> Parser LogEntry

parseJSONList :: Value -> Parser [LogEntry]

ToJSON LogEntry

Defined in Swarm.Game.Log

Methods

toJSON :: LogEntry -> Value

toEncoding :: LogEntry -> Encoding

toJSONList :: [LogEntry] -> Value

toEncodingList :: [LogEntry] -> Encoding

Generic LogEntry

Defined in Swarm.Game.Log

Associated Types

type Rep LogEntry :: Type -> Type

Methods

from :: LogEntry -> Rep LogEntry x

to :: Rep LogEntry x -> LogEntry

Show LogEntry

Defined in Swarm.Game.Log

Methods

showsPrec :: Int -> LogEntry -> ShowS

show :: LogEntry -> String

showList :: [LogEntry] -> ShowS

Eq LogEntry

Defined in Swarm.Game.Log

Methods

(==) :: LogEntry -> LogEntry -> Bool

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

Ord LogEntry

Defined in Swarm.Game.Log

Methods

compare :: LogEntry -> LogEntry -> Ordering

(<) :: LogEntry -> LogEntry -> Bool

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

(>) :: LogEntry -> LogEntry -> Bool

(>=) :: LogEntry -> LogEntry -> Bool

max :: LogEntry -> LogEntry -> LogEntry

min :: LogEntry -> LogEntry -> LogEntry

type Rep LogEntry

Defined in Swarm.Game.Log

type Rep LogEntry = D1 ('MetaData "LogEntry" "Swarm.Game.Log" "swarm-0.3.0.0-DptGDjHvXlqJcJyQcOsuxZ" 'False) (C1 ('MetaCons "LogEntry" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_leTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: (S1 ('MetaSel ('Just "_leSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogSource) :*: S1 ('MetaSel ('Just "_leRobotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "_leRobotID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "_leLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Location) :*: S1 ('MetaSel ('Just "_leText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

leText :: Lens' LogEntry Text

leSource :: Lens' LogEntry LogSource

leRobotName :: Lens' LogEntry Text

leTime :: Lens' LogEntry Integer

leLocation :: Lens' LogEntry Location

leRobotID :: Lens' LogEntry Int