Better docs for ascension result ()

This commit is contained in:
Snarling 2023-06-26 04:56:58 -04:00 committed by GitHub
parent 1af01401d9
commit 91bfb154b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 24 additions and 24 deletions

@ -22,7 +22,7 @@ ascendMember(memberName: string): GangMemberAscension | 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

@ -22,11 +22,11 @@ getAscensionResult(memberName: string): GangMemberAscension | 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
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
Agility multiplier gained from ascending
Factor by which the agility ascension multiplier was increased (newMult / oldMult)
**Signature:**

@ -4,7 +4,7 @@
## GangMemberAscension.cha property
Charisma multiplier gained from ascending
Factor by which the charisma ascension multiplier was increased (newMult / oldMult)
**Signature:**

@ -4,7 +4,7 @@
## GangMemberAscension.def property
Defense multiplier gained from ascending
Factor by which the defense ascension multiplier was increased (newMult / oldMult)
**Signature:**

@ -4,7 +4,7 @@
## GangMemberAscension.dex property
Dexterity multiplier gained from ascending
Factor by which the dexterity ascension multiplier was increased (newMult / oldMult)
**Signature:**

@ -4,7 +4,7 @@
## GangMemberAscension.hack property
Hacking multiplier gained from ascending
Factor by which the hacking ascension multiplier was increased (newMult / oldMult)
**Signature:**

@ -15,11 +15,11 @@ interface GangMemberAscension
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [agi](./bitburner.gangmemberascension.agi.md) | | number | Agility multiplier gained from ascending |
| [cha](./bitburner.gangmemberascension.cha.md) | | number | Charisma multiplier gained from ascending |
| [def](./bitburner.gangmemberascension.def.md) | | number | Defense multiplier gained from ascending |
| [dex](./bitburner.gangmemberascension.dex.md) | | number | Dexterity multiplier gained from ascending |
| [hack](./bitburner.gangmemberascension.hack.md) | | number | Hacking 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 | Factor by which the charisma ascension multiplier was increased (newMult / oldMult) |
| [def](./bitburner.gangmemberascension.def.md) | | number | Factor by which the defense ascension multiplier was increased (newMult / oldMult) |
| [dex](./bitburner.gangmemberascension.dex.md) | | number | Factor by which the dexterity ascension multiplier was increased (newMult / oldMult) |
| [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 |
| [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
Strength multiplier gained from ascending
Factor by which the strength ascension multiplier was increased (newMult / oldMult)
**Signature:**

@ -911,17 +911,17 @@ interface GangMemberInfo {
interface GangMemberAscension {
/** Amount of respect lost from ascending */
respect: number;
/** Hacking multiplier gained from ascending */
/** Factor by which the hacking ascension multiplier was increased (newMult / oldMult) */
hack: number;
/** Strength multiplier gained from ascending */
/** Factor by which the strength ascension multiplier was increased (newMult / oldMult) */
str: number;
/** Defense multiplier gained from ascending */
/** Factor by which the defense ascension multiplier was increased (newMult / oldMult) */
def: number;
/** Dexterity multiplier gained from ascending */
/** Factor by which the dexterity ascension multiplier was increased (newMult / oldMult) */
dex: number;
/** Agility multiplier gained from ascending */
/** Factor by which the agility ascension multiplier was increased (newMult / oldMult) */
agi: number;
/** Charisma multiplier gained from ascending */
/** Factor by which the charisma ascension multiplier was increased (newMult / oldMult) */
cha: number;
}
@ -3508,7 +3508,7 @@ export interface Gang {
* Ascend the specified Gang Member.
*
* @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;
@ -3517,10 +3517,10 @@ export interface Gang {
* @remarks
* 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.
* @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;