Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2025-02-27 15:23:45 +01:00
Code Issues Packages Projects Releases Wiki Activity
bitburner-src/markdown/bitburner.sleeve.settofactionwork.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

1.1 KiB
Raw Blame History

Home > bitburner > sleeve > setToFactionWork

sleeve.setToFactionWork() method

Set a sleeve to work for a faction.

Signature:

setToFactionWork(
    sleeveNumber: number,
    factionName: string,
    factionWorkType: FactionWorkType | `${FactionWorkType}`,
  ): boolean | undefined;

Parameters

Parameter Type Description
sleeveNumber number Index of the sleeve to work for the faction.
factionName string Name of the faction to work for.
factionWorkType FactionWorkType | `${FactionWorkType}` Name of the action to perform for this faction.

Returns:

boolean | undefined

True if the sleeve started working on this faction, false otherwise, can also throw on errors

Remarks

RAM cost: 4 GB

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