Temporary Permissions

Useful plugin for managing temporary permissions, temporary groups and temporary permissions for groups. This is done through chat commands, built-in Oxide commands, and API methods.
Note: The dates is in UTC format.

Contacts

Telegram: https://t.me/iiiaka
Discord: @iiiaka
GitHub: https://github.com/IIIaKa
uMod: https://umod.org/user/IIIaKa
Codefling: https://codefling.com/iiiaka
LoneDesign: https://lone.design/vendor/iiiaka/
GitHub repository page: https://github.com/IIIaKa/TemporaryPermissions

Donations

USDT TRC20: TLN9Tsrdmt96yFCXZTfh4NLtyzWYGkqTA3
USDT TON: UQDma5Ovkk7M9Qve-4P2njmrgSXZQdACU0gLCGNEgkXDlngn
TON: UQDma5Ovkk7M9Qve-4P2njmrgSXZQdACU0gLCGNEgkXDlngn

Features

The ability to grant players temporary permissions by specifying either the number of seconds, an exact expiration date or until the wipe occurs;
The ability to add players to temporary groups by specifying either the number of seconds, an exact expiration date or until the wipe occurs;
The ability to grant groups temporary permissions by specifying either the number of seconds, an exact expiration date or until the wipe occurs;
The ability to revoke temporary permissions from players and groups prematurely;
The ability to remove players from groups prematurely;
The ability to perform all the above actions using existing and familiar console commands(e.g., o.grant), simply by adding the number of seconds, the expiration date or the word "wipe" at the end;
The ability to perform all the above actions using a chat command (by default /tperm);
The ability to perform all the above actions using API methods;
The ability to remove all temporary permissions and groups upon wipe detection.

Permissions

temporarypermissions.admin - Grants access to the chat command(by default /tperm).

Default Configuration

{
  "Chat command": "tperm",
  "Interval in seconds for expiration check": 1.0,
  "Interval in seconds for checking the presence of temporary permissions and temporary groups. There are cases where removal cannot be tracked in the usual way. A value of 0 disables the check": 600.0,
  "Is it worth restoring removed temporary permissions and temporary groups if the timer hasn't expired?": true,
  "Is it worth removing temporary permissions and temporary groups when unloading the plugin?": true,
  "Is it worth using console logging?": true,
  "Is it worth clearing all temporary permissions upon detecting a wipe?": false,
  "Wipe ID": null,
  "Version": {
    "Major": 0,
    "Minor": 1,
    "Patch": 0
  }
}

Localization

EN

{
  "MsgPermissionNotFound": "Permission not found!",
  "MsgPlayerNotFound": "Player not found!",
  "MsgGroupNotFound": "Group not found!",
  "MsgGrantWrongFormat": "Invalid command format! Example: /tperm grant user/group *NameOrId* realpve.vip *secondsOrDateTime*",
  "MsgRevokeWrongFormat": "Invalid command format! Example: /tperm revoke user/group *NameOrId* realpve.vip",
  "MsgUserGroupWrongFormat": "Invalid command format! Example: /tperm group add/remove *NameOrId* *groupName*",
  "MsgUserGranted": "Permission {0} granted to player {1}",
  "MsgGroupGranted": "Permission {0} granted to group {1}",
  "MsgUserGroupAdded": "Player {0} has been added to group {1}",
  "MsgUserRevoked": "Permission {0} has been removed for player {1}",
  "MsgGroupRevoked": "Permission {0} has been removed for group {1}",
  "MsgUserGroupRemoved": "Player {0} has been removed from group {1}"
}

RU

{
  "MsgPermissionNotFound": "Пермишен не найден!",
  "MsgPlayerNotFound": "Игрок не найден!",
  "MsgGroupNotFound": "Группа не найдена!",
  "MsgGrantWrongFormat": "Не верный формат команды! Пример: /tperm grant user/group *NameOrId* realpve.vip *secondsOrDateTime*",
  "MsgRevokeWrongFormat": "Не верный формат команды! Пример: /tperm revoke user/group *NameOrId* realpve.vip",
  "MsgUserGroupWrongFormat": "Не верный формат команды! Пример: /tperm group add/remove *NameOrId* *groupName*",
  "MsgUserGranted": "Пермишен {0} выдан игроку {1}",
  "MsgGroupGranted": "Пермишен {0} выдан группе {1}",
  "MsgUserGroupAdded": "Игрок {0} был добавлен в группу {1}",
  "MsgUserRevoked": "Пермишен {0} был удален для игрока {1}",
  "MsgGroupRevoked": "Пермишен {0} был удален для группы {1}",
  "MsgUserGroupRemoved": "Игрок {0} был удален из группы {1}"
}

Commands

grant - Grants a temporary permission to a player or group.
- user
  - <displayName|userID> realpve.vip wipe - Grants a temporary permission to a player until the next wipe by specifying the player's name or Id, the permission name and the word "wipe";
  - <displayName|userID> realpve.vip 3600 true/false - Grants a temporary permission to a player by specifying the player's name or Id, the permission name, the number of seconds and true/false(optional).
    If true, the specified seconds will count from the current moment, otherwise(default), they will be added to the existing time;
  - <displayName|userID> realpve.vip "2024-08-19 17:57" "2024-08-19 16:57" - Grants a temporary permission to a player by specifying the player's name or Id, the permission name, the expiration date and the assigned date(optional).
    If not specified, the assigned date will default to the current date, otherwise, it will be set to the provided date.
- group
  - realpve.vip wipe - Grants a temporary permission to a group until the next wipe by specifying the group's name, the permission name and the word "wipe";
  - realpve.vip 3600 true/false - Grants a temporary permission to a group by specifying the group's name, the permission name, the number of seconds, and true/false(optional).
    If true, the specified seconds will count from the current moment, otherwise(default), they will be added to the existing time;
  - realpve.vip "2024-08-19 17:57" "2024-08-19 16:57" - Grants a temporary permission to a group by specifying the group's name, the permission name, the expiration date and the assigned date(optional).
    If not specified, the assigned date will default to the current date, otherwise, it will be set to the provided date.
revoke - Revokes a temporary permission from a player or group.
- user <displayName|userID> realpve.vip - Revokes a temporary permission from a player by specifying the player's name or Id and the permission name;
- group realpve.vip - Revokes a temporary permission from a group by specifying the group's name and the permission name.
add - Temporary addition of a player to a group.
- <displayName|userID> wipe - Temporary addition of a player to a group until the next wipe by specifying the player's name or Id, the group name and the word "wipe";
- <displayName|userID> 3600 true/false - Temporary addition of a player to a group by specifying the player's name or Id, the group name, the number of seconds, and true/false(optional).
  If true, the specified seconds will count from the current moment, otherwise(default), they will be added to the existing time;
- <displayName|userID> "2024-08-19 17:57" "2024-08-19 16:57" - Temporary addition of a player to a group by specifying the player's name or Id, the group name, the expiration date and the assigned date(optional).
  If not specified, the assigned date will default to the current date, otherwise, it will be set to the provided date.
remove <displayName|userID> - Removal of a player from a temporary group by specifying the player's name or Id and the group name.

Example:

/tperm grant user iiiaka realpve.vip wipe
/tperm grant user iiiaka realpve.vip 3600 true
/tperm grant user iiiaka realpve.vip "2024-08-19 17:57" "2024-08-19 16:57"

Note: To access the commands, the player must be an admin(console or owner) or have the temporarypermissions.admin permission.

P.S. Templates for the commands above can also be used with existing console commands.
For example: o.grant user iiiaka realpve.vip 3600 true

Developer Hooks

OnTemporaryPermissionsLoaded

Called after the TemporaryPermissions plugin is fully loaded and ready.
No return behaviour.

void OnTemporaryPermissionsLoaded(VersionNumber version = default)
{
  Puts("The TemporaryPermissions plugin is loaded and ready to go!");
}

OnTemporaryPermissionGranted

Called after the player has been granted a temporary permission.
No return behaviour.

void OnTemporaryPermissionGranted(string userID, string perm, DateTime expireDate, DateTime assignedDate)
{
  Puts($"Player {userID} has been granted the temporary permission {perm} from {assignedDate} until {expireDate}.");
}

OnTemporaryPermissionUpdated

Called after the player's temporary permission has been updated.
No return behaviour.

void OnTemporaryPermissionUpdated(string userID, string perm, DateTime expireDate, DateTime assignedDate)
{
  Puts($"Player {userID}'s temporary permission {perm} has been updated. New expiration date: {expireDate}. Assigned date: {assignedDate}.");
}

OnTemporaryPermissionRevoked

Called after the player's temporary permission has expired or been revoked.
No return behaviour.

void OnTemporaryPermissionRevoked(string userID, string perm, bool isExpired)
{
  Puts($"Player {userID} has had the temporary permission {perm} revoked. Permission expired: {isExpired}.");
}

OnTemporaryGroupAdded

Called after the player has been temporarily added to the group.
No return behaviour.

void OnTemporaryGroupAdded(string userID, string groupName, DateTime expireDate, DateTime assignedDate)
{
  Puts($"Player {userID} has been added to the temporary group {groupName} from {assignedDate} until {expireDate}.");
}

OnTemporaryGroupUpdated

Called after the player's temporary group has been updated.
No return behaviour.

void OnTemporaryGroupUpdated(string userID, string groupName, DateTime expireDate, DateTime assignedDate)
{
  Puts($"Player {userID}'s temporary group {groupName} has been updated. New expiration date: {expireDate}. Assigned date: {assignedDate}.");
}

OnTemporaryGroupRemoved

Called after the player's temporary group has expired or been removed.
No return behaviour.

void OnTemporaryGroupRemoved(string userID, string groupName, bool isExpired)
{
  Puts($"Player {userID} has had the temporary group {groupName} revoked. Group expired: {isExpired}.");
}

OnGroupTemporaryPermissionGranted

Called after the group has been granted a temporary permission.
No return behaviour.

void OnGroupTemporaryPermissionGranted(string groupName, string perm, DateTime expireDate, DateTime assignedDate)
{
  Puts($"Group {groupName} has been granted the temporary permission {perm}, valid from {assignedDate} until {expireDate}.");
}

OnGroupTemporaryPermissionUpdated

Called after the group's temporary permission has been updated.
No return behaviour.

void OnGroupTemporaryPermissionUpdated(string groupName, string perm, DateTime expireDate, DateTime assignedDate)
{
  Puts($"Group {groupName}'s temporary permission {perm} has been updated. New expiration date: {expireDate}. Assigned date: {assignedDate}.");
}

OnGroupTemporaryPermissionRevoked

Called after the group's temporary permission has expired or been revoked.
No return behaviour.

void OnGroupTemporaryPermissionRevoked(string groupName, string perm, bool isExpired)
{
  Puts($"Group {groupName} has had the temporary permission {perm} revoked. Permission expired: {isExpired}.");
}

Developer API

[PluginReference]
private Plugin TemporaryPermissions;

There are 28 methods:

IsReady
User's Permissions:
- GrantUserPermission
- RevokeUserPermission
- UserHasPermission
- GrantActiveUsersPermission
- GrantAllUsersPermission
- RevokeActiveUsersPermission
- RevokeAllUsersPermission
- UserGetAllPermissions
- ActiveUsersGetAllPermissions
- AllUsersGetAllPermissions
User's Groups:
- AddUserGroup
- RemoveUserGroup
- UserHasGroup
- AddActiveUsersGroup
- AddAllUsersGroup
- RemoveActiveUsersGroup
- RemoveAllUsersGroup
- UserGetAllGroups
- ActiveUsersGetAllGroups
- AllUsersGetAllGroups
Group's Permissions:
- GrantGroupPermission
- RevokeGroupPermission
- GroupHasPermission
- GrantAllGroupsPermission
- RevokeAllGroupsPermission
- GroupGetAllPermissions
- AllGroupsGetAllPermissions

IsReady

Used to check if the TemporaryPermissions plugin is loaded and ready to work.
The IsReady method returns true if it is ready, or null if it is not.

(bool)TemporaryPermissions?.Call("IsReady");//Calling the IsReady method. If the result is not null(bool true), the plugin is ready.

GrantUserPermission

Used to grant a temporary permission to a player.
Returns true if the grant was successful.
To call the GrantUserPermission method, you need to pass 5 parameters, 3 of which are optional:

IPlayer or BasePlayer or playerID - The player object or their Id;
permName - The name of the permission;
secondsToAdd or expireDate - Optional. The time in seconds to add, or the end date. If a number less than 1 is specified, or if this parameter is not specified, the permission will be valid until the wipe;
fromNow or assignedDate - Optional. true/false to specify whether the seconds should be added to the current date or to the existing time, or an exact assignment date. Defaults to the current date;
checkExistence - Optional. Whether to check for the existence of the permission.

(bool)TemporaryPermissions?.Call("GrantUserPermission", player.UserIDString, "realpve.vip");//Calling the GrantUserPermission method without specifying the third parameter, to grant temporary permission until the wipe.
(bool)TemporaryPermissions?.Call("GrantUserPermission", player.UserIDString, "realpve.vip", 0);//Calling the GrantUserPermission method with the specified number less than 1, to grant temporary permission until the wipe.
(bool)TemporaryPermissions?.Call("GrantUserPermission", player.UserIDString, "realpve.vip", 3600, true, true);//Calling the GrantUserPermission method with the specified number of seconds to add.
(bool)TemporaryPermissions?.Call("GrantUserPermission", player.UserIDString, "realpve.vip", expireDate, assignedDate, true);//Calling the GrantUserPermission method with the specified DateTime for the end and start of the temporary permission.

RevokeUserPermission

Used to revoke a temporary permission from a player.
Returns true if the revoke was successful.
To call the RevokeUserPermission method, you need to pass 2 parameters:

IPlayer or BasePlayer or playerID - The player object or their Id;
permName - The name of the permission.

(bool)TemporaryPermissions?.Call("RevokeUserPermission", player.UserIDString, "realpve.vip");

UserHasPermission

Used to check if a player has a temporary permission.
Returns true if the player has the specified temporary permission.
To call the UserHasPermission method, you need to pass 2 parameters:

IPlayer or BasePlayer or playerID - The player object or their Id;
permName - The name of the permission.

(bool)TemporaryPermissions?.Call("UserHasPermission", player.UserIDString, "realpve.vip");

GrantActiveUsersPermission

Used to temporarily grant a permission to all online players.
Returns the number of successful grants of temporary permissions to players.
To call the GrantActiveUsersPermission method, you need to pass 3 parameters, 2 of which is optional:

permName - The name of the permission;
secondsToAdd or expireDate - Optional. The time in seconds to add, or the end date. If a number less than 1 is specified, or if this parameter is not specified, the permission will be valid until the wipe;
fromNow or assignedDate - Optional. true/false to specify whether the seconds should be added to the current date or to the existing time, or an exact assignment date. Defaults to the current date.

(int)TemporaryPermissions?.Call("GrantActiveUsersPermission", "realpve.vip");//Calling the GrantActiveUsersPermission method without specifying the second parameter, to grant all online players temporary permission until the wipe.
(int)TemporaryPermissions?.Call("GrantActiveUsersPermission", "realpve.vip", 0);//Calling the GrantActiveUsersPermission method with the specified number less than 1, to grant all online players temporary permission until the wipe.
(int)TemporaryPermissions?.Call("GrantActiveUsersPermission", "realpve.vip", 3600, true);//Calling the GrantActiveUsersPermission method with the specified number of seconds to add.
(int)TemporaryPermissions?.Call("GrantActiveUsersPermission", "realpve.vip", expireDate, assignedDate);//Calling the GrantActiveUsersPermission method with the specified DateTime for the end and start of the temporary permission.

GrantAllUsersPermission

Used to grant a temporary permission to all players.
Returns the number of successful grants of temporary permissions to players.
To call the GrantAllUsersPermission method, you need to pass 3 parameters, 2 of which is optional:

permName - The name of the permission;
secondsToAdd or expireDate - Optional. The time in seconds to add, or the end date. If a number less than 1 is specified, or if this parameter is not specified, the permission will be valid until the wipe;
fromNow or assignedDate - Optional. true/false to specify whether the seconds should be added to the current date or to the existing time, or an exact assignment date. Defaults to the current date.

(int)TemporaryPermissions?.Call("GrantAllUsersPermission", "realpve.vip");//Calling the GrantAllUsersPermission method without specifying the second parameter, to grant all players temporary permission until the wipe.
(int)TemporaryPermissions?.Call("GrantAllUsersPermission", "realpve.vip", 0);//Calling the GrantAllUsersPermission method with the specified number less than 1, to grant all players temporary permission until the wipe.
(int)TemporaryPermissions?.Call("GrantAllUsersPermission", "realpve.vip", 3600, true);//Calling the GrantAllUsersPermission method with the specified number of seconds to add.
(int)TemporaryPermissions?.Call("GrantAllUsersPermission", "realpve.vip", expireDate, assignedDate);//Calling the GrantAllUsersPermission method with the specified DateTime for the end and start of the temporary permission.

RevokeActiveUsersPermission

Used to revoke a temporary permission from all online players.
Returns the number of successful revokes of temporary permissions to players.
To call the RevokeActiveUsersPermission method, you need to pass 1 parameter:

permName - The name of the permission.

(int)TemporaryPermissions?.Call("RevokeActiveUsersPermission", "realpve.vip");

RevokeAllUsersPermission

Used to revoke a temporary permission from all players.
Returns the number of successful revokes of temporary permissions to players.
To call the RevokeAllUsersPermission method, you need to pass 1 parameter:

permName - The name of the permission.

(int)TemporaryPermissions?.Call("RevokeAllUsersPermission", "realpve.vip");

UserGetAllPermissions

Used to retrieve all temporary permissions of a player.
Returns a Dictionary<string, DateTime[]> where the key is the permission name and the value is an array of 2 DateTimes: the first date is the assignment date and the second date is the expiration date of the permission.
If the expiration date is set to default, it means the permission is valid until the wipe.
To call the UserGetAllPermissions method, you need to pass 1 parameter:

playerID - The player's Id.

(Dictionary<string, DateTime[]>)TemporaryPermissions?.Call("UserGetAllPermissions", player.UserIDString);

ActiveUsersGetAllPermissions

Used to retrieve all temporary permissions of all online players who have temporary permissions.
Returns a Dictionary<string, Dictionary<string, DateTime[]>> where the key is userID and the value is another Dictionary<string, DateTime[]>, where the key is the permission name and the value is an array of 2 DateTimes: the first date is the assignment date and the second date is the expiration date of the permission.
If the expiration date is set to default, it means the permission is valid until the wipe.

(Dictionary<string, Dictionary<string, DateTime[]>>)TemporaryPermissions?.Call("ActiveUsersGetAllPermissions");

AllUsersGetAllPermissions

Used to retrieve all temporary permissions of all players who have temporary permissions.
Returns a Dictionary<string, Dictionary<string, DateTime[]>> where the key is userID and the value is another Dictionary<string, DateTime[]>, where the key is the permission name and the value is an array of 2 DateTimes: the first date is the assignment date and the second date is the expiration date of the permission.
If the expiration date is set to default, it means the permission is valid until the wipe.

(Dictionary<string, Dictionary<string, DateTime[]>>)TemporaryPermissions?.Call("AllUsersGetAllPermissions");

AddUserGroup

Used to temporarily add a player to a group.
Returns true if the addition was successful.
To call the AddUserGroup method, you need to pass 5 parameters, 3 of which are optional:

IPlayer or BasePlayer or playerID - The player object or their Id;
groupName - The name of the group;
secondsToAdd or expireDate - Optional. The time in seconds to add, or the end date. If a number less than 1 is specified, or if this parameter is not specified, the group will be valid until the wipe;
fromNow or assignedDate - Optional. true/false to specify whether the seconds should be added to the current date or to the existing time, or an exact assignment date. Defaults to the current date;
checkExistence - Optional. Whether to check for the existence of the group.

(bool)TemporaryPermissions?.Call("AddUserGroup", player.UserIDString, "vip");//Calling the AddUserGroup method without specifying the third parameter to temporarily add a player, to a group until the wipe.
(bool)TemporaryPermissions?.Call("AddUserGroup", player.UserIDString, "vip", 0);//Calling the AddUserGroup method with the specified number less than 1, to temporarily add a player to a group until the wipe.
(bool)TemporaryPermissions?.Call("AddUserGroup", player.UserIDString, "vip", 3600, true, true);//Calling the AddUserGroup method with the specified number of seconds to add.
(bool)TemporaryPermissions?.Call("AddUserGroup", player.UserIDString, "vip", expireDate, assignedDate, true);//Calling the AddUserGroup method with the specified DateTime for the end and start of the temporary permission.

RemoveUserGroup

Used to remove a temporary group from a player.
Returns true if the removal was successful.
To call the RemoveUserGroup method, you need to pass 2 parameters:

IPlayer or BasePlayer or playerID - The player object or their Id;
groupName - The name of the group.

(bool)TemporaryPermissions?.Call("RemoveUserGroup", player.UserIDString, "vip");

UserHasGroup

Used to check if a player has a temporary group.
Returns true if the player has the specified temporary group.
To call the UserHasGroup method, you need to pass 2 parameters:

IPlayer or BasePlayer or playerID - The player object or their Id;
groupName - The name of the group.

(bool)TemporaryPermissions?.Call("UserHasGroup", player.UserIDString, "vip");

AddActiveUsersGroup

Used to temporarily add a group to all online players.
Returns the number of successful additions of the temporary group to players.
To call the AddActiveUsersGroup method, you need to pass 3 parameters, 2 of which is optional:

groupName - The name of the group;
secondsToAdd or expireDate - Optional. The time in seconds to add, or the end date. If a number less than 1 is specified, or if this parameter is not specified, the group will be valid until the wipe;
fromNow or assignedDate - Optional. true/false to specify whether the seconds should be added to the current date or to the existing time, or an exact assignment date. Defaults to the current date.

(int)TemporaryPermissions?.Call("AddActiveUsersGroup", "vip");//Calling the AddActiveUsersGroup method without specifying the second parameter to temporarily add all online players to a group until the wipe.
(int)TemporaryPermissions?.Call("AddActiveUsersGroup", "vip", 0);//Calling the AddActiveUsersGroup method with the specified number less than 1, to temporarily add all online players to a group until the wipe.
(int)TemporaryPermissions?.Call("AddActiveUsersGroup", "vip", 3600, true);//Calling the AddActiveUsersGroup method with the specified number of seconds to add.
(int)TemporaryPermissions?.Call("AddActiveUsersGroup", "vip", expireDate, assignedDate);//Calling the AddActiveUsersGroup method with the specified DateTime for the end and start of the temporary permission.

AddAllUsersGroup

Used to temporarily add a group to all players.
Returns the number of successful additions of the temporary group to players.
To call the AddAllUsersGroup method, you need to pass 3 parameters, 2 of which is optional:

groupName - The name of the group;
secondsToAdd or expireDate - Optional. The time in seconds to add, or the end date. If a number less than 1 is specified, or if this parameter is not specified, the group will be valid until the wipe;
fromNow or assignedDate - Optional. true/false to specify whether the seconds should be added to the current date or to the existing time, or an exact assignment date. Defaults to the current date.

(int)TemporaryPermissions?.Call("AddAllUsersGroup", "vip");//Calling the AddAllUsersGroup method without specifying the second parameter to temporarily add all players to a group until the wipe.
(int)TemporaryPermissions?.Call("AddAllUsersGroup", "vip", 0);//Calling the AddAllUsersGroup method with the specified number less than 1, to temporarily add all players to a group until the wipe.
(int)TemporaryPermissions?.Call("AddAllUsersGroup", "vip", 3600, true);//Calling the AddAllUsersGroup method with the specified number of seconds to add.
(int)TemporaryPermissions?.Call("AddAllUsersGroup", "vip", expireDate, assignedDate);//Calling the AddAllUsersGroup method with the specified DateTime for the end and start of the temporary permission.

RemoveActiveUsersGroup

Used to remove a temporary group from all online players.
Returns the number of successful removals of temporary groups from players.
To call the RemoveActiveUsersGroup method, you need to pass 1 parameter:

groupName - The name of the group.

(int)TemporaryPermissions?.Call("RemoveActiveUsersGroup", "vip");

RemoveAllUsersGroup

Used to remove a temporary group from all players.
Returns the number of successful removals of temporary groups from players.
To call the RemoveAllUsersGroup method, you need to pass 1 parameter:

permName - The name of the permission.

(int)TemporaryPermissions?.Call("RemoveAllUsersGroup", "vip");

UserGetAllGroups

Used to retrieve all temporary groups of a player.
Returns a Dictionary<string, DateTime[]> where the key is the group name and the value is an array of 2 DateTimes: the first date is the assignment date and the second date is the expiration date of the group.
If the expiration date is set to default, it means the permission is valid until the wipe.
To call the UserGetAllGroups method, you need to pass 1 parameter:

permName - The name of the permission.

(Dictionary<string, DateTime[]>)TemporaryPermissions?.Call("UserGetAllGroups", player.UserIDString);

ActiveUsersGetAllGroups

Used to retrieve all temporary groups of a player.
Returns a Dictionary<string, Dictionary<string, DateTime[]>> where the key is the group name and the value is an array of 2 DateTimes: the first date is the assignment date and the second date is the expiration date of the group.
If the expiration date is set to default, it means the group is valid until the wipe.

(Dictionary<string, Dictionary<string, DateTime[]>>)TemporaryPermissions?.Call("ActiveUsersGetAllGroups");

ActiveUsersGetAllGroups

Used to retrieve all temporary groups of all players who have temporary groups.
Returns a Dictionary<string, Dictionary<string, DateTime[]>> where the key is userID and the value is another Dictionary<string, DateTime[]>, where the key is the group name and the value is an array of 2 DateTimes: the first date is the assignment date and the second date is the expiration date of the group.
If the expiration date is set to default, it means the group is valid until the wipe.

(Dictionary<string, Dictionary<string, DateTime[]>>)TemporaryPermissions?.Call("ActiveUsersGetAllGroups");

AllUsersGetAllGroups

Used to retrieve all temporary groups of all players who have temporary groups.
Returns a Dictionary<string, Dictionary<string, DateTime[]>> where the key is userID and the value is another Dictionary<string, DateTime[]>, where the key is the group name and the value is an array of 2 DateTimes: the first date is the assignment date and the second date is the expiration date of the group.
If the expiration date is set to default, it means the group is valid until the wipe.

(Dictionary<string, Dictionary<string, DateTime[]>>)TemporaryPermissions?.Call("AllUsersGetAllGroups");

GrantGroupPermission

Used to grant a temporary permission to a group.
Returns true if the grant was successful.
To call the GrantGroupPermission method, you need to pass 5 parameters, 3 of which are optional:

groupName - The name of the group;
permName - The name of the permission;
secondsToAdd or expireDate - Optional. The time in seconds to add, or the end date. If a number less than 1 is specified, or if this parameter is not specified, the permission will be valid until the wipe;
fromNow or assignedDate - Optional. true/false to specify whether the seconds should be added to the current date or to the existing time, or an exact assignment date. Defaults to the current date;
checkExistence - Optional. Whether to check for the existence of the permission.

(bool)TemporaryPermissions?.Call("GrantGroupPermission", "vip", "realpve.vip");//Calling the GrantGroupPermission method without specifying the third parameter, to grant temporary permission until the wipe.
(bool)TemporaryPermissions?.Call("GrantGroupPermission", "vip", "realpve.vip", 0);//Calling the GrantGroupPermission method with the specified number less than 1, to grant temporary permission until the wipe.
(bool)TemporaryPermissions?.Call("GrantGroupPermission", "vip", "realpve.vip", 3600, true, true);//Calling the GrantGroupPermission method with the specified number of seconds to add.
(bool)TemporaryPermissions?.Call("GrantGroupPermission", "vip", "realpve.vip", expireDate, assignedDate, true);//Calling the GrantGroupPermission method with the specified DateTime for the end and start of the temporary permission.

RevokeGroupPermission

Used to revoke a temporary permission from a group.
Returns true if the revoke was successful.
To call the RevokeGroupPermission method, you need to pass 2 parameters:

groupName - The name of the group;
permName - The name of the permission.

(bool)TemporaryPermissions?.Call("RevokeGroupPermission", "vip", "realpve.vip");

GroupHasPermission

Used to check if a group has a temporary permission.
Returns true if the group has the specified temporary permission.
To call the GroupHasPermission method, you need to pass 2 parameters:

groupName - The name of the group;
permName - The name of the permission.

(bool)TemporaryPermissions?.Call("GroupHasPermission", "vip", "realpve.vip");

GrantAllGroupsPermission

Used to temporarily grant a permission to all groups.
Returns the number of successful grants of temporary permissions to groups.
To call the GrantAllGroupsPermission method, you need to pass 3 parameters, 2 of which is optional:

permName - The name of the permission;
secondsToAdd or expireDate - Optional. The time in seconds to add, or the end date. If a number less than 1 is specified, or if this parameter is not specified, the permission will be valid until the wipe;
fromNow or assignedDate - Optional. true/false to specify whether the seconds should be added to the current date or to the existing time, or an exact assignment date. Defaults to the current date.

(int)TemporaryPermissions?.Call("GrantAllGroupsPermission", "realpve.vip");//Calling the GrantAllGroupsPermission method without specifying the second parameter, to grant all groups temporary permission until the wipe.
(int)TemporaryPermissions?.Call("GrantAllGroupsPermission", "realpve.vip", 0);//Calling the GrantAllGroupsPermission method with the specified number less than 1, to grant all groups temporary permission until the wipe.
(int)TemporaryPermissions?.Call("GrantAllGroupsPermission", "realpve.vip", 3600, true);//Calling the GrantAllGroupsPermission method with the specified number of seconds to add.
(int)TemporaryPermissions?.Call("GrantAllGroupsPermission", "realpve.vip", expireDate, assignedDate);//Calling the GrantAllGroupsPermission method with the specified DateTime for the end and start of the temporary permission.

RevokeAllGroupsPermission

Used to revoke a temporary permission from all groups.
Returns the number of successful revokes of temporary permissions to groups.
To call the RevokeAllGroupsPermission method, you need to pass 1 parameter:

permName - The name of the permission.

(int)TemporaryPermissions?.Call("RevokeAllGroupsPermission", "realpve.vip");

GroupGetAllPermissions

Used to retrieve all temporary permissions of a group.
Returns a Dictionary<string, DateTime[]> where the key is the permission name and the value is an array of 2 DateTimes: the first date is the assignment date and the second date is the expiration date of the permission.
If the expiration date is set to default, it means the permission is valid until the wipe.
To call the GroupGetAllPermissions method, you need to pass 1 parameter:

groupName - The name of the group.

(Dictionary<string, DateTime[]>)TemporaryPermissions?.Call("GroupGetAllPermissions", "vip");

AllGroupsGetAllPermissions

Used to retrieve all temporary permissions of all groups that have temporary permissions.
Returns a Dictionary<string, Dictionary<string, DateTime[]>> where the key is the group name and the value is another Dictionary<string, DateTime[]>, where the key is the permission name and the value is an array of 2 DateTimes: the first date is the assignment date and the second date is the expiration date of the permission.
If the expiration date is set to default, it means the permission is valid until the wipe.

(Dictionary<string, Dictionary<string, DateTime[]>>)TemporaryPermissions?.Call("AllGroupsGetAllPermissions");

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
.gitattributes		.gitattributes
LICENSE		LICENSE
README.md		README.md
TemporaryPermissions.cs		TemporaryPermissions.cs

License

IIIaKa/TemporaryPermissions

Folders and files

Latest commit

History

Repository files navigation

Temporary Permissions

Contacts

Donations

Features

Permissions

Default Configuration

Localization

EN

RU

Commands

Developer Hooks

OnTemporaryPermissionsLoaded

OnTemporaryPermissionGranted

OnTemporaryPermissionUpdated

OnTemporaryPermissionRevoked

OnTemporaryGroupAdded

OnTemporaryGroupUpdated

OnTemporaryGroupRemoved

OnGroupTemporaryPermissionGranted

OnGroupTemporaryPermissionUpdated

OnGroupTemporaryPermissionRevoked

Developer API

IsReady

GrantUserPermission

RevokeUserPermission

UserHasPermission

GrantActiveUsersPermission

GrantAllUsersPermission

RevokeActiveUsersPermission

RevokeAllUsersPermission

UserGetAllPermissions

ActiveUsersGetAllPermissions

AllUsersGetAllPermissions

AddUserGroup

RemoveUserGroup

UserHasGroup

AddActiveUsersGroup

AddAllUsersGroup

RemoveActiveUsersGroup

RemoveAllUsersGroup

UserGetAllGroups

ActiveUsersGetAllGroups

ActiveUsersGetAllGroups

AllUsersGetAllGroups

GrantGroupPermission

RevokeGroupPermission

GroupHasPermission

GrantAllGroupsPermission

RevokeAllGroupsPermission

GroupGetAllPermissions

AllGroupsGetAllPermissions

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages