uk.co.thomasc.steamkit.types.gameid

Class GameID

java.lang.Object

uk.co.thomasc.steamkit.types.gameid.GameID

public class GameID
extends Object

This 64bit structure represents an app, mod, shortcut, or p2p file on the Steam network.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) BitVector64	gameId

Constructor Summary

Constructors

Constructor and Description
GameID() Initializes a new instance of the GameID class.
GameID(int nAppID) Initializes a new instance of the GameID class.
GameID(long id) Initializes a new instance of the GameID class.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Determines whether the specified Object is equal to this instance.
long	getAppID() Gets the app id.
GameType	getAppType() Gets the type of the app.
long	getModID() Gets the mod id.
int	hashCode() Returns a hash code for this instance.
boolean	isMod() Gets a value indicating whether this instance is a mod.
boolean	IsP2PFile() Gets a value indicating whether this instance is a peer-to-peer file.
boolean	isShortcut() Gets a value indicating whether this instance is a shortcut.
boolean	IsSteamApp() Gets a value indicating whether this instance is a steam app.
void	set(long gameId) Sets the various components of this GameID from a 64bit integer form.
void	setAppID(long appID) Gets the app id.
void	setAppType(GameType appType) Sets the type of the app.
void	setModID(long modID) Sets the mod id.
long	toLong() Converts this GameID into it's 64bit integer form.
String	toString() Performs an implicit conversion from GameID to String.

Methods inherited from class java.lang.Object

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

Field Detail

gameId

BitVector64 gameId

Constructor Detail

GameID

public GameID()

Initializes a new instance of the GameID class.

GameID

public GameID(long id)

Initializes a new instance of the GameID class.

Parameters:

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

GameID

public GameID(int nAppID)

Initializes a new instance of the GameID class.

Parameters:

nAppID - The 32bit app id to assign this GameID from.

Method Detail

set

public void set(long gameId)

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

Parameters:

gameId - The 64bit integer to assign this GameID from.

toLong

public long toLong()

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

Returns:

A 64bit integer representing this GameID.

toString

public String toString()

Performs an implicit conversion from GameID to String.

Overrides:

toString in class Object

getAppID

public long getAppID()

Gets the app id.

Returns:

The app IDid

setAppID

public void setAppID(long appID)

Gets the app id.

Parameters:

appID - The app IDid

getAppType

public GameType getAppType()

Gets the type of the app.

Returns:

The type of the app.

setAppType

public void setAppType(GameType appType)

Sets the type of the app.

Parameters:

appType - The type of the app.

getModID

public long getModID()

Gets the mod id.

Returns:

The mod ID.

setModID

public void setModID(long modID)

Sets the mod id.

Parameters:

modID - The mod ID.

isMod

public boolean isMod()

Gets a value indicating whether this instance is a mod.

Returns:

true if this instance is a mod; otherwise, false

isShortcut

public boolean isShortcut()

Gets a value indicating whether this instance is a shortcut.

Returns:

true if this instance is a shortcut; otherwise, false

IsP2PFile

public boolean IsP2PFile()

Gets a value indicating whether this instance is a peer-to-peer file.

Returns:

true if this instance is a p2p file; otherwise, false

IsSteamApp

public boolean IsSteamApp()

Gets a value indicating whether this instance is a steam app.

Returns:

true if this instance is a steam app; otherwise, false

equals

public boolean equals(Object obj)

Determines whether the specified Object is equal to this instance.

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class Object