Athena.player.permissions ​
Functions ​
addAcountPermissions ​
Usage
Athena.player.permissions.addAcountPermissions(player
, permission
): Promise
<any
>
Add a permission to the given player's account.
Export
Parameters ​
Name | Type |
---|---|
player | Player |
permission | string |
Returns ​
Promise
<any
>
Defined in ​
server/player/permissions.ts:27
addGroupPerm ​
Usage
Athena.player.permissions.addGroupPerm(player
, groupName
, permission
): Promise
<boolean
>
Add a group permission to a character.
If a player group permission, and a vehicle group permission intercept, then vehicle control is granted.
Export
Parameters ​
Name | Type |
---|---|
player | Player |
groupName | string |
permission | string |
Returns ​
Promise
<boolean
>
Defined in ​
server/player/permissions.ts:133
addPermission ​
Usage
Athena.player.permissions.addPermission(player
, permission
): Promise
<any
>
Adds a permission to the given player character.
Async
Name
addPermission
Exports
Parameters ​
Name | Type |
---|---|
player | Player |
permission | string |
Returns ​
Promise
<any
>
Defined in ​
server/player/permissions.ts:15
hasAccountPermission ​
Usage
Athena.player.permissions.hasAccountPermission(player
, permission
): any
Check if the player has an account permission.
Export
Parameters ​
Name | Type |
---|---|
player | Player |
permission | string |
Returns ​
any
Defined in ​
server/player/permissions.ts:77
hasCommonGroupPermission ​
Usage
Athena.player.permissions.hasCommonGroupPermission(player
, document
, groupName
, permission
): any
Check if a player has any matching permissions against another document.
Export
Parameters ​
Name | Type |
---|---|
player | Player |
document | PermissionGroup |
groupName | string |
permission | string |
Returns ​
any
Defined in ​
server/player/permissions.ts:108
hasGroupPermission ​
Usage
Athena.player.permissions.hasGroupPermission(player
, groupName
, permission
): any
Check if a player character has a group permission.
Export
Parameters ​
Name | Type |
---|---|
player | Player |
groupName | string |
permission | string |
Returns ​
any
Defined in ​
server/player/permissions.ts:90
hasPermission ​
Usage
Athena.player.permissions.hasPermission(player
, permission
): any
Check if the current player character has a permission.
Export
Parameters ​
Name | Type |
---|---|
player | Player |
permission | string |
Returns ​
any
Defined in ​
server/player/permissions.ts:65
removeAccountPermission ​
Usage
Athena.player.permissions.removeAccountPermission(player
, permission
): Promise
<any
>
Remove a permission to the given player's account.
Export
Parameters ​
Name | Type |
---|---|
player | Player |
permission | string |
Returns ​
Promise
<any
>
Defined in ​
server/player/permissions.ts:53
removePermission ​
Usage
Athena.player.permissions.removePermission(player
, permission
): Promise
<any
>
Removes a permission from the given player character.
Async
Name
removePermission
Exports
Parameters ​
Name | Type |
---|---|
player | Player |
permission | string |
Returns ​
Promise
<any
>