messages.impl module

Provides user message implementations.

class messages.impl.SayText2Impl

Bases: UserMessageImpl

SayText2 implementation.

static read_bitbuffer(buffer)

Read data from the given buffer.

Parameters:

buffer (BitBufferRead) – The buffer to read.

Return type:

UserMessageData

static read_protobuf(buffer)

Read data from the given buffer.

Parameters:

buffer (ProtobufMessage) – The buffer to read.

Return type:

UserMessageData

static write_bitbuffer(buffer, data)

Write data to the given buffer.

Parameters:

• buffer (BitBufferWrite) – The buffer to write to.

• data (UserMessageData) – User message data that should be written to the buffer.

static write_protobuf(buffer, data)

Write data to the given buffer.

Parameters:

• buffer (ProtobufMessage) – The buffer to write to.

• data (UserMessageData) – User message data that should be written to the buffer.

class messages.impl.ShowMenuImpl

Bases: UserMessageImpl

ShowMenu implementation.

static read_bitbuffer(buffer)

Read data from the given buffer.

Parameters:

buffer (BitBufferRead) – The buffer to read.

Return type:

UserMessageData

static read_protobuf(buffer)

Read data from the given buffer.

Parameters:

buffer (ProtobufMessage) – The buffer to read.

Return type:

UserMessageData

static write_bitbuffer(buffer, data)

Write data to the given buffer.

Parameters:

• buffer (BitBufferWrite) – The buffer to write to.

• data (UserMessageData) – User message data that should be written to the buffer.

static write_protobuf(buffer, data)

Write data to the given buffer.

Parameters:

• buffer (ProtobufMessage) – The buffer to write to.

• data (UserMessageData) – User message data that should be written to the buffer.

class messages.impl.UserMessageData(**kwargs)

Bases: dict

A dict that keeps track whether it has been modified.

__init__(**kwargs)

has_been_changed()

Return whether the data has been changed.

Return type:

bool

class messages.impl.UserMessageImpl

Bases: object

Base class for user message implementations.

classmethod read(buffer)

A wrapper for read_protobuf() and read_bitbuffer().

Parameters:

buffer – The buffer to read.

Return type:

UserMessageData

classmethod write(buffer, data)

A wrapper for write_protobuf() and write_bitbuffer().

Parameters:

buffer – The buffer to write.

Return type:

UserMessageData

static read_bitbuffer(buffer)

Read data from the given buffer.

Parameters:

buffer (BitBufferRead) – The buffer to read.

Return type:

UserMessageData

static read_protobuf(buffer)

Read data from the given buffer.

Parameters:

buffer (ProtobufMessage) – The buffer to read.

Return type:

UserMessageData

static write_bitbuffer(buffer, data)

Write data to the given buffer.

Parameters:

• buffer (BitBufferWrite) – The buffer to write to.

• data (UserMessageData) – User message data that should be written to the buffer.

static write_protobuf(buffer, data)

Write data to the given buffer.

Parameters:

• buffer (ProtobufMessage) – The buffer to write to.

• data (UserMessageData) – User message data that should be written to the buffer.

class messages.impl.VGUIMenuImpl

Bases: UserMessageImpl

VGUIMenu implementation.

static read_bitbuffer(buffer)

Read data from the given buffer.

Parameters:

buffer (BitBufferRead) – The buffer to read.

Return type:

UserMessageData

static read_protobuf(buffer)

Read data from the given buffer.

Parameters:

buffer (ProtobufMessage) – The buffer to read.

Return type:

UserMessageData

static write_bitbuffer(buffer, data)

Write data to the given buffer.

Parameters:

• buffer (BitBufferWrite) – The buffer to write to.

• data (UserMessageData) – User message data that should be written to the buffer.

static write_protobuf(buffer, data)

Write data to the given buffer.

Parameters:

• buffer (ProtobufMessage) – The buffer to write to.

• data (UserMessageData) – User message data that should be written to the buffer.

messages.impl.get_user_message_impl(msg_index)

Return the user message implementation for the given message index.

Parameters:

msg_index (int) – The index of the user message.

Raises:

NotImplementedError – Raised if the given user message is not implemented.

Return type:

UserMessageImpl

messages.impl.implemented_usermessages = {4: <class 'messages.impl.SayText2Impl'>, 10: <class 'messages.impl.ShowMenuImpl'>, 13: <class 'messages.impl.VGUIMenuImpl'>}

A dictionary that contains all implemented user messages.