API: Return active SF levels in getOwnedSourceFiles and ResetInfo.ownedSF (#1761)

* DOCUMENTATION: Clarify getOwnedSourceFiles when player overrides active levels of SFs
* Return Player.activeSourceFiles instead of Player.sourceFiles
* Get rid of zeroes in the map
This commit is contained in:
catloversg
2024-11-11 13:56:57 +07:00
committed by GitHub
parent cb9e281c45
commit 72a63b15cb
6 changed files with 38 additions and 7 deletions

View File

@@ -74,7 +74,15 @@ interface ResetInfo {
currentNode: number;
/** A map of owned augmentations to their levels. Keyed by the augmentation name. Map values are the augmentation level (e.g. for NeuroFlux governor). */
ownedAugs: Map<string, number>;
/** A map of owned SF to their levels. Keyed by the SF number. Map values are the SF level. */
/**
* A map of owned source files. Its keys are the SF numbers. Its values are the active SF levels. This map takes
* BitNode options into account.
*
* For example, let's say you have SF 1.3, but you overrode the active level of SF1 and set it to level 1. In this
* case, this map contains this entry: Key: 1 => Value: 1.
*
* If the active level of a source file is 0, that source file won't be included in the result.
*/
ownedSF: Map<number, number>;
/** Current BitNode options */
bitNodeOptions: BitNodeOptions;
@@ -2435,7 +2443,12 @@ export interface Singularity {
* RAM cost: 5 GB
*
*
* Returns an array of source files
* Returns an array of source files. This function takes BitNode options into account.
*
* For example, let's say you have SF 1.3, but you overrode the active level of SF1 and set it to level 1. In this
* case, this function returns {"n":1,"lvl":1}.
*
* If the active level of a source file is 0, that source file won't be included in the result.
*
* @returns Array containing an object with number and level of the source file.
*/