Swarm.Game.Display

Utilities for describing how to display in-game entities in the TUI.

The display record

type Priority = Int

Display priority. Entities with higher priority will be drawn on top of entities with lower priority.

data Display

A record explaining how to display an entity in the TUI.

Instances

FromJSON Display

Defined in Swarm.Game.Display

Methods

parseJSON :: Value -> Parser Display

parseJSONList :: Value -> Parser [Display]

ToJSON Display

Defined in Swarm.Game.Display

Methods

toJSON :: Display -> Value

toEncoding :: Display -> Encoding

toJSONList :: [Display] -> Value

toEncodingList :: [Display] -> Encoding

Monoid Display

Defined in Swarm.Game.Display

Methods

mempty :: Display

mappend :: Display -> Display -> Display

mconcat :: [Display] -> Display

Semigroup Display

Defined in Swarm.Game.Display

Methods

(<>) :: Display -> Display -> Display

sconcat :: NonEmpty Display -> Display

stimes :: Integral b => b -> Display -> Display

Generic Display

Defined in Swarm.Game.Display

Associated Types

type Rep Display :: Type -> Type

Methods

from :: Display -> Rep Display x

to :: Rep Display x -> Display

Show Display

Defined in Swarm.Game.Display

Methods

showsPrec :: Int -> Display -> ShowS

show :: Display -> String

showList :: [Display] -> ShowS

Eq Display

Defined in Swarm.Game.Display

Methods

(==) :: Display -> Display -> Bool

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

Ord Display

Defined in Swarm.Game.Display

Methods

compare :: Display -> Display -> Ordering

(<) :: Display -> Display -> Bool

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

(>) :: Display -> Display -> Bool

(>=) :: Display -> Display -> Bool

max :: Display -> Display -> Display

min :: Display -> Display -> Display

Hashable Display

Defined in Swarm.Game.Display

Methods

hashWithSalt :: Int -> Display -> Int

hash :: Display -> Int

type Rep Display

Defined in Swarm.Game.Display

type Rep Display = D1 ('MetaData "Display" "Swarm.Game.Display" "swarm-0.1.0.0-CFIPFkeeTOhKLDsfeG4aYn" 'False) (C1 ('MetaCons "Display" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_defaultChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Char) :*: (S1 ('MetaSel ('Just "_orientationMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map Direction Char)) :*: S1 ('MetaSel ('Just "_curOrientation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Direction)))) :*: (S1 ('MetaSel ('Just "_displayAttr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AttrName) :*: (S1 ('MetaSel ('Just "_displayPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Priority) :*: S1 ('MetaSel ('Just "_invisible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

Fields

defaultChar :: Lens' Display Char

The default character to use for display.

orientationMap :: Lens' Display (Map Direction Char)

For robots or other entities that have an orientation, this map optionally associates different display characters with different orientations. If an orientation is not in the map, the defaultChar will be used.

curOrientation :: Lens' Display (Maybe Direction)

The display caches the current orientation of the entity, so we know which character to use from the orientation map.

displayAttr :: Lens' Display AttrName

The attribute to use for display.

displayPriority :: Lens' Display Priority

This entity's display priority. Higher priorities are drawn on top of lower.

invisible :: Lens' Display Bool

Whether the entity is currently invisible.

Rendering

displayChar :: Display -> Char

Look up the character that should be used for a display.

renderDisplay :: Display -> Widget n

Render a display as a UI widget.

hidden :: Display -> Display

Modify a display to use a ? character for entities that are hidden/unknown.

Construction

defaultTerrainDisplay :: Char -> AttrName -> Display

The default way to display some terrain using the given character and attribute, with priority 0.

defaultEntityDisplay :: Char -> Display

Construct a default display for an entity that uses only a single display character, the default entity attribute, and priority 1.

defaultRobotDisplay :: Display

Construct a default robot display for a given orientation, with display characters "X^>v<", the default robot attribute, and priority 10.

Note that the defaultChar is used for direction DDown and is overriden for the special base robot.

Orphan instances

Hashable AttrName

Methods

hashWithSalt :: Int -> AttrName -> Int

hash :: AttrName -> Int