From f49d3b32a5c4463679380ffa86ea4ed5161007f6 Mon Sep 17 00:00:00 2001 From: catloversg <152669316+catloversg@users.noreply.github.com> Date: Thu, 24 Oct 2024 06:18:18 +0700 Subject: [PATCH] DOCUMENTATION: Clarify cyclesWorked of Task (#1725) --- markdown/bitburner.basetask.cyclesworked.md | 13 +++++ markdown/bitburner.basetask.md | 20 ++++++++ .../bitburner.companyworktask.cyclesworked.md | 11 ----- markdown/bitburner.companyworktask.md | 4 +- ...rner.createprogramworktask.cyclesworked.md | 11 ----- markdown/bitburner.createprogramworktask.md | 4 +- markdown/bitburner.crimetask.cyclesworked.md | 11 ----- markdown/bitburner.crimetask.md | 4 +- .../bitburner.factionworktask.cyclesworked.md | 11 ----- markdown/bitburner.factionworktask.md | 4 +- markdown/bitburner.graftingtask.completion.md | 2 + .../bitburner.graftingtask.cyclesworked.md | 11 ----- markdown/bitburner.graftingtask.md | 8 ++-- markdown/bitburner.md | 1 + markdown/bitburner.studytask.cyclesworked.md | 11 ----- markdown/bitburner.studytask.md | 4 +- src/ScriptEditor/NetscriptDefinitions.d.ts | 48 +++++++++++++------ 17 files changed, 83 insertions(+), 95 deletions(-) create mode 100644 markdown/bitburner.basetask.cyclesworked.md create mode 100644 markdown/bitburner.basetask.md delete mode 100644 markdown/bitburner.companyworktask.cyclesworked.md delete mode 100644 markdown/bitburner.createprogramworktask.cyclesworked.md delete mode 100644 markdown/bitburner.crimetask.cyclesworked.md delete mode 100644 markdown/bitburner.factionworktask.cyclesworked.md delete mode 100644 markdown/bitburner.graftingtask.cyclesworked.md delete mode 100644 markdown/bitburner.studytask.cyclesworked.md diff --git a/markdown/bitburner.basetask.cyclesworked.md b/markdown/bitburner.basetask.cyclesworked.md new file mode 100644 index 0000000000..c267c7692b --- /dev/null +++ b/markdown/bitburner.basetask.cyclesworked.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BaseTask](./bitburner.basetask.md) > [cyclesWorked](./bitburner.basetask.cyclesworked.md) + +## BaseTask.cyclesWorked property + +The number of game engine cycles has passed since this task started. 1 engine cycle = 200ms. + +**Signature:** + +```typescript +cyclesWorked: number; +``` diff --git a/markdown/bitburner.basetask.md b/markdown/bitburner.basetask.md new file mode 100644 index 0000000000..858840b3f4 --- /dev/null +++ b/markdown/bitburner.basetask.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BaseTask](./bitburner.basetask.md) + +## BaseTask interface + +Base interface of all tasks. + +**Signature:** + +```typescript +export interface BaseTask +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [cyclesWorked](./bitburner.basetask.cyclesworked.md) | | number | The number of game engine cycles has passed since this task started. 1 engine cycle = 200ms. | + diff --git a/markdown/bitburner.companyworktask.cyclesworked.md b/markdown/bitburner.companyworktask.cyclesworked.md deleted file mode 100644 index fded2478df..0000000000 --- a/markdown/bitburner.companyworktask.cyclesworked.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyWorkTask](./bitburner.companyworktask.md) > [cyclesWorked](./bitburner.companyworktask.cyclesworked.md) - -## CompanyWorkTask.cyclesWorked property - -**Signature:** - -```typescript -cyclesWorked: number; -``` diff --git a/markdown/bitburner.companyworktask.md b/markdown/bitburner.companyworktask.md index 93f3332507..d1af0f3c26 100644 --- a/markdown/bitburner.companyworktask.md +++ b/markdown/bitburner.companyworktask.md @@ -9,8 +9,9 @@ Company Work **Signature:** ```typescript -export interface CompanyWorkTask +export interface CompanyWorkTask extends BaseTask ``` +**Extends:** [BaseTask](./bitburner.basetask.md) ## Remarks @@ -21,6 +22,5 @@ An object representing the current work for a company | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [companyName](./bitburner.companyworktask.companyname.md) | | [CompanyName](./bitburner.companyname.md) | | -| [cyclesWorked](./bitburner.companyworktask.cyclesworked.md) | | number | | | [type](./bitburner.companyworktask.type.md) | | "COMPANY" | | diff --git a/markdown/bitburner.createprogramworktask.cyclesworked.md b/markdown/bitburner.createprogramworktask.cyclesworked.md deleted file mode 100644 index fb9219eea8..0000000000 --- a/markdown/bitburner.createprogramworktask.cyclesworked.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [CreateProgramWorkTask](./bitburner.createprogramworktask.md) > [cyclesWorked](./bitburner.createprogramworktask.cyclesworked.md) - -## CreateProgramWorkTask.cyclesWorked property - -**Signature:** - -```typescript -cyclesWorked: number; -``` diff --git a/markdown/bitburner.createprogramworktask.md b/markdown/bitburner.createprogramworktask.md index 87761c013c..990874b797 100644 --- a/markdown/bitburner.createprogramworktask.md +++ b/markdown/bitburner.createprogramworktask.md @@ -9,8 +9,9 @@ Create Program **Signature:** ```typescript -export interface CreateProgramWorkTask +export interface CreateProgramWorkTask extends BaseTask ``` +**Extends:** [BaseTask](./bitburner.basetask.md) ## Remarks @@ -20,7 +21,6 @@ An object representing the status of the program being created | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [cyclesWorked](./bitburner.createprogramworktask.cyclesworked.md) | | number | | | [programName](./bitburner.createprogramworktask.programname.md) | | string | | | [type](./bitburner.createprogramworktask.type.md) | | "CREATE\_PROGRAM" | | diff --git a/markdown/bitburner.crimetask.cyclesworked.md b/markdown/bitburner.crimetask.cyclesworked.md deleted file mode 100644 index 85f3fb4fbf..0000000000 --- a/markdown/bitburner.crimetask.cyclesworked.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeTask](./bitburner.crimetask.md) > [cyclesWorked](./bitburner.crimetask.cyclesworked.md) - -## CrimeTask.cyclesWorked property - -**Signature:** - -```typescript -cyclesWorked: number; -``` diff --git a/markdown/bitburner.crimetask.md b/markdown/bitburner.crimetask.md index afc5987f7b..bfff0f84d0 100644 --- a/markdown/bitburner.crimetask.md +++ b/markdown/bitburner.crimetask.md @@ -9,8 +9,9 @@ Crime **Signature:** ```typescript -export interface CrimeTask +export interface CrimeTask extends BaseTask ``` +**Extends:** [BaseTask](./bitburner.basetask.md) ## Remarks @@ -21,6 +22,5 @@ An object representing the crime being committed | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [crimeType](./bitburner.crimetask.crimetype.md) | | [CrimeType](./bitburner.crimetype.md) | | -| [cyclesWorked](./bitburner.crimetask.cyclesworked.md) | | number | | | [type](./bitburner.crimetask.type.md) | | "CRIME" | | diff --git a/markdown/bitburner.factionworktask.cyclesworked.md b/markdown/bitburner.factionworktask.cyclesworked.md deleted file mode 100644 index a2efbe5a15..0000000000 --- a/markdown/bitburner.factionworktask.cyclesworked.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [FactionWorkTask](./bitburner.factionworktask.md) > [cyclesWorked](./bitburner.factionworktask.cyclesworked.md) - -## FactionWorkTask.cyclesWorked property - -**Signature:** - -```typescript -cyclesWorked: number; -``` diff --git a/markdown/bitburner.factionworktask.md b/markdown/bitburner.factionworktask.md index 93ed97e6af..655f7ab40f 100644 --- a/markdown/bitburner.factionworktask.md +++ b/markdown/bitburner.factionworktask.md @@ -9,8 +9,9 @@ Faction Work **Signature:** ```typescript -export interface FactionWorkTask +export interface FactionWorkTask extends BaseTask ``` +**Extends:** [BaseTask](./bitburner.basetask.md) ## Remarks @@ -20,7 +21,6 @@ An object representing the current work for a faction | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [cyclesWorked](./bitburner.factionworktask.cyclesworked.md) | | number | | | [factionName](./bitburner.factionworktask.factionname.md) | | string | | | [factionWorkType](./bitburner.factionworktask.factionworktype.md) | | [FactionWorkType](./bitburner.factionworktype.md) | | | [type](./bitburner.factionworktask.type.md) | | "FACTION" | | diff --git a/markdown/bitburner.graftingtask.completion.md b/markdown/bitburner.graftingtask.completion.md index 62a4ab4cdb..d1a4e3f114 100644 --- a/markdown/bitburner.graftingtask.completion.md +++ b/markdown/bitburner.graftingtask.completion.md @@ -4,6 +4,8 @@ ## GraftingTask.completion property +This promise resolves when the task is complete. + **Signature:** ```typescript diff --git a/markdown/bitburner.graftingtask.cyclesworked.md b/markdown/bitburner.graftingtask.cyclesworked.md deleted file mode 100644 index 0fff6658fe..0000000000 --- a/markdown/bitburner.graftingtask.cyclesworked.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [GraftingTask](./bitburner.graftingtask.md) > [cyclesWorked](./bitburner.graftingtask.cyclesworked.md) - -## GraftingTask.cyclesWorked property - -**Signature:** - -```typescript -cyclesWorked: number; -``` diff --git a/markdown/bitburner.graftingtask.md b/markdown/bitburner.graftingtask.md index 5a175630f3..01c47c8beb 100644 --- a/markdown/bitburner.graftingtask.md +++ b/markdown/bitburner.graftingtask.md @@ -9,21 +9,19 @@ Grafting Work **Signature:** ```typescript -export interface GraftingTask +export interface GraftingTask extends BaseTask ``` +**Extends:** [BaseTask](./bitburner.basetask.md) ## Remarks An object representing the current grafting task -The "completion" property is a promise that resolves when the task is complete. - ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [augmentation](./bitburner.graftingtask.augmentation.md) | | string | | -| [completion](./bitburner.graftingtask.completion.md) | | Promise<void> | | -| [cyclesWorked](./bitburner.graftingtask.cyclesworked.md) | | number | | +| [completion](./bitburner.graftingtask.completion.md) | | Promise<void> | This promise resolves when the task is complete. | | [type](./bitburner.graftingtask.type.md) | | "GRAFTING" | | diff --git a/markdown/bitburner.md b/markdown/bitburner.md index f66f512162..c8255e5a40 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -38,6 +38,7 @@ | [AugmentPair](./bitburner.augmentpair.md) | Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) | | [AutocompleteData](./bitburner.autocompletedata.md) | Used for autocompletion | | [BackdoorRequirement](./bitburner.backdoorrequirement.md) | Player must have installed a backdoor on this server. | +| [BaseTask](./bitburner.basetask.md) | Base interface of all tasks. | | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Options to affect the behavior of [hack](./bitburner.ns.hack.md), [grow](./bitburner.ns.grow.md), and [weaken](./bitburner.ns.weaken.md). | | [BitNodeBooleanOptions](./bitburner.bitnodebooleanoptions.md) |

restrictHomePCUpgrade: The home computer's maximum RAM and number of cores are lower than normal. Max RAM: 128GB. Max core: 1.

disableSleeveExpAndAugmentation: Your Sleeves do not gain experience when they perform action. You also cannot buy augmentations for them.

| | [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) | All multipliers affecting the difficulty of the current challenge. | diff --git a/markdown/bitburner.studytask.cyclesworked.md b/markdown/bitburner.studytask.cyclesworked.md deleted file mode 100644 index 68ccbb8a6c..0000000000 --- a/markdown/bitburner.studytask.cyclesworked.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [StudyTask](./bitburner.studytask.md) > [cyclesWorked](./bitburner.studytask.cyclesworked.md) - -## StudyTask.cyclesWorked property - -**Signature:** - -```typescript -cyclesWorked: number; -``` diff --git a/markdown/bitburner.studytask.md b/markdown/bitburner.studytask.md index 8dd663c9d4..86e077528b 100644 --- a/markdown/bitburner.studytask.md +++ b/markdown/bitburner.studytask.md @@ -9,8 +9,9 @@ Study **Signature:** ```typescript -export interface StudyTask +export interface StudyTask extends BaseTask ``` +**Extends:** [BaseTask](./bitburner.basetask.md) ## Remarks @@ -21,7 +22,6 @@ An object representing the current study task | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [classType](./bitburner.studytask.classtype.md) | | string | | -| [cyclesWorked](./bitburner.studytask.cyclesworked.md) | | number | | | [location](./bitburner.studytask.location.md) | | [LocationName](./bitburner.locationname.md) \| \`${[LocationName](./bitburner.locationname.md)}\` | | | [type](./bitburner.studytask.type.md) | | "CLASS" | | diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 2bd2831276..9c078e20ea 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -1646,63 +1646,81 @@ export interface TIX { nextUpdate(): Promise; } +/** + * Base interface of all tasks. + * + * @public + */ +export interface BaseTask { + /** + * The number of game engine cycles that has passed since this task started. 1 engine cycle = 200ms. + */ + cyclesWorked: number; +} + /** * Study + * * @remarks * An object representing the current study task + * * @public */ -export interface StudyTask { +export interface StudyTask extends BaseTask { type: "CLASS"; - cyclesWorked: number; classType: string; location: LocationName | `${LocationName}`; } + /** * Company Work + * * @remarks * An object representing the current work for a company + * * @public */ -export interface CompanyWorkTask { +export interface CompanyWorkTask extends BaseTask { type: "COMPANY"; - cyclesWorked: number; companyName: CompanyName; } /** * Create Program + * * @remarks * An object representing the status of the program being created + * * @public */ -export interface CreateProgramWorkTask { +export interface CreateProgramWorkTask extends BaseTask { type: "CREATE_PROGRAM"; - cyclesWorked: number; programName: string; } /** * Crime + * * @remarks * An object representing the crime being committed + * * @public */ -export interface CrimeTask { +export interface CrimeTask extends BaseTask { type: "CRIME"; - cyclesWorked: number; crimeType: CrimeType; } /** * Faction Work + * * @remarks * An object representing the current work for a faction + * * @public */ -export interface FactionWorkTask { +export interface FactionWorkTask extends BaseTask { type: "FACTION"; - cyclesWorked: number; factionWorkType: FactionWorkType; factionName: string; } @@ -1713,21 +1731,23 @@ export interface FactionWorkTask { * @remarks * An object representing the current grafting task * - * The "completion" property is a promise that resolves when the task is complete. - * * @public */ -export interface GraftingTask { +export interface GraftingTask extends BaseTask { type: "GRAFTING"; - cyclesWorked: number; augmentation: string; + /** + * This promise resolves when the task is complete. + */ completion: Promise; } /** * Task + * * @remarks * Represents any task, such as studying, working for a faction etc. + * * @public */ export type Task = StudyTask | CompanyWorkTask | CreateProgramWorkTask | CrimeTask | FactionWorkTask | GraftingTask;