bitburner-src/markdown/bitburner.singularity.workforcompany.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.6 KiB

Home > bitburner > Singularity > workForCompany

Singularity.workForCompany() method

Work for a company.

Signature:

workForCompany(companyName: string, focus?: boolean): boolean;

Parameters

Parameter Type Description
companyName string Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked.
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 at your current job at a specified company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will cancel that action.

This function will return true if the player starts working, and false otherwise.

Example 1

// NS1:
var COMPANY_NAME = "Noodle Bar";

var success = singularity.workForCompany(COMPANY_NAME);
if (!success) tprint("ERROR: Failed to start work at " + COMPANY_NAME + ".");

Example 2

// NS2:
const COMPANY_NAME = "Noodle Bar";

let success = ns.singularity.workForCompany(COMPANY_NAME);
if (!success) ns.tprint(`ERROR: Failed to start work at ${COMPANY_NAME].`);