diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 5a2a9a8e6..15a6aaeb5 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -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;