Temporary Permissions 0.1.0

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.
This is an alternative to the well-known TimedPermissions plugin, which was abandoned about three years ago, and it offers more advanced features.

Note: The dates is in UTC format.

 

• The ability to grant players temporary permissions by specifying either the number of seconds or an exact expiration date;
• The ability to add players to temporary groups by specifying either the number of seconds or an exact expiration date;
• The ability to grant groups temporary permissions by specifying either the number of seconds or an exact expiration date;
• 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 or the expiration date 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.

 

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

 

{
  "Chat command": "tperm",
  "Expiration Check Interval": 1.0,
  "Is it worth removing temporary permissions and groups when unloading the plugin or when a player disconnects?": 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
  }
}

 

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}"
}

 

1. grant - Grants a temporary permission to a player or group.
   • user
     • *NameOrId* 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";
     • *NameOrId* 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;
     • *NameOrId* 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
     • *GroupName* 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";
     • *GroupName* 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;
     • *GroupName* 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.
2. revoke - Revokes a temporary permission from a player or group.
   • user *NameOrId* realpve.vip - Revokes a temporary permission from a player by specifying the player's name or Id and the permission name;
   • group *GroupName* realpve.vip - Revokes a temporary permission from a group by specifying the group's name and the permission name.
3. add - Temporary addition of a player to a group.
   • *NameOrId* *GroupName* 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";
   • *NameOrId* *GroupName* 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;
   • *NameOrId* *GroupName* "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.
4. remove *NameOrId* *GroupName* - 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

 

• OnTemporaryPermissionsLoaded:
  • Called after the TemporaryPermissions plugin is fully loaded and ready.
• OnTemporaryPermissionGranted:
  • Called after the player has been granted a temporary permission.
• OnTemporaryPermissionUpdated:
  • Called after the player's temporary permission has been updated.
• OnTemporaryPermissionRevoked:
  • Called after the player's temporary permission has expired or been revoked.
• OnTemporaryGroupAdded:
  • Called after the player has been temporarily added to the group.
• OnTemporaryGroupUpdated:
  • Called after the player's temporary group has been updated.
• OnTemporaryGroupRemoved:
  • Called after the player's temporary group has expired or been removed.
• OnGroupTemporaryPermissionGranted:
  • Called after the group has been granted a temporary permission.
• OnGroupTemporaryPermissionUpdated:
  • Called after the group's temporary permission has been updated.
• OnGroupTemporaryPermissionRevoked:
  • alled after the group's temporary permission has expired or been revoked.

 

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

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

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}.");
}

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

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}.");
}

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}.");
}

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

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}.");
}

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}.");
}

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

 

[PluginReference]
private Plugin TemporaryPermissions;

There are 23 methods:

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

 

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, 2 of which are optional:

1. IPlayer or BasePlayer or <string>playerID - The player object or their Id;
2. <string>permName - The name of the permission;
3. <int>secondsToAdd or <DateTime>expireDate - The time in seconds to add, or the end date;
4. <bool>fromNow or <DateTime>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;
5. <bool>checkExistence - Optional. Whether to check for the existence of the permission.

 

(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:

1. IPlayer or BasePlayer or <string>playerID - The player object or their Id;
2. <string>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:

1. IPlayer or BasePlayer or <string>playerID - The player object or their Id;
2. <string>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 <int>number of successful grants of temporary permissions to players.
To call the GrantActiveUsersPermission method, you need to pass 3 parameters, 1 of which is optional:

1. <string>permName - The name of the permission;
2. <int>secondsToAdd or <DateTime>expireDate - The time in seconds to add, or the end date;
3. <bool>fromNow or <DateTime>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", 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 <int>number of successful grants of temporary permissions to players.
To call the GrantAllUsersPermission method, you need to pass 3 parameters, 1 of which is optional:

1. <string>permName - The name of the permission;
2. <int>secondsToAdd or <DateTime>expireDate - The time in seconds to add, or the end date;
3. <bool>fromNow or <DateTime>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", 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 <int>number of successful revokes of temporary permissions to players.
To call the RevokeActiveUsersPermission method, you need to pass 1 parameter:

1. <string>permName - The name of the permission.

 

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

 

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

1. <string>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.
To call the UserGetAllPermissions method, you need to pass 1 parameter:

1. IPlayer or BasePlayer or <string>playerID - The player object or their Id.

 

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

 

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, 2 of which are optional:

1. IPlayer or BasePlayer or <string>playerID - The player object or their Id;
2. <string>groupName - The name of the group;
3. <int>secondsToAdd or <DateTime>expireDate - The time in seconds to add, or the end date;
4. <bool>fromNow or <DateTime>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;
5. <bool>checkExistence - Optional. Whether to check for the existence of the group.

 

(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:

1. IPlayer or BasePlayer or <string>playerID - The player object or their Id;
2. <string>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:

1. IPlayer or BasePlayer or <string>playerID - The player object or their Id;
2. <string>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 <int>number of successful additions of the temporary group to players.
To call the AddActiveUsersGroup method, you need to pass 3 parameters, 1 of which is optional:

1. <string>groupName - The name of the group;
2. <int>secondsToAdd or <DateTime>expireDate - The time in seconds to add, or the end date;
3. <bool>fromNow or <DateTime>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", 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 <int>number of successful additions of the temporary group to players.
To call the AddAllUsersGroup method, you need to pass 3 parameters, 1 of which is optional:

1. <string>groupName - The name of the group;
2. <int>secondsToAdd or <DateTime>expireDate - The time in seconds to add, or the end date;
3. <bool>fromNow or <DateTime>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", 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 <int>number of successful removals of temporary groups from players.
To call the RemoveActiveUsersGroup method, you need to pass 1 parameter:

1. <string>groupName - The name of the group.

 

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

 

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

1. <string>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 DateTime values: the first date is the assignment date and the second date is the expiration date of the group.
To call the UserGetAllGroups method, you need to pass 1 parameter:

1. <string>permName - The name of the permission.

 

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

 

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, 2 of which are optional:

1. <string>groupName - The name of the group;
2. <string>permName - The name of the permission;
3. <int>secondsToAdd or <DateTime>expireDate - The time in seconds to add, or the end date;
4. <bool>fromNow or <DateTime>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;
5. <bool>checkExistence - Optional. Whether to check for the existence of the permission.

 

(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:

1. <string>groupName - The name of the group;
2. <string>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:

1. <string>groupName - The name of the group;
2. <string>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 <int>number of successful grants of temporary permissions to groups.
To call the GrantAllGroupsPermission method, you need to pass 3 parameters, 1 of which is optional:

1. <string>permName - The name of the permission;
2. <int>secondsToAdd or <DateTime>expireDate - The time in seconds to add, or the end date;
3. <bool>fromNow or <DateTime>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", 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 <int>number of successful revokes of temporary permissions to groups.
To call the RevokeAllGroupsPermission method, you need to pass 1 parameter:

1. <string>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.
To call the GroupGetAllPermissions method, you need to pass 1 parameter:

1. <string>groupName - The name of the group.

 

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