DOC: ns.sleeve.setToCommitCrime(): starting index of sleeves

Document the index of the first sleeve.  Sleeves are indexed starting from zero, i.e. 0.  Increment by 1 to get the index of the next sleeve.  And so on.
This commit is contained in:
Duck McSouls 2022-10-10 12:47:20 +11:00
parent f803355335
commit 304b7645b0

@ -3618,7 +3618,7 @@ export interface Sleeve {
* *
* Returns false if an invalid action is specified. * Returns false if an invalid action is specified.
* *
* @param sleeveNumber - Index of the sleeve to start committing crime. * @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.
* @returns True if this action was set successfully, false otherwise. * @returns True if this action was set successfully, false otherwise.
*/ */