CubeEngine Documentation

Documentation for the CubeEngine Modules


CubeEngine - Roles

This module assigns permissions based on roles.

Features:

Commands:

Command Description Permission
cubeengine.roles.command.<perm>
roles Manages the roles  
roles manadmin Manages the module  
roles manadmin debug Toggles debug mode roles.admin.debug.use
roles manadmin findpermission Searches for registered Permissions roles.admin.findPermission.use
roles manadmin reload Reloads all roles from config roles.admin.reload.use
roles manadmin save Overrides all configs with current settings roles.admin.save.use
roles role Manage roles  
roles role addparent Adds a parent role to given role [in context] roles.role.addParent.use
roles role checkpermission Checks the permission in given role [in context] roles.role.checkPermission.use
roles role cleardata Clears the options for given role [in context] roles.role.clearOption.use
roles role clearparent Removes all parent roles from given role [in context] roles.role.clearParent.use
roles role create Creates a new role roles.role.create.use
roles role default Lists all default roles roles.role.listDefaultRoles.use
roles role delete Deletes a role roles.role.delete.use
roles role list Lists all roles roles.role.list.use
roles role listoption Lists all options of given role [in context] roles.role.listOption.use
roles role listparent Lists all parents of given role [in context] roles.role.listParent.use
roles role listpermission Lists all permissions of given role [in context] roles.role.listPermission.use
roles role priority Show the priority of given role roles.role.priority.use
roles role removeparent Removes a parent role from given role [in context] roles.role.removeParent.use
roles role rename Renames given role roles.role.rename.use
roles role resetoption Resets the options for given role [in context] roles.role.resetOption.use
roles role setoption Sets an option for given role [in context] roles.role.setOption.use
roles role setpermission Sets the permission for given role [in context] roles.role.setPermission.use
roles role setpriority Sets the priority of given role roles.role.setPriority.use
roles role toggledefault Toggles whether given role is a default role roles.role.toggleDefaultRole.use
roles user Manage users  
roles user add Assign a role to the player [-temp] roles.user.assign.use
roles user checkdata Checks for options of a user [in context] roles.user.checkOption.use
roles user checkpermission Checks for permissions of a user [in context] roles.user.checkPermission.use
roles user clear Clears all roles from the player and sets the defaultroles [in context] roles.user.clear.use
roles user cleardata Resets options for this user [in context] roles.user.clearOption.use
roles user deletedata Resets options for this user [in context] roles.user.resetOption.use
roles user list Lists roles of a user roles.user.list.use
roles user listoption Lists assigned options from a user [in context] roles.user.listOption.use
roles user listpermission List permission assigned to a user [in context] roles.user.listPermission.use
roles user remove Removes a role from the player roles.user.remove.use
roles user resetpermission Resets a permission for this user [in context] roles.user.resetPermission.use
roles user setoption Sets options for this user [in context] roles.user.setOption.use
roles user setpermission Sets a permission for this user [in context] roles.user.setPermission.use

roles

Manages the roles
Usage: roles
SubCommands: manadmin role user

roles manadmin

Manages the module
Usage: roles manadmin
Alias: admin
SubCommands: debug findpermission reload save

roles manadmin debug

Toggles debug mode
Usage: roles manadmin debug [seconds]
Permission: cubeengine.roles.command.roles.admin.debug.use

roles manadmin findpermission

Searches for registered Permissions
Usage: roles manadmin findpermission <permission>
Permission: cubeengine.roles.command.roles.admin.findPermission.use

roles manadmin reload

Reloads all roles from config
Usage: roles manadmin reload
Permission: cubeengine.roles.command.roles.admin.reload.use

roles manadmin save

Overrides all configs with current settings
Usage: roles manadmin save
Permission: cubeengine.roles.command.roles.admin.save.use

roles role

Manage roles
Usage: roles role
SubCommands: addparent checkpermission cleardata clearparent create default delete list listoption listparent listpermission priority removeparent rename resetoption setoption setpermission setpriority toggledefault

roles role addparent

Adds a parent role to given role [in context]
Usage: roles role addparent <role> <parentRole>[?]
Permission: cubeengine.roles.command.roles.role.addParent.use

roles role checkpermission

Checks the permission in given role [in context]
Usage: roles role checkpermission <role> <permission>[?]
Alias: checkperm
Permission: cubeengine.roles.command.roles.role.checkPermission.use

roles role cleardata

Clears the options for given role [in context]
Usage: roles role cleardata <role>[?]
Alias: clearoption
Permission: cubeengine.roles.command.roles.role.clearOption.use

roles role clearparent

Removes all parent roles from given role [in context]
Usage: roles role clearparent <role>[?]
Permission: cubeengine.roles.command.roles.role.clearParent.use

roles role create

Creates a new role
Usage: roles role create <name>
Permission: cubeengine.roles.command.roles.role.create.use

roles role default

Lists all default roles
Usage: roles role default
Alias: listdefroles listdefaultroles defaultroles
Permission: cubeengine.roles.command.roles.role.listDefaultRoles.use

roles role delete

Deletes a role
Usage: roles role delete <role>[?]
Permission: cubeengine.roles.command.roles.role.delete.use

roles role list

Lists all roles
Usage: roles role list
Permission: cubeengine.roles.command.roles.role.list.use

roles role listoption

Lists all options of given role [in context]
Usage: roles role listoption <role>[?][?]
Alias: listdata
Permission: cubeengine.roles.command.roles.role.listOption.use

roles role listparent

Lists all parents of given role [in context]
Usage: roles role listparent <role>[?]
Permission: cubeengine.roles.command.roles.role.listParent.use

roles role listpermission

Lists all permissions of given role [in context]
Usage: roles role listpermission <role>[?][?]
Alias: listperm
Permission: cubeengine.roles.command.roles.role.listPermission.use

roles role priority

Show the priority of given role
Usage: roles role priority <role>
Alias: prio
Permission: cubeengine.roles.command.roles.role.priority.use

roles role removeparent

Removes a parent role from given role [in context]
Usage: roles role removeparent <role> <parentRole>[?]
Permission: cubeengine.roles.command.roles.role.removeParent.use

roles role rename

Renames given role
Usage: roles role rename <role> <new name>
Permission: cubeengine.roles.command.roles.role.rename.use

roles role resetoption

Resets the options for given role [in context]
Usage: roles role resetoption <role> <key>[?]
Alias: resetdata
Permission: cubeengine.roles.command.roles.role.resetOption.use

roles role setoption

Sets an option for given role [in context]
Usage: roles role setoption <role> <key> [value][?]
Alias: setdata
Permission: cubeengine.roles.command.roles.role.setOption.use

roles role setpermission

Sets the permission for given role [in context]
Usage: roles role setpermission <role> <permission> [type][?]
Alias: setperm
Permission: cubeengine.roles.command.roles.role.setPermission.use

roles role setpriority

Sets the priority of given role
Usage: roles role setpriority <role> <priority>
Alias: setprio
Permission: cubeengine.roles.command.roles.role.setPriority.use

roles role toggledefault

Toggles whether given role is a default role
Usage: roles role toggledefault <role>
Alias: toggledefaultrole toggledef
Permission: cubeengine.roles.command.roles.role.toggleDefaultRole.use

roles user

Manage users
Usage: roles user
SubCommands: add checkdata checkpermission clear cleardata deletedata list listoption listpermission remove resetpermission setoption setpermission

roles user add

Assign a role to the player [-temp]
Usage: roles user add <player> <role>[?]
Alias: give assign
Permission: cubeengine.roles.command.roles.user.assign.use

roles user checkdata

Checks for options of a user [in context]
Usage: roles user checkdata [player] <key>[?]
Alias: checkoption
Permission: cubeengine.roles.command.roles.user.checkOption.use

roles user checkpermission

Checks for permissions of a user [in context]
Usage: roles user checkpermission [player] <permission>[?]
Alias: checkperm
Permission: cubeengine.roles.command.roles.user.checkPermission.use

roles user clear

Clears all roles from the player and sets the defaultroles [in context]
Usage: roles user clear <player>
Permission: cubeengine.roles.command.roles.user.clear.use

roles user cleardata

Resets options for this user [in context]
Usage: roles user cleardata <player>[?]
Alias: clearoption
Permission: cubeengine.roles.command.roles.user.clearOption.use

roles user deletedata

Resets options for this user [in context]
Usage: roles user deletedata <player> <key>[?]
Alias: deleteoption resetoption resetdata
Permission: cubeengine.roles.command.roles.user.resetOption.use

roles user list

Lists roles of a user
Usage: roles user list [player]
Permission: cubeengine.roles.command.roles.user.list.use

roles user listoption

Lists assigned options from a user [in context]
Usage: roles user listoption [player][?][?]
Alias: listdata
Permission: cubeengine.roles.command.roles.user.listOption.use

roles user listpermission

List permission assigned to a user [in context]
Usage: roles user listpermission [player][?][?]
Alias: listperm
Permission: cubeengine.roles.command.roles.user.listPermission.use

roles user remove

Removes a role from the player
Usage: roles user remove <player> <role>
Permission: cubeengine.roles.command.roles.user.remove.use

roles user resetpermission

Resets a permission for this user [in context]
Usage: roles user resetpermission [player] <permission>[?]
Alias: resetperm
Permission: cubeengine.roles.command.roles.user.resetPermission.use

roles user setoption

Sets options for this user [in context]
Usage: roles user setoption <player> <key> <value>[?]
Alias: setdata
Permission: cubeengine.roles.command.roles.user.setOption.use

roles user setpermission

Sets a permission for this user [in context]
Usage: roles user setpermission <player> <permission> [type][?]
Alias: setperm
Permission: cubeengine.roles.command.roles.user.setPermission.use

Permissions:

Permission Description
cubeengine.roles Base Permission for Roles