effects.templates module

Base templates for effect classes.

class effects.templates.TempEntityTemplate(temp_entity)

Bases: BaseTempEntity

A temp entity template.

__init__(temp_entity)

Initialize the instance.

Parameters:

temp_entity (BaseTempEntity) – The base entity instance to copy the base from.

add_hook(callback)

Register a hook for this temp entity.

Parameters:

callback (function) – The callback function to register.

handle_hook(temp_entity, recipient_filter)

Call the registered callbacks.

Parameters:

• temp_entity (TempEntity) – The TempEntity instance.

• recipient_filter (RecipientFilter) – The RecipientFilter instance.

Return type:

bool

remove_hook(callback)

Unregister a hook for this temp entity.

Parameters:

callback (function) – The callback function to unregister.

property aliases

Return the aliases of the temp entity.

Return type:

GameConfigObj

property hooks

Return the registered hooks for this temp entity.

Return type:

dict

property properties

Return the properties data of the temp entity.

Return type:

dict

property size

Return the size of the temp entity instance.

Return type:

int

class effects.templates.TempEntityTemplates

Bases: dict

Container class used to store the temp entity templates instances.