Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-18 21:53:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

DOC: ns.sleeve.setToCommitCrime(): add 1 example

Browse Source 
An example on how to set a sleeve to commit a crime.  The example shows that sleeves are indexed from 0.
This commit is contained in:
Duck McSouls 2022-10-10 20:49:33 +11:00
parent c728c550f5
commit afe6a837c3
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3635,6 +3635,27 @@ export interface Sleeve {
* - Shoplift * - Shoplift
* - Traffick arms * - 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 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. * @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. * @returns True if this action was set successfully, false otherwise.