messages.hooks module¶
Provides user message hooking functionality.
- class messages.hooks.HookBitBufferUserMessage(*args, **kwargs)[source]¶
Bases:
HookUserMessageBase
Decorator to register a raw user message hook for bitbuffer messages.
- hooks = {}¶
- class messages.hooks.HookProtobufUserMessage(*args, **kwargs)[source]¶
Bases:
HookUserMessageBase
Decorator to register a raw user message hook for protobuf messages.
- hooks = {}¶
- class messages.hooks.HookUserMessage(*args, **kwargs)[source]¶
Bases:
HookUserMessageBase
Decorator to register a convenient user message hook.
- __init__(user_message)[source]¶
Create a new user message hook.
- Raises:
NotImplementedError – Raised if the user message has not been implemented yet in Source.Python.
See also
- hooks = {}¶
- class messages.hooks.HookUserMessageBase(*args, **kwargs)[source]¶
Bases:
AutoUnload
Base decorator for user message hooks.
- __init__(user_message)[source]¶
Create a new user message hook.
- Parameters:
user_message (int/str) – The user message index or name to hook.
- Raises:
TypeError – Raised if
user_message
is not and int or str.ValueError – Raised if the user message does not exist.
- property hooks¶
Return all hooks for a user message.
- Return type: