bitburner-src/bitburner.singularity.workforfaction.md at 6d728613043386c1afb6f7afeb6e4c8155869a23

mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-22 23:53:48 +01:00

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.9 KiB

Raw Blame History

Home > bitburner > Singularity > workForFaction

Singularity.workForFaction() method

Work for a faction.

Signature:

workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}`, focus?: boolean): boolean;

Parameters

Parameter	Type	Description
faction	string	Name of faction to work for.
workType	FactionWorkType \| `${FactionWorkType}`	Type of work to perform for the faction.
focus	boolean	Acquire player focus on this work operation. Optional. Defaults to true.

Returns:

boolean

True if the player starts working, and false otherwise.

Remarks

RAM cost: 3 GB * 16/4/1

This function will set you to start working for the specified faction. You must be a member of the faction and that faction must have the specified work type, or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will cancel that action.

This function will return true if you successfully start working for the specified faction, and false otherwise.

Example 1

// NS1
var FACTION_NAME = "CyberSec", WORK_TYPE = "hacking";

var success = singularity.workForFaction(FACTION_NAME, WORK_TYPE);
if (!success) tprint("ERROR: Failed to start work for " + FACTION_NAME + " with work type " + WORK_TYPE);

Example 2

// NS2
const FACTION_NAME = "CyberSec", WORK_TYPE = "hacking";

let success = ns.singularity.workForFaction(FACTION_NAME, WORK_TYPE);
if (!success) ns.tprint(`ERROR: Failed to start work for ${FACTION_NAME} with work type ${WORK_TYPE}.`)

1.9 KiB Raw Blame History