messages.base module

Provides user messages.

class messages.base.AttrDict

Bases: dict

A dictionary that redirects __getattr__ and __setattr__.

class messages.base.Fade(duration, hold_time, color=Color(255, 255, 255, 255), flags=_messages.FadeFlags.IN)

Bases: UserMessageCreator

Create a Fade.

__init__(duration, hold_time, color=Color(255, 255, 255, 255), flags=_messages.FadeFlags.IN)

Initialize the Fade instance.

bitbuf(buffer, kwargs)

Send the Fade with bitbuf.

protobuf(buffer, kwargs)

Send the Fade with protobuf.

message_name = 'Fade'

moved_frac_bits = 512

translatable_fields = []

class messages.base.HintText(message)

Bases: UserMessageCreator

Create a HintText.

__init__(message)

Initialize the HintText instance.

bitbuf(buffer, kwargs)

Send the HintText with bitbuf.

protobuf(buffer, kwargs)

Send the HintText with protobuf.

message_name = 'HintText'

translatable_fields = ['message']

class messages.base.HudMsg(message, x=-1, y=-1, color1=Color(255, 255, 255, 255), color2=Color(255, 255, 255, 255), effect=0, fade_in=0, fade_out=0, hold_time=4, fx_time=0, channel=0)

Bases: UserMessageCreator

Create a HudMsg.

__init__(message, x=-1, y=-1, color1=Color(255, 255, 255, 255), color2=Color(255, 255, 255, 255), effect=0, fade_in=0, fade_out=0, hold_time=4, fx_time=0, channel=0)

Initialize the HudMsg instance.

bitbuf(buffer, kwargs)

Send the HudMsg with bitbuf.

protobuf(buffer, kwargs)

Send the HudMsg with protobuf.

message_name = 'HudMsg'

translatable_fields = ['message']

class messages.base.KeyHintText(*hints)

Bases: UserMessageCreator

Create a KeyHintText.

__init__(*hints)

Initialize the KeyHintText instance.

bitbuf(buffer, kwargs)

Send the KeyHintText with bitbuf.

protobuf(buffer, kwargs)

Send the KeyHintText with protobuf.

message_name = 'KeyHintText'

class messages.base.ResetHUD(reset=True)

Bases: UserMessageCreator

Create a ResetHUD.

__init__(reset=True)

Initialize the ResetHUD instance.

bitbuf(buffer, kwargs)

Send the ResetHUD with bitbuf.

protobuf(buffer, kwargs)

Send the ResetHUD with protobuf.

message_name = 'ResetHud'

translatable_fields = []

class messages.base.SayText(message, index=0, chat=False, color='\x01')

Bases: UserMessageCreator

Create a SayText.

__init__(message, index=0, chat=False, color='\x01')

Initialize the SayText instance.

bitbuf(buffer, kwargs)

Send the SayText with bitbuf.

protobuf(buffer, kwargs)

Send the SayText with protobuf.

message_name = 'SayText'

reliable = True

translatable_fields = ['message']

class messages.base.SayText2(message, index=0, chat=False, param1='', param2='', param3='', param4='', color='\x01')

Bases: UserMessageCreator

Create a SayText2.

__init__(message, index=0, chat=False, param1='', param2='', param3='', param4='', color='\x01')

Initialize the SayText2 instance.

bitbuf(buffer, kwargs)

Send the SayText2 with bitbuf.

protobuf(buffer, kwargs)

Send the SayText2 with protobuf.

message_name = 'SayText2'

reliable = True

translatable_fields = ['message', 'param1', 'param2', 'param3', 'param4']

class messages.base.Shake(amplitude, duration, frequency=1, shake_command=_messages.ShakeCommand.START)

Bases: UserMessageCreator

Create a Shake.

__init__(amplitude, duration, frequency=1, shake_command=_messages.ShakeCommand.START)

Initialize the Shake instance.

bitbuf(buffer, kwargs)

Send the Shake with bitbuf.

protobuf(buffer, kwargs)

Send the Shake with protobuf.

message_name = 'Shake'

translatable_fields = []

class messages.base.ShowMenu(menu_string, valid_slots=1023, display_time=4)

Bases: UserMessageCreator

Create a radio menu.

__init__(menu_string, valid_slots=1023, display_time=4)

Initialize the radio menu.

bitbuf(player_indexes, kwargs)

Send the ShowMenu with bitbuf.

protobuf(buffer, kwargs)

Send the ShowMenu with protobuf.

send(*player_indexes)

Send the user message.

chunk_size = 62

message_name = 'ShowMenu'

translatable_fields = []

class messages.base.TextMsg(message, destination=_messages.HudDestination.CENTER, param1='', param2='', param3='', param4='')

Bases: UserMessageCreator

Create a TextMsg.

__init__(message, destination=_messages.HudDestination.CENTER, param1='', param2='', param3='', param4='')

Initialize the TextMsg instance.

bitbuf(buffer, kwargs)

Send the TextMsg with bitbuf.

protobuf(buffer, kwargs)

Send the TextMsg with protobuf.

message_name = 'TextMsg'

reliable = True

translatable_fields = ['message', 'param1', 'param2', 'param3', 'param4']

class messages.base.UserMessageCreator(**kwargs)

Bases: AttrDict

Provide an easy interface to create user messages.

Attr bool reliable:

Whether to send message using reliable channel.

__init__(**kwargs)

Initialize the usermessage creator.

Parameters:

kwargs (dict) – All valid fields.

bitbuf(buffer, translated_kwargs)

Bitbuf implementation of this user message.

protobuf(buffer, translated_kwargs)

Protobuf implementation of this user message.

send(*player_indexes, **tokens)

Send the user message.

property message_name

Return the user message name.

reliable = False

property translatable_fields

Return a list of translatable fields.

class messages.base.VGUIMenu(name, subkeys=None, show=True)

Bases: UserMessageCreator

Create a VGUIMenu.

__init__(name, subkeys=None, show=True)

Initialize the VGUI menu.

Parameters:

• name (str) – Name of the menu.

• subkeys (dict) – Additional menu data.

• show (bool) – If True the menu will be shown, else it will be hidden.

bitbuf(buffer, kwargs)

Send the VGUIMenu with bitbuf.

protobuf(buffer, kwargs)

Send the VGUIMenu with protobuf.

message_name = 'VGUIMenu'

translatable_fields = []