Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-08 16:53:54 +01:00
Code Issues Packages Projects Releases Wiki Activity
6459b1ab48
bitburner-src/markdown/bitburner.sleeve.settofactionwork.md
Snarling e7fc0fbb03
Fix documentation for ns.sleeve (#227)
2022-11-24 08:19:51 -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.