bitburner-src/markdown/bitburner.sleeve.settobladeburneraction.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

918 B

Home > bitburner > sleeve > setToBladeburnerAction

sleeve.setToBladeburnerAction() method

Set a sleeve to perform bladeburner actions.

Signature:

setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): boolean;

Parameters

Parameter Type Description
sleeveNumber number Index of the sleeve to workout at the gym.
action string Name of the action to be performed.
contract string Name of the contract if applicable.

Returns:

boolean

True if the sleeve started working out, false otherwise.

Remarks

RAM cost: 4 GB

Return a boolean indicating whether or not the sleeve started working out.