felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-18 15:28:43 +02: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
17 changed files with 86 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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;