Package com.treescrub.spedran.data

Class Game

java.lang.Object

com.treescrub.spedran.data.Resource

com.treescrub.spedran.data.IdentifiableResource

com.treescrub.spedran.data.Game

public class Game
extends IdentifiableResource

A game which has a leaderboard on SRC.

This class is immutable and thread-safe.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Gets the unique shortened name that is used by SRC.
GameAssets	getAssets()	Gets the GameAssets for this game.
int	getBoostsReceived()	Gets the current boosts for this game on SRC.
GameCategoriesRequest	getCategories()	Gets a new GameCategoriesRequest builder object to request categories for this game.
Optional<Instant>	getCreationTime()	Returns an Instant with the time this game was added to SRC.
List<String>	getDevelopers()	Gets a List of developer IDs that developed this game.
Optional<String>	getDiscordLink()	Gets a Discord invite link to the official Discord server for this game, if it exists.
int	getDistinctBoosters()	Gets the number of unique supporters currently boosting this game.
List<String>	getEngines()	Gets a List of engine IDs that this game runs in.
List<String>	getGametypes()	Gets a List of all gametype IDs that describe this game.
List<String>	getGenres()	Gets a List of genre IDs that this game is in.
GameLevelsRequest	getLevels()	Gets a new GameLevelsRequest builder object to request levels for this game.
Map<String,ModeratorType>	getModerators()	Gets a Map of user IDs as keys and moderator types as values.
Names	getNames()	Gets a Names object with the names for this game.
List<String>	getPlatforms()	Gets a List of platform IDs that this game is on.
List<String>	getPublishers()	Gets a List of publisher IDs that published this game.
GameRecordsRequest	getRecords()	Gets a new GameRecordsRequest builder object to request records for this game.
List<String>	getRegions()	Gets a List of region IDs that this game is in.
LocalDate	getReleaseDate()	Gets the date when this game was released.
GameRomhacksRequest	getRomhacks()	Gets a new GameRomhacksRequest builder object to request romhacks (derived games) for this game.
Optional<GameRuleset>	getRuleset()	Gets a GameRuleset object with the game-wide rules.
RunsRequest	getRuns()	Gets a new RunsRequest builder object to request all runs for this game.
GameVariablesRequest	getVariables()	Gets a new GameVariablesRequest builder object to request variables for this game.
String	getWebLink()	Gets a link to this game on SRC.
String	toString()

Methods inherited from class com.treescrub.spedran.data.IdentifiableResource

equals, getId, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getRuns

public RunsRequest getRuns()

Gets a new RunsRequest builder object to request all runs for this game.

Returns:

a RunsRequest builder

getCategories

public GameCategoriesRequest getCategories()

Gets a new GameCategoriesRequest builder object to request categories for this game.

Returns:

a GameCategoriesRequest builder

getLevels

public GameLevelsRequest getLevels()

Gets a new GameLevelsRequest builder object to request levels for this game.

Returns:

a GameLevelsRequest builder

getRecords

public GameRecordsRequest getRecords()

Gets a new GameRecordsRequest builder object to request records for this game.

Returns:

a GameRecordsRequest builder

getRomhacks

public GameRomhacksRequest getRomhacks()

Gets a new GameRomhacksRequest builder object to request romhacks (derived games) for this game.

Returns:

a GameRomhacksRequest builder

getVariables

public GameVariablesRequest getVariables()

Gets a new GameVariablesRequest builder object to request variables for this game.

Returns:

a GameVariablesRequest builder

getNames

public Names getNames()

Gets a Names object with the names for this game.

Returns:

a Names of this game's names

getBoostsReceived

public int getBoostsReceived()

Gets the current boosts for this game on SRC.

Returns:

current boosts used on this game

See Also:

SRC Supporter FAQ

getDistinctBoosters

public int getDistinctBoosters()

Gets the number of unique supporters currently boosting this game.

Returns:

total unique users that have boosted this game

See Also:

SRC Supporter FAQ

getAbbreviation

public String getAbbreviation()

Gets the unique shortened name that is used by SRC.

Returns:

the shortened game title

getWebLink

public String getWebLink()

Gets a link to this game on SRC.

Returns:

a link to this game on SRC

getDiscordLink

public Optional<String> getDiscordLink()

Gets a Discord invite link to the official Discord server for this game, if it exists.

Returns:

an Optional with an invitation link to this game's Discord server

getReleaseDate

public LocalDate getReleaseDate()

Gets the date when this game was released.

Returns:

a LocalDate describing when this game was released

getRuleset

public Optional<GameRuleset> getRuleset()

Gets a GameRuleset object with the game-wide rules.

Returns:

an Optional with a GameRuleset

getGametypes

public List<String> getGametypes()

Gets a List of all gametype IDs that describe this game.

Returns:

an unmodifiable List of gametype IDs

See Also:

Gametype, Spedran.getGametype(String)

getPlatforms

public List<String> getPlatforms()

Gets a List of platform IDs that this game is on.

Returns:

an unmodifiable List of platform IDs

See Also:

Platform, Spedran.getPlatform(String)

getRegions

public List<String> getRegions()

Gets a List of region IDs that this game is in.

Returns:

an unmodifiable List of region IDs

See Also:

Region, Spedran.getRegion(String)

getGenres

public List<String> getGenres()

Gets a List of genre IDs that this game is in.

Returns:

an unmodifiable List of genre IDs

See Also:

Genre, Spedran.getGenre(String)

getEngines

public List<String> getEngines()

Gets a List of engine IDs that this game runs in.

Returns:

an unmodifiable List of engine IDs

See Also:

Engine, Spedran.getEngine(String)

getDevelopers

public List<String> getDevelopers()

Gets a List of developer IDs that developed this game.

Returns:

an unmodifiable List of developer IDs

See Also:

Developer, Spedran.getDeveloper(String)

getPublishers

public List<String> getPublishers()

Gets a List of publisher IDs that published this game.

Returns:

an unmodifiable List of publisher IDs

See Also:

Publisher, Spedran.getPublisher(String)

getModerators

public Map<String,ModeratorType> getModerators()

Gets a Map of user IDs as keys and moderator types as values.

Returns:

an unmodifiable Map of user IDs to moderator types

See Also:

User, Spedran.getUser(String)

getCreationTime

public Optional<Instant> getCreationTime()

Returns an Instant with the time this game was added to SRC.

Games added before this field was implemented will return an empty Optional.

Returns:

an Optional with an Instant describing when this game was added to SRC

getAssets

public GameAssets getAssets()

Gets the GameAssets for this game.

Returns:

a GameAssets object

toString

public String toString()

Overrides:

toString in class Object