Add ns.getFunctionRamCost (#526)

This commit is contained in:
G4mingJon4s 2023-05-26 13:46:08 +02:00 committed by GitHub
parent 294603fff8
commit 113af6e711
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 48 additions and 6 deletions

@ -0,0 +1,28 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [getFunctionRamCost](./bitburner.ns.getfunctionramcost.md)
## NS.getFunctionRamCost() method
Get the ram cost of a netscript function.
**Signature:**
```typescript
getFunctionRamCost(name: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | The fully-qualified function name, without the leading <code>ns</code>. Example inputs: <code>hack</code>, <code>tprint</code>, <code>stock.getPosition</code>. |
**Returns:**
number
## Remarks
RAM cost: 0 GB

@ -74,6 +74,7 @@ export async function main(ns) {
| [ftpcrack(host)](./bitburner.ns.ftpcrack.md) | Runs FTPCrack.exe on a server. |
| [getBitNodeMultipliers(n, lvl)](./bitburner.ns.getbitnodemultipliers.md) | Get the current Bitnode multipliers. |
| [getFavorToDonate()](./bitburner.ns.getfavortodonate.md) | Returns the amount of Faction favor required to be able to donate to a faction. |
| [getFunctionRamCost(name)](./bitburner.ns.getfunctionramcost.md) | Get the ram cost of a netscript function. |
| [getGrowTime(host)](./bitburner.ns.getgrowtime.md) | Get the execution time of a grow() call. |
| [getHackingLevel()](./bitburner.ns.gethackinglevel.md) | Returns the players current hacking level. |
| [getHackingMultipliers()](./bitburner.ns.gethackingmultipliers.md) | Get hacking related multipliers. |

@ -534,6 +534,7 @@ export const RamCosts: RamCostTree<NSFull> = {
getMoneySources: RamCostConstants.GetMoneySourcesCost,
mv: 0,
getResetInfo: 1,
getFunctionRamCost: 0,
tail: 0,
toast: 0,
moveTail: 0,
@ -613,15 +614,13 @@ export const RamCosts: RamCostTree<NSFull> = {
export function getRamCost(...args: string[]): number {
if (args.length === 0) {
console.warn(`No arguments passed to getRamCost()`);
return 0;
throw new Error(`No arguments passed to getRamCost()`);
}
let curr = RamCosts[args[0] as keyof typeof RamCosts];
for (let i = 1; i < args.length; ++i) {
if (curr == null) {
console.warn(`Invalid function passed to getRamCost: ${args}`);
return 0;
throw new Error(`Invalid function passed to getRamCost: ${args.join(".")}`);
}
const currType = typeof curr;
@ -640,6 +639,5 @@ export function getRamCost(...args: string[]): number {
return curr();
}
console.warn(`Unexpected type (${curr}) for value [${args}]`);
return 0;
throw new Error(`Invalid function passed to getRamCost: ${args.join(".")}`);
}

@ -93,6 +93,7 @@ import { ContentFilePath } from "./Paths/ContentFile";
import { LiteratureName } from "./Literature/data/LiteratureNames";
import { hasProgramExtension } from "./Paths/ProgramFilePath";
import { hasContractExtension } from "./Paths/ContractFilePath";
import { getRamCost } from "./Netscript/RamCostGenerator";
export const enums: NSEnums = {
CityName,
@ -1737,6 +1738,10 @@ export const ns: InternalAPI<NSFull> = {
lastNodeReset: Player.lastNodeReset,
currentNode: Player.bitNodeN,
}),
getFunctionRamCost: (ctx) => (_name) => {
const name = helpers.string(ctx, "name", _name);
return getRamCost(...name.split("."));
},
flags: Flags,
...NetscriptExtra(),
};

@ -6510,6 +6510,16 @@ export interface NS {
* */
getResetInfo(): ResetInfo;
/**
* Get the ram cost of a netscript function.
*
* @remarks
* RAM cost: 0 GB
*
* @param name - The fully-qualified function name, without the leading `ns`. Example inputs: `hack`, `tprint`, `stock.getPosition`.
*/
getFunctionRamCost(name: string): number;
/**
* Parse command line flags.
* @remarks