mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-09 17:23:53 +01:00
Better docs for ascension result (#649)
This commit is contained in:
parent
1af01401d9
commit
91bfb154b6
@ -22,7 +22,7 @@ ascendMember(memberName: string): GangMemberAscension | undefined;
|
|||||||
|
|
||||||
[GangMemberAscension](./bitburner.gangmemberascension.md) \| undefined
|
[GangMemberAscension](./bitburner.gangmemberascension.md) \| undefined
|
||||||
|
|
||||||
Object with info about the ascension results. Undefined if ascension did not occur.
|
Object with info about the ascension results, or undefined if ascension did not occur.
|
||||||
|
|
||||||
## Remarks
|
## Remarks
|
||||||
|
|
||||||
|
@ -22,11 +22,11 @@ getAscensionResult(memberName: string): GangMemberAscension | undefined;
|
|||||||
|
|
||||||
[GangMemberAscension](./bitburner.gangmemberascension.md) \| undefined
|
[GangMemberAscension](./bitburner.gangmemberascension.md) \| undefined
|
||||||
|
|
||||||
Object with info about the ascension results. Undefined if ascension is impossible.
|
Object with info about the ascension results, or undefined if ascension is not possible.
|
||||||
|
|
||||||
## Remarks
|
## Remarks
|
||||||
|
|
||||||
RAM cost: 2 GB
|
RAM cost: 2 GB
|
||||||
|
|
||||||
Get the result of an ascension without ascending.
|
Get a [GangMemberAscension](./bitburner.gangmemberascension.md) result for ascending a gang member without performing the ascension.
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
## GangMemberAscension.agi property
|
## GangMemberAscension.agi property
|
||||||
|
|
||||||
Agility multiplier gained from ascending
|
Factor by which the agility ascension multiplier was increased (newMult / oldMult)
|
||||||
|
|
||||||
**Signature:**
|
**Signature:**
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
## GangMemberAscension.cha property
|
## GangMemberAscension.cha property
|
||||||
|
|
||||||
Charisma multiplier gained from ascending
|
Factor by which the charisma ascension multiplier was increased (newMult / oldMult)
|
||||||
|
|
||||||
**Signature:**
|
**Signature:**
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
## GangMemberAscension.def property
|
## GangMemberAscension.def property
|
||||||
|
|
||||||
Defense multiplier gained from ascending
|
Factor by which the defense ascension multiplier was increased (newMult / oldMult)
|
||||||
|
|
||||||
**Signature:**
|
**Signature:**
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
## GangMemberAscension.dex property
|
## GangMemberAscension.dex property
|
||||||
|
|
||||||
Dexterity multiplier gained from ascending
|
Factor by which the dexterity ascension multiplier was increased (newMult / oldMult)
|
||||||
|
|
||||||
**Signature:**
|
**Signature:**
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
## GangMemberAscension.hack property
|
## GangMemberAscension.hack property
|
||||||
|
|
||||||
Hacking multiplier gained from ascending
|
Factor by which the hacking ascension multiplier was increased (newMult / oldMult)
|
||||||
|
|
||||||
**Signature:**
|
**Signature:**
|
||||||
|
|
||||||
|
@ -15,11 +15,11 @@ interface GangMemberAscension
|
|||||||
|
|
||||||
| Property | Modifiers | Type | Description |
|
| Property | Modifiers | Type | Description |
|
||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| [agi](./bitburner.gangmemberascension.agi.md) | | number | Agility multiplier gained from ascending |
|
| [agi](./bitburner.gangmemberascension.agi.md) | | number | Factor by which the agility ascension multiplier was increased (newMult / oldMult) |
|
||||||
| [cha](./bitburner.gangmemberascension.cha.md) | | number | Charisma multiplier gained from ascending |
|
| [cha](./bitburner.gangmemberascension.cha.md) | | number | Factor by which the charisma ascension multiplier was increased (newMult / oldMult) |
|
||||||
| [def](./bitburner.gangmemberascension.def.md) | | number | Defense multiplier gained from ascending |
|
| [def](./bitburner.gangmemberascension.def.md) | | number | Factor by which the defense ascension multiplier was increased (newMult / oldMult) |
|
||||||
| [dex](./bitburner.gangmemberascension.dex.md) | | number | Dexterity multiplier gained from ascending |
|
| [dex](./bitburner.gangmemberascension.dex.md) | | number | Factor by which the dexterity ascension multiplier was increased (newMult / oldMult) |
|
||||||
| [hack](./bitburner.gangmemberascension.hack.md) | | number | Hacking multiplier gained from ascending |
|
| [hack](./bitburner.gangmemberascension.hack.md) | | number | Factor by which the hacking ascension multiplier was increased (newMult / oldMult) |
|
||||||
| [respect](./bitburner.gangmemberascension.respect.md) | | number | Amount of respect lost from ascending |
|
| [respect](./bitburner.gangmemberascension.respect.md) | | number | Amount of respect lost from ascending |
|
||||||
| [str](./bitburner.gangmemberascension.str.md) | | number | Strength multiplier gained from ascending |
|
| [str](./bitburner.gangmemberascension.str.md) | | number | Factor by which the strength ascension multiplier was increased (newMult / oldMult) |
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
## GangMemberAscension.str property
|
## GangMemberAscension.str property
|
||||||
|
|
||||||
Strength multiplier gained from ascending
|
Factor by which the strength ascension multiplier was increased (newMult / oldMult)
|
||||||
|
|
||||||
**Signature:**
|
**Signature:**
|
||||||
|
|
||||||
|
18
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
18
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
@ -911,17 +911,17 @@ interface GangMemberInfo {
|
|||||||
interface GangMemberAscension {
|
interface GangMemberAscension {
|
||||||
/** Amount of respect lost from ascending */
|
/** Amount of respect lost from ascending */
|
||||||
respect: number;
|
respect: number;
|
||||||
/** Hacking multiplier gained from ascending */
|
/** Factor by which the hacking ascension multiplier was increased (newMult / oldMult) */
|
||||||
hack: number;
|
hack: number;
|
||||||
/** Strength multiplier gained from ascending */
|
/** Factor by which the strength ascension multiplier was increased (newMult / oldMult) */
|
||||||
str: number;
|
str: number;
|
||||||
/** Defense multiplier gained from ascending */
|
/** Factor by which the defense ascension multiplier was increased (newMult / oldMult) */
|
||||||
def: number;
|
def: number;
|
||||||
/** Dexterity multiplier gained from ascending */
|
/** Factor by which the dexterity ascension multiplier was increased (newMult / oldMult) */
|
||||||
dex: number;
|
dex: number;
|
||||||
/** Agility multiplier gained from ascending */
|
/** Factor by which the agility ascension multiplier was increased (newMult / oldMult) */
|
||||||
agi: number;
|
agi: number;
|
||||||
/** Charisma multiplier gained from ascending */
|
/** Factor by which the charisma ascension multiplier was increased (newMult / oldMult) */
|
||||||
cha: number;
|
cha: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -3508,7 +3508,7 @@ export interface Gang {
|
|||||||
* Ascend the specified Gang Member.
|
* Ascend the specified Gang Member.
|
||||||
*
|
*
|
||||||
* @param memberName - Name of member to ascend.
|
* @param memberName - Name of member to ascend.
|
||||||
* @returns Object with info about the ascension results. Undefined if ascension did not occur.
|
* @returns Object with info about the ascension results, or undefined if ascension did not occur.
|
||||||
*/
|
*/
|
||||||
ascendMember(memberName: string): GangMemberAscension | undefined;
|
ascendMember(memberName: string): GangMemberAscension | undefined;
|
||||||
|
|
||||||
@ -3517,10 +3517,10 @@ export interface Gang {
|
|||||||
* @remarks
|
* @remarks
|
||||||
* RAM cost: 2 GB
|
* RAM cost: 2 GB
|
||||||
*
|
*
|
||||||
* Get the result of an ascension without ascending.
|
* Get a {@link GangMemberAscension} result for ascending a gang member without performing the ascension.
|
||||||
*
|
*
|
||||||
* @param memberName - Name of member.
|
* @param memberName - Name of member.
|
||||||
* @returns Object with info about the ascension results. Undefined if ascension is impossible.
|
* @returns Object with info about the ascension results, or undefined if ascension is not possible.
|
||||||
*/
|
*/
|
||||||
getAscensionResult(memberName: string): GangMemberAscension | undefined;
|
getAscensionResult(memberName: string): GangMemberAscension | undefined;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user