endstone/permissions

meth~Permissiblevirtual

~Permissible() =default

methgetPermissionLevelabstractconst

PermissionLevel getPermissionLevel() const =0

Gets the permission level of this object.

methisPermissionSetabstractconst

bool isPermissionSet(std::string name) const =0

Checks if this object contains an override for the specified permission, by fully qualified name.

methisPermissionSetabstractconst

bool isPermissionSet(const Permission& perm) const =0

Checks if this object contains an override for the specified Permission.

methhasPermissionabstractconst

bool hasPermission(std::string name) const =0

Gets the value of the specified permission, if set. If a permission override is not set on this object, the default value of the permission will be returned.

methhasPermissionabstractconst

bool hasPermission(const Permission& perm) const =0

Gets the value of the specified permission, if set. If a permission override is not set on this object, the default value of the permission will be returned.

methaddAttachmentabstract

PermissionAttachment* addAttachment(Plugin& plugin, const std::string& name, bool value) =0

Adds a new PermissionAttachment with a single permission by name and value.

methaddAttachmentabstract

PermissionAttachment* addAttachment(Plugin& plugin) =0

Adds a new empty PermissionAttachment to this object.

methremoveAttachmentabstract

bool removeAttachment(PermissionAttachment& attachment) =0

Removes the given PermissionAttachment from this object.

methrecalculatePermissionsabstract

void recalculatePermissions() =0

Recalculates the permissions for this object, if the attachments have changed values. This should very rarely need to be called from a plugin.

methgetEffectivePermissionsabstractconst

std::unordered_set<PermissionAttachmentInfo*> getEffectivePermissions() const =0

Gets a set containing all the permissions currently in effect by this object.

methasCommandSenderabstractconst

CommandSender* asCommandSender() const =0

Casts a Permissible as CommandSender.

varDefaultPermissionstaticconstexpr

auto DefaultPermission

methPermissionexplicit

Permission(std::string name, std::string description = "", PermissionDefault default_value = DefaultPermission, std::unordered_map<std::string, bool> children = {})

methgetNameconst

std::string getName() const

Returns the unique fully qualified name of this Permission

methgetChildren

std::unordered_map<std::string, bool>& getChildren()

Gets the children of this permission. If you change this map in any form, you must call recalculatePermissibles() to recalculate all Permissibles

methgetDefaultconst

PermissionDefault getDefault() const

Gets the default value of this permission.

methsetDefault

void setDefault(PermissionDefault value)

Sets the default value of this permission.

This will not be saved to disk, and is a temporary operation until the server reloads permissions. Changing this default will cause all Permissibles that contain this permission to recalculate their permissions

methgetDescriptionconst

std::string getDescription() const

Gets a brief description of this permission, may be empty

methsetDescription

void setDescription(std::string value)

Sets the description of this permission.

This will not be saved to disk, and is a temporary operation until the server reloads permissions.

methgetPermissiblesconst

std::unordered_set<Permissible*> getPermissibles() const

Gets a set containing every Permissible that has this permission. This set cannot be modified.

methrecalculatePermissibles

void recalculatePermissibles()

Recalculates all Permissibles that contain this permission.

This should be called after modifying the children, and is automatically called after modifying the default value

methaddParent

Permission* addParent(std::string name, bool value)

Adds this permission to the specified parent permission.

If the parent permission does not exist, it will be created and registered.

methaddParentconst

void addParent(Permission& perm, bool value) const

Adds this permission to the specified parent permission.

methinit

void init(PluginManager& plugin_manager)

methPermissionAttachment

PermissionAttachment(Plugin& plugin, Permissible& permissible)

methgetPluginconst

Plugin& getPlugin() const

Gets the plugin responsible for this attachment

methsetRemovalCallback

void setRemovalCallback(PermissionRemovedExecutor ex)

Sets an executor to be called for when this attachment is removed from a Permissible. May be empty.

methgetRemovalCallbackconst

PermissionRemovedExecutor getRemovalCallback() const

Gets the class that was previously set to be called when this attachment was removed from a Permissible. May be empty.

methgetPermissibleconst

Permissible& getPermissible() const

Gets the Permissible that this is attached to

methgetPermissionsconst

std::unordered_map<std::string, bool> getPermissions() const

Gets a copy of all set permissions and values contained within this attachment. This map may be modified but will not affect the attachment, as it is a copy.

methsetPermission

void setPermission(std::string name, bool value)

Sets a permission to the given value, by its fully qualified name

methsetPermission

void setPermission(Permission& perm, bool value)

Sets a permission to the given value

methunsetPermission

void unsetPermission(std::string name)

Removes the specified permission from this attachment. If the permission does not exist in this attachment, nothing will happen.

methunsetPermission

void unsetPermission(Permission& perm)

Removes the specified permission from this attachment. If the permission does not exist in this attachment, nothing will happen.

methremove

bool remove()

Removes this attachment from its registered Permissible

methPermissionAttachmentInfo

PermissionAttachmentInfo(Permissible& permissible, std::string permission, PermissionAttachment* attachment, bool value)

methgetPermissibleconst

Permissible& getPermissible() const

Gets the permissible this is attached to

methgetPermissionconst

std::string getPermission() const

Gets the permission being set

methgetAttachmentconst

PermissionAttachment* getAttachment() const

Gets the attachment providing this permission. This may be null for default permissions (usually parent permissions).

methgetValueconst

bool getValue() const

Gets the value of this permission