bitburner-src/markdown/bitburner.workformulas.companygains.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

922 B

Home > bitburner > WorkFormulas > companyGains

WorkFormulas.companyGains() method

Signature:

companyGains(
    person: Person,
    companyName: string,
    workType: CompanyPosName | `${CompanyPosName}`,
    favor: number,
  ): WorkStats;

Parameters

Parameter Type Description
person Person
companyName string
workType CompanyPosName | `${CompanyPosName}`
favor number

Returns:

WorkStats

The WorkStats applied every game cycle (200ms) by performing the specified company work.