Skip to content
On this page

Athena.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 ​

NameTypeDescription
consoleMessagestringWhat to tell console when they are kicked. Player name is automatically appended to the beginning.
kickMessagestringWhat do we tell them when they are kicked

Defined in ​

server/utility/restrict.ts:37


notify ​

• Optional notify: string

What to tell the user if they are restricted

Defined in ​

server/utility/restrict.ts:29


permissions ​

• permissions: Object

Type declaration ​

NameType
accountstring[]
characterstring[]

Defined in ​

server/utility/restrict.ts:11


strategy ​

• strategy: "hasOne" | "hasAll"

hasOne - Checks if character, or account has a given permission hasAll - Expects all permissions to exist on character && account

Defined in ​

server/utility/restrict.ts:22

Created by Stuyk | Est. 2020