Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-18 21:53:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add deprecation messages (#486)

Browse Source 
Add back getPlayer().playtimeSinceLastX, but with deprecation messages applied
This commit is contained in:
Snarling 2023-04-24 10:21:43 -04:00 committed by GitHub
parent 72037b5dab
commit 6f56f35943
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
src/NetscriptFunctions.ts
View File

@ -81,7 +81,7 @@ import { Flags } from "./NetscriptFunctions/Flags";
import { calculateIntelligenceBonus } from "./PersonObjects/formulas/intelligence";
import { CalculateShareMult, StartSharing } from "./NetworkShare/Share";
import { recentScripts } from "./Netscript/RecentScripts";
import { InternalAPI, removedFunction, NSProxy } from "./Netscript/APIWrapper";
import { InternalAPI, removedFunction, NSProxy, NetscriptContext } from "./Netscript/APIWrapper";
import { INetscriptExtra } from "./NetscriptFunctions/Extra";
import { ScriptDeath } from "./Netscript/ScriptDeath";
import { getBitNodeMultipliers } from "./BitNode/BitNode";
@ -1742,7 +1742,7 @@ export const ns: InternalAPI<NSFull> = {
getFavorToDonate: () => () => {
return Math.floor(CONSTANTS.BaseFavorToDonate * BitNodeMultipliers.RepToDonateToFaction);
},
getPlayer: () => () => {
getPlayer: (ctx) => () => {
const data = {
hp: cloneDeep(Player.hp),
skills: cloneDeep(Player.skills),
@ -1758,6 +1758,22 @@ export const ns: InternalAPI<NSFull> = {
factions: Player.factions.slice(),
entropy: Player.entropy,
};
createDeprecatedProperty(
ctx,
data,
"playtimeSinceLastAug",
Player.playtimeSinceLastAug,
"getPlayer.playtimeSinceLastAug",
"Use ns.getPlaytimeSinceLastAug or ns.singularity.getLastAugReset instead.",
);
createDeprecatedProperty(
ctx,
data,
"playtimeSinceLastBitnode",
Player.playtimeSinceLastBitnode,
"getPlayer.playtimeSinceLastBitnode",
"Use ns.singularity.getLastNodeReset instead.",
);
return data;
},
getMoneySources: () => () => ({
@ -1855,3 +1871,26 @@ function getFunctionNames(obj: object, prefix: string): string[] {
}
return functionNames;
}
const deprecatedWarningsGiven = new Set();
function createDeprecatedProperty(
ctx: NetscriptContext,
obj: object,
propName: string,
value: any,
identifier: string,
message: string,
) {
Object.defineProperty(obj, propName, {
set: (newVal: any) => (value = newVal),
get: () => {
if (!deprecatedWarningsGiven.has(identifier)) {
deprecatedWarningsGiven.add(identifier);
Terminal.warn(`Deprecated property ${propName} accessed from ns.${ctx.functionPath} return value.`);
Terminal.warn(`This is no longer supported usage and will be removed in a later version.`);
Terminal.warn(message);
}
return value;
},
});
}