effects.base module

Provides base effect classes.

class effects.base.BaseTempEntity

Bases: instance

__init__()

Raises an exception This class cannot be instantiated from Python

create((BaseTempEntity)arg1, (_filters._recipients.BaseRecipientFilter)arg2[, (float)delay=0.0]) → None
precache((BaseTempEntity)arg1) → None
test((BaseTempEntity)arg1, (_mathlib.Vector)arg2, (_mathlib.QAngle)arg3) → None
property name

None( (_effects._base.BaseTempEntity)arg1) -> str

property next

None( (_effects._base.BaseTempEntity)arg1) -> _effects._base.BaseTempEntity

property server_class

None( (_effects._base.BaseTempEntity)arg1) -> object

class effects.base.TempEntity(temp_entity, **aliases)[source]

Bases: BaseTempEntity

Class used to interact with a specific temp entity.

__init__(temp_entity, **aliases)[source]

Initialize the temp entity instance.

Parameters:

  • temp_entity (str/Pointer) – The name of the temp entity to initialize or the pointer to wrap.

  • aliases – Any alias to set on initialization.

create(*recipients, delay=0.0, **aliases)[source]

Create the temp entity effect.

Parameters:

  • recipients (RecipientFilter) – The recipient filter listing the players to send the effect to.

  • delay (float) – The delay before creating the effect.

  • aliases (dict) – Any aliases to set before creating the temp entity effect.

get_property_array(prop_name)[source]

Return the value of the given property as an Array instance.

Parameters:

prop_name (str) – The name of the property.

Return type:

Array

get_property_bool(prop_name)[source]

Return the value of the given property as a boolean.

Parameters:

prop_name (str) – The name of the property.

Return type:

bool

get_property_float(prop_name)[source]

Return the value of the given property as a float.

Parameters:

prop_name (str) – The name of the property.

Return type:

float

get_property_int(prop_name)[source]

Return the value of the given property as an integer.

Parameters:

prop_name (str) – The name of the property.

Return type:

int

get_property_string(prop_name)[source]

Return the value of the given property as a string.

Parameters:

prop_name (str) – The name of the property.

Return type:

str

get_property_vector(prop_name)[source]

Return the value of the given property as a string.

Parameters:

prop_name (str) – The name of the property.

Return type:

Vector

set_property_array(prop_name, value)[source]

Set the value of the given property as an Array instance.

Parameters:

  • prop_name (str) – The name of the property.

  • value (Array) – The value to set.

set_property_bool(prop_name, value)[source]

Set the value of the given property as a boolean.

Parameters:

  • prop_name (str) – The name of the property.

  • value (bool) – The value to set.

set_property_float(prop_name, value)[source]

Set the value of the given property as a float.

Parameters:

  • prop_name (str) – The name of the property.

  • value (float) – The value to set.

set_property_int(prop_name, value)[source]

Set the value of the given property as an integer.

Parameters:

  • prop_name (str) – The name of the property.

  • value (int) – The value to set.

set_property_string(prop_name, value)[source]

Set the value of the given property as a string.

Parameters:

  • prop_name (str) – The name of the property.

  • value (str) – The value to set.

set_property_vector(prop_name, value)[source]

Set the value of the given property as a string.

Parameters:

  • prop_name (str) – The name of the property.

  • value (Vector) – The value to set.

property template

Return the template of the temp entity.

Return type:

TempEntityTemplate