steamid

Documentation

Index

• Constants
• type AccountInstance
  • func (i AccountInstance) HasFlag(flag uint32) bool
• type ChatInstanceFlag
• type SteamId
  • func NewId(id string) (SteamId, error)
  • func NewIdAdv(accountId, instance uint32, universe int32, accountType int32) SteamId
  • func (s SteamId) ChatToClan() SteamId
  • func (s SteamId) ClanToChat() SteamId
  • func (s SteamId) GetAccountId() uint32
  • func (s SteamId) GetAccountInstance() AccountInstance
  • func (s SteamId) GetAccountType() int32
  • func (s SteamId) GetAccountUniverse() int32
  • func (s SteamId) SetAccountId(id uint32) SteamId
  • func (s SteamId) SetAccountInstance(value uint32) SteamId
  • func (s SteamId) SetAccountType(t int32) SteamId
  • func (s SteamId) SetAccountUniverse(universe int32) SteamId
  • func (s SteamId) String() string
  • func (s SteamId) ToSteam2() string
  • func (s SteamId) ToSteam3() string
  • func (s SteamId) ToString() string
  • func (s SteamId) ToUint64() uint64

Constants

const (
	// ChatInstanceFlagClan is set for clan based chat steam ids.
	ChatInstanceFlagClan ChatInstanceFlag = ChatInstanceFlag((AccountInstanceMask + 1) >> 1)
	// ChatInstanceFlagLobby is set for lobby based chat steam ids.
	ChatInstanceFlagLobby = ChatInstanceFlag((AccountInstanceMask + 1) >> 2)
	// ChatInstanceFlagMMSLobby is set for matchmaking lobby based chat steam ids.
	ChatInstanceFlagMMSLobby = ChatInstanceFlag((AccountInstanceMask + 1) >> 3)
)

const AccountInstanceMask uint32 = 0x000FFFFF

AccountInstanceMask is used for packing chat instance flags in a steam ID.

const ConsoleInstance uint32 = 2

ConsoleInstance is the account instance value for a console.

const DesktopInstance uint32 = 1

DesktopInstance is the account instance value for a desktop.

const WebInstance uint32 = 4

WebInstance is the account instance value for mobile or web-based.

Types

type AccountInstance

type AccountInstance uint32

AccountInstance is an instance of an account.

func (AccountInstance) HasFlag

func (i AccountInstance) HasFlag(flag uint32) bool

HasFlag sees if the flag is set.

type ChatInstanceFlag

type ChatInstanceFlag uint32

ChatInstanceFlag is a flag a chat steam ID may have.

type SteamId

type SteamId uint64

SteamId is a steam identifier.

func NewId

func NewId(id string) (SteamId, error)

NewId attempts to parse the steam ID.

func NewIdAdv

func NewIdAdv(accountId, instance uint32, universe int32, accountType int32) SteamId

func (SteamId) ChatToClan

func (s SteamId) ChatToClan() SteamId

used to fix the Chat SteamId to a Clan SteamId

func (SteamId) ClanToChat

func (s SteamId) ClanToChat() SteamId

used to fix the Clan SteamId to a Chat SteamId

func (SteamId) GetAccountId

func (s SteamId) GetAccountId() uint32

func (SteamId) GetAccountInstance

func (s SteamId) GetAccountInstance() AccountInstance

func (SteamId) GetAccountType

func (s SteamId) GetAccountType() int32

func (SteamId) GetAccountUniverse

func (s SteamId) GetAccountUniverse() int32

func (SteamId) SetAccountId

func (s SteamId) SetAccountId(id uint32) SteamId

func (SteamId) SetAccountInstance

func (s SteamId) SetAccountInstance(value uint32) SteamId

func (SteamId) SetAccountType

func (s SteamId) SetAccountType(t int32) SteamId

func (SteamId) SetAccountUniverse

func (s SteamId) SetAccountUniverse(universe int32) SteamId

func (SteamId) String

func (s SteamId) String() string

func (SteamId) ToSteam2

func (s SteamId) ToSteam2() string

ToSteam2 converts to the steam2 ID representation.

func (SteamId) ToSteam3

func (s SteamId) ToSteam3() string

ToSteam3 converts to the steam3 ID representation.

func (SteamId) ToString

func (s SteamId) ToString() string

func (SteamId) ToUint64

func (s SteamId) ToUint64() uint64