Permissions (10)

All currently available hooks that are found in Carbon. Most hooks would be ones compatible with Oxide, although there are Carbon-only ones as well.

OnGroupCreated

• Gets called when group got created.

• Called when a group has been created successfully.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Permission.CreateGroup of Carbon.Common.dll.

Example

void OnGroupCreated(string group, string title, int rank)
{
    Puts("OnGroupCreated was called!");
}

OnGroupDeleted

• Gets called when group got obliterated.

• Called when a group has been deleted successfully.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Permission.RemoveGroup of Carbon.Common.dll.

Example

void OnGroupDeleted(string group)
{
    Puts("OnGroupDeleted was called!");
}

OnGroupParentSet

• Gets called when group parent is set.

• Called when a group parent has been updated.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Permission.SetGroupParent of Carbon.Common.dll.

Example

void OnGroupParentSet(string group, string parentGroup)
{
    Puts("OnGroupParentSet was called!");
}

OnGroupPermissionGranted

• Gets called when a permission has been assigned to a group.

• Called when a permission has been granted to a group.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Permission.GrantGroupPermission of Carbon.Common.dll.

Example

void OnGroupPermissionGranted(string group, string permission)
{
    Puts("OnGroupPermissionGranted was called!");
}

OnGroupPermissionRevoked

• Gets called when a permission has been revoked from a group.

• Called when a permission has been revoked from a group.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Permission.RevokeGroupPermission of Carbon.Common.dll.

Example

void OnGroupPermissionRevoked(string group, string permission)
{
    Puts("OnGroupPermissionRevoked was called!");
}

OnGroupRankSet

• Gets called when group rank is set.

• Called when a group rank has been updated.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Permission.SetGroupRank of Carbon.Common.dll.

Example

void OnGroupRankSet(string group, int rank)
{
    Puts("OnGroupRankSet was called!");
}

OnGroupTitleSet

• Gets called when group title is set.

• Called when a group title has been updated.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Permission.SetGroupTitle of Carbon.Common.dll.

Example

void OnGroupTitleSet(string group, string title)
{
    Puts("OnGroupTitleSet was called!");
}

OnPermissionRegistered

• Gets called when a permission has been registered for a plugin.

• Called when a permission has been registered.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Permission.RegisterPermission of Carbon.Common.dll.

Example

void OnPermissionRegistered(string permission, Oxide.Core.Plugins.Plugin plugin)
{
    Puts("OnPermissionRegistered was called!");
}

OnPermissionsUnregistered

• Gets called when all permission of a plugin have been unregistered.

• Returning a non-null value cancels default behavior.

• This hook is Carbon-only compatible.

• Patches Permission.UnregisterPermissions of Carbon.Common.dll.

Example

void OnPermissionsUnregistered(Oxide.Core.Plugins.Plugin plugin)
{
    Puts("OnPermissionsUnregistered was called!");
}

OnUserNameUpdated

• Gets called the nickname of a player gets updated.

• Called when a player's stored nickname has been changed.

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches Permission.UpdateNickname of Carbon.Common.dll.

Example

void OnUserNameUpdated(string id, string oldName, string newName)
{
    Puts("OnUserNameUpdated was called!");
}