javasteam/in.dragonbra.javasteam.types/SteamID

SteamID

open class SteamID

This 64-bit structure is used for identifying various objects on the Steam network.

Constructors

Link copied to clipboard
constructor()
constructor(unAccountID: Long, eUniverse: EUniverse, eAccountType: EAccountType)
constructor(unAccountID: Long, unInstance: Long, eUniverse: EUniverse, eAccountType: EAccountType)
Initializes a new instance of the SteamID class.
constructor(id: Long)
Initializes a new instance of the SteamID class.
constructor(steamId: String)
Initializes a new instance of the SteamID class from a Steam2 "STEAM_" rendered form.
constructor(steamId: String, eUniverse: EUniverse)
Initializes a new instance of the SteamID class from a Steam2 "STEAM_" rendered form and universe.

Types

Link copied to clipboard
enum ChatInstanceFlags
Represents various flags a chat SteamID may have, packed into its instance.

Properties

Link copied to clipboard
val ACCOUNT_ID_MASK: Long = 4294967295
Masking value used for the account id.
Link copied to clipboard
val ACCOUNT_INSTANCE_MASK: Long = 1048575
Masking value used for packing chat instance flags into a SteamID.
Link copied to clipboard
val ALL_INSTANCES: Long = 0
The account instance value when representing all instanced SteamIDs.
Link copied to clipboard
val CONSOLE_INSTANCE: Long = 2
The account instance value for a console SteamID.
Link copied to clipboard
val DESKTOP_INSTANCE: Long = 1
The account instance value for a desktop SteamID.
Link copied to clipboard
Link copied to clipboard
val WEB_INSTANCE: Long = 4
The account instance for mobile or web based SteamIDs.

Functions

Link copied to clipboard
open fun convertToUInt64(): Long
Converts this SteamID into it's 64bit integer form.
Link copied to clipboard
open fun equals(obj: Any): Boolean
Determines whether the specified java.lang.Object is equal to this instance.
Link copied to clipboard
open fun getAccountID(): Long
Link copied to clipboard
open fun getAccountInstance(): Long
Link copied to clipboard
open fun getAccountType(): EAccountType
Link copied to clipboard
open fun getAccountUniverse(): EUniverse
Link copied to clipboard
open fun getStaticAccountKey(): Long
Returns a static account key used for grouping accounts with differing instances.
Link copied to clipboard
open fun hashCode(): Int
Returns a hash code for this instance.
Link copied to clipboard
open fun instancedSet(unAccountID: Long, unInstance: Long, eUniverse: EUniverse, eAccountType: EAccountType)
Sets the various components of this SteamID instance.
Link copied to clipboard
open fun isAnonAccount(): Boolean
Gets a value indicating whether this instance is an anonymous account.
Link copied to clipboard
open fun isAnonGameServerAccount(): Boolean
Gets a value indicating whether this instance is an anonymous game server account.
Link copied to clipboard
open fun isAnonUserAccount(): Boolean
Gets a value indicating whether this instance is an anonymous user account.
Link copied to clipboard
open fun isBlankAnonAccount(): Boolean
Gets a value indicating whether this instance is a game server account.
Link copied to clipboard
open fun isChatAccount(): Boolean
Gets a value indicating whether this instance is a chat account.
Link copied to clipboard
open fun isClanAccount(): Boolean
Gets a value indicating whether this instance is a clan account.
Link copied to clipboard
open fun isConsoleUserAccount(): Boolean
Gets a value indicating whether this instance is a console user account.
Link copied to clipboard
open fun isContentServerAccount(): Boolean
Gets a value indicating whether this instance is a content server account.
Link copied to clipboard
open fun isGameServerAccount(): Boolean
Gets a value indicating whether this instance is a game server account.
Link copied to clipboard
open fun isIndividualAccount(): Boolean
Gets a value indicating whether this instance is an individual account.
Link copied to clipboard
open fun isLobby(): Boolean
Gets a value indicating whether this instance is a lobby.
Link copied to clipboard
open fun isPersistentGameServerAccount(): Boolean
Gets a value indicating whether this instance is a persistent game server account.
Link copied to clipboard
open fun isValid(): Boolean
Gets a value indicating whether this instance is valid.
Link copied to clipboard
open fun render(): String
Renders this instance into it's Steam3 representation.
open fun render(steam3: Boolean): String
Renders this instance into it's Steam2 "STEAM_" or Steam3 representation.
Link copied to clipboard
open fun set(unAccountID: Long, eUniverse: EUniverse, eAccountType: EAccountType)
Sets the various components of this SteamID instance.
Link copied to clipboard
open fun setAccountID(accountID: Long)
Link copied to clipboard
open fun setAccountInstance(accountInstance: Long)
Link copied to clipboard
open fun setAccountType(accountType: EAccountType)
Link copied to clipboard
open fun setAccountUniverse(accountUniverse: EUniverse)
Link copied to clipboard
open fun setFromSteam3String(steamId: String): Boolean
Sets the various components of this SteamID from a Steam3 "[X:1:2:3]" rendered form and universe.
Link copied to clipboard
open fun setFromString(steamId: String, eUniverse: EUniverse): Boolean
Sets the various components of this SteamID from a Steam2 "STEAM_" rendered form and universe.
Link copied to clipboard
open fun setFromUInt64(longSteamId: Long)
Sets the various components of this SteamID from a 64bit integer form.
Link copied to clipboard
open fun toChatID(): SteamID
Converts this clan ID to a chat ID.
Link copied to clipboard
open fun toString(): String
Returns a java.lang.String that represents this instance.
Link copied to clipboard
open fun tryGetClanID(): SteamID
Converts this chat ID to a clan ID.