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

DOC: typo fixes in sleeves API (#467)

Browse Source 
A bunch of typographical fixes in the documentation of the Sleeve API.
This commit is contained in:
quacksouls 2023-04-07 21:45:14 +10:00 committed by GitHub
parent 482a04d757
commit 4ade263ae8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3657,7 +3657,7 @@ export interface Sleeve {
*
* Return the number of duplicate sleeves the player has.
*
* @returns number of duplicate sleeves the player has.
* @returns Number of duplicate sleeves the player has.
*/
getNumSleeves(): number;
@ -3749,12 +3749,12 @@ export interface Sleeve {
* @remarks
* RAM cost: 4 GB
*
* Return a boolean indicating whether or not the sleeve started working or this faction.
* Return a boolean indicating whether or not the sleeve started working for a faction.
*
* @param sleeveNumber - Index of the sleeve to work for the faction.
* @param factionName - Name of the faction to work for.
* @param factionWorkType - Name of the action to perform for this faction.
* @returns True if the sleeve started working on this faction, false otherwise, can also throw on errors
* @returns True if the sleeve started working for this faction, false otherwise. Can also throw on errors.
*/
setToFactionWork(
sleeveNumber: number,
@ -3767,11 +3767,11 @@ export interface Sleeve {
* @remarks
* RAM cost: 4 GB
*
* Return a boolean indicating whether or not the sleeve started working or this company.
* Return a boolean indicating whether or not the sleeve started working for a company.
*
* @param sleeveNumber - Index of the sleeve to work for the company.
* @param companyName - Name of the company to work for.
* @returns True if the sleeve started working on this company, false otherwise.
* @returns True if the sleeve started working for this company, false otherwise.
*/
setToCompanyWork(sleeveNumber: number, companyName: string): boolean;
@ -3876,16 +3876,16 @@ export interface Sleeve {
purchaseSleeveAug(sleeveNumber: number, augName: string): boolean;
/**
* Set a sleeve to perform bladeburner actions.
* Set a sleeve to perform Bladeburner actions.
* @remarks
* RAM cost: 4 GB
*
* Return a boolean indicating whether or not the sleeve started working out.
* Return a boolean indicating whether or not the sleeve started a Bladeburner action.
*
* @param sleeveNumber - Index of the sleeve to workout at the gym.
* @param sleeveNumber - Index of the sleeve to perform a Bladeburner action.
* @param action - Name of the action to be performed.
* @param contract - Name of the contract if applicable.
* @returns True if the sleeve started working out, false otherwise.
* @returns True if the sleeve started the given Bladeburner action, false otherwise.
*/
setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): boolean;
}