Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-29 19:13:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4225 from quacksouls/doc-sleeve-crime

Browse Source 
DOC: `ns.sleeve.setToCommitCrime()`: add list of crimes a sleeve can commit
This commit is contained in:
hydroflame 2022-10-11 00:58:58 -04:00 committed by GitHub
commit 1cf7b28ac8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -3618,8 +3618,46 @@ export interface Sleeve {
*
* Returns false if an invalid action is specified.
*
* @param sleeveNumber - Index of the sleeve to start committing crime.
* @param name - Name of the crime. Must be an exact match.
* You can set a sleeve to commit one of the following crimes. The crime names are not
* case sensitive. For example, you can pass in the crime name as `"Shoplift"`,
* `"shoplift"`, `"shopLift"`, or even `"SHOPLIFT"`.
*
* - Assassination
* - Bond forgery
* - Deal drugs
* - Grand theft auto
* - Heist
* - Homicide
* - Kidnap
* - Larceny
* - Mug
* - Rob store
* - Shoplift
* - Traffick arms
*
* @example
* ```ts
* // NS1
* // Assign the first 3 sleeves to commit various crimes.
* var crime = ["mug", "rob store", "shoplift"];
* for (var i = 0; i < crime.length; i++) {
* tprintf("Sleeve %d commits crime: %s", i, crime[i]);
* sleeve.setToCommitCrime(i, crime[i]);
* }
* ```
* @example
* ```ts
* // NS2
* // Assign the first 3 sleeves to commit various crimes.
* const crime = ["mug", "rob store", "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]);
* }
* ```
*
* @param sleeveNumber - Index of the sleeve to start committing crime. Sleeves are numbered starting from 0.
* @param name - Name of the crime. Must be an exact match. Refer to the list of crimes.
* @returns True if this action was set successfully, false otherwise.
*/
setToCommitCrime(sleeveNumber: number, name: string): boolean;