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

doc

Browse Source
This commit is contained in:
Olivier Gagnon 2022-10-11 01:06:26 -04:00
parent 1cf7b28ac8
commit 73bcf0870f
2 changed files with 72 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
dist/bitburner.d.ts vendored
View File

@ -6366,8 +6366,46 @@ export declare 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;

34
markdown/bitburner.sleeve.settocommitcrime.md
View File

@ -16,8 +16,8 @@ setToCommitCrime(sleeveNumber: number, name: string): boolean;
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to start committing crime. |
| name | string | Name of the crime. Must be an exact match. |
| sleeveNumber | number | Index of the sleeve to start committing crime. Sleeves are numbered starting from 0. |
| name | string | Name of the crime. Must be an exact match. Refer to the list of crimes. |
<b>Returns:</b>
@ -33,3 +33,33 @@ Return a boolean indicating whether or not this action was set successfully.
Returns false if an invalid action is specified.
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 1
```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 2
```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]);
}
```