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

regen doc

Browse Source
This commit is contained in:
Olivier Gagnon 2021-12-09 12:59:46 -05:00
parent 394a286646
commit d5e47a7180
5 changed files with 156 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
dist/bitburner.d.ts vendored
View File

@ -1361,6 +1361,20 @@ export declare interface GangFormulas {
* @returns The calculated money gain. * @returns The calculated money gain.
*/ */
moneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; moneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number;
/**
* Calculate ascension point gain.
* @param exp - Experience point before ascension.
* @returns The calculated ascension point gain.
*/
ascensionPointsGain(exp: number): number;
/**
* Calculate ascension mult.
* @param points - Amount of ascension points.
* @returns The calculated ascension mult.
*/
ascensionMultiplier(points: number): number;
} }
/** /**

88
input/bitburner.api.json
View File

@ -8573,6 +8573,94 @@
"releaseTag": "Public", "releaseTag": "Public",
"name": "GangFormulas", "name": "GangFormulas",
"members": [ "members": [
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!GangFormulas#ascensionMultiplier:member(1)",
"docComment": "/**\n * Calculate ascension mult.\n *\n * @param points - Amount of ascension points.\n *\n * @returns The calculated ascension mult.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "ascensionMultiplier(points: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "points",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "ascensionMultiplier"
},
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!GangFormulas#ascensionPointsGain:member(1)",
"docComment": "/**\n * Calculate ascension point gain.\n *\n * @param exp - Experience point before ascension.\n *\n * @returns The calculated ascension point gain.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "ascensionPointsGain(exp: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "exp",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "ascensionPointsGain"
},
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!GangFormulas#moneyGain:member(1)", "canonicalReference": "bitburner!GangFormulas#moneyGain:member(1)",

26
markdown/bitburner.gangformulas.ascensionmultiplier.md Normal file
View File

@ -0,0 +1,26 @@
<!-- 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; [ascensionMultiplier](./bitburner.gangformulas.ascensionmultiplier.md)
## GangFormulas.ascensionMultiplier() method
Calculate ascension mult.
<b>Signature:</b>
```typescript
ascensionMultiplier(points: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| points | number | Amount of ascension points. |
<b>Returns:</b>
number
The calculated ascension mult.

26
markdown/bitburner.gangformulas.ascensionpointsgain.md Normal file
View File

@ -0,0 +1,26 @@
<!-- 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; [ascensionPointsGain](./bitburner.gangformulas.ascensionpointsgain.md)
## GangFormulas.ascensionPointsGain() method
Calculate ascension point gain.
<b>Signature:</b>
```typescript
ascensionPointsGain(exp: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| exp | number | Experience point before ascension. |
<b>Returns:</b>
number
The calculated ascension point gain.

2
markdown/bitburner.gangformulas.md
View File

@ -16,6 +16,8 @@ interface GangFormulas
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [ascensionMultiplier(points)](./bitburner.gangformulas.ascensionmultiplier.md) | Calculate ascension mult. |
| [ascensionPointsGain(exp)](./bitburner.gangformulas.ascensionpointsgain.md) | Calculate ascension point gain. |
| [moneyGain(gang, member, task)](./bitburner.gangformulas.moneygain.md) | Calculate money gain per tick. | | [moneyGain(gang, member, task)](./bitburner.gangformulas.moneygain.md) | Calculate money gain per tick. |
| [respectGain(gang, member, task)](./bitburner.gangformulas.respectgain.md) | Calculate respect gain per tick. | | [respectGain(gang, member, task)](./bitburner.gangformulas.respectgain.md) | Calculate respect gain per tick. |
| [wantedLevelGain(gang, member, task)](./bitburner.gangformulas.wantedlevelgain.md) | Calculate wanted gain per tick. | | [wantedLevelGain(gang, member, task)](./bitburner.gangformulas.wantedlevelgain.md) | Calculate wanted gain per tick. |