registries package
Submodules
registries.condition_registry module
- class registries.condition_registry.ConditionRegistry
Bases:
object
Registry for condition classes.
This class allows registering, retrieving, and instantiating condition classes by name.
- create(data: dict)
Create an instance of a registered condition class from a dictionary.
- Parameters:
data (dict) – Dictionary containing at least a “type” key.
- Raises:
ValueError – If the type is not registered.
- Returns:
An instance of the registered class.
- get_all()
Get a list of all registered condition names.
- Returns:
List of registered condition names.
- Return type:
list[str]
- get_class(name)
Get the registered class for a given name.
- Parameters:
name (str) – The name of the registered class.
- Returns:
The registered class, or None if not found.
- Return type:
type or None
- list_keys()
Alias for
get_all()
.- Returns:
List of registered condition names.
- Return type:
list[str]
- register(name, cls)
Register a condition class with a given name.
- Parameters:
name (str) – The name to register the class under.
cls (type) – The class to register.
registries.reaction_registry module
- class registries.reaction_registry.ReactionRegistry
Bases:
object
Registry for reaction classes.
This class allows registering, retrieving, and instantiating reaction classes by name.
- create(data: dict)
Create an instance of a registered reaction class from a dictionary.
- Parameters:
data (dict) – Dictionary containing at least a “type” key.
- Raises:
ValueError – If the type is not registered.
- Returns:
An instance of the registered class.
- get_all()
Get a list of all registered reaction names.
- Returns:
List of registered names.
- Return type:
list
- get_class(name)
Get the class registered under the given name.
- Parameters:
name (str) – The name of the registered class.
- Returns:
The registered class or None if not found.
- list_keys()
Alias for get_all(). Returns all registered reaction names.
- Returns:
List of registered names.
- Return type:
list
- register(name, cls)
Register a reaction class with a given name.
- Parameters:
name (str) – The name to register the class under.
cls (type) – The class to register.
registries.trigger_presets module
This module defines preset triggers for different entity types in the game.
Each preset is a list of Trigger objects, specifying the event, condition, and reaction.
- registries.trigger_presets.trigger_presets
A dictionary mapping entity types to lists of Trigger presets.
- Type:
dict
- registries.trigger_presets.trigger_presets = {'enemy': [<core.gameCreation.trigger.Trigger object>], 'npc': [<core.gameCreation.trigger.Trigger object>], 'object': [], 'player': [], 'trap': [<core.gameCreation.trigger.Trigger object>]}
Preset triggers for different entity types.
Keys are entity types (str), values are lists of Trigger objects.
registries.trigger_registry module
- class registries.trigger_registry.TriggerRegistry
Bases:
object
Registry for managing triggers, their associated functions, and their sources.
- condition_registry
Registry for conditions.
- Type:
- reaction_registry
Registry for reactions.
- Type:
- add_trigger(trigger, source=None)
Add a trigger to the registry.
- Parameters:
trigger (object) – The trigger object to add.
source (str, optional) – The source or origin of the trigger.
- Returns:
True if the trigger was added, False if it already exists.
- Return type:
bool
- debug_print()
Print debug information about all registered triggers.
- get_all_triggers()
Get a list of all registered triggers.
- Returns:
List of all registered triggers.
- Return type:
list
- get_function(name)
Retrieve a registered function by name.
- Parameters:
name (str) – The name of the function.
- Returns:
The registered function, or None if not found.
- Return type:
callable or None
- get_source(trigger)
Get the source associated with a trigger.
- Parameters:
trigger (object) – The trigger to query.
- Returns:
The source of the trigger, or “unknown” if not found.
- Return type:
str
- get_triggers_by_source(source_name)
Get all triggers registered from a specific source.
- Parameters:
source_name (str) – The name of the source.
- Returns:
List of triggers from the specified source.
- Return type:
list
- is_registered(trigger)
Check if a trigger is registered.
- Parameters:
trigger (object) – The trigger to check.
- Returns:
True if the trigger is registered, False otherwise.
- Return type:
bool
- register_function(func, name=None)
Register a function for use by triggers.
- Parameters:
func (callable) – The function to register.
name (str, optional) – The name to register the function under. If None, uses func.__name__.
- remove_trigger(trigger)
Remove a trigger from the registry.
- Parameters:
trigger (object) – The trigger to remove.