endstone.permissions

Classes relating to permissions of players.

Classes

Name	Description
`Permissible`	Represents an object that may become a server operator and can be assigned permissions.
`Permission`	Represents a unique permission that may be attached to a Permissible
`PermissionAttachment`	Holds information about a permission attachment on a Permissible object
`PermissionAttachmentInfo`	Holds information on a permission and which PermissionAttachment provides it
`PermissionDefault`	Represents the possible default values for permissions
`PermissionLevel`

`class`Permissible

Permissible()

Represents an object that may become a server operator and can be assigned permissions.

Methods

Name	Description
`recalculate_permissions`	Recalculates the permissions.
`remove_attachment`	Removes a given PermissionAttachment.

Attributes

Name	Type	Description
`effective_permissions`	`set[PermissionAttachmentInfo]`	Gets effective permissions.
`permission_level`	`PermissionLevel`	Gets the permission level of this object

`attr`effective_permissionsproperty

effective_permissions: set[PermissionAttachmentInfo]

Gets effective permissions.

`attr`permission_levelproperty

permission_level: PermissionLevel

Gets the permission level of this object

`meth`recalculate_permissions

recalculate_permissions() -> None

Recalculates the permissions.

`meth`remove_attachment

remove_attachment(attachment: PermissionAttachment) -> bool

Removes a given PermissionAttachment.

`class`Permission

Permission(name: str, description: str | None = None, default: PermissionDefault | None = None, children: Mapping[str, bool] | None = None, *args, **kwargs)

Represents a unique permission that may be attached to a Permissible

Methods

Name	Description
`recalculate_permissibles`	Recalculates all Permissibles that contain this permission.

Attributes

Name	Type	Description
`children`	`dict[str, bool]`	Gets the children of this permission.
`default`	`PermissionDefault`	The default value of this permission.
`description`	`str`	The brief description of this permission
`name`	`str`	Gets the unique fully qualified name of this Permission.
`permissibles`	`set[Permissible]`	Gets a set containing every Permissible that has this permission.

`attr`childrenproperty

children: dict[str, bool]

Gets the children of this permission.

`attr`defaultproperty

default: PermissionDefault

The default value of this permission.

`attr`descriptionproperty

description: str

The brief description of this permission

`attr`nameproperty

name: str

Gets the unique fully qualified name of this Permission.

`attr`permissiblesproperty

permissibles: set[Permissible]

Gets a set containing every Permissible that has this permission.

`meth`recalculate_permissibles

recalculate_permissibles() -> None

Recalculates all Permissibles that contain this permission.

`class`PermissionAttachment

PermissionAttachment(plugin: Plugin, permissible: Permissible)

Holds information about a permission attachment on a Permissible object

Methods

Name	Description
`remove`	Removes this attachment from its registered Permissible.

Attributes

Name	Type	Description
`permissible`	`Permissible`	Gets the Permissible that this is attached to.
`permissions`	`dict[str, bool]`	Gets a copy of all set permissions and values contained within this attachment.
`plugin`	`Plugin`	Gets the plugin responsible for this attachment.
`removal_callback`	`Callable[[PermissionAttachment], None]`	The callback to be called when this attachment is removed.

`attr`permissibleproperty

permissible: Permissible

Gets the Permissible that this is attached to.

`attr`permissionsproperty

permissions: dict[str, bool]

Gets a copy of all set permissions and values contained within this attachment.

`attr`pluginproperty

plugin: Plugin

Gets the plugin responsible for this attachment.

`attr`removal_callbackproperty

removal_callback: Callable[[PermissionAttachment], None]

The callback to be called when this attachment is removed.

`meth`remove

remove() -> bool

Removes this attachment from its registered Permissible.

`class`PermissionAttachmentInfo

PermissionAttachmentInfo(permissible: Permissible, permission: str, attachment: PermissionAttachment, value: bool)

Holds information on a permission and which PermissionAttachment provides it

Attributes

Name	Type	Description
`attachment`	`PermissionAttachment`	Gets the attachment providing this permission.
`permissible`	`Permissible`	Get the permissible this is attached to
`permission`	`str`	Gets the permission being set
`value`	`bool`	Gets the value of this permission

`attr`attachmentproperty

attachment: PermissionAttachment

Gets the attachment providing this permission.

`attr`permissibleproperty

permissible: Permissible

Get the permissible this is attached to

`attr`permissionproperty

permission: str

Gets the permission being set

`attr`valueproperty

value: bool

Gets the value of this permission

`class`PermissionDefault

Bases: Enum

PermissionDefault()

Represents the possible default values for permissions

Attributes

Name	Type	Description
`CONSOLE`
`FALSE`
`NOT_OP`
`OP`
`TRUE`

`attr`CONSOLE

CONSOLE = 4

`attr`FALSE

FALSE = 1

`attr`NOT_OP

NOT_OP = 3

`attr`OP

OP = 2

`attr`TRUE

TRUE = 0

`class`PermissionLevel

Bases: IntEnum

PermissionLevel()

Attributes

Name	Type	Description
`CONSOLE`
`DEFAULT`
`OP`

`attr`CONSOLE

CONSOLE = 2

`attr`DEFAULT

DEFAULT = 0

`attr`OP

OP = 1

endstone.permissions

classPermissible

attreffective_permissionsproperty

attrpermission_levelproperty

methrecalculate_permissions

methremove_attachment

classPermission

attrchildrenproperty

attrdefaultproperty

attrdescriptionproperty

attrnameproperty

attrpermissiblesproperty

methrecalculate_permissibles

classPermissionAttachment

attrpermissibleproperty

attrpermissionsproperty

attrpluginproperty

attrremoval_callbackproperty

methremove

classPermissionAttachmentInfo

attrattachmentproperty

attrpermissibleproperty

attrpermissionproperty

attrvalueproperty

classPermissionDefault

attrCONSOLE

attrFALSE

attrNOT_OP

attrOP

attrTRUE

classPermissionLevel

attrCONSOLE

attrDEFAULT

attrOP

On this page

`class`Permissible

`attr`effective_permissionsproperty

`attr`permission_levelproperty

`meth`recalculate_permissions

`meth`remove_attachment

`class`Permission

`attr`childrenproperty

`attr`defaultproperty

`attr`descriptionproperty

`attr`nameproperty

`attr`permissiblesproperty

`meth`recalculate_permissibles

`class`PermissionAttachment

`attr`permissibleproperty

`attr`permissionsproperty

`attr`pluginproperty

`attr`removal_callbackproperty

`meth`remove

`class`PermissionAttachmentInfo

`attr`attachmentproperty

`attr`permissibleproperty

`attr`permissionproperty

`attr`valueproperty

`class`PermissionDefault

`attr`CONSOLE

`attr`FALSE

`attr`NOT_OP

`attr`OP

`attr`TRUE

`class`PermissionLevel

`attr`CONSOLE

`attr`DEFAULT

`attr`OP