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

Merge pull request #1842 from danielyxie/dev

Browse Source 
Formulas doc
This commit is contained in:
hydroflame 2021-12-08 19:19:42 -05:00 committed by GitHub
commit 30af70c4ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
37 changed files with 632 additions and 205 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

183
dist/bitburner.d.ts vendored
View File

@ -1270,7 +1270,7 @@ export declare interface GangFormulas {
* @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation} * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}
* @returns The calculated wanted penalty. * @returns The calculated wanted penalty.
*/ */
calculateWantedPenalty(gang: GangGenInfo): number; wantedPenalty(gang: GangGenInfo): number;
/** /**
* Calculate respect gain per tick. * Calculate respect gain per tick.
* @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation} * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}
@ -1278,7 +1278,7 @@ export declare interface GangFormulas {
* @param task - Gang info from {@link Gang.getTaskStats | getTaskStats} * @param task - Gang info from {@link Gang.getTaskStats | getTaskStats}
* @returns The calculated respect gain. * @returns The calculated respect gain.
*/ */
calculateRespectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; respectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number;
/** /**
* Calculate wanted gain per tick. * Calculate wanted gain per tick.
* @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation} * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}
@ -1286,7 +1286,7 @@ export declare interface GangFormulas {
* @param task - Task info from {@link Gang.getTaskStats | getTaskStats} * @param task - Task info from {@link Gang.getTaskStats | getTaskStats}
* @returns The calculated wanted gain. * @returns The calculated wanted gain.
*/ */
calculateWantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; wantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number;
/** /**
* Calculate money gain per tick. * Calculate money gain per tick.
* @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation} * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}
@ -1294,7 +1294,7 @@ export declare interface GangFormulas {
* @param task - Task info from {@link Gang.getTaskStats | getTaskStats} * @param task - Task info from {@link Gang.getTaskStats | getTaskStats}
* @returns The calculated money gain. * @returns The calculated money gain.
*/ */
calculateMoneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; moneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number;
} }
/** /**
@ -1471,16 +1471,65 @@ export declare interface GangTerritory {
} }
/** /**
* Hacking formulas
* @public * @public
*/ */
export declare interface HackingFormulas { export declare interface HackingFormulas {
hackChance(server: number, player: number): number; /**
hackExp(server: number, player: number): number; * Calculate hack chance.
hackPercent(server: number, player: number): number; * @param server - Server info from {@link NS.getServer | getServer}
growPercent(server: number, threads: number, player: number, cores?: number): number; * @param player - Player info from {@link NS.getPlayer | getPlayer}
hackTime(server: number, player: number): number; * @returns The calculated hack chance.
growTime(server: number, player: number): number; */
weakenTime(server: number, player: number): number; hackChance(server: Server, player: Player): number;
/**
* Calculate hack exp for one thread.
* @remarks
* Multiply by thread to get total exp
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated hack exp.
*/
hackExp(server: Server, player: Player): number;
/**
* Calculate hack percent for one thread.
* @remarks
* Multiply by thread to get total percent hacked.
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated hack percent.
*/
hackPercent(server: Server, player: Player): number;
/**
* Calculate the percent a server would grow.
* @param server - Server info from {@link NS.getServer | getServer}
* @param threads - Amount of thread.
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @param cores - Number of cores on the computer that will execute grow.
* @returns The calculated grow percent.
*/
growPercent(server: Server, threads: number, player: Player, cores?: number): number;
/**
* Calculate hack time.
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated hack time.
*/
hackTime(server: Server, player: Player): number;
/**
* Calculate grow time.
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated grow time.
*/
growTime(server: Server, player: Player): number;
/**
* Calculate weaken time.
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated weaken time.
*/
weakenTime(server: Server, player: Player): number;
} }
/** /**
@ -1834,28 +1883,121 @@ export declare interface HacknetMultipliers {
} }
/** /**
* Hacknet Node formulas
* @public * @public
*/ */
export declare interface HacknetNodesFormulas { export declare interface HacknetNodesFormulas {
/**
* Calculate money gain rate.
* @param level - level of the node.
* @param ram - ram of the node.
* @param cores - cores of the node.
* @param mult - player production mult (default to 1)
* @returns The calculated money gain rate.
*/
moneyGainRate(level: number, ram: number, cores: number, mult?: number): number; moneyGainRate(level: number, ram: number, cores: number, mult?: number): number;
/**
* Calculate cost of upgrading hacknet node level.
* @param startingLevel - starting level
* @param extraLevels - amount of level to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number; levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number;
/**
* Calculate cost of upgrading hacknet node ram.
* @param startingRam - starting ram
* @param extraLevels - amount of level of ram to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number; ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number;
/**
* Calculate cost of upgrading hacknet node cores.
* @param startingCore - starting cores
* @param extraCores - amount of cores to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number; coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number;
/**
* Calculate the cost of a hacknet node.
* @param n - number of the hacknet node
* @param mult - player cost reduction (defaults to 1)
* @returns The calculated cost.
*/
hacknetNodeCost(n: number, mult: number): number; hacknetNodeCost(n: number, mult: number): number;
/**
* All constants used by the game.
* @returns An object with all hacknet node constants used by the game.
*/
constants(): number; constants(): number;
} }
/** /**
* Hacknet Server formulas
* @public * @public
*/ */
export declare interface HacknetServersFormulas { export declare interface HacknetServersFormulas {
/**
* Calculate hash gain rate.
* @param level - level of the server.
* @param ramUsed - ramUsed of the server.
* @param maxRam - maxRam of the server.
* @param cores - cores of the server.
* @param mult - player production mult (default to 1)
* @returns The calculated hash gain rate.
*/
hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult?: number): number; hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult?: number): number;
/**
* Calculate cost of upgrading hacknet server level.
* @param startingLevel - starting level
* @param extraLevels - amount of level to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number; levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number;
/**
* Calculate cost of upgrading hacknet server ram.
* @param startingRam - starting ram
* @param extraLevels - amount of level of ram to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number; ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number;
/**
* Calculate cost of upgrading hacknet server cores.
* @param startingCore - starting cores
* @param extraCores - amount of cores to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number; coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number;
/**
* Calculate cost of upgrading hacknet server cache.
* @param startingCache - starting cache level
* @param extraCache - amount of levels of cache to purchase (defaults to 1)
* @returns The calculated cost.
*/
cacheUpgradeCost(startingCache: number, extraCache?: number): number; cacheUpgradeCost(startingCache: number, extraCache?: number): number;
/**
* Calculate hash cost of an upgrade.
* @param upgName - name of the upgrade
* @param level - level of the upgrade
* @returns The calculated hash cost.
*/
hashUpgradeCost(upgName: number, level: number): number; hashUpgradeCost(upgName: number, level: number): number;
hacknetServerCost(n: number, mult: number): number; /**
* Calculate the cost of a hacknet server.
* @param n - number of the hacknet server
* @param mult - player cost reduction (defaults to 1)
* @returns The calculated cost.
*/
hacknetServerCost(n: number, mult?: number): number;
/**
* All constants used by the game.
* @returns An object with all hacknet server constants used by the game.
*/
constants(): any; constants(): any;
} }
@ -4550,11 +4692,24 @@ export declare interface Singularity {
} }
/** /**
* Skills formulas
* @public * @public
*/ */
export declare interface SkillsFormulas { export declare interface SkillsFormulas {
calculateSkill(exp: number, mult?: number): number; /**
calculateExp(skill: number, mult?: number): number; * Calculate skill level.
* @param exp - experience for that skill
* @param skillMult - Multiplier for that skill, defaults to 1.
* @returns The calculated skill level.
*/
calculateSkill(exp: number, skillMult?: number): number;
/**
* Calculate exp for skill level.
* @param skill - target skill level
* @param skillMult - Multiplier for that skill, defaults to 1.
* @returns The calculated exp required.
*/
calculateExp(skill: number, skillMult?: number): number;
} }
/** /**

158
input/bitburner.api.json
View File

@ -8575,12 +8575,12 @@
"members": [ "members": [
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!GangFormulas#calculateMoneyGain:member(1)", "canonicalReference": "bitburner!GangFormulas#moneyGain:member(1)",
"docComment": "/**\n * Calculate money gain per tick.\n *\n * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}\n *\n * @param member - Member info from {@link Gang.getMemberInformation | getMemberInformation}\n *\n * @param task - Task info from {@link Gang.getTaskStats | getTaskStats}\n *\n * @returns The calculated money gain.\n */\n", "docComment": "/**\n * Calculate money gain per tick.\n *\n * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}\n *\n * @param member - Member info from {@link Gang.getMemberInformation | getMemberInformation}\n *\n * @param task - Task info from {@link Gang.getTaskStats | getTaskStats}\n *\n * @returns The calculated money gain.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "calculateMoneyGain(gang: " "text": "moneyGain(gang: "
}, },
{ {
"kind": "Reference", "kind": "Reference",
@ -8648,16 +8648,16 @@
} }
} }
], ],
"name": "calculateMoneyGain" "name": "moneyGain"
}, },
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!GangFormulas#calculateRespectGain:member(1)", "canonicalReference": "bitburner!GangFormulas#respectGain:member(1)",
"docComment": "/**\n * Calculate respect gain per tick.\n *\n * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}\n *\n * @param member - Gang info from {@link Gang.getMemberInformation | getMemberInformation}\n *\n * @param task - Gang info from {@link Gang.getTaskStats | getTaskStats}\n *\n * @returns The calculated respect gain.\n */\n", "docComment": "/**\n * Calculate respect gain per tick.\n *\n * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}\n *\n * @param member - Gang info from {@link Gang.getMemberInformation | getMemberInformation}\n *\n * @param task - Gang info from {@link Gang.getTaskStats | getTaskStats}\n *\n * @returns The calculated respect gain.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "calculateRespectGain(gang: " "text": "respectGain(gang: "
}, },
{ {
"kind": "Reference", "kind": "Reference",
@ -8725,16 +8725,16 @@
} }
} }
], ],
"name": "calculateRespectGain" "name": "respectGain"
}, },
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!GangFormulas#calculateWantedLevelGain:member(1)", "canonicalReference": "bitburner!GangFormulas#wantedLevelGain:member(1)",
"docComment": "/**\n * Calculate wanted gain per tick.\n *\n * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}\n *\n * @param member - Member info from {@link Gang.getMemberInformation | getMemberInformation}\n *\n * @param task - Task info from {@link Gang.getTaskStats | getTaskStats}\n *\n * @returns The calculated wanted gain.\n */\n", "docComment": "/**\n * Calculate wanted gain per tick.\n *\n * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}\n *\n * @param member - Member info from {@link Gang.getMemberInformation | getMemberInformation}\n *\n * @param task - Task info from {@link Gang.getTaskStats | getTaskStats}\n *\n * @returns The calculated wanted gain.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "calculateWantedLevelGain(gang: " "text": "wantedLevelGain(gang: "
}, },
{ {
"kind": "Reference", "kind": "Reference",
@ -8802,16 +8802,16 @@
} }
} }
], ],
"name": "calculateWantedLevelGain" "name": "wantedLevelGain"
}, },
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!GangFormulas#calculateWantedPenalty:member(1)", "canonicalReference": "bitburner!GangFormulas#wantedPenalty:member(1)",
"docComment": "/**\n * Calculate the wanted penalty.\n *\n * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}\n *\n * @returns The calculated wanted penalty.\n */\n", "docComment": "/**\n * Calculate the wanted penalty.\n *\n * @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}\n *\n * @returns The calculated wanted penalty.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "calculateWantedPenalty(gang: " "text": "wantedPenalty(gang: "
}, },
{ {
"kind": "Reference", "kind": "Reference",
@ -8847,7 +8847,7 @@
} }
} }
], ],
"name": "calculateWantedPenalty" "name": "wantedPenalty"
} }
], ],
"extendsTokenRanges": [] "extendsTokenRanges": []
@ -11159,7 +11159,7 @@
{ {
"kind": "Interface", "kind": "Interface",
"canonicalReference": "bitburner!HackingFormulas:interface", "canonicalReference": "bitburner!HackingFormulas:interface",
"docComment": "/**\n * @public\n */\n", "docComment": "/**\n * Hacking formulas\n *\n * @public\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -11172,15 +11172,16 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HackingFormulas#growPercent:member(1)", "canonicalReference": "bitburner!HackingFormulas#growPercent:member(1)",
"docComment": "", "docComment": "/**\n * Calculate the percent a server would grow.\n *\n * @param server - Server info from {@link NS.getServer | getServer}\n *\n * @param threads - Amount of thread.\n *\n * @param player - Player info from {@link NS.getPlayer | getPlayer}\n *\n * @param cores - Number of cores on the computer that will execute grow.\n *\n * @returns The calculated grow percent.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "growPercent(server: " "text": "growPercent(server: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Server",
"canonicalReference": "bitburner!Server:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -11195,8 +11196,9 @@
"text": ", player: " "text": ", player: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Player",
"canonicalReference": "bitburner!Player:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -11261,23 +11263,25 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HackingFormulas#growTime:member(1)", "canonicalReference": "bitburner!HackingFormulas#growTime:member(1)",
"docComment": "", "docComment": "/**\n * Calculate grow time.\n *\n * @param server - Server info from {@link NS.getServer | getServer}\n *\n * @param player - Player info from {@link NS.getPlayer | getPlayer}\n *\n * @returns The calculated grow time.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "growTime(server: " "text": "growTime(server: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Server",
"canonicalReference": "bitburner!Server:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
"text": ", player: " "text": ", player: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Player",
"canonicalReference": "bitburner!Player:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -11320,23 +11324,25 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HackingFormulas#hackChance:member(1)", "canonicalReference": "bitburner!HackingFormulas#hackChance:member(1)",
"docComment": "", "docComment": "/**\n * Calculate hack chance.\n *\n * @param server - Server info from {@link NS.getServer | getServer}\n *\n * @param player - Player info from {@link NS.getPlayer | getPlayer}\n *\n * @returns The calculated hack chance.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "hackChance(server: " "text": "hackChance(server: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Server",
"canonicalReference": "bitburner!Server:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
"text": ", player: " "text": ", player: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Player",
"canonicalReference": "bitburner!Player:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -11379,23 +11385,25 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HackingFormulas#hackExp:member(1)", "canonicalReference": "bitburner!HackingFormulas#hackExp:member(1)",
"docComment": "", "docComment": "/**\n * Calculate hack exp for one thread.\n *\n * @remarks\n *\n * Multiply by thread to get total exp\n *\n * @param server - Server info from {@link NS.getServer | getServer}\n *\n * @param player - Player info from {@link NS.getPlayer | getPlayer}\n *\n * @returns The calculated hack exp.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "hackExp(server: " "text": "hackExp(server: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Server",
"canonicalReference": "bitburner!Server:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
"text": ", player: " "text": ", player: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Player",
"canonicalReference": "bitburner!Player:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -11438,23 +11446,25 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HackingFormulas#hackPercent:member(1)", "canonicalReference": "bitburner!HackingFormulas#hackPercent:member(1)",
"docComment": "", "docComment": "/**\n * Calculate hack percent for one thread.\n *\n * @remarks\n *\n * Multiply by thread to get total percent hacked.\n *\n * @param server - Server info from {@link NS.getServer | getServer}\n *\n * @param player - Player info from {@link NS.getPlayer | getPlayer}\n *\n * @returns The calculated hack percent.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "hackPercent(server: " "text": "hackPercent(server: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Server",
"canonicalReference": "bitburner!Server:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
"text": ", player: " "text": ", player: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Player",
"canonicalReference": "bitburner!Player:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -11497,23 +11507,25 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HackingFormulas#hackTime:member(1)", "canonicalReference": "bitburner!HackingFormulas#hackTime:member(1)",
"docComment": "", "docComment": "/**\n * Calculate hack time.\n *\n * @param server - Server info from {@link NS.getServer | getServer}\n *\n * @param player - Player info from {@link NS.getPlayer | getPlayer}\n *\n * @returns The calculated hack time.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "hackTime(server: " "text": "hackTime(server: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Server",
"canonicalReference": "bitburner!Server:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
"text": ", player: " "text": ", player: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Player",
"canonicalReference": "bitburner!Player:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -11556,23 +11568,25 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HackingFormulas#weakenTime:member(1)", "canonicalReference": "bitburner!HackingFormulas#weakenTime:member(1)",
"docComment": "", "docComment": "/**\n * Calculate weaken time.\n *\n * @param server - Server info from {@link NS.getServer | getServer}\n *\n * @param player - Player info from {@link NS.getPlayer | getPlayer}\n *\n * @returns The calculated weaken time.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
"text": "weakenTime(server: " "text": "weakenTime(server: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Server",
"canonicalReference": "bitburner!Server:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
"text": ", player: " "text": ", player: "
}, },
{ {
"kind": "Content", "kind": "Reference",
"text": "number" "text": "Player",
"canonicalReference": "bitburner!Player:interface"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -12788,7 +12802,7 @@
{ {
"kind": "Interface", "kind": "Interface",
"canonicalReference": "bitburner!HacknetNodesFormulas:interface", "canonicalReference": "bitburner!HacknetNodesFormulas:interface",
"docComment": "/**\n * @public\n */\n", "docComment": "/**\n * Hacknet Node formulas\n *\n * @public\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -12801,7 +12815,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetNodesFormulas#constants:member(1)", "canonicalReference": "bitburner!HacknetNodesFormulas#constants:member(1)",
"docComment": "", "docComment": "/**\n * All constants used by the game.\n *\n * @returns An object with all hacknet node constants used by the game.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -12829,7 +12843,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetNodesFormulas#coreUpgradeCost:member(1)", "canonicalReference": "bitburner!HacknetNodesFormulas#coreUpgradeCost:member(1)",
"docComment": "", "docComment": "/**\n * Calculate cost of upgrading hacknet node cores.\n *\n * @param startingCore - starting cores\n *\n * @param extraCores - amount of cores to purchase (defaults to 1)\n *\n * @param costMult - player cost reduction (default to 1)\n *\n * @returns The calculated cost.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -12903,7 +12917,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetNodesFormulas#hacknetNodeCost:member(1)", "canonicalReference": "bitburner!HacknetNodesFormulas#hacknetNodeCost:member(1)",
"docComment": "", "docComment": "/**\n * Calculate the cost of a hacknet node.\n *\n * @param n - number of the hacknet node\n *\n * @param mult - player cost reduction (defaults to 1)\n *\n * @returns The calculated cost.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -12962,7 +12976,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetNodesFormulas#levelUpgradeCost:member(1)", "canonicalReference": "bitburner!HacknetNodesFormulas#levelUpgradeCost:member(1)",
"docComment": "", "docComment": "/**\n * Calculate cost of upgrading hacknet node level.\n *\n * @param startingLevel - starting level\n *\n * @param extraLevels - amount of level to purchase (defaults to 1)\n *\n * @param costMult - player cost reduction (default to 1)\n *\n * @returns The calculated cost.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13036,7 +13050,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetNodesFormulas#moneyGainRate:member(1)", "canonicalReference": "bitburner!HacknetNodesFormulas#moneyGainRate:member(1)",
"docComment": "", "docComment": "/**\n * Calculate money gain rate.\n *\n * @param level - level of the node.\n *\n * @param ram - ram of the node.\n *\n * @param cores - cores of the node.\n *\n * @param mult - player production mult (default to 1)\n *\n * @returns The calculated money gain rate.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13125,7 +13139,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetNodesFormulas#ramUpgradeCost:member(1)", "canonicalReference": "bitburner!HacknetNodesFormulas#ramUpgradeCost:member(1)",
"docComment": "", "docComment": "/**\n * Calculate cost of upgrading hacknet node ram.\n *\n * @param startingRam - starting ram\n *\n * @param extraLevels - amount of level of ram to purchase (defaults to 1)\n *\n * @param costMult - player cost reduction (default to 1)\n *\n * @returns The calculated cost.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13202,7 +13216,7 @@
{ {
"kind": "Interface", "kind": "Interface",
"canonicalReference": "bitburner!HacknetServersFormulas:interface", "canonicalReference": "bitburner!HacknetServersFormulas:interface",
"docComment": "/**\n * @public\n */\n", "docComment": "/**\n * Hacknet Server formulas\n *\n * @public\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13215,7 +13229,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetServersFormulas#cacheUpgradeCost:member(1)", "canonicalReference": "bitburner!HacknetServersFormulas#cacheUpgradeCost:member(1)",
"docComment": "", "docComment": "/**\n * Calculate cost of upgrading hacknet server cache.\n *\n * @param startingCache - starting cache level\n *\n * @param extraCache - amount of levels of cache to purchase (defaults to 1)\n *\n * @returns The calculated cost.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13274,7 +13288,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetServersFormulas#constants:member(1)", "canonicalReference": "bitburner!HacknetServersFormulas#constants:member(1)",
"docComment": "", "docComment": "/**\n * All constants used by the game.\n *\n * @returns An object with all hacknet server constants used by the game.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13302,7 +13316,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetServersFormulas#coreUpgradeCost:member(1)", "canonicalReference": "bitburner!HacknetServersFormulas#coreUpgradeCost:member(1)",
"docComment": "", "docComment": "/**\n * Calculate cost of upgrading hacknet server cores.\n *\n * @param startingCore - starting cores\n *\n * @param extraCores - amount of cores to purchase (defaults to 1)\n *\n * @param costMult - player cost reduction (default to 1)\n *\n * @returns The calculated cost.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13376,7 +13390,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetServersFormulas#hacknetServerCost:member(1)", "canonicalReference": "bitburner!HacknetServersFormulas#hacknetServerCost:member(1)",
"docComment": "", "docComment": "/**\n * Calculate the cost of a hacknet server.\n *\n * @param n - number of the hacknet server\n *\n * @param mult - player cost reduction (defaults to 1)\n *\n * @returns The calculated cost.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13388,7 +13402,7 @@
}, },
{ {
"kind": "Content", "kind": "Content",
"text": ", mult: " "text": ", mult?: "
}, },
{ {
"kind": "Content", "kind": "Content",
@ -13435,7 +13449,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetServersFormulas#hashGainRate:member(1)", "canonicalReference": "bitburner!HacknetServersFormulas#hashGainRate:member(1)",
"docComment": "", "docComment": "/**\n * Calculate hash gain rate.\n *\n * @param level - level of the server.\n *\n * @param ramUsed - ramUsed of the server.\n *\n * @param maxRam - maxRam of the server.\n *\n * @param cores - cores of the server.\n *\n * @param mult - player production mult (default to 1)\n *\n * @returns The calculated hash gain rate.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13539,7 +13553,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetServersFormulas#hashUpgradeCost:member(1)", "canonicalReference": "bitburner!HacknetServersFormulas#hashUpgradeCost:member(1)",
"docComment": "", "docComment": "/**\n * Calculate hash cost of an upgrade.\n *\n * @param upgName - name of the upgrade\n *\n * @param level - level of the upgrade\n *\n * @returns The calculated hash cost.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13598,7 +13612,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetServersFormulas#levelUpgradeCost:member(1)", "canonicalReference": "bitburner!HacknetServersFormulas#levelUpgradeCost:member(1)",
"docComment": "", "docComment": "/**\n * Calculate cost of upgrading hacknet server level.\n *\n * @param startingLevel - starting level\n *\n * @param extraLevels - amount of level to purchase (defaults to 1)\n *\n * @param costMult - player cost reduction (default to 1)\n *\n * @returns The calculated cost.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -13672,7 +13686,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!HacknetServersFormulas#ramUpgradeCost:member(1)", "canonicalReference": "bitburner!HacknetServersFormulas#ramUpgradeCost:member(1)",
"docComment": "", "docComment": "/**\n * Calculate cost of upgrading hacknet server ram.\n *\n * @param startingRam - starting ram\n *\n * @param extraLevels - amount of level of ram to purchase (defaults to 1)\n *\n * @param costMult - player cost reduction (default to 1)\n *\n * @returns The calculated cost.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -25825,7 +25839,7 @@
{ {
"kind": "Interface", "kind": "Interface",
"canonicalReference": "bitburner!SkillsFormulas:interface", "canonicalReference": "bitburner!SkillsFormulas:interface",
"docComment": "/**\n * @public\n */\n", "docComment": "/**\n * Skills formulas\n *\n * @public\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -25838,7 +25852,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!SkillsFormulas#calculateExp:member(1)", "canonicalReference": "bitburner!SkillsFormulas#calculateExp:member(1)",
"docComment": "", "docComment": "/**\n * Calculate exp for skill level.\n *\n * @param skill - target skill level\n *\n * @param skillMult - Multiplier for that skill, defaults to 1.\n *\n * @returns The calculated exp required.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -25850,7 +25864,7 @@
}, },
{ {
"kind": "Content", "kind": "Content",
"text": ", mult?: " "text": ", skillMult?: "
}, },
{ {
"kind": "Content", "kind": "Content",
@ -25885,7 +25899,7 @@
} }
}, },
{ {
"parameterName": "mult", "parameterName": "skillMult",
"parameterTypeTokenRange": { "parameterTypeTokenRange": {
"startIndex": 3, "startIndex": 3,
"endIndex": 4 "endIndex": 4
@ -25897,7 +25911,7 @@
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!SkillsFormulas#calculateSkill:member(1)", "canonicalReference": "bitburner!SkillsFormulas#calculateSkill:member(1)",
"docComment": "", "docComment": "/**\n * Calculate skill level.\n *\n * @param exp - experience for that skill\n *\n * @param skillMult - Multiplier for that skill, defaults to 1.\n *\n * @returns The calculated skill level.\n */\n",
"excerptTokens": [ "excerptTokens": [
{ {
"kind": "Content", "kind": "Content",
@ -25909,7 +25923,7 @@
}, },
{ {
"kind": "Content", "kind": "Content",
"text": ", mult?: " "text": ", skillMult?: "
}, },
{ {
"kind": "Content", "kind": "Content",
@ -25944,7 +25958,7 @@
} }
}, },
{ {
"parameterName": "mult", "parameterName": "skillMult",
"parameterTypeTokenRange": { "parameterTypeTokenRange": {
"startIndex": 3, "startIndex": 3,
"endIndex": 4 "endIndex": 4

8
markdown/bitburner.gangformulas.md
View File

@ -16,8 +16,8 @@ interface GangFormulas
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [calculateMoneyGain(gang, member, task)](./bitburner.gangformulas.calculatemoneygain.md) | Calculate money gain per tick. | | [moneyGain(gang, member, task)](./bitburner.gangformulas.moneygain.md) | Calculate money gain per tick. |
| [calculateRespectGain(gang, member, task)](./bitburner.gangformulas.calculaterespectgain.md) | Calculate respect gain per tick. | | [respectGain(gang, member, task)](./bitburner.gangformulas.respectgain.md) | Calculate respect gain per tick. |
| [calculateWantedLevelGain(gang, member, task)](./bitburner.gangformulas.calculatewantedlevelgain.md) | Calculate wanted gain per tick. | | [wantedLevelGain(gang, member, task)](./bitburner.gangformulas.wantedlevelgain.md) | Calculate wanted gain per tick. |
| [calculateWantedPenalty(gang)](./bitburner.gangformulas.calculatewantedpenalty.md) | Calculate the wanted penalty. | | [wantedPenalty(gang)](./bitburner.gangformulas.wantedpenalty.md) | Calculate the wanted penalty. |

6
markdown/bitburner.gangformulas.calculatemoneygain.md → markdown/bitburner.gangformulas.moneygain.md
View File

@ -1,15 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. --> <!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangFormulas](./bitburner.gangformulas.md) &gt; [calculateMoneyGain](./bitburner.gangformulas.calculatemoneygain.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangFormulas](./bitburner.gangformulas.md) &gt; [moneyGain](./bitburner.gangformulas.moneygain.md)
## GangFormulas.calculateMoneyGain() method ## GangFormulas.moneyGain() method
Calculate money gain per tick. Calculate money gain per tick.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
calculateMoneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; moneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number;
``` ```
## Parameters ## Parameters

6
markdown/bitburner.gangformulas.calculaterespectgain.md → markdown/bitburner.gangformulas.respectgain.md
View File

@ -1,15 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. --> <!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangFormulas](./bitburner.gangformulas.md) &gt; [calculateRespectGain](./bitburner.gangformulas.calculaterespectgain.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangFormulas](./bitburner.gangformulas.md) &gt; [respectGain](./bitburner.gangformulas.respectgain.md)
## GangFormulas.calculateRespectGain() method ## GangFormulas.respectGain() method
Calculate respect gain per tick. Calculate respect gain per tick.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
calculateRespectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; respectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number;
``` ```
## Parameters ## Parameters

6
markdown/bitburner.gangformulas.calculatewantedlevelgain.md → markdown/bitburner.gangformulas.wantedlevelgain.md
View File

@ -1,15 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. --> <!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangFormulas](./bitburner.gangformulas.md) &gt; [calculateWantedLevelGain](./bitburner.gangformulas.calculatewantedlevelgain.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangFormulas](./bitburner.gangformulas.md) &gt; [wantedLevelGain](./bitburner.gangformulas.wantedlevelgain.md)
## GangFormulas.calculateWantedLevelGain() method ## GangFormulas.wantedLevelGain() method
Calculate wanted gain per tick. Calculate wanted gain per tick.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
calculateWantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; wantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number;
``` ```
## Parameters ## Parameters

6
markdown/bitburner.gangformulas.calculatewantedpenalty.md → markdown/bitburner.gangformulas.wantedpenalty.md
View File

@ -1,15 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. --> <!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangFormulas](./bitburner.gangformulas.md) &gt; [calculateWantedPenalty](./bitburner.gangformulas.calculatewantedpenalty.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangFormulas](./bitburner.gangformulas.md) &gt; [wantedPenalty](./bitburner.gangformulas.wantedpenalty.md)
## GangFormulas.calculateWantedPenalty() method ## GangFormulas.wantedPenalty() method
Calculate the wanted penalty. Calculate the wanted penalty.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
calculateWantedPenalty(gang: GangGenInfo): number; wantedPenalty(gang: GangGenInfo): number;
``` ```
## Parameters ## Parameters

14
markdown/bitburner.hackingformulas.growpercent.md
View File

@ -4,22 +4,26 @@
## HackingFormulas.growPercent() method ## HackingFormulas.growPercent() method
Calculate the percent a server would grow.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
growPercent(server: number, threads: number, player: number, cores?: number): number; growPercent(server: Server, threads: number, player: Player, cores?: number): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| server | number | | | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| threads | number | | | threads | number | Amount of thread. |
| player | number | | | player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
| cores | number | | | cores | number | Number of cores on the computer that will execute grow. |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated grow percent.

10
markdown/bitburner.hackingformulas.growtime.md
View File

@ -4,20 +4,24 @@
## HackingFormulas.growTime() method ## HackingFormulas.growTime() method
Calculate grow time.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
growTime(server: number, player: number): number; growTime(server: Server, player: Player): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| server | number | | | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | number | | | player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated grow time.

10
markdown/bitburner.hackingformulas.hackchance.md
View File

@ -4,20 +4,24 @@
## HackingFormulas.hackChance() method ## HackingFormulas.hackChance() method
Calculate hack chance.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
hackChance(server: number, player: number): number; hackChance(server: Server, player: Player): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| server | number | | | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | number | | | player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated hack chance.

14
markdown/bitburner.hackingformulas.hackexp.md
View File

@ -4,20 +4,28 @@
## HackingFormulas.hackExp() method ## HackingFormulas.hackExp() method
Calculate hack exp for one thread.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
hackExp(server: number, player: number): number; hackExp(server: Server, player: Player): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| server | number | | | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | number | | | player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated hack exp.
## Remarks
Multiply by thread to get total exp

14
markdown/bitburner.hackingformulas.hackpercent.md
View File

@ -4,20 +4,28 @@
## HackingFormulas.hackPercent() method ## HackingFormulas.hackPercent() method
Calculate hack percent for one thread.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
hackPercent(server: number, player: number): number; hackPercent(server: Server, player: Player): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| server | number | | | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | number | | | player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated hack percent.
## Remarks
Multiply by thread to get total percent hacked.

10
markdown/bitburner.hackingformulas.hacktime.md
View File

@ -4,20 +4,24 @@
## HackingFormulas.hackTime() method ## HackingFormulas.hackTime() method
Calculate hack time.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
hackTime(server: number, player: number): number; hackTime(server: Server, player: Player): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| server | number | | | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | number | | | player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated hack time.

15
markdown/bitburner.hackingformulas.md
View File

@ -4,6 +4,7 @@
## HackingFormulas interface ## HackingFormulas interface
Hacking formulas
<b>Signature:</b> <b>Signature:</b>
@ -15,11 +16,11 @@ interface HackingFormulas
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [growPercent(server, threads, player, cores)](./bitburner.hackingformulas.growpercent.md) | | | [growPercent(server, threads, player, cores)](./bitburner.hackingformulas.growpercent.md) | Calculate the percent a server would grow. |
| [growTime(server, player)](./bitburner.hackingformulas.growtime.md) | | | [growTime(server, player)](./bitburner.hackingformulas.growtime.md) | Calculate grow time. |
| [hackChance(server, player)](./bitburner.hackingformulas.hackchance.md) | | | [hackChance(server, player)](./bitburner.hackingformulas.hackchance.md) | Calculate hack chance. |
| [hackExp(server, player)](./bitburner.hackingformulas.hackexp.md) | | | [hackExp(server, player)](./bitburner.hackingformulas.hackexp.md) | Calculate hack exp for one thread. |
| [hackPercent(server, player)](./bitburner.hackingformulas.hackpercent.md) | | | [hackPercent(server, player)](./bitburner.hackingformulas.hackpercent.md) | Calculate hack percent for one thread. |
| [hackTime(server, player)](./bitburner.hackingformulas.hacktime.md) | | | [hackTime(server, player)](./bitburner.hackingformulas.hacktime.md) | Calculate hack time. |
| [weakenTime(server, player)](./bitburner.hackingformulas.weakentime.md) | | | [weakenTime(server, player)](./bitburner.hackingformulas.weakentime.md) | Calculate weaken time. |

10
markdown/bitburner.hackingformulas.weakentime.md
View File

@ -4,20 +4,24 @@
## HackingFormulas.weakenTime() method ## HackingFormulas.weakenTime() method
Calculate weaken time.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
weakenTime(server: number, player: number): number; weakenTime(server: Server, player: Player): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| server | number | | | server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | number | | | player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated weaken time.

4
markdown/bitburner.hacknetnodesformulas.constants.md
View File

@ -4,6 +4,8 @@
## HacknetNodesFormulas.constants() method ## HacknetNodesFormulas.constants() method
All constants used by the game.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -13,3 +15,5 @@ constants(): number;
number number
An object with all hacknet node constants used by the game.

10
markdown/bitburner.hacknetnodesformulas.coreupgradecost.md
View File

@ -4,6 +4,8 @@
## HacknetNodesFormulas.coreUpgradeCost() method ## HacknetNodesFormulas.coreUpgradeCost() method
Calculate cost of upgrading hacknet node cores.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,11 +16,13 @@ coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): n
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| startingCore | number | | | startingCore | number | starting cores |
| extraCores | number | | | extraCores | number | amount of cores to purchase (defaults to 1) |
| costMult | number | | | costMult | number | player cost reduction (default to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated cost.

8
markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md
View File

@ -4,6 +4,8 @@
## HacknetNodesFormulas.hacknetNodeCost() method ## HacknetNodesFormulas.hacknetNodeCost() method
Calculate the cost of a hacknet node.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,10 +16,12 @@ hacknetNodeCost(n: number, mult: number): number;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| n | number | | | n | number | number of the hacknet node |
| mult | number | | | mult | number | player cost reduction (defaults to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated cost.

10
markdown/bitburner.hacknetnodesformulas.levelupgradecost.md
View File

@ -4,6 +4,8 @@
## HacknetNodesFormulas.levelUpgradeCost() method ## HacknetNodesFormulas.levelUpgradeCost() method
Calculate cost of upgrading hacknet node level.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,11 +16,13 @@ levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number)
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| startingLevel | number | | | startingLevel | number | starting level |
| extraLevels | number | | | extraLevels | number | amount of level to purchase (defaults to 1) |
| costMult | number | | | costMult | number | player cost reduction (default to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated cost.

13
markdown/bitburner.hacknetnodesformulas.md
View File

@ -4,6 +4,7 @@
## HacknetNodesFormulas interface ## HacknetNodesFormulas interface
Hacknet Node formulas
<b>Signature:</b> <b>Signature:</b>
@ -15,10 +16,10 @@ interface HacknetNodesFormulas
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [constants()](./bitburner.hacknetnodesformulas.constants.md) | | | [constants()](./bitburner.hacknetnodesformulas.constants.md) | All constants used by the game. |
| [coreUpgradeCost(startingCore, extraCores, costMult)](./bitburner.hacknetnodesformulas.coreupgradecost.md) | | | [coreUpgradeCost(startingCore, extraCores, costMult)](./bitburner.hacknetnodesformulas.coreupgradecost.md) | Calculate cost of upgrading hacknet node cores. |
| [hacknetNodeCost(n, mult)](./bitburner.hacknetnodesformulas.hacknetnodecost.md) | | | [hacknetNodeCost(n, mult)](./bitburner.hacknetnodesformulas.hacknetnodecost.md) | Calculate the cost of a hacknet node. |
| [levelUpgradeCost(startingLevel, extraLevels, costMult)](./bitburner.hacknetnodesformulas.levelupgradecost.md) | | | [levelUpgradeCost(startingLevel, extraLevels, costMult)](./bitburner.hacknetnodesformulas.levelupgradecost.md) | Calculate cost of upgrading hacknet node level. |
| [moneyGainRate(level, ram, cores, mult)](./bitburner.hacknetnodesformulas.moneygainrate.md) | | | [moneyGainRate(level, ram, cores, mult)](./bitburner.hacknetnodesformulas.moneygainrate.md) | Calculate money gain rate. |
| [ramUpgradeCost(startingRam, extraLevels, costMult)](./bitburner.hacknetnodesformulas.ramupgradecost.md) | | | [ramUpgradeCost(startingRam, extraLevels, costMult)](./bitburner.hacknetnodesformulas.ramupgradecost.md) | Calculate cost of upgrading hacknet node ram. |

12
markdown/bitburner.hacknetnodesformulas.moneygainrate.md
View File

@ -4,6 +4,8 @@
## HacknetNodesFormulas.moneyGainRate() method ## HacknetNodesFormulas.moneyGainRate() method
Calculate money gain rate.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,12 +16,14 @@ moneyGainRate(level: number, ram: number, cores: number, mult?: number): number;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| level | number | | | level | number | level of the node. |
| ram | number | | | ram | number | ram of the node. |
| cores | number | | | cores | number | cores of the node. |
| mult | number | | | mult | number | player production mult (default to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated money gain rate.

10
markdown/bitburner.hacknetnodesformulas.ramupgradecost.md
View File

@ -4,6 +4,8 @@
## HacknetNodesFormulas.ramUpgradeCost() method ## HacknetNodesFormulas.ramUpgradeCost() method
Calculate cost of upgrading hacknet node ram.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,11 +16,13 @@ ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): nu
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| startingRam | number | | | startingRam | number | starting ram |
| extraLevels | number | | | extraLevels | number | amount of level of ram to purchase (defaults to 1) |
| costMult | number | | | costMult | number | player cost reduction (default to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated cost.

8
markdown/bitburner.hacknetserversformulas.cacheupgradecost.md
View File

@ -4,6 +4,8 @@
## HacknetServersFormulas.cacheUpgradeCost() method ## HacknetServersFormulas.cacheUpgradeCost() method
Calculate cost of upgrading hacknet server cache.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,10 +16,12 @@ cacheUpgradeCost(startingCache: number, extraCache?: number): number;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| startingCache | number | | | startingCache | number | starting cache level |
| extraCache | number | | | extraCache | number | amount of levels of cache to purchase (defaults to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated cost.

4
markdown/bitburner.hacknetserversformulas.constants.md
View File

@ -4,6 +4,8 @@
## HacknetServersFormulas.constants() method ## HacknetServersFormulas.constants() method
All constants used by the game.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -13,3 +15,5 @@ constants(): any;
any any
An object with all hacknet server constants used by the game.

10
markdown/bitburner.hacknetserversformulas.coreupgradecost.md
View File

@ -4,6 +4,8 @@
## HacknetServersFormulas.coreUpgradeCost() method ## HacknetServersFormulas.coreUpgradeCost() method
Calculate cost of upgrading hacknet server cores.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,11 +16,13 @@ coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): n
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| startingCore | number | | | startingCore | number | starting cores |
| extraCores | number | | | extraCores | number | amount of cores to purchase (defaults to 1) |
| costMult | number | | | costMult | number | player cost reduction (default to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated cost.

10
markdown/bitburner.hacknetserversformulas.hacknetservercost.md
View File

@ -4,20 +4,24 @@
## HacknetServersFormulas.hacknetServerCost() method ## HacknetServersFormulas.hacknetServerCost() method
Calculate the cost of a hacknet server.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
hacknetServerCost(n: number, mult: number): number; hacknetServerCost(n: number, mult?: number): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| n | number | | | n | number | number of the hacknet server |
| mult | number | | | mult | number | player cost reduction (defaults to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated cost.

14
markdown/bitburner.hacknetserversformulas.hashgainrate.md
View File

@ -4,6 +4,8 @@
## HacknetServersFormulas.hashGainRate() method ## HacknetServersFormulas.hashGainRate() method
Calculate hash gain rate.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,13 +16,15 @@ hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| level | number | | | level | number | level of the server. |
| ramUsed | number | | | ramUsed | number | ramUsed of the server. |
| maxRam | number | | | maxRam | number | maxRam of the server. |
| cores | number | | | cores | number | cores of the server. |
| mult | number | | | mult | number | player production mult (default to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated hash gain rate.

8
markdown/bitburner.hacknetserversformulas.hashupgradecost.md
View File

@ -4,6 +4,8 @@
## HacknetServersFormulas.hashUpgradeCost() method ## HacknetServersFormulas.hashUpgradeCost() method
Calculate hash cost of an upgrade.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,10 +16,12 @@ hashUpgradeCost(upgName: number, level: number): number;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| upgName | number | | | upgName | number | name of the upgrade |
| level | number | | | level | number | level of the upgrade |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated hash cost.

10
markdown/bitburner.hacknetserversformulas.levelupgradecost.md
View File

@ -4,6 +4,8 @@
## HacknetServersFormulas.levelUpgradeCost() method ## HacknetServersFormulas.levelUpgradeCost() method
Calculate cost of upgrading hacknet server level.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,11 +16,13 @@ levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number)
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| startingLevel | number | | | startingLevel | number | starting level |
| extraLevels | number | | | extraLevels | number | amount of level to purchase (defaults to 1) |
| costMult | number | | | costMult | number | player cost reduction (default to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated cost.

17
markdown/bitburner.hacknetserversformulas.md
View File

@ -4,6 +4,7 @@
## HacknetServersFormulas interface ## HacknetServersFormulas interface
Hacknet Server formulas
<b>Signature:</b> <b>Signature:</b>
@ -15,12 +16,12 @@ interface HacknetServersFormulas
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [cacheUpgradeCost(startingCache, extraCache)](./bitburner.hacknetserversformulas.cacheupgradecost.md) | | | [cacheUpgradeCost(startingCache, extraCache)](./bitburner.hacknetserversformulas.cacheupgradecost.md) | Calculate cost of upgrading hacknet server cache. |
| [constants()](./bitburner.hacknetserversformulas.constants.md) | | | [constants()](./bitburner.hacknetserversformulas.constants.md) | All constants used by the game. |
| [coreUpgradeCost(startingCore, extraCores, costMult)](./bitburner.hacknetserversformulas.coreupgradecost.md) | | | [coreUpgradeCost(startingCore, extraCores, costMult)](./bitburner.hacknetserversformulas.coreupgradecost.md) | Calculate cost of upgrading hacknet server cores. |
| [hacknetServerCost(n, mult)](./bitburner.hacknetserversformulas.hacknetservercost.md) | | | [hacknetServerCost(n, mult)](./bitburner.hacknetserversformulas.hacknetservercost.md) | Calculate the cost of a hacknet server. |
| [hashGainRate(level, ramUsed, maxRam, cores, mult)](./bitburner.hacknetserversformulas.hashgainrate.md) | | | [hashGainRate(level, ramUsed, maxRam, cores, mult)](./bitburner.hacknetserversformulas.hashgainrate.md) | Calculate hash gain rate. |
| [hashUpgradeCost(upgName, level)](./bitburner.hacknetserversformulas.hashupgradecost.md) | | | [hashUpgradeCost(upgName, level)](./bitburner.hacknetserversformulas.hashupgradecost.md) | Calculate hash cost of an upgrade. |
| [levelUpgradeCost(startingLevel, extraLevels, costMult)](./bitburner.hacknetserversformulas.levelupgradecost.md) | | | [levelUpgradeCost(startingLevel, extraLevels, costMult)](./bitburner.hacknetserversformulas.levelupgradecost.md) | Calculate cost of upgrading hacknet server level. |
| [ramUpgradeCost(startingRam, extraLevels, costMult)](./bitburner.hacknetserversformulas.ramupgradecost.md) | | | [ramUpgradeCost(startingRam, extraLevels, costMult)](./bitburner.hacknetserversformulas.ramupgradecost.md) | Calculate cost of upgrading hacknet server ram. |

10
markdown/bitburner.hacknetserversformulas.ramupgradecost.md
View File

@ -4,6 +4,8 @@
## HacknetServersFormulas.ramUpgradeCost() method ## HacknetServersFormulas.ramUpgradeCost() method
Calculate cost of upgrading hacknet server ram.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
@ -14,11 +16,13 @@ ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): nu
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| startingRam | number | | | startingRam | number | starting ram |
| extraLevels | number | | | extraLevels | number | amount of level of ram to purchase (defaults to 1) |
| costMult | number | | | costMult | number | player cost reduction (default to 1) |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated cost.

8
markdown/bitburner.md
View File

@ -37,12 +37,12 @@
| [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | | | [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |
| [GangTaskStats](./bitburner.gangtaskstats.md) | Object representing data representing a gang member task. | | [GangTaskStats](./bitburner.gangtaskstats.md) | Object representing data representing a gang member task. |
| [GangTerritory](./bitburner.gangterritory.md) | | | [GangTerritory](./bitburner.gangterritory.md) | |
| [HackingFormulas](./bitburner.hackingformulas.md) | | | [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas |
| [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. | | [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. |
| [Hacknet](./bitburner.hacknet.md) | Hacknet API | | [Hacknet](./bitburner.hacknet.md) | Hacknet API |
| [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. | | [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. |
| [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | | | [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas |
| [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | | | [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas |
| [Material](./bitburner.material.md) | | | [Material](./bitburner.material.md) | |
| [NodeStats](./bitburner.nodestats.md) | Object representing all the values related to a hacknet node. | | [NodeStats](./bitburner.nodestats.md) | Object representing all the values related to a hacknet node. |
| [NS](./bitburner.ns.md) | Collection of all functions passed to scripts | | [NS](./bitburner.ns.md) | Collection of all functions passed to scripts |
@ -55,7 +55,7 @@
| [RunningScript](./bitburner.runningscript.md) | | | [RunningScript](./bitburner.runningscript.md) | |
| [Server](./bitburner.server.md) | A single server. | | [Server](./bitburner.server.md) | A single server. |
| [Singularity](./bitburner.singularity.md) | Singularity API | | [Singularity](./bitburner.singularity.md) | Singularity API |
| [SkillsFormulas](./bitburner.skillsformulas.md) | | | [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas |
| [Sleeve](./bitburner.sleeve.md) | Sleeve API | | [Sleeve](./bitburner.sleeve.md) | Sleeve API |
| [SleeveInformation](./bitburner.sleeveinformation.md) | Object representing sleeve information. | | [SleeveInformation](./bitburner.sleeveinformation.md) | Object representing sleeve information. |
| [SleeveSkills](./bitburner.sleeveskills.md) | Object representing a sleeve stats. | | [SleeveSkills](./bitburner.sleeveskills.md) | Object representing a sleeve stats. |

10
markdown/bitburner.skillsformulas.calculateexp.md
View File

@ -4,20 +4,24 @@
## SkillsFormulas.calculateExp() method ## SkillsFormulas.calculateExp() method
Calculate exp for skill level.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
calculateExp(skill: number, mult?: number): number; calculateExp(skill: number, skillMult?: number): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| skill | number | | | skill | number | target skill level |
| mult | number | | | skillMult | number | Multiplier for that skill, defaults to 1. |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated exp required.

10
markdown/bitburner.skillsformulas.calculateskill.md
View File

@ -4,20 +4,24 @@
## SkillsFormulas.calculateSkill() method ## SkillsFormulas.calculateSkill() method
Calculate skill level.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
calculateSkill(exp: number, mult?: number): number; calculateSkill(exp: number, skillMult?: number): number;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| exp | number | | | exp | number | experience for that skill |
| mult | number | | | skillMult | number | Multiplier for that skill, defaults to 1. |
<b>Returns:</b> <b>Returns:</b>
number number
The calculated skill level.

5
markdown/bitburner.skillsformulas.md
View File

@ -4,6 +4,7 @@
## SkillsFormulas interface ## SkillsFormulas interface
Skills formulas
<b>Signature:</b> <b>Signature:</b>
@ -15,6 +16,6 @@ interface SkillsFormulas
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [calculateExp(skill, mult)](./bitburner.skillsformulas.calculateexp.md) | | | [calculateExp(skill, skillMult)](./bitburner.skillsformulas.calculateexp.md) | Calculate exp for skill level. |
| [calculateSkill(exp, mult)](./bitburner.skillsformulas.calculateskill.md) | | | [calculateSkill(exp, skillMult)](./bitburner.skillsformulas.calculateskill.md) | Calculate skill level. |

2
src/NetscriptFunctions/Formulas.ts
View File

@ -175,7 +175,7 @@ export function NetscriptFormulas(player: IPlayer, workerScript: WorkerScript, h
} }
return upg.getCost(level); return upg.getCost(level);
}, },
hacknetServerCost: function (n: any, mult: any): any { hacknetServerCost: function (n: any, mult: any = 1): any {
checkFormulasAccess("hacknetServers.hacknetServerCost"); checkFormulasAccess("hacknetServers.hacknetServerCost");
return HScalculateServerCost(n, mult); return HScalculateServerCost(n, mult);
}, },

174
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -3308,35 +3308,137 @@ export interface Sleeve {
} }
/** /**
* Skills formulas
* @public * @public
*/ */
interface SkillsFormulas { interface SkillsFormulas {
calculateSkill(exp: number, mult?: number): number; /**
calculateExp(skill: number, mult?: number): number; * Calculate skill level.
* @param exp - experience for that skill
* @param skillMult - Multiplier for that skill, defaults to 1.
* @returns The calculated skill level.
*/
calculateSkill(exp: number, skillMult?: number): number;
/**
* Calculate exp for skill level.
* @param skill - target skill level
* @param skillMult - Multiplier for that skill, defaults to 1.
* @returns The calculated exp required.
*/
calculateExp(skill: number, skillMult?: number): number;
} }
/** /**
* Hacking formulas
* @public * @public
*/ */
interface HackingFormulas { interface HackingFormulas {
hackChance(server: number, player: number): number; /**
hackExp(server: number, player: number): number; * Calculate hack chance.
hackPercent(server: number, player: number): number; * @param server - Server info from {@link NS.getServer | getServer}
growPercent(server: number, threads: number, player: number, cores?: number): number; * @param player - Player info from {@link NS.getPlayer | getPlayer}
hackTime(server: number, player: number): number; * @returns The calculated hack chance.
growTime(server: number, player: number): number; */
weakenTime(server: number, player: number): number; hackChance(server: Server, player: Player): number;
/**
* Calculate hack exp for one thread.
* @remarks
* Multiply by thread to get total exp
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated hack exp.
*/
hackExp(server: Server, player: Player): number;
/**
* Calculate hack percent for one thread.
* @remarks
* Multiply by thread to get total percent hacked.
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated hack percent.
*/
hackPercent(server: Server, player: Player): number;
/**
* Calculate the percent a server would grow.
* @param server - Server info from {@link NS.getServer | getServer}
* @param threads - Amount of thread.
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @param cores - Number of cores on the computer that will execute grow.
* @returns The calculated grow percent.
*/
growPercent(server: Server, threads: number, player: Player, cores?: number): number;
/**
* Calculate hack time.
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated hack time.
*/
hackTime(server: Server, player: Player): number;
/**
* Calculate grow time.
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated grow time.
*/
growTime(server: Server, player: Player): number;
/**
* Calculate weaken time.
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated weaken time.
*/
weakenTime(server: Server, player: Player): number;
} }
/** /**
* Hacknet Node formulas
* @public * @public
*/ */
interface HacknetNodesFormulas { interface HacknetNodesFormulas {
/**
* Calculate money gain rate.
* @param level - level of the node.
* @param ram - ram of the node.
* @param cores - cores of the node.
* @param mult - player production mult (default to 1)
* @returns The calculated money gain rate.
*/
moneyGainRate(level: number, ram: number, cores: number, mult?: number): number; moneyGainRate(level: number, ram: number, cores: number, mult?: number): number;
/**
* Calculate cost of upgrading hacknet node level.
* @param startingLevel - starting level
* @param extraLevels - amount of level to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number; levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number;
/**
* Calculate cost of upgrading hacknet node ram.
* @param startingRam - starting ram
* @param extraLevels - amount of level of ram to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number; ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number;
/**
* Calculate cost of upgrading hacknet node cores.
* @param startingCore - starting cores
* @param extraCores - amount of cores to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number; coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number;
/**
* Calculate the cost of a hacknet node.
* @param n - number of the hacknet node
* @param mult - player cost reduction (defaults to 1)
* @returns The calculated cost.
*/
hacknetNodeCost(n: number, mult: number): number; hacknetNodeCost(n: number, mult: number): number;
/**
* All constants used by the game.
* @returns An object with all hacknet node constants used by the game.
*/
constants(): number; constants(): number;
} }
@ -3345,13 +3447,65 @@ interface HacknetNodesFormulas {
* @public * @public
*/ */
interface HacknetServersFormulas { interface HacknetServersFormulas {
/**
* Calculate hash gain rate.
* @param level - level of the server.
* @param ramUsed - ramUsed of the server.
* @param maxRam - maxRam of the server.
* @param cores - cores of the server.
* @param mult - player production mult (default to 1)
* @returns The calculated hash gain rate.
*/
hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult?: number): number; hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult?: number): number;
/**
* Calculate cost of upgrading hacknet server level.
* @param startingLevel - starting level
* @param extraLevels - amount of level to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number; levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number;
/**
* Calculate cost of upgrading hacknet server ram.
* @param startingRam - starting ram
* @param extraLevels - amount of level of ram to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number; ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number;
/**
* Calculate cost of upgrading hacknet server cores.
* @param startingCore - starting cores
* @param extraCores - amount of cores to purchase (defaults to 1)
* @param costMult - player cost reduction (default to 1)
* @returns The calculated cost.
*/
coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number; coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number;
/**
* Calculate cost of upgrading hacknet server cache.
* @param startingCache - starting cache level
* @param extraCache - amount of levels of cache to purchase (defaults to 1)
* @returns The calculated cost.
*/
cacheUpgradeCost(startingCache: number, extraCache?: number): number; cacheUpgradeCost(startingCache: number, extraCache?: number): number;
/**
* Calculate hash cost of an upgrade.
* @param upgName - name of the upgrade
* @param level - level of the upgrade
* @returns The calculated hash cost.
*/
hashUpgradeCost(upgName: number, level: number): number; hashUpgradeCost(upgName: number, level: number): number;
hacknetServerCost(n: number, mult: number): number; /**
* Calculate the cost of a hacknet server.
* @param n - number of the hacknet server
* @param mult - player cost reduction (defaults to 1)
* @returns The calculated cost.
*/
hacknetServerCost(n: number, mult?: number): number;
/**
* All constants used by the game.
* @returns An object with all hacknet server constants used by the game.
*/
constants(): any; constants(): any;
} }