bitburner-src/markdown/bitburner.sleeve.settocommitcrime.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.5 KiB

Home > bitburner > sleeve > setToCommitCrime

sleeve.setToCommitCrime() method

Set a sleeve to commit crime.

Signature:

setToCommitCrime(sleeveNumber: number, crimeType: CrimeType | `${CrimeType}`): boolean;

Parameters

Parameter Type Description
sleeveNumber number Index of the sleeve to start committing crime. Sleeves are numbered starting from 0.
crimeType CrimeType | `${CrimeType}`

Returns:

boolean

True if this action was set successfully, false otherwise.

Remarks

RAM cost: 4 GB

Return a boolean indicating whether or not this action was set successfully (false if an invalid action is specified).

Example 1

// NS1
// Assign the first 3 sleeves to commit various crimes.
var crime = ["MUG", "ROBSTORE", "SHOPLIFT"];
for (var i = 0; i < crime.length; i++) {
    tprintf("Sleeve %d commits crime: %s", i, crime[i]);
    sleeve.setToCommitCrime(i, crime[i]);
}

Example 2

// NS2
// Assign the first 3 sleeves to commit various crimes.
const crime = ["MUG", "ROBSTORE", "SHOPLIFT"];
for (let i = 0; i < crime.length; i++) {
    ns.tprintf("Sleeve %d commits crime: %s", i, crime[i]);
    ns.sleeve.setToCommitCrime(i, crime[i]);
}