Game.LambdaHack.Common.State

The common, for server and clients, main game state type and its operations.

Basic game state, local or global

data State

The main game state, the basic one, pertaining to a single game, not to a single playing session or an intersection of both. This state persists between playing sessions, until the particular game ends. Anything that persists between games is stored in server state, client state or client UI session state.

Another differentiating property of this state is that it's kept separately on the server and each of the clients (players, human or AI) and separately updated, according to what each player can observe. It's never updated directly, but always through atomic commands (CmdAtomic) that are filtered and interpreted differently on server and on each client. Therefore, the type is a view on the game state, not the real game state, except on the server that alone stores the full game information.

Instances

Eq State

Defined in Game.LambdaHack.Common.State

Methods

(==) :: State -> State -> Bool

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

Show State

Defined in Game.LambdaHack.Common.State

Methods

showsPrec :: Int -> State -> ShowS

show :: State -> String

showList :: [State] -> ShowS

Binary State

Defined in Game.LambdaHack.Common.State

Methods

put :: State -> Put

get :: Get State

putList :: [State] -> Put

State components

sdungeon :: State -> Dungeon

stotalDepth :: State -> AbsDepth

sactorD :: State -> ActorDict

sitemD :: State -> ItemDict

sitemIxMap :: State -> ItemIxMap

sfactionD :: State -> FactionDict

stime :: State -> Time

scops :: State -> COps

sgold :: State -> Int

shigh :: State -> ScoreDict

sgameModeId :: State -> ContentId ModeKind

sdiscoKind :: State -> DiscoveryKind

sdiscoAspect :: State -> DiscoveryAspect

sactorMaxSkills :: State -> ActorMaxSkills

State construction

defStateGlobal :: Dungeon -> AbsDepth -> FactionDict -> COps -> ScoreDict -> ContentId ModeKind -> DiscoveryKind -> State

Initial complete global game state.

emptyState :: State

Initial empty state.

localFromGlobal :: State -> State

Local state created by removing secret information from global state components.

State update

updateDungeon :: (Dungeon -> Dungeon) -> State -> State

Update dungeon data within state.

updateDepth :: (AbsDepth -> AbsDepth) -> State -> State

Update dungeon depth.

updateActorD :: (ActorDict -> ActorDict) -> State -> State

Update the actor dictionary.

updateItemD :: (ItemDict -> ItemDict) -> State -> State

Update the item dictionary.

updateItemIxMap :: (ItemIxMap -> ItemIxMap) -> State -> State

Update the item kind index map.

updateFactionD :: (FactionDict -> FactionDict) -> State -> State

Update faction data within state.

updateTime :: (Time -> Time) -> State -> State

Update global time within state.

updateCOpsAndCachedData :: (COps -> COps) -> State -> State

Update content data within state and recompute the cached data.

updateGold :: (Int -> Int) -> State -> State

Update total gold value in the dungeon.

updateDiscoKind :: (DiscoveryKind -> DiscoveryKind) -> State -> State

updateDiscoAspect :: (DiscoveryAspect -> DiscoveryAspect) -> State -> State

updateActorMaxSkills :: (ActorMaxSkills -> ActorMaxSkills) -> State -> State

State operations

getItemBody :: ItemId -> State -> Item

aspectRecordFromItem :: ItemId -> Item -> State -> AspectRecord

aspectRecordFromIid :: ItemId -> State -> AspectRecord

maxSkillsFromActor :: Actor -> State -> Skills

maxSkillsInDungeon :: State -> ActorMaxSkills

Internal operations

unknownLevel :: COps -> ContentId CaveKind -> AbsDepth -> Area -> ([Point], [Point]) -> [Point] -> Int -> Bool -> Level

Operations both internal and used in unit tests

unknownTileMap :: Area -> ContentId TileKind -> X -> Y -> TileMap

Create a map full of unknown tiles.

>>> unknownTileMap (fromJust (toArea (0,0,0,0))) TK.unknownId 2 2
PointArray.Array with size (2,2)