Octane.Type.RemoteId

Documentation

data RemoteId

A player's canonical remote ID. This is the best way to uniquely identify players

Constructors

RemotePlayStationId PlayStationId

RemoteSplitscreenId SplitscreenId

RemoteSteamId SteamId

RemoteXboxId XboxId

Instances

Eq RemoteId

Methods

(==) :: RemoteId -> RemoteId -> Bool

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

Show RemoteId

Methods

showsPrec :: Int -> RemoteId -> ShowS

show :: RemoteId -> String

showList :: [RemoteId] -> ShowS

Generic RemoteId

Associated Types

type Rep RemoteId :: * -> *

Methods

from :: RemoteId -> Rep RemoteId x

to :: Rep RemoteId x -> RemoteId

ToJSON RemoteId

Encodes the remote ID as an object with Type and Value keys.

>>> Aeson.encode (RemoteSteamId (SteamId 1))
"{\"Value\":1,\"Type\":\"Steam\"}"

Methods

toJSON :: RemoteId -> Value

toEncoding :: RemoteId -> Encoding

toJSONList :: [RemoteId] -> Value

toEncodingList :: [RemoteId] -> Encoding

NFData RemoteId

Methods

rnf :: RemoteId -> ()

type Rep RemoteId

type Rep RemoteId = D1 (MetaData "RemoteId" "Octane.Type.RemoteId" "octane-0.14.0-IznL7Q8DYDX3jshGLPoKHr" False) ((:+:) ((:+:) (C1 (MetaCons "RemotePlayStationId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 PlayStationId))) (C1 (MetaCons "RemoteSplitscreenId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 SplitscreenId)))) ((:+:) (C1 (MetaCons "RemoteSteamId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 SteamId))) (C1 (MetaCons "RemoteXboxId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 XboxId)))))

newtype SteamId

Constructors

SteamId

Fields

• steamIdUnpack :: Word64

Instances

Eq SteamId

Methods

(==) :: SteamId -> SteamId -> Bool

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

Show SteamId

Methods

showsPrec :: Int -> SteamId -> ShowS

show :: SteamId -> String

showList :: [SteamId] -> ShowS

Generic SteamId

Associated Types

type Rep SteamId :: * -> *

Methods

from :: SteamId -> Rep SteamId x

to :: Rep SteamId x -> SteamId

ToJSON SteamId

Encoded directly as a number.

>>> Aeson.encode (SteamId 1)
"1"

Methods

toJSON :: SteamId -> Value

toEncoding :: SteamId -> Encoding

toJSONList :: [SteamId] -> Value

toEncodingList :: [SteamId] -> Encoding

BinaryBit SteamId

Stored as a plain Word64.

>>> Binary.runGet (BinaryBit.runBitGet (BinaryBit.getBits 0)) "\x80\x00\x00\x00\x00\x00\x00\x00" :: SteamId
SteamId {steamIdUnpack = 0x0000000000000001}

>>> Binary.runPut (BinaryBit.runBitPut (BinaryBit.putBits 0 (SteamId 1)))
"\128\NUL\NUL\NUL\NUL\NUL\NUL\NUL"

Methods

putBits :: Int -> SteamId -> BitPut ()

getBits :: Int -> BitGet SteamId

NFData SteamId

Methods

rnf :: SteamId -> ()

HasField "unpack" SteamId Word64

Methods

getField :: Proxy# Symbol "unpack" -> SteamId -> Word64

ModifyField "unpack" SteamId SteamId Word64 Word64

Methods

modifyField :: Proxy# Symbol "unpack" -> (Word64 -> Word64) -> SteamId -> SteamId

setField :: Proxy# Symbol "unpack" -> SteamId -> Word64 -> SteamId

fieldLens :: Functor f => Proxy# Symbol "unpack" -> (Word64 -> f Word64) -> SteamId -> f SteamId

ModifyRec "unpack" Word64 cs0 => HasField "unpack" (Rec cs0 SteamId) Word64

Methods

getField :: Proxy# Symbol "unpack" -> Rec cs0 SteamId -> Word64

ModifyRec "unpack" Word64 cs0 => ModifyField "unpack" (Rec cs0 SteamId) (Rec cs0 SteamId) Word64 Word64

Methods

modifyField :: Proxy# Symbol "unpack" -> (Word64 -> Word64) -> Rec cs0 SteamId -> Rec cs0 SteamId

setField :: Proxy# Symbol "unpack" -> Rec cs0 SteamId -> Word64 -> Rec cs0 SteamId

fieldLens :: Functor f => Proxy# Symbol "unpack" -> (Word64 -> f Word64) -> Rec cs0 SteamId -> f (Rec cs0 SteamId)

type Rep SteamId

type Rep SteamId = D1 (MetaData "SteamId" "Octane.Type.RemoteId" "octane-0.14.0-IznL7Q8DYDX3jshGLPoKHr" True) (C1 (MetaCons "SteamId" PrefixI True) (S1 (MetaSel (Just Symbol "steamIdUnpack") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64)))

type FieldType "unpack" SteamId

type FieldType "unpack" SteamId = Word64

type UpdateType "unpack" SteamId Word64

type UpdateType "unpack" SteamId Word64 = SteamId

data PlayStationId

Constructors

PlayStationId

Fields

• playStationIdName :: Text
• playStationIdUnknown :: ByteString

Instances

Eq PlayStationId

Methods

(==) :: PlayStationId -> PlayStationId -> Bool

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

Show PlayStationId

Methods

showsPrec :: Int -> PlayStationId -> ShowS

show :: PlayStationId -> String

showList :: [PlayStationId] -> ShowS

Generic PlayStationId

Associated Types

type Rep PlayStationId :: * -> *

Methods

from :: PlayStationId -> Rep PlayStationId x

to :: Rep PlayStationId x -> PlayStationId

ToJSON PlayStationId

>>> Aeson.encode (PlayStationId "A" "B")
"{\"Unknown\":\"0x42\",\"Name\":\"A\"}"

Methods

toJSON :: PlayStationId -> Value

toEncoding :: PlayStationId -> Encoding

toJSONList :: [PlayStationId] -> Value

toEncodingList :: [PlayStationId] -> Encoding

BinaryBit PlayStationId

Each part is stored as exactly 16 bits.

>>> Binary.runGet (BinaryBit.runBitGet (BinaryBit.getBits 0)) "\x42\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80" :: PlayStationId
PlayStationId {playStationIdName = "B", playStationIdUnknown = "\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\SOH"}

>>> Binary.runPut (BinaryBit.runBitPut (BinaryBit.putBits 0 (PlayStationId "A" "\x01")))
"\130\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\128"

Methods

putBits :: Int -> PlayStationId -> BitPut ()

getBits :: Int -> BitGet PlayStationId

NFData PlayStationId

Methods

rnf :: PlayStationId -> ()

HasField "name" PlayStationId Text

Methods

getField :: Proxy# Symbol "name" -> PlayStationId -> Text

HasField "unknown" PlayStationId ByteString

Methods

getField :: Proxy# Symbol "unknown" -> PlayStationId -> ByteString

ModifyField "name" PlayStationId PlayStationId Text Text

Methods

modifyField :: Proxy# Symbol "name" -> (Text -> Text) -> PlayStationId -> PlayStationId

setField :: Proxy# Symbol "name" -> PlayStationId -> Text -> PlayStationId

fieldLens :: Functor f => Proxy# Symbol "name" -> (Text -> f Text) -> PlayStationId -> f PlayStationId

ModifyField "unknown" PlayStationId PlayStationId ByteString ByteString

Methods

modifyField :: Proxy# Symbol "unknown" -> (ByteString -> ByteString) -> PlayStationId -> PlayStationId

setField :: Proxy# Symbol "unknown" -> PlayStationId -> ByteString -> PlayStationId

fieldLens :: Functor f => Proxy# Symbol "unknown" -> (ByteString -> f ByteString) -> PlayStationId -> f PlayStationId

ModifyRec "name" Text cs0 => HasField "name" (Rec cs0 PlayStationId) Text

Methods

getField :: Proxy# Symbol "name" -> Rec cs0 PlayStationId -> Text

ModifyRec "unknown" ByteString cs0 => HasField "unknown" (Rec cs0 PlayStationId) ByteString

Methods

getField :: Proxy# Symbol "unknown" -> Rec cs0 PlayStationId -> ByteString

ModifyRec "name" Text cs0 => ModifyField "name" (Rec cs0 PlayStationId) (Rec cs0 PlayStationId) Text Text

Methods

modifyField :: Proxy# Symbol "name" -> (Text -> Text) -> Rec cs0 PlayStationId -> Rec cs0 PlayStationId

setField :: Proxy# Symbol "name" -> Rec cs0 PlayStationId -> Text -> Rec cs0 PlayStationId

fieldLens :: Functor f => Proxy# Symbol "name" -> (Text -> f Text) -> Rec cs0 PlayStationId -> f (Rec cs0 PlayStationId)

ModifyRec "unknown" ByteString cs0 => ModifyField "unknown" (Rec cs0 PlayStationId) (Rec cs0 PlayStationId) ByteString ByteString

Methods

modifyField :: Proxy# Symbol "unknown" -> (ByteString -> ByteString) -> Rec cs0 PlayStationId -> Rec cs0 PlayStationId

setField :: Proxy# Symbol "unknown" -> Rec cs0 PlayStationId -> ByteString -> Rec cs0 PlayStationId

fieldLens :: Functor f => Proxy# Symbol "unknown" -> (ByteString -> f ByteString) -> Rec cs0 PlayStationId -> f (Rec cs0 PlayStationId)

type Rep PlayStationId

type Rep PlayStationId = D1 (MetaData "PlayStationId" "Octane.Type.RemoteId" "octane-0.14.0-IznL7Q8DYDX3jshGLPoKHr" False) (C1 (MetaCons "PlayStationId" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "playStationIdName") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "playStationIdUnknown") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 ByteString))))

type FieldType "name" PlayStationId

type FieldType "name" PlayStationId = Text

type FieldType "unknown" PlayStationId

type FieldType "unknown" PlayStationId = ByteString

type UpdateType "name" PlayStationId Text

type UpdateType "name" PlayStationId Text = PlayStationId

type UpdateType "unknown" PlayStationId ByteString

type UpdateType "unknown" PlayStationId ByteString = PlayStationId

newtype SplitscreenId

Constructors

SplitscreenId

Fields

• splitscreenIdUnpack :: Maybe Int

Instances

Eq SplitscreenId

Methods

(==) :: SplitscreenId -> SplitscreenId -> Bool

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

Show SplitscreenId

Methods

showsPrec :: Int -> SplitscreenId -> ShowS

show :: SplitscreenId -> String

showList :: [SplitscreenId] -> ShowS

Generic SplitscreenId

Associated Types

type Rep SplitscreenId :: * -> *

Methods

from :: SplitscreenId -> Rep SplitscreenId x

to :: Rep SplitscreenId x -> SplitscreenId

ToJSON SplitscreenId

Encoded as an optional number.

>>> Aeson.encode (SplitscreenId Nothing)
"null"

>>> Aeson.encode (SplitscreenId (Just 0))
"0"

Methods

toJSON :: SplitscreenId -> Value

toEncoding :: SplitscreenId -> Encoding

toJSONList :: [SplitscreenId] -> Value

toEncodingList :: [SplitscreenId] -> Encoding

BinaryBit SplitscreenId

Stored as a bare byte string.

>>> Binary.runGet (BinaryBit.runBitGet (BinaryBit.getBits 0)) "\x00\x00\x00" :: SplitscreenId
SplitscreenId {splitscreenIdUnpack = Just 0}

>>> Binary.runPut (BinaryBit.runBitPut (BinaryBit.putBits 0 (SplitscreenId (Just 0))))
"\NUL\NUL\NUL"

Methods

putBits :: Int -> SplitscreenId -> BitPut ()

getBits :: Int -> BitGet SplitscreenId

NFData SplitscreenId

Methods

rnf :: SplitscreenId -> ()

ModifyField "unpack" SplitscreenId SplitscreenId (Maybe Int) (Maybe Int)

Methods

modifyField :: Proxy# Symbol "unpack" -> (Maybe Int -> Maybe Int) -> SplitscreenId -> SplitscreenId

setField :: Proxy# Symbol "unpack" -> SplitscreenId -> Maybe Int -> SplitscreenId

fieldLens :: Functor f => Proxy# Symbol "unpack" -> (Maybe Int -> f (Maybe Int)) -> SplitscreenId -> f SplitscreenId

HasField "unpack" SplitscreenId (Maybe Int)

Methods

getField :: Proxy# Symbol "unpack" -> SplitscreenId -> Maybe Int

ModifyRec "unpack" (Maybe Int) cs0 => HasField "unpack" (Rec cs0 SplitscreenId) (Maybe Int)

Methods

getField :: Proxy# Symbol "unpack" -> Rec cs0 SplitscreenId -> Maybe Int

ModifyRec "unpack" (Maybe Int) cs0 => ModifyField "unpack" (Rec cs0 SplitscreenId) (Rec cs0 SplitscreenId) (Maybe Int) (Maybe Int)

Methods

modifyField :: Proxy# Symbol "unpack" -> (Maybe Int -> Maybe Int) -> Rec cs0 SplitscreenId -> Rec cs0 SplitscreenId

setField :: Proxy# Symbol "unpack" -> Rec cs0 SplitscreenId -> Maybe Int -> Rec cs0 SplitscreenId

fieldLens :: Functor f => Proxy# Symbol "unpack" -> (Maybe Int -> f (Maybe Int)) -> Rec cs0 SplitscreenId -> f (Rec cs0 SplitscreenId)

type Rep SplitscreenId

type Rep SplitscreenId = D1 (MetaData "SplitscreenId" "Octane.Type.RemoteId" "octane-0.14.0-IznL7Q8DYDX3jshGLPoKHr" True) (C1 (MetaCons "SplitscreenId" PrefixI True) (S1 (MetaSel (Just Symbol "splitscreenIdUnpack") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))))

type FieldType "unpack" SplitscreenId

type FieldType "unpack" SplitscreenId = Maybe Int

type UpdateType "unpack" SplitscreenId (Maybe Int)

type UpdateType "unpack" SplitscreenId (Maybe Int) = SplitscreenId

newtype XboxId

Constructors

XboxId

Fields

• xboxIdUnpack :: Word64

Instances

Eq XboxId

Methods

(==) :: XboxId -> XboxId -> Bool

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

Show XboxId

Methods

showsPrec :: Int -> XboxId -> ShowS

show :: XboxId -> String

showList :: [XboxId] -> ShowS

Generic XboxId

Associated Types

type Rep XboxId :: * -> *

Methods

from :: XboxId -> Rep XboxId x

to :: Rep XboxId x -> XboxId

ToJSON XboxId

Encoded directly as a number.

>>> Aeson.encode (XboxId 1)
"1"

Methods

toJSON :: XboxId -> Value

toEncoding :: XboxId -> Encoding

toJSONList :: [XboxId] -> Value

toEncodingList :: [XboxId] -> Encoding

BinaryBit XboxId

Stored as a plain Word64.

>>> Binary.runGet (BinaryBit.runBitGet (BinaryBit.getBits 0)) "\x80\x00\x00\x00\x00\x00\x00\x00" :: XboxId
XboxId {xboxIdUnpack = 0x0000000000000001}

>>> Binary.runPut (BinaryBit.runBitPut (BinaryBit.putBits 0 (XboxId 1)))
"\128\NUL\NUL\NUL\NUL\NUL\NUL\NUL"

Methods

putBits :: Int -> XboxId -> BitPut ()

getBits :: Int -> BitGet XboxId

NFData XboxId

Methods

rnf :: XboxId -> ()

HasField "unpack" XboxId Word64

Methods

getField :: Proxy# Symbol "unpack" -> XboxId -> Word64

ModifyField "unpack" XboxId XboxId Word64 Word64

Methods

modifyField :: Proxy# Symbol "unpack" -> (Word64 -> Word64) -> XboxId -> XboxId

setField :: Proxy# Symbol "unpack" -> XboxId -> Word64 -> XboxId

fieldLens :: Functor f => Proxy# Symbol "unpack" -> (Word64 -> f Word64) -> XboxId -> f XboxId

ModifyRec "unpack" Word64 cs0 => HasField "unpack" (Rec cs0 XboxId) Word64

Methods

getField :: Proxy# Symbol "unpack" -> Rec cs0 XboxId -> Word64

ModifyRec "unpack" Word64 cs0 => ModifyField "unpack" (Rec cs0 XboxId) (Rec cs0 XboxId) Word64 Word64

Methods

modifyField :: Proxy# Symbol "unpack" -> (Word64 -> Word64) -> Rec cs0 XboxId -> Rec cs0 XboxId

setField :: Proxy# Symbol "unpack" -> Rec cs0 XboxId -> Word64 -> Rec cs0 XboxId

fieldLens :: Functor f => Proxy# Symbol "unpack" -> (Word64 -> f Word64) -> Rec cs0 XboxId -> f (Rec cs0 XboxId)

type Rep XboxId

type Rep XboxId = D1 (MetaData "XboxId" "Octane.Type.RemoteId" "octane-0.14.0-IznL7Q8DYDX3jshGLPoKHr" True) (C1 (MetaCons "XboxId" PrefixI True) (S1 (MetaSel (Just Symbol "xboxIdUnpack") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64)))

type FieldType "unpack" XboxId

type FieldType "unpack" XboxId = Word64

type UpdateType "unpack" XboxId Word64

type UpdateType "unpack" XboxId Word64 = XboxId