A B C D E F G H I K L M N O P R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- abbreviation(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the abbreviation to filter for.
- abbreviation(String) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Search for an exact game abbreviation.
- abbreviation(String) - Method in class com.treescrub.spedran.requests.builders.series.AllSeriesRequest
-
Search for an exact series abbreviation.
- abbreviation(String) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Search for an exact game abbreviation.
- addGuest(Guest) - Method in class com.treescrub.spedran.requests.builders.run.RunPlayersRequest
- addGuest(String) - Method in class com.treescrub.spedran.requests.builders.run.RunPlayersRequest
- addUser(User) - Method in class com.treescrub.spedran.requests.builders.run.RunPlayersRequest
- addUser(String) - Method in class com.treescrub.spedran.requests.builders.run.RunPlayersRequest
- ADMIN - com.treescrub.spedran.data.UserRole
-
SRC site admin.
- ALL_LEVELS - com.treescrub.spedran.data.VariableScope.ScopeType
-
Applies to runs that do have levels.
- AllSeriesRequest - Class in com.treescrub.spedran.requests.builders.series
-
A request builder to get all
Seriesmatching the set filters. - AllSeriesRequest() - Constructor for class com.treescrub.spedran.requests.builders.series.AllSeriesRequest
- areEmulatorsAllowed() - Method in class com.treescrub.spedran.data.GameRuleset
-
Returns
trueif emulators are allowed to be used in runs, otherwisefalse. - areMillisecondsShown() - Method in class com.treescrub.spedran.data.GameRuleset
-
Returns
trueif milliseconds are shown on the leaderboard, otherwisefalse. - asBulk() - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
- asBulk() - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
- ASCENDING - com.treescrub.spedran.requests.SortDirection
-
The list will be sorted from the lowest values at the start of the list to the highest at the end of the list.
B
- BANNED - com.treescrub.spedran.data.UserRole
-
The user is currently banned, either temporarily or permanently.
- beforeDate(String) - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Restricts the results to runs done before or on this date.
C
- category(Category) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs played in the given
Category. - category(Category) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the
Categoryfor the run. - category(String) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs played in the given
Category. - category(String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the
Categoryfor the run. - Category - Class in com.treescrub.spedran.data
-
A category of runs which has its own specific rules.
- CategoryPlayers - Class in com.treescrub.spedran.data
-
Contains the rules for how many players can participate in the category.
- CategoryRecordsRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get the top runs of a
Category. - CategoryRecordsRequest(Category) - Constructor for class com.treescrub.spedran.requests.builders.CategoryRecordsRequest
- CategoryRecordsRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.CategoryRecordsRequest
- CategoryRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Category. - CategoryRequest(Category) - Constructor for class com.treescrub.spedran.requests.builders.CategoryRequest
- CategoryRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.CategoryRequest
- CategoryVariablesRequest - Class in com.treescrub.spedran.requests.builders
- CategoryVariablesRequest(Category) - Constructor for class com.treescrub.spedran.requests.builders.CategoryVariablesRequest
- CategoryVariablesRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.CategoryVariablesRequest
- clearApiKey() - Static method in class com.treescrub.spedran.Spedran
-
Clears the current API key.
- com.treescrub.spedran - package com.treescrub.spedran
- com.treescrub.spedran.data - package com.treescrub.spedran.data
-
Contains all the classes that represent resources on the SRC API.
- com.treescrub.spedran.requests - package com.treescrub.spedran.requests
- com.treescrub.spedran.requests.builders - package com.treescrub.spedran.requests.builders
-
All request builders to get resources from the SRC API.
- com.treescrub.spedran.requests.builders.game - package com.treescrub.spedran.requests.builders.game
- com.treescrub.spedran.requests.builders.run - package com.treescrub.spedran.requests.builders.run
- com.treescrub.spedran.requests.builders.series - package com.treescrub.spedran.requests.builders.series
- com.treescrub.spedran.requests.builders.user - package com.treescrub.spedran.requests.builders.user
- comment(String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the comment/description for the run.
- complete() - Method in class com.treescrub.spedran.ModifyResourceRequest
- complete() - Method in class com.treescrub.spedran.ResourceCollectionRequest
-
Starts executing the request and returns a
CompletableFuturethat will complete with the resulting list of resource objects. - complete() - Method in class com.treescrub.spedran.SingleResourceRequest
-
Starts executing the request and returns a
CompletableFuturethat will complete with the resulting resource object. - customVariable(Variable, String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the value for a
Variablewith custom user defined text. - customVariable(String, String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the value for a
Variablewith custom user defined text.
D
- date(LocalDate) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the date that this run was played on.
- delete() - Method in class com.treescrub.spedran.data.Run
-
Gets a new
DeleteRunRequestbuilder to delete this run from SRC. - deleteRun(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
DeleteRunRequestbuilder to delete aRun. - DeleteRunRequest - Class in com.treescrub.spedran.requests.builders.run
-
A request builder to delete a
Runfrom SRC. - DeleteRunRequest(Run) - Constructor for class com.treescrub.spedran.requests.builders.run.DeleteRunRequest
- DeleteRunRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.run.DeleteRunRequest
- DESCENDING - com.treescrub.spedran.requests.SortDirection
-
The list will be sorted from the highest values at the start of the list to the lowest at the end of the list.
- developer(Developer) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the developer to filter for.
- developer(Developer) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Developer. - developer(Developer) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Developer. - developer(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the developer to filter for.
- developer(String) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Developer. - developer(String) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Developer. - Developer - Class in com.treescrub.spedran.data
-
The developer of a game.
- DeveloperRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Developer. - DeveloperRequest(Developer) - Constructor for class com.treescrub.spedran.requests.builders.DeveloperRequest
- DeveloperRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.DeveloperRequest
- DevelopersRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get all
Developers matching the set filters. - DevelopersRequest() - Constructor for class com.treescrub.spedran.requests.builders.DevelopersRequest
- disableCache() - Static method in class com.treescrub.spedran.Spedran
-
Disable request caching.
E
- emulated(boolean) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs that are on emulators, or runs that are not on an emulator.
- emulated(boolean) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets whether the run was played on an emulator.
- enableCache() - Static method in class com.treescrub.spedran.Spedran
-
Enable request caching.
- engine(Engine) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the engine to filter for.
- engine(Engine) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Engine. - engine(Engine) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Engine. - engine(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the engine to filter for.
- engine(String) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Engine. - engine(String) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Engine. - Engine - Class in com.treescrub.spedran.data
-
The game engine used in a game.
- EngineRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Engine. - EngineRequest(Engine) - Constructor for class com.treescrub.spedran.requests.builders.EngineRequest
- EngineRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.EngineRequest
- EnginesRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get all
Engines matching the set filters. - EnginesRequest() - Constructor for class com.treescrub.spedran.requests.builders.EnginesRequest
- equals(Object) - Method in class com.treescrub.spedran.data.Guest
- equals(Object) - Method in class com.treescrub.spedran.data.IdentifiableResource
- equals(Object) - Method in class com.treescrub.spedran.data.LocationInfo
F
- FULL_GAME - com.treescrub.spedran.data.VariableScope.ScopeType
-
Applies only to runs that don't have levels.
G
- game(Game) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs in the given
Game. - game(String) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs in the given
Game. - game(String) - Method in class com.treescrub.spedran.requests.builders.user.UserPBsRequest
-
Restricts the results to the given
Game. - Game - Class in com.treescrub.spedran.data
-
A game which has a leaderboard on SRC.
- GameAssets - Class in com.treescrub.spedran.data
- GameCategoriesRequest - Class in com.treescrub.spedran.requests.builders.game
- GameCategoriesRequest(Game) - Constructor for class com.treescrub.spedran.requests.builders.game.GameCategoriesRequest
- GameCategoriesRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.game.GameCategoriesRequest
- GameLevelsRequest - Class in com.treescrub.spedran.requests.builders.game
- GameLevelsRequest(Game) - Constructor for class com.treescrub.spedran.requests.builders.game.GameLevelsRequest
- GameLevelsRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.game.GameLevelsRequest
- GameRecordsRequest - Class in com.treescrub.spedran.requests.builders.game
-
A request builder to get records for a given
Game. - GameRecordsRequest(Game) - Constructor for class com.treescrub.spedran.requests.builders.game.GameRecordsRequest
- GameRecordsRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.game.GameRecordsRequest
- GameRequest - Class in com.treescrub.spedran.requests.builders.game
-
A request builder to get a single
Game. - GameRequest(Game) - Constructor for class com.treescrub.spedran.requests.builders.game.GameRequest
- GameRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.game.GameRequest
- GameRomhacksRequest - Class in com.treescrub.spedran.requests.builders.game
-
A request builder to get all derived
Games (romhacks) for a givenGame. - GameRomhacksRequest(Game) - Constructor for class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
- GameRomhacksRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
- GameRuleset - Class in com.treescrub.spedran.data
-
A set of moderator specified rules that define how runs can be submitted for a specific
Game. - GamesRequest - Class in com.treescrub.spedran.requests.builders.game
-
A request builder to get all
Games matching the set filters. - GamesRequest() - Constructor for class com.treescrub.spedran.requests.builders.game.GamesRequest
- gameType(Gametype) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the gametype to filter for.
- gameType(Gametype) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Gametype. - gameType(Gametype) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Gametype. - gameType(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the gametype to filter for.
- gameType(String) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Gametype. - gameType(String) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Gametype. - Gametype - Class in com.treescrub.spedran.data
-
Represents different types of unofficial games.
- GametypeRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Gametype. - GametypeRequest(Gametype) - Constructor for class com.treescrub.spedran.requests.builders.GametypeRequest
- GametypeRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.GametypeRequest
- GametypesRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get all
Gametypes matching the set filters. - GametypesRequest() - Constructor for class com.treescrub.spedran.requests.builders.GametypesRequest
- GameVariablesRequest - Class in com.treescrub.spedran.requests.builders.game
- GameVariablesRequest(Game) - Constructor for class com.treescrub.spedran.requests.builders.game.GameVariablesRequest
- GameVariablesRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.game.GameVariablesRequest
- genre(Genre) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the genre to filter for.
- genre(Genre) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Genre. - genre(Genre) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Genre. - genre(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the genre to filter for.
- genre(String) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Genre. - genre(String) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Genre. - Genre - Class in com.treescrub.spedran.data
-
A genre of game.
- GenreRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Genre. - GenreRequest(Genre) - Constructor for class com.treescrub.spedran.requests.builders.GenreRequest
- GenreRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.GenreRequest
- GenresRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get all
Genres matching the set filters. - GenresRequest() - Constructor for class com.treescrub.spedran.requests.builders.GenresRequest
- getAbbreviation() - Method in class com.treescrub.spedran.data.Game
-
Gets the unique shortened name that is used by SRC.
- getAbbreviation() - Method in class com.treescrub.spedran.data.Series
-
Gets the abbreviation for this series as used on SRC.
- getAssets() - Method in class com.treescrub.spedran.data.Game
-
Gets the
GameAssetsfor this game. - getAssets() - Method in class com.treescrub.spedran.data.Series
-
Gets the
GameAssetsfor this series. - getAssets() - Method in class com.treescrub.spedran.data.User
-
Gets the
UserAssetsfor this user. - getAvatar() - Method in class com.treescrub.spedran.data.UserAssets
-
Gets a
Linkto the user's custom avatar. - getBackground() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the background image. - getBoostsReceived() - Method in class com.treescrub.spedran.data.Game
-
Gets the current boosts for this game on SRC.
- getCategories() - Method in class com.treescrub.spedran.data.Game
-
Gets a new
GameCategoriesRequestbuilder object to request categories for this game. - getCategories() - Method in class com.treescrub.spedran.data.Level
-
Gets a new
LevelCategoriesRequestbuilder object to request categories for this level. - getCategory() - Method in class com.treescrub.spedran.data.Leaderboard
-
Gets the category ID for this leaderboard.
- getCategory() - Method in class com.treescrub.spedran.data.Run
-
Returns a String containing the ID of this run's category.
- getCategory() - Method in class com.treescrub.spedran.data.Variable
-
Gets the category ID that this variable applies to.
- getCategory(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Categorythat corresponds to the providedidasynchronously. - getCategoryRecords(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
CategoryRecordsRequestbuilder to request the records for the specifiedCategory. - getCategoryVariables(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
CategoryVariablesRequestbuilder to request all the variables for the specifiedCategory. - getCode() - Method in class com.treescrub.spedran.data.LocationInfo
-
Gets the code for this location.
- getColor() - Method in class com.treescrub.spedran.data.NameStyle
-
Gets the color when
NameStyle.getStyle()isNameStyle.Style.SOLID. - getComment() - Method in class com.treescrub.spedran.data.Run
-
Gets the description of this run.
- getCountry() - Method in class com.treescrub.spedran.data.UserLocation
-
Gets the
LocationInfofor the country. - getCreationTime() - Method in class com.treescrub.spedran.data.Game
-
Returns an
Instantwith the time this game was added to SRC. - getCreationTime() - Method in class com.treescrub.spedran.data.Notification
-
Gets the time that the notification was created.
- getCreationTime() - Method in class com.treescrub.spedran.data.Series
-
Gets the time that this series was created on SRC.
- getDark() - Method in class com.treescrub.spedran.data.NameColor
-
Gets the color for use on dark backgrounds.
- getDateRan() - Method in class com.treescrub.spedran.data.Run
-
Returns the
LocalDatethat this run was actually ran. - getDefaultTime() - Method in class com.treescrub.spedran.data.GameRuleset
-
Gets the default
TimingTypethat this game uses to sort the leaderboard by. - getDefaultValue() - Method in class com.treescrub.spedran.data.Variable
-
Gets the default value ID for this variable.
- getDeveloper(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Developerthat corresponds to the providedidasynchronously. - getDevelopers() - Method in class com.treescrub.spedran.data.Game
-
Gets a
Listof developer IDs that developed this game. - getDevelopers() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
DevelopersRequestbuilder to request allDevelopers. - getDiscord() - Method in class com.treescrub.spedran.data.Series
-
Gets the Discord invite link for the Discord server dedicated to this series.
- getDiscordLink() - Method in class com.treescrub.spedran.data.Game
-
Gets a Discord invite link to the official Discord server for this game, if it exists.
- getDistinctBoosters() - Method in class com.treescrub.spedran.data.Game
-
Gets the number of unique supporters currently boosting this game.
- getEmulators() - Method in class com.treescrub.spedran.data.Leaderboard
-
Gets whether runs using an emulator were filtered out.
- getEndColor() - Method in class com.treescrub.spedran.data.NameStyle
-
Gets the end or rightmost color when
NameStyle.getStyle()isNameStyle.Style.GRADIENT. - getEngine(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Enginethat corresponds to the providedidasynchronously. - getEngines() - Method in class com.treescrub.spedran.data.Game
-
Gets a
Listof engine IDs that this game runs in. - getEngines() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
EnginesRequestbuilder to request allEngines. - getExaminer() - Method in class com.treescrub.spedran.data.RunStatus
-
Gets the ID of the verifier.
- getFirstTrophy() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the trophy icon that is shown next to the first place run. - getFlags() - Method in class com.treescrub.spedran.data.VariableValue
-
Gets a
Mapof flags. - getForeground() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the foreground image. - getFourthTrophy() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the trophy icon that is shown next to the fourth place run. - getGame() - Method in class com.treescrub.spedran.data.Leaderboard
-
Gets the game ID for this leaderboard.
- getGame() - Method in class com.treescrub.spedran.data.Run
-
Returns a String containing the ID of this run's game.
- getGame(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Gamethat corresponds to the providedidasynchronously. - getGameCategories(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
GameCategoriesRequestbuilder to request the categories for the specifiedGame. - getGameLevels(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
GameLevelsRequestbuilder to request the levels for the specifiedGame. - getGameRecords(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
GameRecordsRequestbuilder to request the records for the specifiedGame. - getGameRomhacks(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
GameRomhacksRequestbuilder to request the romhacks of the specifiedGame. - getGames() - Method in class com.treescrub.spedran.data.Developer
-
Gets a new
GamesRequestbuilder object to request all the games developed by this developer. - getGames() - Method in class com.treescrub.spedran.data.Engine
-
Gets a new
GamesRequestbuilder object to request all the games using this game engine. - getGames() - Method in class com.treescrub.spedran.data.Gametype
-
Gets a new
GamesRequestbuilder object to request all the games that fall under this gametype. - getGames() - Method in class com.treescrub.spedran.data.Genre
-
Gets a new
GamesRequestbuilder object to request all the games that are in this genre. - getGames() - Method in class com.treescrub.spedran.data.Platform
-
Gets a new
GamesRequestbuilder object to request all games that are on this platform. - getGames() - Method in class com.treescrub.spedran.data.Publisher
-
Gets a new
GamesRequestbuilder object to request all games that were published by this publisher. - getGames() - Method in class com.treescrub.spedran.data.Region
-
Gets a new
GamesRequestbuilder object to request all games that use this region. - getGames() - Method in class com.treescrub.spedran.data.Series
-
Gets a new
SeriesGamesRequestbuilder object to request games that are part of this series. - getGames() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
GamesRequestbuilder to request allGames matching the specified criteria. - getGamesModerated() - Method in class com.treescrub.spedran.data.User
-
Gets a new
GamesRequestbuilder object to request all the games this user moderates. - getGametype(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Gametypethat corresponds to the providedidasynchronously. - getGametypes() - Method in class com.treescrub.spedran.data.Game
-
Gets a
Listof all gametype IDs that describe this game. - getGametypes() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
GametypesRequestbuilder to request allGametypes. - getGameVariables(String) - Static method in class com.treescrub.spedran.Spedran
- getGenre(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Genrethat corresponds to the providedidasynchronously. - getGenres() - Method in class com.treescrub.spedran.data.Game
-
Gets a
Listof genre IDs that this game is in. - getGenres() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
GenresRequestbuilder to request allGenres. - getGuest(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Guestthat corresponds to the providednameasynchronously. - getHitboxLink() - Method in class com.treescrub.spedran.data.User
-
Gets the link to this user's Hitbox account.
- getIcon() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the icon that is shown on the browser tab. - getIcon() - Method in class com.treescrub.spedran.data.UserAssets
-
Gets a
Linkto the user's custom icon. - getId() - Method in class com.treescrub.spedran.data.IdentifiableResource
-
Gets the ID for this resource.
- getId() - Method in class com.treescrub.spedran.data.RunPlayer
- getIngameTime() - Method in class com.treescrub.spedran.data.RunTimes
-
Gets the in-game time of this run.
- getInternationalName() - Method in class com.treescrub.spedran.data.Names
-
Gets the international name for this item.
- getItemLink() - Method in class com.treescrub.spedran.data.Notification
-
Gets a link with the type of notification and URL of the relevant page.
- getJapaneseName() - Method in class com.treescrub.spedran.data.Names
-
Gets the Japanese name for this item.
- getLabel() - Method in class com.treescrub.spedran.data.VariableValue
-
Gets the label for this value.
- getLargeCover() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the "large" size version of the cover art for the game or series. - getLeaderboard(Game, Category) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
LeaderboardRequestbuilder to request a specificLeaderboard. - getLeaderboard(Game, Category, Level) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
LeaderboardRequestbuilder to request a specificLeaderboard. - getLeaderboard(String, String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
LeaderboardRequestbuilder to request a specificLeaderboard. - getLeaderboard(String, String, String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
LeaderboardRequestbuilder to request a specificLeaderboard. - getLevel() - Method in class com.treescrub.spedran.data.Leaderboard
-
Gets the level ID as an
Optional. - getLevel() - Method in class com.treescrub.spedran.data.Run
-
Returns an
OptionalString containing the ID of this run's level. - getLevel() - Method in class com.treescrub.spedran.data.VariableScope
-
Gets the associated level ID if the scope type is
VariableScope.ScopeType.SINGLE_LEVEL. - getLevel(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Levelthat corresponds to the providedidasynchronously. - getLevelCategories(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
LevelCategoriesRequestbuilder to request all applicable categories for the specifiedLevel. - getLevelRecords(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
LevelRecordsRequestbuilder to request the records for the specifiedLevel. - getLevels() - Method in class com.treescrub.spedran.data.Game
-
Gets a new
GameLevelsRequestbuilder object to request levels for this game. - getLevelVariables(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
LevelVariablesRequestbuilder to request all the variables for the specifiedLevel. - getLight() - Method in class com.treescrub.spedran.data.NameColor
-
Gets the color for use on light backgrounds.
- getLinks() - Method in class com.treescrub.spedran.data.RunVideos
-
Gets the video links mentioned in the run.
- getLocation() - Method in class com.treescrub.spedran.data.User
-
Gets the location that this user specified.
- getLogo() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the Speedrun.com logo at the top left. - getMediumCover() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the "medium" size version of the cover art for the game or series. - getModerators() - Method in class com.treescrub.spedran.data.Game
-
Gets a
Mapof user IDs as keys and moderator types as values. - getModerators() - Method in class com.treescrub.spedran.data.Series
-
Gets a
Mapof user IDs as keys and moderator types as values. - getMultipleSeries() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
AllSeriesRequestbuilder to request allSeriess. - getName() - Method in class com.treescrub.spedran.data.Guest
-
Gets the username for this guest.
- getName() - Method in class com.treescrub.spedran.data.IdentifiableNamedResource
-
Gets the name for this resource.
- getNames() - Method in class com.treescrub.spedran.data.Game
-
Gets a
Namesobject with the names for this game. - getNames() - Method in class com.treescrub.spedran.data.LocationInfo
-
Gets the
Namesfor this location. - getNames() - Method in class com.treescrub.spedran.data.Series
-
Gets the
Namesfor this series. - getNames() - Method in class com.treescrub.spedran.data.User
-
Gets the
Namesfor this user. - getNameStyle() - Method in class com.treescrub.spedran.data.User
-
Gets the
NameStylefor this user. - getNotifications() - Static method in class com.treescrub.spedran.Spedran
-
Gets all of the
Notifications for the currently authenticated user. - getNotificationText() - Method in class com.treescrub.spedran.data.Notification
-
Gets the text of the notification.
- getPersonalBests() - Method in class com.treescrub.spedran.data.User
-
Gets a new
UserPBsRequestbuilder object to request this user's personal best runs. - getPlace() - Method in class com.treescrub.spedran.data.LeaderboardRun
-
Gets the ranking/place of the run.
- getPlatform() - Method in class com.treescrub.spedran.data.Leaderboard
-
Gets the platform ID as an
Optional. - getPlatform() - Method in class com.treescrub.spedran.data.RunSystem
-
Gets the platform ID that this run was played on
- getPlatform(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Platformthat corresponds to the providedidasynchronously. - getPlatforms() - Method in class com.treescrub.spedran.data.Game
-
Gets a
Listof platform IDs that this game is on. - getPlatforms() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
PlatformsRequestbuilder to request allPlatforms. - getPlayers() - Method in class com.treescrub.spedran.data.Category
-
Gets the player count restriction for this category.
- getPlayers() - Method in class com.treescrub.spedran.data.CategoryPlayers
-
Gets the number of allowed players.
- getPlayers() - Method in class com.treescrub.spedran.data.Run
-
Gets a
Listof the runners of this run. - getPrimaryTime() - Method in class com.treescrub.spedran.data.RunTimes
-
Gets the primary or default time of this run.
- getProfile() - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Userthat owns the current API key. - getPronouns() - Method in class com.treescrub.spedran.data.User
-
Gets the user specified pronouns for this user.
- getPublisher(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Publisherthat corresponds to the providedidasynchronously. - getPublishers() - Method in class com.treescrub.spedran.data.Game
-
Gets a
Listof publisher IDs that published this game. - getPublishers() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
PublishersRequestbuilder to request allPublishers. - getRealNoLoadsTime() - Method in class com.treescrub.spedran.data.RunTimes
-
Gets the real with loads removed time of this run.
- getRealTime() - Method in class com.treescrub.spedran.data.RunTimes
-
Gets the real time of this run.
- getReason() - Method in class com.treescrub.spedran.data.RunStatus
-
Gets the verifier supplied reason for rejection.
- getRecords() - Method in class com.treescrub.spedran.data.Category
-
Gets a new
CategoryRecordsRequestbuilder object to request records for this category. - getRecords() - Method in class com.treescrub.spedran.data.Game
-
Gets a new
GameRecordsRequestbuilder object to request records for this game. - getRecords() - Method in class com.treescrub.spedran.data.Level
-
Gets a new
LevelRecordsRequestbuilder object to request records for this level. - getRegion() - Method in class com.treescrub.spedran.data.Leaderboard
-
Gets the region ID as an
Optional. - getRegion() - Method in class com.treescrub.spedran.data.RunSystem
-
Gets the region ID that this run was played on
- getRegion() - Method in class com.treescrub.spedran.data.UserLocation
-
Gets the
LocationInfofor the region of the country. - getRegion(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Regionthat corresponds to the providedidasynchronously. - getRegions() - Method in class com.treescrub.spedran.data.Game
-
Gets a
Listof region IDs that this game is in. - getRegions() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
RegionsRequestbuilder to request allRegions. - getRelation() - Method in class com.treescrub.spedran.data.Link
-
Gets the relation for this link.
- getReleaseDate() - Method in class com.treescrub.spedran.data.Game
-
Gets the date when this game was released.
- getReleaseYear() - Method in class com.treescrub.spedran.data.Platform
-
Gets the year that this platform was released.
- getRole() - Method in class com.treescrub.spedran.data.User
-
Gets the role of this user across the entire site.
- getRomhacks() - Method in class com.treescrub.spedran.data.Game
-
Gets a new
GameRomhacksRequestbuilder object to request romhacks (derived games) for this game. - getRules() - Method in class com.treescrub.spedran.data.Category
-
Gets the moderator defined rules text for this category.
- getRules() - Method in class com.treescrub.spedran.data.Level
-
Gets the rules text for this level.
- getRules() - Method in class com.treescrub.spedran.data.VariableValue
-
Gets the rules text if the variable is marked as a subcategory.
- getRuleset() - Method in class com.treescrub.spedran.data.Game
-
Gets a
GameRulesetobject with the game-wide rules. - getRun() - Method in class com.treescrub.spedran.data.LeaderboardRun
-
Gets the associated run.
- getRun(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Runthat corresponds to the providedidasynchronously. - getRuns() - Method in class com.treescrub.spedran.data.Category
-
Gets a new
RunsRequestbuilder object to request all runs in this category. - getRuns() - Method in class com.treescrub.spedran.data.Game
-
Gets a new
RunsRequestbuilder object to request all runs for this game. - getRuns() - Method in class com.treescrub.spedran.data.Guest
-
Gets a new
RunsRequestbuilder object to request all the runs that this guest participated in. - getRuns() - Method in class com.treescrub.spedran.data.Leaderboard
-
Gets all runs on the leaderboard.
- getRuns() - Method in class com.treescrub.spedran.data.Level
-
Gets a new
RunsRequestbuilder object to request all runs on this level. - getRuns() - Method in class com.treescrub.spedran.data.Platform
-
Gets a new
RunsRequestbuilder object to request all runs that are on this platform. - getRuns() - Method in class com.treescrub.spedran.data.Region
-
Gets a new
RunsRequestbuilder object to request all runs that are played in this region. - getRuns() - Method in class com.treescrub.spedran.data.User
-
Gets a new
RunsRequestbuilder object to request all of this user's runs. - getRuns() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
RunsRequestbuilder to request allRuns matching the specified criteria. - getRunTimes() - Method in class com.treescrub.spedran.data.GameRuleset
-
Gets a
Listof allowedTimingTypes that a run can have. - getRunTimes() - Method in class com.treescrub.spedran.data.Run
-
Gets the times for this run in each timing category.
- getScope() - Method in class com.treescrub.spedran.data.Variable
-
Gets the
VariableScopewhere this variable is usable. - getSecondTrophy() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the trophy icon that is shown next to the second place run. - getSeriesGames(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
SeriesGamesRequestbuilder to request the games in the specifiedSeries. - getSignupTime() - Method in class com.treescrub.spedran.data.User
-
Gets the time that this user signed up on SRC.
- getSingleSeries(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Seriesthat corresponds to the providedidasynchronously. - getSmallCover() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the "small" size version of the cover art for the game or series. - getSpeedrunsLiveLink() - Method in class com.treescrub.spedran.data.User
-
Gets the link to this user's SpeedRunsLive account.
- getSplits() - Method in class com.treescrub.spedran.data.Run
-
Gets a link to the API of a splits hosting site.
- getStartColor() - Method in class com.treescrub.spedran.data.NameStyle
-
Gets the start or leftmost color when
NameStyle.getStyle()isNameStyle.Style.GRADIENT. - getStatus() - Method in class com.treescrub.spedran.data.Notification
-
Gets the current status of the notification.
- getStatus() - Method in class com.treescrub.spedran.data.Run
-
Gets the current verification status of this run.
- getStatus() - Method in class com.treescrub.spedran.data.RunStatus
-
Gets the submission status type.
- getStyle() - Method in class com.treescrub.spedran.data.NameStyle
-
Gets the style of the name.
- getSubmitTime() - Method in class com.treescrub.spedran.data.Run
-
Returns the
Instantthat this run was submitted to SRC. - getSupporterIcon() - Method in class com.treescrub.spedran.data.UserAssets
-
Gets a
Linkto the user's custom supporter icon. - getSystem() - Method in class com.treescrub.spedran.data.Run
-
Gets the system that this run was played on.
- getText() - Method in class com.treescrub.spedran.data.RunVideos
-
Gets the full text of the main video section if it contains more than just a video link.
- getThirdTrophy() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the trophy icon that is shown next to the third place run. - getTiming() - Method in class com.treescrub.spedran.data.Leaderboard
-
Gets the
TimingTypethat was used to sort the runs fromLeaderboard.getRuns(). - getTinyCover() - Method in class com.treescrub.spedran.data.GameAssets
-
Gets a
Linkto the "tiny" size version of the cover art for the game or series. - getTwitchLink() - Method in class com.treescrub.spedran.data.User
-
Gets the link to this user's Twitch account.
- getTwitchName() - Method in class com.treescrub.spedran.data.Names
-
Gets the Twitch (as in the streaming site) name for this item.
- getTwitterLink() - Method in class com.treescrub.spedran.data.User
-
Gets the link to this user's Twitter account.
- getType() - Method in class com.treescrub.spedran.data.VariableScope
-
Gets the
VariableScope.ScopeTypefor the variable. - getURI() - Method in class com.treescrub.spedran.data.Link
-
Gets the URI for this link.
- getUser(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Userthat corresponds to the providedidasynchronously. - getUserPBs(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
UserPBsRequestbuilder to request the personal best runs for the specifiedUser. - getUsers() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
UsersRequestbuilder to request allUsers matching the specified criteria. - getValues() - Method in class com.treescrub.spedran.data.Leaderboard
-
Gets a mapping of variable IDs to variable value IDs.
- getValues() - Method in class com.treescrub.spedran.data.Variable
-
Gets a
Mapto map variable value IDs to aVariableValue. - getVariable(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets the
Variablethat corresponds to the providedidasynchronously. - getVariables() - Method in class com.treescrub.spedran.data.Category
-
Gets a new
CategoryVariablesRequestbuilder object to request variables for this category. - getVariables() - Method in class com.treescrub.spedran.data.Game
-
Gets a new
GameVariablesRequestbuilder object to request variables for this game. - getVariables() - Method in class com.treescrub.spedran.data.Level
-
Gets a new
LevelVariablesRequestbuilder object to request variables for this level. - getVariableValues() - Method in class com.treescrub.spedran.data.Run
-
Returns a
Mapwith each key being a variable ID, and the corresponding value being the variable value ID. - getVerifyDate() - Method in class com.treescrub.spedran.data.RunStatus
-
Gets the time that the run was verified.
- getVideos() - Method in class com.treescrub.spedran.data.Run
-
Gets a
RunVideosdescribing the videos in this run. - getWeblink() - Method in class com.treescrub.spedran.data.Category
-
Gets the link to this category on SRC.
- getWeblink() - Method in class com.treescrub.spedran.data.Leaderboard
-
Gets the link to this leaderboard on SRC.
- getWeblink() - Method in class com.treescrub.spedran.data.Level
-
Gets the link to this level on SRC.
- getWeblink() - Method in class com.treescrub.spedran.data.Run
-
Returns a String containing the URL of the run on SRC.
- getWeblink() - Method in class com.treescrub.spedran.data.Series
-
Gets the link to this series on SRC.
- getWeblink() - Method in class com.treescrub.spedran.data.User
-
Gets the link to this user on SRC.
- getWebLink() - Method in class com.treescrub.spedran.data.Game
-
Gets a link to this game on SRC.
- getYoutubeLink() - Method in class com.treescrub.spedran.data.User
-
Gets the link to this user's YouTube channel.
- GLOBAL - com.treescrub.spedran.data.VariableScope.ScopeType
-
Applies to every run in the game.
- GRADIENT - com.treescrub.spedran.data.NameStyle.Style
-
The name color is a horizontal gradient, left to right.
- guest(Guest) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs that the given
Guesthas participated in. - guest(String) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs that the given
Guesthas participated in. - Guest - Class in com.treescrub.spedran.data
-
A guest runner.
- guestPlayer(Guest) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Adds a
Guestthat participated in the run. - guestPlayer(String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Adds a
Guestthat participated in the run. - GuestRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Guest. - GuestRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.GuestRequest
H
- hashCode() - Method in class com.treescrub.spedran.data.Guest
- hashCode() - Method in class com.treescrub.spedran.data.IdentifiableResource
- hashCode() - Method in class com.treescrub.spedran.data.LocationInfo
- hasSupporterAnimation() - Method in class com.treescrub.spedran.data.User
-
Gets whether this user has the name color supporter animation enabled.
- hitbox(String) - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Searches for a single
Userwith the given Hitbox username. - HttpRequestException - Exception in com.treescrub.spedran
-
An exception that represents a failed request to the API.
I
- IdentifiableNamedResource - Class in com.treescrub.spedran.data
-
A resource from the SRC API that has a unique ID and a name.
- IdentifiableResource - Class in com.treescrub.spedran.data
-
A resource from the SRC API that has a unique ID.
- INGAME - com.treescrub.spedran.data.TimingType
-
The time that the game measures and reports itself.
- ingameTime(Duration) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the ingame time (IGT) for the run.
- InvalidBuilderStateException - Exception in com.treescrub.spedran.requests
-
An exception that signifies a request builder being in an invalid state.
- InvalidBuilderStateException(String) - Constructor for exception com.treescrub.spedran.requests.InvalidBuilderStateException
- isEmulated() - Method in class com.treescrub.spedran.data.RunSystem
-
Gets whether the run was played on an emulator.
- isExact() - Method in class com.treescrub.spedran.data.CategoryPlayers
-
If
true, there must be exactlyCategoryPlayers.getPlayers()players. - isGuest() - Method in class com.treescrub.spedran.data.RunPlayer
-
Gets whether this runner is a guest.
- isMandatory() - Method in class com.treescrub.spedran.data.Variable
-
Gets whether the
Usersubmitting a run is required to set a value for this variable. - isMiscellaneous() - Method in class com.treescrub.spedran.data.Category
-
Is this category considered a miscellaneous category.
- isObsoleting() - Method in class com.treescrub.spedran.data.Variable
-
Gets whether this variable having different values prevents runs from being obsoleted.
- isPerLevel() - Method in class com.treescrub.spedran.data.Category
-
If
true, this category has specific levels, otherwise this category does not have levels. - isSubcategory() - Method in class com.treescrub.spedran.data.Variable
-
Gets whether this variable is handled as a subcategory.
- isUserDefined() - Method in class com.treescrub.spedran.data.Variable
-
Gets whether the
Usersubmitting a run can enter custom values for this variable. - isVerificationRequired() - Method in class com.treescrub.spedran.data.GameRuleset
-
Returns
trueif a run needs to be verified before it appears on the leaderboard. - isVideoOnly() - Method in class com.treescrub.spedran.data.Leaderboard
-
If runs with no video were filtered out, returns
true, otherwisefalse. - isVideoRequired() - Method in class com.treescrub.spedran.data.GameRuleset
-
Returns
trueif a video link is required, otherwisefalse.
K
- keepEmptyResults() - Method in class com.treescrub.spedran.requests.builders.CategoryRecordsRequest
-
Keeps all leaderboards in the results, regardless of whether they have any runs.
- keepEmptyResults() - Method in class com.treescrub.spedran.requests.builders.LevelRecordsRequest
-
Keeps leaderboards with no runs.
L
- Leaderboard - Class in com.treescrub.spedran.data
-
A collection of runs sorted by ranking as they would appear on SRC.
- LeaderboardRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a specific
Leaderboard. - LeaderboardRequest(Game, Category) - Constructor for class com.treescrub.spedran.requests.builders.LeaderboardRequest
- LeaderboardRequest(Game, Category, Level) - Constructor for class com.treescrub.spedran.requests.builders.LeaderboardRequest
- LeaderboardRequest(String, String) - Constructor for class com.treescrub.spedran.requests.builders.LeaderboardRequest
- LeaderboardRequest(String, String, String) - Constructor for class com.treescrub.spedran.requests.builders.LeaderboardRequest
- LeaderboardRun - Class in com.treescrub.spedran.data
-
A run on a leaderboard.
- level(Level) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs played on the given
Level. - level(Level) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the
Levelfor the run. - level(String) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs played on the given
Level. - level(String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the
Levelfor the run. - Level - Class in com.treescrub.spedran.data
-
A specific level in a
Game. - LevelCategoriesRequest - Class in com.treescrub.spedran.requests.builders
- LevelCategoriesRequest(Level) - Constructor for class com.treescrub.spedran.requests.builders.LevelCategoriesRequest
- LevelCategoriesRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.LevelCategoriesRequest
- LevelRecordsRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get records for a given
Level. - LevelRecordsRequest(Level) - Constructor for class com.treescrub.spedran.requests.builders.LevelRecordsRequest
- LevelRecordsRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.LevelRecordsRequest
- LevelRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Level. - LevelRequest(Level) - Constructor for class com.treescrub.spedran.requests.builders.LevelRequest
- LevelRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.LevelRequest
- LevelVariablesRequest - Class in com.treescrub.spedran.requests.builders
- LevelVariablesRequest(Level) - Constructor for class com.treescrub.spedran.requests.builders.LevelVariablesRequest
- LevelVariablesRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.LevelVariablesRequest
- Link - Class in com.treescrub.spedran.data
-
A link consisting of a URI and optionally a relation.
- LocationInfo - Class in com.treescrub.spedran.data
-
Contains a location code and
Namesfor a location in the world. - lookup(String) - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Searches for a single
Userwith the given name.
M
- MAX_ITEMS_BULK - Static variable in class com.treescrub.spedran.requests.builders.game.GamesRequest
- miscellaneous(boolean) - Method in class com.treescrub.spedran.requests.builders.game.GameCategoriesRequest
-
Sets whether miscellaneous categories should be returned.
- miscellaneous(boolean) - Method in class com.treescrub.spedran.requests.builders.game.GameRecordsRequest
-
Sets whether miscellaneous categories should be returned.
- miscellaneous(boolean) - Method in class com.treescrub.spedran.requests.builders.LevelCategoriesRequest
-
Restricts whether miscellaneous categories should be in the results.
- moderator(User) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the moderator to filter for.
- moderator(User) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games where the given
Useris a moderator. - moderator(User) - Method in class com.treescrub.spedran.requests.builders.series.AllSeriesRequest
-
Restricts the results to series moderated by the given
User. - moderator(User) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games where the given
Useris a moderator. - moderator(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the moderator to filter for.
- moderator(String) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games where the given
Useris a moderator. - moderator(String) - Method in class com.treescrub.spedran.requests.builders.series.AllSeriesRequest
-
Restricts the results to series moderated by the given
User. - moderator(String) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games where the given
Useris a moderator. - MODERATOR - com.treescrub.spedran.data.ModeratorType
-
A basic moderator.
- MODERATOR - com.treescrub.spedran.data.UserRole
-
SRC site moderator.
- ModeratorType - Enum in com.treescrub.spedran.data
-
The type of moderator.
- ModifyResourceRequest<T extends Resource> - Class in com.treescrub.spedran
-
A request to modify a resource on SRC.
N
- name(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the value to search across names and abbreviations.
- name(String) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Use a fuzzy search to filter game names and abbreviations.
- name(String) - Method in class com.treescrub.spedran.requests.builders.series.AllSeriesRequest
-
Use a fuzzy search to filter series names and abbreviations.
- name(String) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Use a fuzzy search to filter game names and abbreviations.
- name(String) - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Searches for
Users with a name that contains the given string. - NameColor - Class in com.treescrub.spedran.data
-
Represents a color preset for a user's name.
- Names - Class in com.treescrub.spedran.data
-
Contains international, Japanese, and Twitch names.
- NameStyle - Class in com.treescrub.spedran.data
-
Describes how the name for a
Usershould be colored. - NameStyle.Style - Enum in com.treescrub.spedran.data
-
The styling type for a given name styling.
- NEW - com.treescrub.spedran.data.SubmissionStatus
-
The run is currently in the verification queue.
- Notification - Class in com.treescrub.spedran.data
-
A notification on SRC for an authenticated
User. - NotificationsRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get the
Notifications of the authenticatedUser. - NotificationsRequest() - Constructor for class com.treescrub.spedran.requests.builders.NotificationsRequest
- NotificationStatus - Enum in com.treescrub.spedran.data
-
The read status of a notification.
O
- onlyEmulators() - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Restricts the results to runs done on an emulator.
- onlyRealDevices() - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Restricts the results to runs done on hardware (that is, not an emulator).
P
- platform(Platform) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the platform to filter for.
- platform(Platform) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Platform. - platform(Platform) - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Restricts the results to runs done on the given
Platform. - platform(Platform) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs played on the given
Platform. - platform(Platform) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the
Platformfor the run. - platform(Platform) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Platform. - platform(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the platform to filter for.
- platform(String) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Platform. - platform(String) - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Restricts the results to runs done on the given
Platform. - platform(String) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs played on the given
Platform. - platform(String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the
Platformfor the run. - platform(String) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Platform. - Platform - Class in com.treescrub.spedran.data
-
A platform which a game can be run on.
- PlatformRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Platform. - PlatformRequest(Platform) - Constructor for class com.treescrub.spedran.requests.builders.PlatformRequest
- PlatformRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.PlatformRequest
- PlatformsRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get all
Platforms matching the set filters. - PlatformsRequest() - Constructor for class com.treescrub.spedran.requests.builders.PlatformsRequest
- PRIMARY - com.treescrub.spedran.data.TimingType
-
The timing type that the leaderboard is sorted by.
- ProfileRequest - Class in com.treescrub.spedran.requests.builders.user
-
A request builder to get the
Userthat owns the current API key. - ProfileRequest() - Constructor for class com.treescrub.spedran.requests.builders.user.ProfileRequest
- PROGRAMMER - com.treescrub.spedran.data.UserRole
-
SRC site programmer.
- publisher(Publisher) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the publisher to filter for.
- publisher(Publisher) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Publisher. - publisher(Publisher) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Publisher. - publisher(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the publisher to filter for.
- publisher(String) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Publisher. - publisher(String) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Publisher. - Publisher - Class in com.treescrub.spedran.data
-
A publisher of games.
- PublisherRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Publisher. - PublisherRequest(Publisher) - Constructor for class com.treescrub.spedran.requests.builders.PublisherRequest
- PublisherRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.PublisherRequest
- PublishersRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get all
Gametypes matching the set filters. - PublishersRequest() - Constructor for class com.treescrub.spedran.requests.builders.PublishersRequest
R
- READ - com.treescrub.spedran.data.NotificationStatus
-
The notification has been marked as read.
- realTime(Duration) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the realtime (RTA) time for the run.
- REALTIME - com.treescrub.spedran.data.TimingType
-
The real world time as determined by a clock.
- REALTIME_NOLOADS - com.treescrub.spedran.data.TimingType
-
The real world time but loads are removed from the total time.
- realTimeNoLoads(Duration) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the realtime (RTA) with loads removed time for the run.
- region(Region) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the region to filter for.
- region(Region) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Region. - region(Region) - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Restricts the results to runs done on the given
Region. - region(Region) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs played on the given
Region. - region(Region) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the
Regiongame version for the run. - region(Region) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Region. - region(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the region to filter for.
- region(String) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given
Region. - region(String) - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Restricts the results to runs done on the given
Region. - region(String) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs played on the given
Region. - region(String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the
Regiongame version for the run. - region(String) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given
Region. - Region - Class in com.treescrub.spedran.data
-
Historical regions of the world where games were distributed.
- RegionRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Region. - RegionRequest(Region) - Constructor for class com.treescrub.spedran.requests.builders.RegionRequest
- RegionRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.RegionRequest
- RegionsRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get all
Gametypes matching the set filters. - RegionsRequest() - Constructor for class com.treescrub.spedran.requests.builders.RegionsRequest
- reject(String) - Method in class com.treescrub.spedran.requests.builders.run.RunStatusRequest
-
Sets the status of the
RuntoSubmissionStatus.REJECTEDwith the provided rejection reason. - REJECTED - com.treescrub.spedran.data.SubmissionStatus
-
The run was rejected by a verifier.
- releaseYear(int) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the release year to filter for.
- releaseYear(int) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Restricts the results to games with the given release year.
- releaseYear(int) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Restricts the results to games with the given release year.
- removeApiKey() - Static method in class com.treescrub.spedran.Spedran
-
Identical to
Spedran.clearApiKey() - Resource - Class in com.treescrub.spedran.data
-
A resource from the SRC API.
- ResourceCollectionRequest<T extends Resource> - Class in com.treescrub.spedran
-
A request to get a collection of resources from the SRC API.
- Run - Class in com.treescrub.spedran.data
-
A speedrun on SRC.
- RunPlayer - Class in com.treescrub.spedran.data
-
Has information about a specific runner.
- RunPlayersRequest - Class in com.treescrub.spedran.requests.builders.run
-
A request builder to set the players that participated in a
Run. - RunPlayersRequest(Run) - Constructor for class com.treescrub.spedran.requests.builders.run.RunPlayersRequest
- RunPlayersRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.run.RunPlayersRequest
- RunRequest - Class in com.treescrub.spedran.requests.builders.run
-
A request builder to get a single
Run. - RunRequest(Run) - Constructor for class com.treescrub.spedran.requests.builders.run.RunRequest
- RunRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.run.RunRequest
- RunsRequest - Class in com.treescrub.spedran.requests.builders.run
-
A request builder to get all
Runs matching the set filters. - RunsRequest() - Constructor for class com.treescrub.spedran.requests.builders.run.RunsRequest
- RunStatus - Class in com.treescrub.spedran.data
-
The verification status of a
Runon SRC. - RunStatusRequest - Class in com.treescrub.spedran.requests.builders.run
-
A request builder to reject or verify a run.
- RunStatusRequest(Run) - Constructor for class com.treescrub.spedran.requests.builders.run.RunStatusRequest
- RunStatusRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.run.RunStatusRequest
- RunSystem - Class in com.treescrub.spedran.data
-
Contains platform and region info, as well as if the run used an emulator.
- RunTimes - Class in com.treescrub.spedran.data
-
Contains info of all times set for a run.
- RunVideos - Class in com.treescrub.spedran.data
-
Has information about all video links in the run.
S
- scope(String) - Method in class com.treescrub.spedran.requests.builders.game.GameRecordsRequest
-
Sets the scope type.
- series(String) - Method in class com.treescrub.spedran.requests.builders.user.UserPBsRequest
-
Restricts the results to the given
Series. - Series - Class in com.treescrub.spedran.data
-
A collection of multiple games as part of one franchise.
- Series(JSONObject) - Constructor for class com.treescrub.spedran.data.Series
- SeriesGamesRequest - Class in com.treescrub.spedran.requests.builders.series
- SeriesGamesRequest(Series) - Constructor for class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
- SeriesGamesRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
- setApiKey(String) - Static method in class com.treescrub.spedran.Spedran
-
Sets the current API key.
- setBackoffValues(double, long, double) - Static method in class com.treescrub.spedran.Spedran
-
Sets the values for exponential backoff.
- setCacheTimeLimit(long) - Static method in class com.treescrub.spedran.Spedran
-
Sets the maximum time that entries are considered valid in the request cache.
- setPlayers() - Method in class com.treescrub.spedran.data.Run
-
Gets a new
RunPlayersRequestbuilder to set the players on this run. - setRunPlayers(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
RunPlayersRequestbuilder to change the players in aRun. - setRunStatus(String) - Static method in class com.treescrub.spedran.Spedran
-
Gets a
RunStatusRequestbuilder to change theRun's verification status. - setStatus() - Method in class com.treescrub.spedran.data.Run
-
Gets a new
RunStatusRequestbuilder to change the status of this run. - shutDown() - Static method in class com.treescrub.spedran.Spedran
-
Shuts down all work threads, allowing the application to exit.
- SINGLE_LEVEL - com.treescrub.spedran.data.VariableScope.ScopeType
-
Applies only to one specific level.
- SingleResourceRequest<T extends Resource> - Class in com.treescrub.spedran
-
A request to get a single resource from the SRC API.
- SingleSeriesRequest - Class in com.treescrub.spedran.requests.builders.series
-
A request builder to get a single
Series. - SingleSeriesRequest(Series) - Constructor for class com.treescrub.spedran.requests.builders.series.SingleSeriesRequest
- SingleSeriesRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.series.SingleSeriesRequest
- skipEmpty(boolean) - Method in class com.treescrub.spedran.requests.builders.game.GameRecordsRequest
-
Sets whether record entries without any runs should be kept.
- skipEmptyResults() - Method in class com.treescrub.spedran.requests.builders.CategoryRecordsRequest
-
Skips leaderboards if they do not contain any runs.
- skipEmptyResults() - Method in class com.treescrub.spedran.requests.builders.LevelRecordsRequest
-
Skips leaderboards with no runs.
- SOLID - com.treescrub.spedran.data.NameStyle.Style
-
The name color is one solid color.
- sortByAbbreviation() - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sorts the returned games by the abbreviation.
- sortByAbbreviation() - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Sorts the results alphanumerically by the abbreviation of the games.
- sortByAbbreviation() - Method in class com.treescrub.spedran.requests.builders.series.AllSeriesRequest
-
Sorts the results alphanumerically by the abbreviation of the series.
- sortByAbbreviation() - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Sorts the results alphanumerically by the abbreviation of the games.
- sortByCategory() - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sorts the results by the creation time of
Categorys. - sortByCreationDate() - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sorts the returned games by the creation time.
- sortByCreationDate() - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Sorts the results by the creation date of the games on SRC.
- sortByCreationDate() - Method in class com.treescrub.spedran.requests.builders.series.AllSeriesRequest
-
Sorts the results by the creation time of the series on SRC.
- sortByCreationDate() - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Sorts the results by the creation date of the games on SRC.
- sortByDate() - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sorts the results by the date of the run.
- sortByEmulation() - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sorts the results by the
RunSystem.isEmulated()boolean flag. - sortByGame() - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sorts the results by the creation time of
Games. - sortByInternationalName() - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sorts the returned games by the international name.
- sortByInternationalName() - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Sorts the results alphanumerically by the international name of the games.
- sortByInternationalName() - Method in class com.treescrub.spedran.requests.builders.series.AllSeriesRequest
-
Sorts the results alphanumerically by the international name of the series.
- sortByInternationalName() - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Sorts the results alphanumerically by the international name of the games.
- sortByInternationalName() - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Sorts the results alphanumerically by the international name of the users.
- sortByJapaneseName() - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sorts the returned games by the japanese name.
- sortByJapaneseName() - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Sorts the results alphanumerically by the Japanese name of the games.
- sortByJapaneseName() - Method in class com.treescrub.spedran.requests.builders.series.AllSeriesRequest
-
Sorts the results alphanumerically by the Japanese name of the series.
- sortByJapaneseName() - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Sorts the results alphanumerically by the Japanese name of the games.
- sortByJapaneseName() - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Sorts the results alphanumerically by the Japanese name of the users.
- sortByLevel() - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sorts the results by the creation time of
Levels. - sortByMandatory() - Method in class com.treescrub.spedran.requests.builders.CategoryVariablesRequest
-
Sorts the returned variables by mandatory flag.
- sortByMandatory() - Method in class com.treescrub.spedran.requests.builders.game.GameVariablesRequest
-
Sorts the variables by the
Variable.isMandatory()boolean flag. - sortByMandatory() - Method in class com.treescrub.spedran.requests.builders.LevelVariablesRequest
-
Sorts the variables by the
Variable.isMandatory()boolean flag. - sortByMiscellaneous() - Method in class com.treescrub.spedran.requests.builders.game.GameCategoriesRequest
-
Sorts the returned categories by the miscellaneous flag.
- sortByMiscellaneous() - Method in class com.treescrub.spedran.requests.builders.LevelCategoriesRequest
-
Sorts the results by the miscellaneous boolean flag.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.CategoryVariablesRequest
-
Sorts the returned variables alphanumerically by name.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.game.GameCategoriesRequest
-
Sorts the returned categories alphanumerically by name.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.game.GameLevelsRequest
-
Sorts the returned levels alphanumerically by name.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.game.GameVariablesRequest
-
Sorts the variables alphanumerically by the variable name.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.GametypesRequest
-
Sorts the results alphanumerically by name.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.GenresRequest
-
Sorts the results alphanumerically by name.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.LevelCategoriesRequest
-
Sorts the results alphanumerically by the category name.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.LevelVariablesRequest
-
Sorts the variables alphanumerically by the variable name.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.PlatformsRequest
-
Sorts the results alphanumerically by the platform name.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.PublishersRequest
-
Sorts the results alphanumerically by name.
- sortByName() - Method in class com.treescrub.spedran.requests.builders.RegionsRequest
-
Sorts the results alphanumerically by name.
- sortByNameSimilarity() - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sorts the returned games by name similarity.
- sortByNameSimilarity() - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Sorts the results by similarity when
GamesRequest.name(String)is set. - sortByNameSimilarity() - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Sorts the results by similarity when
GamesRequest.name(String)is set. - sortByPlatform() - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sorts the results by the creation time of
Platforms. - sortByPosition() - Method in class com.treescrub.spedran.requests.builders.CategoryVariablesRequest
-
Sorts the returned variables by the moderator defined position.
- sortByPosition() - Method in class com.treescrub.spedran.requests.builders.game.GameCategoriesRequest
-
Sorts the returned categories by the moderator defined position.
- sortByPosition() - Method in class com.treescrub.spedran.requests.builders.game.GameLevelsRequest
-
Sorts the returned levels by the moderator defined position.
- sortByPosition() - Method in class com.treescrub.spedran.requests.builders.game.GameVariablesRequest
-
Sorts the variables by the moderator defined position.
- sortByPosition() - Method in class com.treescrub.spedran.requests.builders.LevelCategoriesRequest
-
Sorts the results by the moderator defined category position.
- sortByPosition() - Method in class com.treescrub.spedran.requests.builders.LevelVariablesRequest
-
Sorts the variables by the moderator defined position.
- sortByRegion() - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sorts the results by the creation time of
Regions. - sortByReleaseDate() - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sorts the returned games by the release date.
- sortByReleaseDate() - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Sorts the results by the release date of the games.
- sortByReleaseDate() - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Sorts the results by the release date of the games.
- sortByReleaseYear() - Method in class com.treescrub.spedran.requests.builders.PlatformsRequest
-
Sorts the results by the year the platform was released.
- sortByRole() - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Sorts the results by the user's role on SRC.
- sortBySignupDate() - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Sorts the results by the user's signup time.
- sortBySubmissionDate() - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sorts the results by the submission time of the run.
- sortByUserDefined() - Method in class com.treescrub.spedran.requests.builders.CategoryVariablesRequest
-
Sorts the returned variables by user defined flag.
- sortByUserDefined() - Method in class com.treescrub.spedran.requests.builders.game.GameVariablesRequest
-
Sorts the variables by the
Variable.isUserDefined()boolean flag. - sortByUserDefined() - Method in class com.treescrub.spedran.requests.builders.LevelVariablesRequest
-
Sorts the variables by the
Variable.isUserDefined()boolean flag. - sortByVerificationDate() - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sorts the results by the time that the run was rejected or verified.
- sortByVerificationStatus() - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sorts the results by the verification status.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.CategoryVariablesRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.DevelopersRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.EnginesRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.game.GameCategoriesRequest
-
Sets the direction to sort the returned categories.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.game.GameLevelsRequest
-
Sets the direction to sort the returned levels.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.game.GameRomhacksRequest
-
Sets the direction to sort the returned games.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.game.GamesRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.game.GameVariablesRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.GametypesRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.GenresRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.LevelCategoriesRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.LevelVariablesRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.PlatformsRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.PublishersRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.RegionsRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.series.AllSeriesRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.series.SeriesGamesRequest
-
Sets the direction (ascending or descending) of the sorting.
- sortDirection(SortDirection) - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Sets the direction (ascending or descending) of the sorting.
- SortDirection - Enum in com.treescrub.spedran.requests
-
The sorting direction for requests of collections of resources.
- Spedran - Class in com.treescrub.spedran
-
The main Spedran API.
- speedrunsLive(String) - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Searches for a single
Userwith the given SpeedRunsLive username. - splitsIO(String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the ID or URL for the splits.io run page.
- status(SubmissionStatus) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs with the provided
SubmissionStatus. - SubmissionStatus - Enum in com.treescrub.spedran.data
-
The submission status type for a run.
- submitRun() - Static method in class com.treescrub.spedran.Spedran
-
Gets a
SubmitRunRequestbuilder to submit a run to SRC. - SubmitRunRequest - Class in com.treescrub.spedran.requests.builders.run
-
A request builder to submit a
Runto SRC. - SubmitRunRequest() - Constructor for class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
- SUPER_MODERATOR - com.treescrub.spedran.data.ModeratorType
-
The highest privileged moderator type.
T
- timing(TimingType) - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Sorts the leaderboard by the timing type.
- TimingType - Enum in com.treescrub.spedran.data
-
Timing type for runs.
- toAPIName() - Method in enum com.treescrub.spedran.data.SubmissionStatus
- top(int) - Method in class com.treescrub.spedran.requests.builders.game.GameRecordsRequest
-
Sets the number of places to return.
- top(int) - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
- top(int) - Method in class com.treescrub.spedran.requests.builders.LevelRecordsRequest
-
Sets the number of places to return.
- top(int) - Method in class com.treescrub.spedran.requests.builders.user.UserPBsRequest
-
Sets the minimum placement to restrict the results to.
- toParameter() - Method in enum com.treescrub.spedran.requests.SortDirection
-
Gets the SRC API query parameter string.
- topPlaces(int) - Method in class com.treescrub.spedran.requests.builders.CategoryRecordsRequest
-
Sets number of places to return.
- toString() - Method in class com.treescrub.spedran.data.Category
- toString() - Method in class com.treescrub.spedran.data.CategoryPlayers
- toString() - Method in class com.treescrub.spedran.data.Developer
- toString() - Method in class com.treescrub.spedran.data.Engine
- toString() - Method in class com.treescrub.spedran.data.Game
- toString() - Method in class com.treescrub.spedran.data.GameRuleset
- toString() - Method in class com.treescrub.spedran.data.Gametype
- toString() - Method in class com.treescrub.spedran.data.Genre
- toString() - Method in class com.treescrub.spedran.data.Guest
- toString() - Method in class com.treescrub.spedran.data.Leaderboard
- toString() - Method in class com.treescrub.spedran.data.LeaderboardRun
- toString() - Method in class com.treescrub.spedran.data.Level
- toString() - Method in class com.treescrub.spedran.data.Link
- toString() - Method in class com.treescrub.spedran.data.LocationInfo
- toString() - Method in class com.treescrub.spedran.data.NameColor
- toString() - Method in class com.treescrub.spedran.data.Names
- toString() - Method in class com.treescrub.spedran.data.NameStyle
- toString() - Method in class com.treescrub.spedran.data.Platform
- toString() - Method in class com.treescrub.spedran.data.Publisher
- toString() - Method in class com.treescrub.spedran.data.Region
- toString() - Method in class com.treescrub.spedran.data.Run
- toString() - Method in class com.treescrub.spedran.data.RunPlayer
- toString() - Method in class com.treescrub.spedran.data.RunStatus
- toString() - Method in class com.treescrub.spedran.data.RunSystem
- toString() - Method in class com.treescrub.spedran.data.RunTimes
- toString() - Method in class com.treescrub.spedran.data.RunVideos
- toString() - Method in class com.treescrub.spedran.data.Series
- toString() - Method in class com.treescrub.spedran.data.User
- toString() - Method in class com.treescrub.spedran.data.UserLocation
- toString() - Method in class com.treescrub.spedran.data.Variable
- toString() - Method in class com.treescrub.spedran.data.VariableScope
- toString() - Method in class com.treescrub.spedran.data.VariableValue
- TRUSTED - com.treescrub.spedran.data.UserRole
-
Unknown, unsure if actually used.
- twitch(String) - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Searches for a single
Userwith the given Twitch username. - twitter(String) - Method in class com.treescrub.spedran.requests.builders.user.UsersRequest
-
Searches for a single
Userwith the given Twitter handle.
U
- UNREAD - com.treescrub.spedran.data.NotificationStatus
-
The notification has not yet been marked as read.
- user(User) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs that the given
Userhas participated in. - user(String) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs that the given
Userhas participated in. - User - Class in com.treescrub.spedran.data
-
Represents a user on SRC.
- USER - com.treescrub.spedran.data.UserRole
-
The default role for a normal user.
- UserAssets - Class in com.treescrub.spedran.data
- UserLocation - Class in com.treescrub.spedran.data
-
A
Users location in the world as set by the user. - UserPBsRequest - Class in com.treescrub.spedran.requests.builders.user
- UserPBsRequest(User) - Constructor for class com.treescrub.spedran.requests.builders.user.UserPBsRequest
- UserPBsRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.user.UserPBsRequest
- userPlayer(User) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Adds a
Userthat participated in the run. - userPlayer(String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Adds a
Userthat participated in the run. - UserRequest - Class in com.treescrub.spedran.requests.builders.user
-
A request builder to get a single
User. - UserRequest(User) - Constructor for class com.treescrub.spedran.requests.builders.user.UserRequest
- UserRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.user.UserRequest
- UserRole - Enum in com.treescrub.spedran.data
-
The role of a user on SRC.
- UsersRequest - Class in com.treescrub.spedran.requests.builders.user
-
A request builder to get all
Users matching the set filters. - UsersRequest() - Constructor for class com.treescrub.spedran.requests.builders.user.UsersRequest
V
- valueOf(String) - Static method in enum com.treescrub.spedran.data.ModeratorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.treescrub.spedran.data.NameStyle.Style
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.treescrub.spedran.data.NotificationStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.treescrub.spedran.data.SubmissionStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.treescrub.spedran.data.TimingType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.treescrub.spedran.data.UserRole
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.treescrub.spedran.data.VariableScope.ScopeType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.treescrub.spedran.requests.SortDirection
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.treescrub.spedran.data.ModeratorType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.treescrub.spedran.data.NameStyle.Style
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.treescrub.spedran.data.NotificationStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.treescrub.spedran.data.SubmissionStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.treescrub.spedran.data.TimingType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.treescrub.spedran.data.UserRole
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.treescrub.spedran.data.VariableScope.ScopeType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.treescrub.spedran.requests.SortDirection
-
Returns an array containing the constants of this enum type, in the order they are declared.
- variable(Variable, String) - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Restricts the results to runs with the given
Variableset to the given variable value. - variable(Variable, String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the value for a
Variablewith a predefined value ID. - variable(String, String) - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Restricts the results to runs with the given
Variableset to the given variable value. - variable(String, String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the value for a
Variablewith a predefined value ID. - Variable - Class in com.treescrub.spedran.data
-
A moderator defined variable for which a value can be set on a
Run. - VariableRequest - Class in com.treescrub.spedran.requests.builders
-
A request builder to get a single
Variable. - VariableRequest(Variable) - Constructor for class com.treescrub.spedran.requests.builders.VariableRequest
- VariableRequest(String) - Constructor for class com.treescrub.spedran.requests.builders.VariableRequest
- VariableScope - Class in com.treescrub.spedran.data
-
The scope that a
Variableshould apply or be visible in. - VariableScope.ScopeType - Enum in com.treescrub.spedran.data
-
The type of scope that a variable has.
- VariableValue - Class in com.treescrub.spedran.data
-
A value for a
Variable. - verified() - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the run to be immediately verified when submitted.
- VERIFIED - com.treescrub.spedran.data.SubmissionStatus
-
The run was verified by a verifier.
- verifier(User) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs that the given
Userhas rejected or verified. - verifier(String) - Method in class com.treescrub.spedran.requests.builders.run.RunsRequest
-
Restricts the results to runs that the given
Userhas rejected or verified. - verify() - Method in class com.treescrub.spedran.requests.builders.run.RunStatusRequest
-
Sets the status of the
RuntoSubmissionStatus.VERIFIED. - video(String) - Method in class com.treescrub.spedran.requests.builders.run.SubmitRunRequest
-
Sets the video URL for the run.
- videosOnly() - Method in class com.treescrub.spedran.requests.builders.LeaderboardRequest
-
Restricts the results to runs with videos specified.
All Classes All Packages