From fed3cf1af2d4de7baa58256a5aaadbbc02a699fa Mon Sep 17 00:00:00 2001 From: catloversg <152669316+catloversg@users.noreply.github.com> Date: Fri, 28 Feb 2025 01:03:46 +0700 Subject: [PATCH] DOCUMENTATION: Clarify ns.singularity.quitJob (#1979) --- markdown/bitburner.singularity.quitjob.md | 8 +++++--- src/ScriptEditor/NetscriptDefinitions.d.ts | 6 ++++-- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/markdown/bitburner.singularity.quitjob.md b/markdown/bitburner.singularity.quitjob.md index db29575fa..7bf38ec19 100644 --- a/markdown/bitburner.singularity.quitjob.md +++ b/markdown/bitburner.singularity.quitjob.md @@ -9,14 +9,14 @@ Quit jobs by company. **Signature:** ```typescript -quitJob(companyName?: CompanyName | `${CompanyName}`): void; +quitJob(companyName: CompanyName | `${CompanyName}`): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | _(Optional)_ Name of the company. | +| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)}\` | Name of the company. | **Returns:** @@ -26,5 +26,7 @@ void RAM cost: 3 GB \* 16/4/1 -This function will finish work with the company provided and quit any jobs. +This function quits the current work if it's from the provided company. + +This function affects you and all sleeves. If a sleeve is working for this company, it will stop working and be idle. diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index d75013368..4bdb62af4 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -2130,12 +2130,14 @@ export interface Singularity { * @remarks * RAM cost: 3 GB * 16/4/1 * + * This function quits the current work if it's from the provided company. * - * This function will finish work with the company provided and quit any jobs. + * This function affects you and all sleeves. If a sleeve is working for this company, it will stop working and be + * idle. * * @param companyName - Name of the company. */ - quitJob(companyName?: CompanyName | `${CompanyName}`): void; + quitJob(companyName: CompanyName | `${CompanyName}`): void; /** * Apply for a job at a company.