bitburner-src/src/NetscriptFunctions/Bladeburner.ts

327 lines
13 KiB
TypeScript
Raw Normal View History

import { Player } from "@player";
2021-10-14 09:22:02 +02:00
import { Bladeburner } from "../Bladeburner/Bladeburner";
import { BitNodeMultipliers } from "../BitNode/BitNodeMultipliers";
import { Bladeburner as INetscriptBladeburner } from "@nsdefs";
import { Action } from "src/Bladeburner/Action";
2022-05-08 01:08:07 +02:00
import { InternalAPI, NetscriptContext } from "src/Netscript/APIWrapper";
2022-07-20 00:25:06 +02:00
import { BlackOperation } from "../Bladeburner/BlackOperation";
2022-08-08 19:43:41 +02:00
import { helpers } from "../Netscript/NetscriptHelpers";
import { checkEnum } from "../utils/helpers/enum";
import { CityName } from "../Enums";
2021-10-14 09:22:02 +02:00
2022-08-09 21:41:47 +02:00
export function NetscriptBladeburner(): InternalAPI<INetscriptBladeburner> {
2022-09-06 15:07:12 +02:00
const checkBladeburnerAccess = function (ctx: NetscriptContext): void {
getBladeburner(ctx);
return;
};
const getBladeburner = function (ctx: NetscriptContext): Bladeburner {
const apiAccess = Player.bitNodeN === 7 || Player.sourceFiles.some((a) => a.n === 7);
2021-10-14 09:22:02 +02:00
if (!apiAccess) {
2022-09-06 15:07:12 +02:00
throw helpers.makeRuntimeErrorMsg(ctx, "You have not unlocked the bladeburner API.", "API ACCESS");
2021-10-14 09:22:02 +02:00
}
2022-09-06 15:07:12 +02:00
const bladeburner = Player.bladeburner;
if (!bladeburner)
throw helpers.makeRuntimeErrorMsg(ctx, "You must be a member of the Bladeburner division to use this API.");
return bladeburner;
2021-10-14 09:22:02 +02:00
};
const getBladeburnerActionObject = function (ctx: NetscriptContext, type: string, name: string): Action {
2022-09-06 15:07:12 +02:00
const bladeburner = Player.bladeburner;
2021-10-14 09:22:02 +02:00
if (bladeburner === null) throw new Error("Must have joined bladeburner");
const actionId = bladeburner.getActionIdFromTypeAndName(type, name);
if (!actionId) {
2022-08-08 19:43:41 +02:00
throw helpers.makeRuntimeErrorMsg(ctx, `Invalid action type='${type}', name='${name}'`);
2021-10-14 09:22:02 +02:00
}
const actionObj = bladeburner.getActionObject(actionId);
if (!actionObj) {
2022-08-08 19:43:41 +02:00
throw helpers.makeRuntimeErrorMsg(ctx, `Invalid action type='${type}', name='${name}'`);
2021-10-14 09:22:02 +02:00
}
return actionObj;
};
return {
NETSCRIPT: ns.sleeve.getSleeve added. getPlayer and getSleeve can both be used for formulas. (#200) * BREAKING CHANGE: Removed getSleeveStats and getSleeveInformation because this info is provided by getSleeve in a more usable form. * BREAKING CHANGE: Removed tor, inBladeburner, and hasCorporation fields from ns.getPlayer. Functionality still exists via added functions ns.hasTorRouter, ns.corporation.hasCorporation, and ns.bladeburner.inBladeburner. * Separated ns definitions for Person, Sleeve, and Player interfaces with both Player and Sleeve just extending Person. Added getSleeve, which provides a Sleeve object similar to getPlayer. * Renamed the sleeve ns layer's interface as sleeve lowercase because of name conflict. todo: May move all the ns layers interface names to lowercase for consistency * Added ns.formulas.work.crimeSuccessChance and reworked to allow both sleeve and player calculations. * Removed internal Person.getIntelligenceBonus function which was just a wrapper for calculateIntelligenceBonus. Any use of the former in formulas creates a conflict where ns-provided Person objects throw an error. * Renamed helpers.player to helpers.person for netscript person validation. Reduced number of fields validated due to Person being a smaller interface. * Fixed bug in bladeburner where Player multipliers and int were being used no matter which person was performing the task * Fixed leak of Player.jobs at ns.getPlayer * Person / Player / Sleeve classes now implement the netscript equivalent interfaces. Netscript helper for person no longer asserts that it's a real Person class member, only that it's a Person interface. Functions that use netscript persons have been changed to expect just a person interface to prevent needing this incorrect type assertion.
2022-11-09 13:26:26 +01:00
inBladeburner: () => () => !!Player.bladeburner,
getContractNames: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return bladeburner.getContractNamesNetscriptFn();
},
getOperationNames: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return bladeburner.getOperationNamesNetscriptFn();
},
getBlackOpNames: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return bladeburner.getBlackOpNamesNetscriptFn();
},
getBlackOpRank: (ctx) => (_blackOpName) => {
const blackOpName = helpers.string(ctx, "blackOpName", _blackOpName);
checkBladeburnerAccess(ctx);
const action = getBladeburnerActionObject(ctx, "blackops", blackOpName);
if (!(action instanceof BlackOperation)) throw new Error("action was not a black operation");
return action.reqdRank;
},
getGeneralActionNames: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return bladeburner.getGeneralActionNamesNetscriptFn();
},
getSkillNames: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return bladeburner.getSkillNamesNetscriptFn();
},
startAction: (ctx) => (_type, _name) => {
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
const bladeburner = getBladeburner(ctx);
try {
return bladeburner.startActionNetscriptFn(type, name, ctx.workerScript);
} catch (e: unknown) {
throw helpers.makeRuntimeErrorMsg(ctx, String(e));
}
},
stopBladeburnerAction: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return bladeburner.resetAction();
},
getCurrentAction: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return bladeburner.getTypeAndNameFromActionId(bladeburner.action);
},
getActionTime: (ctx) => (_type, _name) => {
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
const bladeburner = getBladeburner(ctx);
try {
const time = bladeburner.getActionTimeNetscriptFn(Player, type, name);
if (typeof time === "string") {
const errorLogText = `Invalid action: type='${type}' name='${name}'`;
helpers.log(ctx, () => errorLogText);
return -1;
} else {
return time;
}
} catch (e: unknown) {
throw helpers.makeRuntimeErrorMsg(ctx, String(e));
}
},
getActionCurrentTime: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
try {
2022-05-22 06:40:32 +02:00
const timecomputed =
Math.min(bladeburner.actionTimeCurrent + bladeburner.actionTimeOverflow, bladeburner.actionTimeToComplete) *
1000;
return timecomputed;
2022-07-15 07:51:30 +02:00
} catch (e: unknown) {
2022-08-08 19:43:41 +02:00
throw helpers.makeRuntimeErrorMsg(ctx, String(e));
}
},
getActionEstimatedSuccessChance: (ctx) => (_type, _name) => {
2023-01-02 19:28:31 +01:00
const bladeburner = getBladeburner(ctx);
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
try {
const chance = bladeburner.getActionEstimatedSuccessChanceNetscriptFn(Player, type, name);
if (typeof chance === "string") {
const errorLogText = `Invalid action: type='${type}' name='${name}'`;
helpers.log(ctx, () => errorLogText);
return [-1, -1];
} else {
return chance;
}
} catch (e: unknown) {
throw helpers.makeRuntimeErrorMsg(ctx, String(e));
}
},
getActionRepGain: (ctx) => (_type, _name, _level) => {
2023-01-02 19:28:31 +01:00
checkBladeburnerAccess(ctx);
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
2023-01-02 19:59:31 +01:00
const action = getBladeburnerActionObject(ctx, type, name);
const level = _level === undefined ? action.level : helpers.number(ctx, "level", _level);
const rewardMultiplier = Math.pow(action.rewardFac, level - 1);
return action.rankGain * rewardMultiplier * BitNodeMultipliers.BladeburnerRank;
},
getActionCountRemaining: (ctx) => (_type, _name) => {
2023-01-02 19:28:31 +01:00
const bladeburner = getBladeburner(ctx);
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
try {
return bladeburner.getActionCountRemainingNetscriptFn(type, name, ctx.workerScript);
} catch (e: unknown) {
throw helpers.makeRuntimeErrorMsg(ctx, String(e));
}
},
getActionMaxLevel: (ctx) => (_type, _name) => {
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
checkBladeburnerAccess(ctx);
const action = getBladeburnerActionObject(ctx, type, name);
return action.maxLevel;
},
getActionCurrentLevel: (ctx) => (_type, _name) => {
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
checkBladeburnerAccess(ctx);
const action = getBladeburnerActionObject(ctx, type, name);
return action.level;
},
getActionAutolevel: (ctx) => (_type, _name) => {
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
checkBladeburnerAccess(ctx);
const action = getBladeburnerActionObject(ctx, type, name);
return action.autoLevel;
},
2022-05-08 01:08:07 +02:00
setActionAutolevel:
(ctx) =>
(_type, _name, _autoLevel = true) => {
2022-08-08 19:43:41 +02:00
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
const autoLevel = !!_autoLevel;
2022-05-08 01:08:07 +02:00
checkBladeburnerAccess(ctx);
const action = getBladeburnerActionObject(ctx, type, name);
action.autoLevel = autoLevel;
},
setActionLevel:
(ctx) =>
(_type, _name, _level = 1) => {
2022-08-08 19:43:41 +02:00
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
const level = helpers.number(ctx, "level", _level);
2022-05-08 01:08:07 +02:00
checkBladeburnerAccess(ctx);
const action = getBladeburnerActionObject(ctx, type, name);
if (level < 1 || level > action.maxLevel) {
throw helpers.makeRuntimeErrorMsg(ctx, `Level must be between 1 and ${action.maxLevel}, is ${level}`);
2022-05-08 01:08:07 +02:00
}
action.level = level;
},
getRank: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return bladeburner.rank;
},
getSkillPoints: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return bladeburner.skillPoints;
},
getSkillLevel: (ctx) => (_skillName) => {
const skillName = helpers.string(ctx, "skillName", _skillName);
const bladeburner = getBladeburner(ctx);
try {
return bladeburner.getSkillLevelNetscriptFn(skillName, ctx.workerScript);
} catch (e: unknown) {
throw helpers.makeRuntimeErrorMsg(ctx, String(e));
}
},
2022-05-08 01:08:07 +02:00
getSkillUpgradeCost:
(ctx) =>
(_skillName, _count = 1) => {
const bladeburner = getBladeburner(ctx);
2022-08-08 19:43:41 +02:00
const skillName = helpers.string(ctx, "skillName", _skillName);
const count = helpers.number(ctx, "count", _count);
2022-05-08 01:08:07 +02:00
try {
2022-08-09 21:41:47 +02:00
return bladeburner.getSkillUpgradeCostNetscriptFn(skillName, count, ctx.workerScript);
2022-07-15 07:51:30 +02:00
} catch (e: unknown) {
2022-08-08 19:43:41 +02:00
throw helpers.makeRuntimeErrorMsg(ctx, String(e));
2022-05-08 01:08:07 +02:00
}
},
upgradeSkill:
(ctx) =>
(_skillName, _count = 1) => {
const bladeburner = getBladeburner(ctx);
2022-08-08 19:43:41 +02:00
const skillName = helpers.string(ctx, "skillName", _skillName);
const count = helpers.number(ctx, "count", _count);
2022-05-08 01:08:07 +02:00
try {
2022-08-09 21:41:47 +02:00
return bladeburner.upgradeSkillNetscriptFn(skillName, count, ctx.workerScript);
2022-07-15 07:51:30 +02:00
} catch (e: unknown) {
2022-08-08 19:43:41 +02:00
throw helpers.makeRuntimeErrorMsg(ctx, String(e));
2022-05-08 01:08:07 +02:00
}
},
getTeamSize: (ctx) => (_type, _name) => {
const bladeburner = getBladeburner(ctx);
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
try {
return bladeburner.getTeamSizeNetscriptFn(type, name, ctx.workerScript);
} catch (e: unknown) {
throw helpers.makeRuntimeErrorMsg(ctx, String(e));
}
},
setTeamSize: (ctx) => (_type, _name, _size) => {
const bladeburner = getBladeburner(ctx);
const type = helpers.string(ctx, "type", _type);
const name = helpers.string(ctx, "name", _name);
const size = helpers.number(ctx, "size", _size);
try {
return bladeburner.setTeamSizeNetscriptFn(type, name, size, ctx.workerScript);
} catch (e: unknown) {
throw helpers.makeRuntimeErrorMsg(ctx, String(e));
}
},
getCityEstimatedPopulation: (ctx) => (_cityName) => {
const bladeburner = getBladeburner(ctx);
const cityName = helpers.string(ctx, "cityName", _cityName);
if (!checkEnum(CityName, cityName)) throw new Error(`Invalid city: ${cityName}`);
return bladeburner.cities[cityName].popEst;
},
getCityCommunities: (ctx) => (_cityName) => {
const bladeburner = getBladeburner(ctx);
const cityName = helpers.string(ctx, "cityName", _cityName);
if (!checkEnum(CityName, cityName)) throw new Error(`Invalid city: ${cityName}`);
return bladeburner.cities[cityName].comms;
},
getCityChaos: (ctx) => (_cityName) => {
const bladeburner = getBladeburner(ctx);
const cityName = helpers.string(ctx, "cityName", _cityName);
if (!checkEnum(CityName, cityName)) throw new Error(`Invalid city: ${cityName}`);
return bladeburner.cities[cityName].chaos;
},
getCity: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return bladeburner.city;
},
switchCity: (ctx) => (_cityName) => {
const bladeburner = getBladeburner(ctx);
const cityName = helpers.string(ctx, "cityName", _cityName);
if (!checkEnum(CityName, cityName)) throw new Error(`Invalid city: ${cityName}`);
bladeburner.city = cityName;
return true;
},
getStamina: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2021-10-14 09:22:02 +02:00
return [bladeburner.stamina, bladeburner.maxStamina];
},
joinBladeburnerFaction: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2022-08-09 21:41:47 +02:00
return bladeburner.joinBladeburnerFactionNetscriptFn(ctx.workerScript);
2021-10-14 09:22:02 +02:00
},
joinBladeburnerDivision: (ctx) => () => {
2022-09-06 15:07:12 +02:00
if (Player.bitNodeN === 7 || Player.sourceFileLvl(7) > 0) {
2022-09-23 05:45:00 +02:00
if (BitNodeMultipliers.BladeburnerRank === 0) {
return false; // Disabled in this bitnode
2021-10-14 09:22:02 +02:00
}
if (Player.bladeburner) {
2021-10-14 09:22:02 +02:00
return true; // Already member
} else if (
2022-09-06 15:07:12 +02:00
Player.skills.strength >= 100 &&
Player.skills.defense >= 100 &&
Player.skills.dexterity >= 100 &&
Player.skills.agility >= 100
2021-10-14 09:22:02 +02:00
) {
2022-09-06 15:07:12 +02:00
Player.bladeburner = new Bladeburner();
2022-08-08 21:51:50 +02:00
helpers.log(ctx, () => "You have been accepted into the Bladeburner division");
2021-10-14 09:22:02 +02:00
return true;
} else {
2022-08-08 21:51:50 +02:00
helpers.log(ctx, () => "You do not meet the requirements for joining the Bladeburner division");
2021-10-14 09:22:02 +02:00
return false;
}
}
return false;
2021-10-14 09:22:02 +02:00
},
getBonusTime: (ctx) => () => {
2022-09-06 15:07:12 +02:00
const bladeburner = getBladeburner(ctx);
2022-03-30 02:44:27 +02:00
return Math.round(bladeburner.storedCycles / 5) * 1000;
2021-10-14 09:22:02 +02:00
},
};
}