neighborly.preconditions package

Submodules

neighborly.preconditions.base_types module

Abstract base types for implementing preconditions.

class neighborly.preconditions.base_types.Precondition[source]

Bases: abc.ABC

Abstract base class for all precondition objects.

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

abstract classmethod instantiate(world: neighborly.ecs.World, params: dict[str, Any]) → neighborly.preconditions.base_types.Precondition[source]

Construct a new instance of the precondition using a data dict.

Parameters

world – The simulation’s world instance
params – Keyword parameters to pass to the precondition.

neighborly.preconditions.defaults module

Module contents