rename the functions I created 2 minutes ago.

This commit is contained in:
Olivier Gagnon
2021-12-08 18:41:49 -05:00
parent d64ce5271e
commit 6eba92b36c
20 changed files with 151 additions and 48 deletions

View File

@@ -4,6 +4,8 @@
## Formulas.gang property
Gang formulas
<b>Signature:</b>
```typescript

View File

@@ -4,6 +4,8 @@
## Formulas.hacking property
Hacking formulas
<b>Signature:</b>
```typescript

View File

@@ -4,6 +4,8 @@
## Formulas.hacknetNodes property
Hacknet Nodes formulas
<b>Signature:</b>
```typescript

View File

@@ -4,6 +4,8 @@
## Formulas.hacknetServers property
Hacknet Servers formulas
<b>Signature:</b>
```typescript

View File

@@ -4,6 +4,7 @@
## Formulas interface
Formulas API
<b>Signature:</b>
@@ -11,13 +12,17 @@
export interface Formulas
```
## Remarks
You need Formulas.exe on your home computer to use this API.
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [gang](./bitburner.formulas.gang.md) | [GangFormulas](./bitburner.gangformulas.md) | |
| [hacking](./bitburner.formulas.hacking.md) | [HackingFormulas](./bitburner.hackingformulas.md) | |
| [hacknetNodes](./bitburner.formulas.hacknetnodes.md) | [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | |
| [hacknetServers](./bitburner.formulas.hacknetservers.md) | [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | |
| [skills](./bitburner.formulas.skills.md) | [SkillsFormulas](./bitburner.skillsformulas.md) | |
| [gang](./bitburner.formulas.gang.md) | [GangFormulas](./bitburner.gangformulas.md) | Gang formulas |
| [hacking](./bitburner.formulas.hacking.md) | [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas |
| [hacknetNodes](./bitburner.formulas.hacknetnodes.md) | [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Nodes formulas |
| [hacknetServers](./bitburner.formulas.hacknetservers.md) | [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Servers formulas |
| [skills](./bitburner.formulas.skills.md) | [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas |

View File

@@ -4,6 +4,8 @@
## Formulas.skills property
Skills formulas
<b>Signature:</b>
```typescript

View File

@@ -4,6 +4,8 @@
## GangFormulas.calculateMoneyGain() method
Calculate money gain per tick.
<b>Signature:</b>
```typescript
@@ -14,11 +16,13 @@ calculateMoneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStat
| Parameter | Type | Description |
| --- | --- | --- |
| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | |
| member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | |
| task | [GangTaskStats](./bitburner.gangtaskstats.md) | |
| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) |
| member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | Member info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) |
| task | [GangTaskStats](./bitburner.gangtaskstats.md) | Task info from [getTaskStats](./bitburner.gang.gettaskstats.md) |
<b>Returns:</b>
number
The calculated money gain.

View File

@@ -4,6 +4,8 @@
## GangFormulas.calculateRespectGain() method
Calculate respect gain per tick.
<b>Signature:</b>
```typescript
@@ -14,11 +16,13 @@ calculateRespectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskSt
| Parameter | Type | Description |
| --- | --- | --- |
| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | |
| member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | |
| task | [GangTaskStats](./bitburner.gangtaskstats.md) | |
| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) |
| member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | Gang info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) |
| task | [GangTaskStats](./bitburner.gangtaskstats.md) | Gang info from [getTaskStats](./bitburner.gang.gettaskstats.md) |
<b>Returns:</b>
number
The calculated respect gain.

View File

@@ -4,6 +4,8 @@
## GangFormulas.calculateWantedLevelGain() method
Calculate wanted gain per tick.
<b>Signature:</b>
```typescript
@@ -14,11 +16,13 @@ calculateWantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTa
| Parameter | Type | Description |
| --- | --- | --- |
| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | |
| member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | |
| task | [GangTaskStats](./bitburner.gangtaskstats.md) | |
| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) |
| member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | Member info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) |
| task | [GangTaskStats](./bitburner.gangtaskstats.md) | Task info from [getTaskStats](./bitburner.gang.gettaskstats.md) |
<b>Returns:</b>
number
The calculated wanted gain.

View File

@@ -4,6 +4,8 @@
## GangFormulas.calculateWantedPenalty() method
Calculate the wanted penalty.
<b>Signature:</b>
```typescript
@@ -14,9 +16,11 @@ calculateWantedPenalty(gang: GangGenInfo): number;
| Parameter | Type | Description |
| --- | --- | --- |
| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | |
| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) |
<b>Returns:</b>
number
The calculated wanted penalty.

View File

@@ -4,6 +4,7 @@
## GangFormulas interface
Gang formulas
<b>Signature:</b>
@@ -15,8 +16,8 @@ interface GangFormulas
| Method | Description |
| --- | --- |
| [calculateMoneyGain(gang, member, task)](./bitburner.gangformulas.calculatemoneygain.md) | |
| [calculateRespectGain(gang, member, task)](./bitburner.gangformulas.calculaterespectgain.md) | |
| [calculateWantedLevelGain(gang, member, task)](./bitburner.gangformulas.calculatewantedlevelgain.md) | |
| [calculateWantedPenalty(gang)](./bitburner.gangformulas.calculatewantedpenalty.md) | |
| [calculateMoneyGain(gang, member, task)](./bitburner.gangformulas.calculatemoneygain.md) | Calculate money gain per tick. |
| [calculateRespectGain(gang, member, task)](./bitburner.gangformulas.calculaterespectgain.md) | Calculate respect gain per tick. |
| [calculateWantedLevelGain(gang, member, task)](./bitburner.gangformulas.calculatewantedlevelgain.md) | Calculate wanted gain per tick. |
| [calculateWantedPenalty(gang)](./bitburner.gangformulas.calculatewantedpenalty.md) | Calculate the wanted penalty. |

View File

@@ -26,10 +26,10 @@
| [Employee](./bitburner.employee.md) | |
| [EmployeeJobs](./bitburner.employeejobs.md) | |
| [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. |
| [Formulas](./bitburner.formulas.md) | |
| [Formulas](./bitburner.formulas.md) | Formulas API |
| [Fragment](./bitburner.fragment.md) | |
| [Gang](./bitburner.gang.md) | Gang API |
| [GangFormulas](./bitburner.gangformulas.md) | |
| [GangFormulas](./bitburner.gangformulas.md) | Gang formulas |
| [GangGenInfo](./bitburner.ganggeninfo.md) | Gang general info. |
| [GangMemberAscension](./bitburner.gangmemberascension.md) | |
| [GangMemberInfo](./bitburner.gangmemberinfo.md) | |

View File

@@ -9,7 +9,7 @@ Arguments passed into the script.
<b>Signature:</b>
```typescript
readonly args: (string | number)[];
readonly args: (string | number | boolean)[];
```
## Remarks

View File

@@ -17,7 +17,7 @@ export interface NS extends Singularity
| Property | Type | Description |
| --- | --- | --- |
| [args](./bitburner.ns.args.md) | (string \| number)\[\] | Arguments passed into the script. |
| [args](./bitburner.ns.args.md) | (string \| number \| boolean)\[\] | Arguments passed into the script. |
| [bladeburner](./bitburner.ns.bladeburner.md) | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. |
| [codingcontract](./bitburner.ns.codingcontract.md) | [CodingContract](./bitburner.codingcontract.md) | Namespace for codingcontract functions. |
| [corporation](./bitburner.ns.corporation.md) | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. RAM cost: 0 GB |