V5 DocsAthena.utility.restrict.Restrictions ​
server/utility/restrict.Restrictions
Used to build a restricted function.
Interface
Restrictions
Properties ​
kickOnBadPermission ​
• Optional kickOnBadPermission: Object
Kick the player if they do not have permission
Memberof
Restrictions
Type declaration ​
| Name | Type | Description |
|---|---|---|
consoleMessage | string | What to tell console when they are kicked. Player name is automatically appended to the beginning. |
kickMessage | string | What do we tell them when they are kicked |
Defined in ​
notify ​
• Optional notify: string
What to tell the user if they are restricted
Defined in ​
permissions ​
• permissions: Object
Type declaration ​
| Name | Type |
|---|---|
account | string[] |
character | string[] |
Defined in ​
strategy ​
• strategy: "hasOne" | "hasAll"
hasOne - Checks if character, or account has a given permission hasAll - Expects all permissions to exist on character && account