commands.client package

Provides client command and client command filter functionality.

class commands.client.ClientCommand(names, *args, **kwargs)[source]

Bases: commands.command._BaseCommand

Decorator class used to register a client command.

_manager_class = <commands.client._ClientCommandManager object>
class commands.client.ClientCommandDispatcher

Bases: Boost.Python.instance

__init__()

Raises an exception This class cannot be instantiated from Python

add_callback((ClientCommandDispatcher)arg1, (object)callable) → None :

Adds a callback to the client command’s list.

remove_callback((ClientCommandDispatcher)arg1, (object)callable) → None :

Removes a callback from the client command’s list.

class commands.client.ClientCommandFilter(callback)[source]

Bases: commands.filter._BaseFilter

Class used to register a client command filter.

_manager_class = <commands.client._ClientCommandManager object>
class commands.client.ClientCommandGenerator

Bases: Boost.Python.instance

__init__((object)arg1) → None
class commands.client._ClientCommandManager[source]

Bases: commands.player._PlayerCommandManager

Registers client commands and client command filters.

static _get_command()
get_client_command( (str)name) -> ClientCommandDispatcher :
Returns the ClientCommandDispatcher instance for the given command
static register_filter()
register_client_command_filter( (object)callable) -> None :
Registers a callable to be called when clients use commands.
static unregister_filter()
unregister_client_command_filter( (object)callable) -> None :
Unregisters a client command filter.
commands.client.get_client_command((str)name) → ClientCommandDispatcher :

Returns the ClientCommandDispatcher instance for the given command

commands.client.register_client_command_filter((object)callable) → None :

Registers a callable to be called when clients use commands.

commands.client.unregister_client_command_filter((object)callable) → None :

Unregisters a client command filter.

commands.client.client_command_manager

The singleton object of the _ClientCommandManager class.