Athena.systems.permissionGroup ​

Interfaces ​

• PermissionGroup

Functions ​

addGroupPerm ​

Add a group key to a document, and return the document.

Document can be anything.

Example ​

const data = Athena.document.character.get(somePlayer);
if (!data) {
    return;
}

const modifiedDocument = Athena.systems.permissionGroup.addGroupKey<typeof data>(data, 'police', 'police-chief');
await Athena.document.character.set(somePlayer, 'groups', modifiedDocument.groups);

Export

Type parameters ​

Parameters ​

Returns ​

T & PermissionGroup

Defined in ​

server/systems/permissionGroup.ts:28

hasAtLeastOneGroupPerm ​

Check if a specific document has any of the listed permissions.

Export

Parameters ​

Returns ​

boolean

Defined in ​

server/systems/permissionGroup.ts:168

hasCommonPermission ​

Checks if the given documents have a common permission.

Name

hasCommonPermission

Exports

Parameters ​

Returns ​

boolean

Defined in ​

server/systems/permissionGroup.ts:203

hasGroup ​

Checks if the documet is part of a group.

Export

Parameters ​

Returns ​

boolean

Defined in ​

server/systems/permissionGroup.ts:127

hasGroupPerm ​

Check if a document has a specific group permission.

Export

Parameters ​

Returns ​

boolean

Defined in ​

server/systems/permissionGroup.ts:148

removeGroup ​

Removes a group entirely from a document.

Export

Type parameters ​

Parameters ​

Returns ​

T & PermissionGroup

Defined in ​

server/systems/permissionGroup.ts:110

removeGroupPerm ​

Remove a permission from a group key.

Export

Type parameters ​

Parameters ​

Returns ​

T & PermissionGroup

Defined in ​

server/systems/permissionGroup.ts:67