neighborly.effects package

Submodules

neighborly.effects.base_types module

Abstract base types for implementing Effects.

class neighborly.effects.base_types.Effect[source]

Bases: abc.ABC

Abstract base class for all effect objects.

abstract apply(target: neighborly.ecs.GameObject) → None[source]: Apply the effects of this effect.

abstract property description: str: Get a string description of the effect.

abstract classmethod instantiate(world: neighborly.ecs.World, params: dict[str, Any]) → neighborly.effects.base_types.Effect[source]: Construct a new instance of the effect type using a data dict.

abstract remove(target: neighborly.ecs.GameObject) → None[source]: Remove the effects of this effect.

neighborly.effects.effects module

Module contents