DOC: ns.sleeve.setToCommitCrime(): add all crimes a sleeve can commit

Add a list of crimes that a sleeve can commit.  Update the parameter documentation to refer to this list.
This commit is contained in:
Duck McSouls 2022-10-10 13:17:14 +11:00
parent 304b7645b0
commit c728c550f5

@ -3618,8 +3618,25 @@ export interface Sleeve {
*
* 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
*
* @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.
* @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;