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

DOCUMENTATION: Clarify cyclesWorked of Task (#1725)

Browse Source
This commit is contained in:
catloversg 2024-10-24 06:18:18 +07:00 committed by GitHub
parent 9a0400d3df
commit f49d3b32a5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 86 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
markdown/bitburner.basetask.cyclesworked.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BaseTask](./bitburner.basetask.md) &gt; [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;
```

20
markdown/bitburner.basetask.md Normal file
View File

@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [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. |

11
markdown/bitburner.companyworktask.cyclesworked.md
View File

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyWorkTask](./bitburner.companyworktask.md) &gt; [cyclesWorked](./bitburner.companyworktask.cyclesworked.md)
## CompanyWorkTask.cyclesWorked property
**Signature:**
```typescript
cyclesWorked: number;
```

4
markdown/bitburner.companyworktask.md
View File

@ -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" | |

11
markdown/bitburner.createprogramworktask.cyclesworked.md
View File

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CreateProgramWorkTask](./bitburner.createprogramworktask.md) &gt; [cyclesWorked](./bitburner.createprogramworktask.cyclesworked.md)
## CreateProgramWorkTask.cyclesWorked property
**Signature:**
```typescript
cyclesWorked: number;
```

4
markdown/bitburner.createprogramworktask.md
View File

@ -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" | |

11
markdown/bitburner.crimetask.cyclesworked.md
View File

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CrimeTask](./bitburner.crimetask.md) &gt; [cyclesWorked](./bitburner.crimetask.cyclesworked.md)
## CrimeTask.cyclesWorked property
**Signature:**
```typescript
cyclesWorked: number;
```

4
markdown/bitburner.crimetask.md
View File

@ -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" | |

11
markdown/bitburner.factionworktask.cyclesworked.md
View File

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionWorkTask](./bitburner.factionworktask.md) &gt; [cyclesWorked](./bitburner.factionworktask.cyclesworked.md)
## FactionWorkTask.cyclesWorked property
**Signature:**
```typescript
cyclesWorked: number;
```

4
markdown/bitburner.factionworktask.md
View File

@ -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" | |

2
markdown/bitburner.graftingtask.completion.md
View File

@ -4,6 +4,8 @@
## GraftingTask.completion property
This promise resolves when the task is complete.
**Signature:**
```typescript

11
markdown/bitburner.graftingtask.cyclesworked.md
View File

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GraftingTask](./bitburner.graftingtask.md) &gt; [cyclesWorked](./bitburner.graftingtask.cyclesworked.md)
## GraftingTask.cyclesWorked property
**Signature:**
```typescript
cyclesWorked: number;
```

8
markdown/bitburner.graftingtask.md
View File

@ -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&lt;void&gt; | |
| [cyclesWorked](./bitburner.graftingtask.cyclesworked.md) | | number | |
| [completion](./bitburner.graftingtask.completion.md) | | Promise&lt;void&gt; | This promise resolves when the task is complete. |
| [type](./bitburner.graftingtask.type.md) | | "GRAFTING" | |

1
markdown/bitburner.md
View File

@ -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) | <p>restrictHomePCUpgrade: The home computer's maximum RAM and number of cores are lower than normal. Max RAM: 128GB. Max core: 1.</p><p>disableSleeveExpAndAugmentation: Your Sleeves do not gain experience when they perform action. You also cannot buy augmentations for them.</p> |
| [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) | All multipliers affecting the difficulty of the current challenge. |

11
markdown/bitburner.studytask.cyclesworked.md
View File

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [StudyTask](./bitburner.studytask.md) &gt; [cyclesWorked](./bitburner.studytask.cyclesworked.md)
## StudyTask.cyclesWorked property
**Signature:**
```typescript
cyclesWorked: number;
```

4
markdown/bitburner.studytask.md
View File

@ -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" | |

54
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -1647,62 +1647,80 @@ export interface TIX {
}
/**
* Study
* @remarks
* An object representing the current study task
* Base interface of all tasks.
*
* @public
*/
export interface StudyTask {
type: "CLASS";
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 extends BaseTask {
type: "CLASS";
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<void>;
}
/**
* Task
*
* @remarks
* Represents any task, such as studying, working for a faction etc.
*
* @public
*/
export type Task = StudyTask | CompanyWorkTask | CreateProgramWorkTask | CrimeTask | FactionWorkTask | GraftingTask;