Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-09 17:23:53 +01:00
Code Issues Packages Projects Releases Wiki Activity
cacecda72f
bitburner-src/markdown/bitburner.sleeve.settobladeburneraction.md
catloversg cacecda72f
API: Add types for parameters of gym-university-bladeburner API (Fix merging error) (#1596) 
* API: Add types for parameters of gym-university-bladeburner API
* Fix merging error
2024-08-17 14:08:55 -07:00

1.3 KiB
Raw Blame History

Home > bitburner > Sleeve > setToBladeburnerAction

Sleeve.setToBladeburnerAction() method

Set a sleeve to perform Bladeburner actions.

Signature:

setToBladeburnerAction(
    sleeveNumber: number,
    action: BladeburnerActionTypeForSleeve | `${BladeburnerActionTypeForSleeve}`,
    contract?: BladeburnerContractName,
  ): boolean;

Parameters

Parameter Type Description
sleeveNumber number Index of the sleeve to perform a Bladeburner action.
action BladeburnerActionTypeForSleeve | `${BladeburnerActionTypeForSleeve}` Name of the action to be performed.
contract BladeburnerContractName (Optional) Name of the contract if applicable.

Returns:

boolean

True if the sleeve started the given Bladeburner action, false otherwise.

Remarks

RAM cost: 4 GB

Return a boolean indicating whether or not the sleeve started a Bladeburner action.