Ban

endstone.ban

Classes:

Name	Description
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.

IpBanEntry

IpBanEntry(address: str)

Bases: BanEntry

Represents a ban entry for an IP address.

Attributes:

Name	Type	Description
address	str	Gets the banned IP address.

address property

address: str

Gets the banned IP address.

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.

entries property

entries: list[IpBanEntry]

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

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.

get_ban_entry

get_ban_entry(address: str) -> IpBanEntry

Gets a BanEntry by IP address.

is_banned

is_banned(address: str) -> bool

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

remove_ban

remove_ban(address: str) -> None

Removes an IP address from the ban list.

PlayerBanEntry

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

Bases: BanEntry

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.

name property

name: str

Gets the banned player's name.

unique_id property

unique_id: UUID | None

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

xuid property

xuid: str | None

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

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.

entries property

entries: list[PlayerBanEntry]

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

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.

get_ban_entry

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

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

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.

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.