endstone.ban

Classes relevant to bans.

Classes

Name	Description
`BanEntry`	A single entry from a ban list.
`IpBanEntry`	Represents a ban entry for an IP address.
`IpBanList`	Represents a ban list containing banned IP addresses.
`PlayerBanEntry`	Represents a ban entry for a player.
`PlayerBanList`	Represents a ban list containing banned players.

`class`BanEntry

BanEntry()

A single entry from a ban list.

Attributes

Name	Type	Description
`created`	`datetime`	Gets or sets the date this ban entry was created.
`expiration`	`datetime \| None`	Gets or sets the date this ban expires on.
`reason`	`str`	Gets or sets the reason for this ban.
`source`	`str`	Gets or sets the source of this ban.

`attr`createdproperty

created: datetime

Gets or sets the date this ban entry was created.

`attr`expirationproperty

expiration: datetime | None

Gets or sets the date this ban expires on.

`attr`reasonproperty

reason: str

Gets or sets the reason for this ban.

`attr`sourceproperty

source: str

Gets or sets the source of this ban.

`class`IpBanEntry

Bases: BanEntry

IpBanEntry(address: str)

Represents a ban entry for an IP address.

Attributes

Name	Type	Description
`address`	`str`	Gets the banned IP address.

`attr`addressproperty

address: str

Gets the banned IP address.

`class`IpBanList

IpBanList()

Represents a ban list containing banned IP addresses.

Methods

Name	Description
`add_ban`	Adds a ban to this list, or updates an existing one.
`get_ban_entry`	Gets a BanEntry by IP address.
`is_banned`	Checks if a BanEntry exists for the target by IP address.
`remove_ban`	Removes an IP address from the ban list.

Attributes

Name	Type	Description
`entries`	`list[IpBanEntry]`	Gets a vector of pointers to entries in the ban list.

`attr`entriesproperty

entries: list[IpBanEntry]

Gets a vector of pointers to entries in the ban list.

`meth`add_ban

add_ban(address: str, reason: str | None = None, expires: datetime | None = None, source: str | None = None) -> IpBanEntry

Adds a ban to this list, or updates an existing one.

`meth`get_ban_entry

get_ban_entry(address: str) -> IpBanEntry | None

Gets a BanEntry by IP address.

`meth`is_banned

is_banned(address: str) -> bool

Checks if a BanEntry exists for the target by IP address.

`meth`remove_ban

remove_ban(address: str) -> None

Removes an IP address from the ban list.

`class`PlayerBanEntry

Bases: BanEntry

PlayerBanEntry(name: str, uuid: UUID | None = None, xuid: str | None = None)

Represents a ban entry for a player.

Attributes

Name	Type	Description
`name`	`str`	Gets the banned player's name.
`unique_id`	`UUID \| None`	Gets the banned player's unique ID, or None if not available.
`xuid`	`str \| None`	Gets the banned player's Xbox user ID (XUID), or None if not available.

`attr`nameproperty

name: str

Gets the banned player's name.

`attr`unique_idproperty

unique_id: UUID | None

Gets the banned player's unique ID, or None if not available.

`attr`xuidproperty

xuid: str | None

Gets the banned player's Xbox user ID (XUID), or None if not available.

`class`PlayerBanList

PlayerBanList()

Represents a ban list containing banned players.

Methods

Name	Description
`add_ban`	Adds a ban to this list, or updates an existing one.
`get_ban_entry`	Gets a BanEntry by player name, UUID, or XUID.
`is_banned`	Checks if a BanEntry exists for the target by name, UUID, or XUID.
`remove_ban`	Removes a player from the ban list by name, UUID, or XUID.

Attributes

Name	Type	Description
`entries`	`list[PlayerBanEntry]`	Gets a vector of pointers to entries in the ban list.

`attr`entriesproperty

entries: list[PlayerBanEntry]

Gets a vector of pointers to entries in the ban list.

`meth`add_ban

add_ban(name: str, uuid: UUID | None = None, xuid: str | None = None, reason: str | None = None, expires: datetime | None = None, source: str | None = None) -> PlayerBanEntry

Adds a ban to this list, or updates an existing one.

`meth`get_ban_entry

get_ban_entry(name: str, uuid: UUID | None = None, xuid: str | None = None) -> PlayerBanEntry | None

Gets a BanEntry by player name, UUID, or XUID.

`meth`is_banned

is_banned(name: str, uuid: UUID | None = None, xuid: str | None = None) -> bool

Checks if a BanEntry exists for the target by name, UUID, or XUID.

`meth`remove_ban

remove_ban(name: str, uuid: UUID | None = None, xuid: str | None = None) -> None

Removes a player from the ban list by name, UUID, or XUID.

classBanEntry

attrcreatedproperty

attrexpirationproperty

attrreasonproperty

attrsourceproperty

classIpBanEntry

attraddressproperty

classIpBanList

attrentriesproperty

methadd_ban

methget_ban_entry

methis_banned

methremove_ban

classPlayerBanEntry

attrnameproperty

attrunique_idproperty

attrxuidproperty

classPlayerBanList

attrentriesproperty

methadd_ban

methget_ban_entry

methis_banned

methremove_ban

On this page

`class`BanEntry

`attr`createdproperty

`attr`expirationproperty

`attr`reasonproperty

`attr`sourceproperty

`class`IpBanEntry

`attr`addressproperty

`class`IpBanList

`attr`entriesproperty

`meth`add_ban

`meth`get_ban_entry

`meth`is_banned

`meth`remove_ban

`class`PlayerBanEntry

`attr`nameproperty

`attr`unique_idproperty

`attr`xuidproperty

`class`PlayerBanList

`attr`entriesproperty

`meth`add_ban

`meth`get_ban_entry

`meth`is_banned

`meth`remove_ban