listeners package¶

Subpackages¶

listeners.tick package

Module contents¶

Provides listener based functionality.

class listeners.ButtonStatus(*values)[source]¶

Bases: IntEnum

Indicate whether a button has been pressed or released.

PRESSED = 1¶

RELEASED = 0¶

class listeners.ListenerManager¶

Bases: instance

__init__((object)arg1) → None¶

clear((ListenerManager)arg1) → None :¶: Remove all registered callbacks.

finalize((ListenerManager)arg1) → None :¶: Called when the last callback is being unregistered.

initialize((ListenerManager)arg1) → None :¶: Called when the first callback is being registered.

notify()¶

object notify(tuple args, dict kwds) :: Notifies all registered listeners.

register_listener((ListenerManager)arg1, (object)callable) → None :¶: Registers a callable object. If it was already registered it will be ignored.

unregister_listener((ListenerManager)arg1, (object)callable) → None :¶: Removes a callable object. If it was not registered nothing will happen.

class listeners.ListenerManagerDecorator(*args, **kwargs)[source]¶

Bases: AutoUnload

Base decorator class used to register/unregister a listener.

__init__(callback)[source]¶: Store the callback and register the listener.

property manager¶: Return a ListenerManager object.

property name¶: Return the class name of the instance.

class listeners.OnButtonStateChanged(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a button state change listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnClientActive(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a ClientActive listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnClientConnect(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a ClientConnect listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnClientDisconnect(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a ClientDisconnect listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnClientFullyConnect(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a ClientFullyConnect listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnClientPutInServer(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a ClientPutInServer listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnClientSettingsChanged(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a ClientSettingsChanged listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnCombinerPreCache(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnCombinerPreCache listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnConVarChanged(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a ConVar listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnDataLoaded(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnDataLoaded listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnDataUnloaded(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnDataUnloaded listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnEdictAllocated(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister an OnEdictAllocated listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnEdictFreed(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister an OnEdictFreed listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnEntityCollision(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnEntityCollision listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnEntityCreated(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnEntityCreated listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnEntityDeleted(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnEntityDeleted listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnEntityOutput(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister an EntityOutput listener.

manager = <listeners.OnEntityOutputListenerManager object>¶

class listeners.OnEntityOutputListenerManager[source]¶

Bases: ListenerManager

Register/unregister an EntityOutput listener.

finalize()[source]¶: Called when the last callback is being unregistered.

initialize()[source]¶: Called when the first callback is being registered.

class listeners.OnEntityPreSpawned(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnEntityPreSpawned listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnEntitySpawned(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnEntitySpawned listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnEntityTransmit(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnEntityTransmit listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnLevelEnd(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a map end listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnLevelInit(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a LevelInit listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnLevelShutdown(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a LevelShutdown listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnNetworkedEntityCreated(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnNetworkedEntityCreated listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnNetworkedEntityDeleted(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnNetworkedEntityDeleted listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnNetworkedEntityPreSpawned(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnNetworkedEntityPreSpawned listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnNetworkedEntitySpawned(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnNetworkedEntitySpawned listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnNetworkidValidated(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a NetworkidValidated listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnPlayerCollision(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnPlayerCollision listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnPlayerPostRunCommand(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a post run command listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnPlayerRunCommand(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a run command listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnPlayerTransmit(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a OnPlayerTransmit listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnPluginLoaded(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a plugin loaded listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnPluginLoading(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a plugin loading listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnPluginUnloaded(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a plugin unloaded listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnPluginUnloading(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a plugin unloading listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnQueryCvarValueFinished(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister an OnQueryCvarValueFinished listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnServerActivate(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a ServerActivate listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnServerOutput(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a server output listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnTick(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a Tick listener.

manager = <_listeners.ListenerManager object>¶

class listeners.OnVersionUpdate(*args, **kwargs)[source]¶

Bases: ListenerManagerDecorator

Register/unregister a version update listener.

manager = <_listeners.ListenerManager object>¶

listeners.get_button_combination_status(old_buttons, new_buttons, combination)[source]¶

Return the status of a button combination.

Parameters:

old_buttons (PlayerButtons) – Previously pressed buttons.
new_buttons (PlayerButtons) – Now pressed buttons.
combination (PlayerButtons) – Button combination to check.

Returns:

Return the status of the button combination. If the combination was neither pressed nor released, None will be returned.

Return type:

ButtonStatus

Example:

@OnButtonStateChanged
def on_buttons_state_changed(player, old_buttons, new_buttons):
    status = get_button_combination_status(old_buttons, new_buttons,
        PlayerButtons.ATTACK|PlayerButtons.JUMP)

    if status == ButtonStatus.PRESSED:
        SayText2(
            '{} is jumping and attacking.'.format(player.name)).send()

    elif status == ButtonStatus.RELEASED:
        SayText2(
            '{} stopped jumping and attacking at the same time.'.format(
            player.name)).send()

listeners package¶

Subpackages¶

Module contents¶

Table of Contents

This Page