uk.co.thomasc.steamkit.types.steamid

Class SteamID

java.lang.Object

uk.co.thomasc.steamkit.types.steamid.SteamID

public class SteamID
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SteamID.ChatInstanceFlags Represents various flags a chat SteamID may have, packed into its instance.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AccountIDMask Masking value used for the account id.
static int	AccountInstanceMask Masking value used for packing chat instance flags into a SteamID.
static int	AllInstances The account instance value when representing all instanced SteamID
static int	ConsoleInstance The account instance value for a console SteamID.
static int	DesktopInstance The account instance value for a desktop SteamID.
(package private) BitVector64	steamid
(package private) static Pattern	SteamIDRegex
static int	WebInstance The account instance for a mobile or web based SteamID.

Constructor Summary

Constructors

Constructor and Description
SteamID() Initializes a new instance of the SteamID class.
SteamID(int unAccountID, EUniverse eUniverse, EAccountType eAccountType) Initializes a new instance of the SteamID class.
SteamID(int unAccountID, int unInstance, EUniverse eUniverse, EAccountType eAccountType) Initializes a new instance of the SteamID class.
SteamID(long id) Initializes a new instance of the SteamID class.
SteamID(String steamId) Initializes a new instance of the SteamID class from a rendered form.
SteamID(String steamId, EUniverse eUniverse) Initializes a new instance of the SteamID class from a rendered form and universe.

Method Summary

Methods

Modifier and Type	Method and Description
SteamID	clone()
long	convertToLong() Converts this SteamID into it's 64bit integer form.
boolean	equals(Object obj) Determines whether the specified Object is equal to this instance
long	getAccountID() Gets the account id.
long	getAccountInstance() Gets the account instance.
EAccountType	getAccountType() Gets the account type.
EUniverse	getAccountUniverse() Gets the account universe.
long	getStaticAccountKey() Returns a static account key used for grouping accounts with differing instances.
int	hashCode() Returns a hash code for this instance.
void	instancedSet(int unAccountID, int unInstance, EUniverse eUniverse, EAccountType eAccountType) Sets the various components of this SteamID instance.
boolean	isAnonAccount() Gets a value indicating whether this instance is an anonymous account.
boolean	isAnonGameServerAccount() Gets a value indicating whether this instance is an anonymous game server account.
boolean	isAnonUserAccount() Gets a value indicating whether this instance is an anonymous user account.
boolean	isBlankAnonAccount() Gets a value indicating whether this instance is a blank anonymous account
boolean	isChatAccount() Gets a value indicating whether this instance is a chat account.
boolean	isClanAccount() Gets a value indicating whether this instance is a clan account.
boolean	isConsoleUserAccount() Gets a value indicating whether this instance is a console user account.
boolean	isContentServerAccount() Gets a value indicating whether this instance is a content server account.
boolean	isGameServerAccount() Gets a value indicating whether this instance is a game server account.
boolean	isIndividualAccount() Gets a value indicating whether this instance is an individual account.
boolean	IsLobby() Gets a value indicating whether this instance is a lobby.
boolean	isPersistentGameServerAccount() Gets a value indicating whether this instance is a persistent game server account.
boolean	IsValid() Gets a value indicating whether this instance is valid.
String	render() Renders this instance into it's "STEAM_" represenation.
void	set(int unAccountID, EUniverse eUniverse, EAccountType eAccountType) Sets the various components of this SteamID instance.
void	setAccountID(long value) Sets the account id.
void	setAccountInstance(long value) Sets the account instance.
void	setAccountInstance(SteamID.ChatInstanceFlags clan)
void	setAccountType(EAccountType value) Sets the account type.
void	setAccountUniverse(EUniverse value) Sets the account universe.
boolean	setFromString(String steamId, EUniverse eUniverse) Sets the various components of this SteamID from a rendered form and universe.
void	setFromUInt64(long ulSteamID) Sets the various components of this SteamID from a 64bit integer form.
String	toString() Returns a String that represents this instance.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

steamid

BitVector64 steamid

SteamIDRegex

static Pattern SteamIDRegex

AllInstances

public static final int AllInstances

The account instance value when representing all instanced SteamID

See Also:

Constant Field Values

DesktopInstance

public static final int DesktopInstance

The account instance value for a desktop SteamID.

See Also:

Constant Field Values

ConsoleInstance

public static final int ConsoleInstance

The account instance value for a console SteamID.

See Also:

Constant Field Values

WebInstance

public static final int WebInstance

The account instance for a mobile or web based SteamID.

See Also:

Constant Field Values

AccountIDMask

public static final int AccountIDMask

Masking value used for the account id.

See Also:

Constant Field Values

AccountInstanceMask

public static final int AccountInstanceMask

Masking value used for packing chat instance flags into a SteamID.

See Also:

Constant Field Values

Constructor Detail

SteamID

public SteamID()

Initializes a new instance of the SteamID class.

SteamID

public SteamID(int unAccountID,
       EUniverse eUniverse,
       EAccountType eAccountType)

Initializes a new instance of the SteamID class.

Parameters:

unAccountID - The account ID.

eUniverse - The universe.

eAccountType - The account type.

SteamID

public SteamID(int unAccountID,
       int unInstance,
       EUniverse eUniverse,
       EAccountType eAccountType)

Initializes a new instance of the SteamID class.

Parameters:

unAccountID - The account ID.

unInstance - The instance.

eUniverse - The universe.

eAccountType - The account type.

SteamID

public SteamID(long id)

Initializes a new instance of the SteamID class.

Parameters:

id - The 64bit integer to assign this SteamID from.

SteamID

public SteamID(String steamId)

Initializes a new instance of the SteamID class from a rendered form. This constructor assumes the rendered SteamID is in the public universe.

Parameters:

steamId - A "STEAM_" rendered form of the SteamID.

SteamID

public SteamID(String steamId,
       EUniverse eUniverse)

Initializes a new instance of the SteamID class from a rendered form and universe.

Parameters:

steamId - A "STEAM_" rendered form of the SteamID.

eUniverse - The universe the SteamID belongs to.

Method Detail

set

public void set(int unAccountID,
       EUniverse eUniverse,
       EAccountType eAccountType)

Sets the various components of this SteamID instance.

Parameters:

unAccountID - The account ID.

eUniverse - The universe.

eAccountType - The account type.

instancedSet

public void instancedSet(int unAccountID,
                int unInstance,
                EUniverse eUniverse,
                EAccountType eAccountType)

Sets the various components of this SteamID instance.

Parameters:

unAccountID - The account ID.

unInstance - The instance.

eUniverse - The universe.

eAccountType - The account type.

setFromString

public boolean setFromString(String steamId,
                    EUniverse eUniverse)

Sets the various components of this SteamID from a rendered form and universe.

Parameters:

steamId - A "STEAM_" rendered form of the SteamID.

eUniverse - The universe the SteamID belongs to.

Returns:

True if this instance was successfully assigned, or false if the given string was in an invalid format.

setFromUInt64

public void setFromUInt64(long ulSteamID)

Sets the various components of this SteamID from a 64bit integer form.

Parameters:

ulSteamID - The 64bit integer to assign this SteamID from.

convertToLong

public long convertToLong()

Converts this SteamID into it's 64bit integer form.

Returns:

A 64bit integer representing this SteamID.

getStaticAccountKey

public long getStaticAccountKey()

Returns a static account key used for grouping accounts with differing instances.

Returns:

A 64bit static account key.

isBlankAnonAccount

public boolean isBlankAnonAccount()

Gets a value indicating whether this instance is a blank anonymous account

Returns:

true if this instance is a blank anon account; otherwise, false.

isGameServerAccount

public boolean isGameServerAccount()

Gets a value indicating whether this instance is a game server account.

Returns:

true if this instance is a game server account; otherwise, false

isPersistentGameServerAccount

public boolean isPersistentGameServerAccount()

Gets a value indicating whether this instance is a persistent game server account.

Returns:

true if this instance is a persistent game server account; otherwise, false

isAnonGameServerAccount

public boolean isAnonGameServerAccount()

Gets a value indicating whether this instance is an anonymous game server account.

Returns:

true if this instance is an anon game server account; otherwise, false.

isContentServerAccount

public boolean isContentServerAccount()

Gets a value indicating whether this instance is a content server account.

Returns:

true if this instance is a content server account; otherwise, false.

isClanAccount

public boolean isClanAccount()

Gets a value indicating whether this instance is a clan account.

Returns:

true if this instance is a clan account; otherwise, false.

isChatAccount

public boolean isChatAccount()

Gets a value indicating whether this instance is a chat account.

Returns:

true if this instance is a chat account; otherwise, false.

IsLobby

public boolean IsLobby()

Gets a value indicating whether this instance is a lobby.

Returns:

true if this instance is a lobby; otherwise, false.

isIndividualAccount

public boolean isIndividualAccount()

Gets a value indicating whether this instance is an individual account.

Returns:

true if this instance is an individual account; otherwise, false.

isAnonAccount

public boolean isAnonAccount()

Gets a value indicating whether this instance is an anonymous account.

Returns:

true if this instance is an anon account; otherwise, false.

isAnonUserAccount

public boolean isAnonUserAccount()

Gets a value indicating whether this instance is an anonymous user account.

Returns:

true if this instance is an anon user account; otherwise, false.

isConsoleUserAccount

public boolean isConsoleUserAccount()

Gets a value indicating whether this instance is a console user account.

Returns:

true if this instance is a console user account; otherwise, false.

IsValid

public boolean IsValid()

Gets a value indicating whether this instance is valid.

Returns:

true if this instance is valid; otherwise, false.

getAccountID

public long getAccountID()

Gets the account id.

Returns:

The account id.

setAccountID

public void setAccountID(long value)

Sets the account id.

Parameters:

value - The account id.

getAccountInstance

public long getAccountInstance()

Gets the account instance.

Returns:

The account instance.

setAccountInstance

public void setAccountInstance(long value)

Sets the account instance.

Parameters:

value - The account instance.

setAccountInstance

public void setAccountInstance(SteamID.ChatInstanceFlags clan)

getAccountType

public EAccountType getAccountType()

Gets the account type.

Returns:

The account type.

setAccountType

public void setAccountType(EAccountType value)

Sets the account type.

Parameters:

value - The account type.

getAccountUniverse

public EUniverse getAccountUniverse()

Gets the account universe.

Returns:

The account universe.

setAccountUniverse

public void setAccountUniverse(EUniverse value)

Sets the account universe.

Parameters:

value - The account universe.

render

public String render()

Renders this instance into it's "STEAM_" represenation.

Returns:

A string "STEAM_" representation of this SteamID.

toString

public String toString()

Returns a String that represents this instance.

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Determines whether the specified Object is equal to this instance

Overrides:

equals in class Object

clone

public SteamID clone()

Overrides:

clone in class Object

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class Object