This is the general holding class for a full history of sts2 runs.
It can be indexed like a list (i.e. x[1]).
Value
A new STS2RunHistory object.
Filters
Any method starting filter_ returns a new STS2RunHistory object.
As such these can be chained together:
STS2Run objects
STS2Run objects are passed by reference. As such if you modify a run in a filtered history, those changes will appear in the original list.
Public fields
runsThe parsed run logs. A list of STS2Run objects.
owneridThe steam ID of the run history owner.
filterstepsThe filtering steps performed on this run history.
Methods
Method new()
Create a new run history container from a list of STS2Run objects.
Arguments
historydataA list of STS2Run objects.
steamidThe owner's steamid (for differentiating in the case of multiplayer runs).
filterstepsThe filtering steps performed on this run history.
Print an STS2RunHistory object.
Usage
STS2RunHistory$print(...)
Method get_individual_player_data()
Retrieve player data for a given player from runs.
Usage
STS2RunHistory$get_individual_player_data(id = NULL)
Arguments
idThe Steam ID of the player data to retrieve (or NULL to retrieve the data of the run owner).
Method get_player_data()
Retrieve player data for all players from runs.
Usage
STS2RunHistory$get_player_data()
Method filter_seed()
Retrieve runs by seed.
Usage
STS2RunHistory$filter_seed(seed, .filtertext = "filtered by seed")
Arguments
seedThe seed (or seeds) that one wishes to retrieve.
.filtertextThe text to add to the filter list (mostly used internally).
Method filter_character()
Retrieve runs containing character/s across the run history.
Usage
STS2RunHistory$filter_character(
char,
onlyowner = FALSE,
.filtertext = "filtered by character"
)
Arguments
charThe character/s to retrieve data for.
onlyownerIf TRUE, only retrieve runs where the owner was the character specified.
.filtertextThe text to add to the filter list (mostly used internally).
Method filter_outcome()
Retrieve runs with desired outcome/s across the run history.
Usage
STS2RunHistory$filter_outcome(outcome, .filtertext = "filtered by outcome")
Arguments
outcomeThe outcome/s to retrieve data for.
.filtertextThe text to add to the filter list (mostly used internally).
Method filter_ascension()
Retrieve runs with desired ascensions across the run history.
Usage
STS2RunHistory$filter_ascension(
ascension = 0,
.filtertext = "filtered by ascension"
)
Arguments
ascensionThe ascensions to retrieve data for.
.filtertextThe text to add to the filter list (mostly used internally).
Method filter_playercount()
Retrieve runs with desired player count across the run history.
Usage
STS2RunHistory$filter_playercount(
players = 1,
.filtertext = "filtered by player count"
)
Arguments
playersThe player count/s to retrieve data for.
.filtertextThe text to add to the filter list (mostly used internally).
Method filter_version()
Retrieve runs with desired patch version across the run history.
Usage
STS2RunHistory$filter_version(
cond = "==",
patch,
.filtertext = "filtered by version"
)
Arguments
condA condition (e.g. "=" or ">").
patchThe version to compare runs against.
.filtertextThe text to add to the filter list (mostly used internally).
Method filter_floorcount()
Retrieve runs with desired floor count across the run history.
Usage
STS2RunHistory$filter_floorcount(
floors,
.filtertext = "filtered by number of floors"
)
Arguments
floorsThe floor count/s to retrieve data for.
.filtertextThe text to add to the filter list (mostly used internally).
Method filter_gamemode()
Retrieve runs with desired gamemode across the run history.
Usage
STS2RunHistory$filter_gamemode(gamemode, .filtertext = "filtered by gamemode")
Arguments
gamemodeThe gamemode/s to retrieve data for.
.filtertextThe text to add to the filter list (mostly used internally).
Method generate_summary()
Generate a summary dataframe for the run history.
Usage
STS2RunHistory$generate_summary()
Method clone()
The objects of this class are cloneable with this method.
Usage
STS2RunHistory$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
