From 91bfb154b65196519811f7860abb13fc40c461d0 Mon Sep 17 00:00:00 2001 From: Snarling <84951833+Snarling@users.noreply.github.com> Date: Mon, 26 Jun 2023 04:56:58 -0400 Subject: [PATCH] Better docs for ascension result (#649) --- markdown/bitburner.gang.ascendmember.md | 2 +- markdown/bitburner.gang.getascensionresult.md | 4 ++-- markdown/bitburner.gangmemberascension.agi.md | 2 +- markdown/bitburner.gangmemberascension.cha.md | 2 +- markdown/bitburner.gangmemberascension.def.md | 2 +- markdown/bitburner.gangmemberascension.dex.md | 2 +- markdown/bitburner.gangmemberascension.hack.md | 2 +- markdown/bitburner.gangmemberascension.md | 12 ++++++------ markdown/bitburner.gangmemberascension.str.md | 2 +- src/ScriptEditor/NetscriptDefinitions.d.ts | 18 +++++++++--------- 10 files changed, 24 insertions(+), 24 deletions(-) diff --git a/markdown/bitburner.gang.ascendmember.md b/markdown/bitburner.gang.ascendmember.md index 49a05e819..028a3e6ed 100644 --- a/markdown/bitburner.gang.ascendmember.md +++ b/markdown/bitburner.gang.ascendmember.md @@ -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 diff --git a/markdown/bitburner.gang.getascensionresult.md b/markdown/bitburner.gang.getascensionresult.md index 6fef44dee..e860893e8 100644 --- a/markdown/bitburner.gang.getascensionresult.md +++ b/markdown/bitburner.gang.getascensionresult.md @@ -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. diff --git a/markdown/bitburner.gangmemberascension.agi.md b/markdown/bitburner.gangmemberascension.agi.md index f5252ccaa..784129a8d 100644 --- a/markdown/bitburner.gangmemberascension.agi.md +++ b/markdown/bitburner.gangmemberascension.agi.md @@ -4,7 +4,7 @@ ## GangMemberAscension.agi property -Agility multiplier gained from ascending +Factor by which the agility ascension multiplier was increased (newMult / oldMult) **Signature:** diff --git a/markdown/bitburner.gangmemberascension.cha.md b/markdown/bitburner.gangmemberascension.cha.md index 2434cbe36..243565c56 100644 --- a/markdown/bitburner.gangmemberascension.cha.md +++ b/markdown/bitburner.gangmemberascension.cha.md @@ -4,7 +4,7 @@ ## GangMemberAscension.cha property -Charisma multiplier gained from ascending +Factor by which the charisma ascension multiplier was increased (newMult / oldMult) **Signature:** diff --git a/markdown/bitburner.gangmemberascension.def.md b/markdown/bitburner.gangmemberascension.def.md index 32f08317c..622e3f2b7 100644 --- a/markdown/bitburner.gangmemberascension.def.md +++ b/markdown/bitburner.gangmemberascension.def.md @@ -4,7 +4,7 @@ ## GangMemberAscension.def property -Defense multiplier gained from ascending +Factor by which the defense ascension multiplier was increased (newMult / oldMult) **Signature:** diff --git a/markdown/bitburner.gangmemberascension.dex.md b/markdown/bitburner.gangmemberascension.dex.md index fb5de53bc..77479762b 100644 --- a/markdown/bitburner.gangmemberascension.dex.md +++ b/markdown/bitburner.gangmemberascension.dex.md @@ -4,7 +4,7 @@ ## GangMemberAscension.dex property -Dexterity multiplier gained from ascending +Factor by which the dexterity ascension multiplier was increased (newMult / oldMult) **Signature:** diff --git a/markdown/bitburner.gangmemberascension.hack.md b/markdown/bitburner.gangmemberascension.hack.md index ad34eab91..40315ffa5 100644 --- a/markdown/bitburner.gangmemberascension.hack.md +++ b/markdown/bitburner.gangmemberascension.hack.md @@ -4,7 +4,7 @@ ## GangMemberAscension.hack property -Hacking multiplier gained from ascending +Factor by which the hacking ascension multiplier was increased (newMult / oldMult) **Signature:** diff --git a/markdown/bitburner.gangmemberascension.md b/markdown/bitburner.gangmemberascension.md index ecb555ff0..adc8a45af 100644 --- a/markdown/bitburner.gangmemberascension.md +++ b/markdown/bitburner.gangmemberascension.md @@ -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) | diff --git a/markdown/bitburner.gangmemberascension.str.md b/markdown/bitburner.gangmemberascension.str.md index e882bd958..01528da98 100644 --- a/markdown/bitburner.gangmemberascension.str.md +++ b/markdown/bitburner.gangmemberascension.str.md @@ -4,7 +4,7 @@ ## GangMemberAscension.str property -Strength multiplier gained from ascending +Factor by which the strength ascension multiplier was increased (newMult / oldMult) **Signature:** diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index f4de55869..5ec068317 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -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;