Game.LambdaHack.Common.ClientOptions

Options that affect the behaviour of the client.

Documentation

data FullscreenMode

Kinds of fullscreen or windowed mode. See https://hackage.haskell.org/package/sdl2-2.5.3.0/docs/SDL-Video.html#t:WindowMode.

Constructors

NotFullscreen

a normal window instead of fullscreen

BigBorderlessWindow

fake fullscreen; window the size of the desktop; this is the preferred one, if it works

ModeChange

real fullscreen with a video mode change

Instances

Eq FullscreenMode

Defined in Game.LambdaHack.Common.ClientOptions

Methods

(==) :: FullscreenMode -> FullscreenMode -> Bool

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

Read FullscreenMode

Defined in Game.LambdaHack.Common.ClientOptions

Methods

readsPrec :: Int -> ReadS FullscreenMode

readList :: ReadS [FullscreenMode]

readPrec :: ReadPrec FullscreenMode

readListPrec :: ReadPrec [FullscreenMode]

Show FullscreenMode

Defined in Game.LambdaHack.Common.ClientOptions

Methods

showsPrec :: Int -> FullscreenMode -> ShowS

show :: FullscreenMode -> String

showList :: [FullscreenMode] -> ShowS

Generic FullscreenMode

Defined in Game.LambdaHack.Common.ClientOptions

Associated Types

type Rep FullscreenMode :: Type -> Type

Methods

from :: FullscreenMode -> Rep FullscreenMode x

to :: Rep FullscreenMode x -> FullscreenMode

Binary FullscreenMode

Defined in Game.LambdaHack.Common.ClientOptions

Methods

put :: FullscreenMode -> Put

get :: Get FullscreenMode

putList :: [FullscreenMode] -> Put

NFData FullscreenMode

Defined in Game.LambdaHack.Common.ClientOptions

Methods

rnf :: FullscreenMode -> ()

type Rep FullscreenMode

Defined in Game.LambdaHack.Common.ClientOptions

type Rep FullscreenMode = D1 ('MetaData "FullscreenMode" "Game.LambdaHack.Common.ClientOptions" "LambdaHack-0.11.0.0-inplace" 'False) (C1 ('MetaCons "NotFullscreen" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "BigBorderlessWindow" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ModeChange" 'PrefixI 'False) (U1 :: Type -> Type)))

data ClientOptions

Options that affect the behaviour of the client (but not game rules).

Constructors

ClientOptions

Fields

• schosenFontset :: Maybe Text

  Font set chosen by the player for the whole UI.

• sallFontsScale :: Maybe Double

  The scale applied to all fonts, resizing the whole UI.

• sfonts :: [(Text, FontDefinition)]

  Available fonts as defined in config file.

• sfontsets :: [(Text, FontSet)]

  Available font sets as defined in config file.

• sfullscreenMode :: Maybe FullscreenMode

  Whether to start in fullscreen mode and in which one.

• slogPriority :: Maybe Int

  How much to log (e.g., from SDL). 1 is all, 5 is errors, the default.

• smaxFps :: Maybe Double

  Maximal frames per second. This is better low and fixed, to avoid jerkiness and delays that tell the player there are many intelligent enemies on the level. That's better than scaling AI sofistication down based on the FPS setting and machine speed.

• sdisableAutoYes :: Bool

  Never auto-answer all prompts, even if under AI control.

• snoAnim :: Maybe Bool

  Don't show any animations.

• snewGameCli :: Bool

  Start a new game, overwriting the save file.

• sbenchmark :: Bool

  Don't create directories and files and show time stats.

• sbenchMessages :: Bool

  Display messages in realistic was under AI control (e.g., for benchmarking).

• stitle :: Maybe String
• ssavePrefixCli :: String

  Prefix of the save game file name.

• sfrontendANSI :: Bool

  Whether to use the ANSI frontend.

• sfrontendTeletype :: Bool

  Whether to use the stdout/stdin frontend.

• sfrontendNull :: Bool

  Whether to use null (no input/output) frontend.

• sfrontendLazy :: Bool

  Whether to use lazy (output not even calculated) frontend.

• sdbgMsgCli :: Bool

  Show clients' internal debug messages.

• sstopAfterSeconds :: Maybe Int
• sstopAfterFrames :: Maybe Int
• sprintEachScreen :: Bool
• sexposePlaces :: Bool
• sexposeItems :: Bool
• sexposeActors :: Bool

Instances

Eq ClientOptions

Defined in Game.LambdaHack.Common.ClientOptions

Methods

(==) :: ClientOptions -> ClientOptions -> Bool

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

Show ClientOptions

Defined in Game.LambdaHack.Common.ClientOptions

Methods

showsPrec :: Int -> ClientOptions -> ShowS

show :: ClientOptions -> String

showList :: [ClientOptions] -> ShowS

Generic ClientOptions

Defined in Game.LambdaHack.Common.ClientOptions

Associated Types

type Rep ClientOptions :: Type -> Type

Methods

from :: ClientOptions -> Rep ClientOptions x

to :: Rep ClientOptions x -> ClientOptions

Binary ClientOptions

Defined in Game.LambdaHack.Common.ClientOptions

Methods

put :: ClientOptions -> Put

get :: Get ClientOptions

putList :: [ClientOptions] -> Put

type Rep ClientOptions

Defined in Game.LambdaHack.Common.ClientOptions

type Rep ClientOptions = D1 ('MetaData "ClientOptions" "Game.LambdaHack.Common.ClientOptions" "LambdaHack-0.11.0.0-inplace" 'False) (C1 ('MetaCons "ClientOptions" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "schosenFontset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sallFontsScale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "sfonts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Text, FontDefinition)]))) :*: (S1 ('MetaSel ('Just "sfontsets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Text, FontSet)]) :*: (S1 ('MetaSel ('Just "sfullscreenMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FullscreenMode)) :*: S1 ('MetaSel ('Just "slogPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "smaxFps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "sdisableAutoYes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "snoAnim") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "snewGameCli") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "sbenchmark") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "sbenchMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))) :*: (((S1 ('MetaSel ('Just "stitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe String)) :*: (S1 ('MetaSel ('Just "ssavePrefixCli") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String) :*: S1 ('MetaSel ('Just "sfrontendANSI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :*: (S1 ('MetaSel ('Just "sfrontendTeletype") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "sfrontendNull") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "sfrontendLazy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "sdbgMsgCli") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "sstopAfterSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "sstopAfterFrames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "sprintEachScreen") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "sexposePlaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "sexposeItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "sexposeActors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))))

defClientOptions :: ClientOptions

Default value of client options.