API Server kinds

Server kinds

Import	from proleak import server

What kind of server the game is connected to, and what that allows.

Functions

Returns	Function
bool	allows(capability: str)	True when capability is allowed on the current server.
None	require(capability: str)	Raise NotAllowedHere unless capability is allowed on the current server.

Values

Type	Value
str	kind read-only	The kind of server the game is connected to: one of the values below.
str	MENU read-only	In the menus, connected to no game.
str	OFFICIAL_RANKED read-only	A ranked game on the official servers.
str	OFFICIAL_CASUAL read-only	Any other game on the official servers.
str	LOCAL read-only	A game on ProLeak's local server.
str	UNKNOWN read-only	A game ProLeak cannot place.

Detailed description

server.kind is one of menu, official_ranked, official_casual, local, unknown. Capabilities: observe (always); actions, cosmetics.modify and raw.access (local only).

Function documentation

allows

allows(capability: str) -> bool

True when capability is allowed on the current server.

require

require(capability: str) -> None

Raise NotAllowedHere unless capability is allowed on the current server.

Value documentation

kind

kind: str [read-only]

The kind of server the game is connected to: one of the values below.

MENU

MENU: str [read-only]

In the menus, connected to no game.

OFFICIAL_RANKED

OFFICIAL_RANKED: str [read-only]

A ranked game on the official servers.

OFFICIAL_CASUAL

OFFICIAL_CASUAL: str [read-only]

Any other game on the official servers.

LOCAL

LOCAL: str [read-only]

A game on ProLeak's local server.

UNKNOWN

UNKNOWN: str [read-only]

A game ProLeak cannot place.

---

Previous: Raw game access | Next: Sounds