def __init__(self, model):
"""
Default constructor
:param model: model where character acts
:type model: Model
"""
super().__init__()
# attributes
self.model = model
self.__body = None
self.__finesse = None
self.__mind = None
self.name = 'prototype'
self.race = None
self.kit = None
self.__hit_points = None
self.__max_hp = None
self.__spirit = 100
self.max_spirit = 100
self.speed = None
self.inventory = Inventory()
self.feats = []
#location
self.level = None
self.location = ()
#icon
self.icon = None
#internal
self.tick = 0
self.short_term_memory = []
self.__event_listeners = []
self.__update_listeners = []
self.item_memory = {}
self.size = 'medium'
self.attack = None
self.__active_effects = []
self.artificial_intelligence = None
self.__effects_collection = EffectsCollection()
self.__spellbook = SpellBook()
self.cooldowns = {}
self.visited_levels = []
self.enemy_names = []
self.enemies = []
def __init__(self, model):
"""
Default constructor
:param model: model where character acts
:type model: Model
"""
super().__init__()
# attributes
self.model = model
self.__body = None
self.__finesse = None
self.__mind = None
self.name = 'prototype'
self.race = None
self.kit = None
self.__hit_points = None
self.__max_hp = None
self.__spirit = 100
self.max_spirit = 100
self.speed = None
self.inventory = Inventory()
self.feats = []
#location
self.level = None
self.location = ()
#icon
self.icon = None
#internal
self.tick = 0
self.short_term_memory = []
self.__event_listeners = []
self.__update_listeners = []
self.item_memory = {}
self.size = 'medium'
self.attack = None
self.__active_effects = []
self.artificial_intelligence = None
self.__effects_collection = EffectsCollection()
self.__spellbook = SpellBook()
self.cooldowns = {}
self.visited_levels = []
self.enemy_names = []
self.enemies = []
class Character():
"""
Represents a character in playing world
"""
@log_debug
def __init__(self, model):
"""
Default constructor
:param model: model where character acts
:type model: Model
"""
super().__init__()
# attributes
self.model = model
self.__body = None
self.__finesse = None
self.__mind = None
self.name = 'prototype'
self.race = None
self.kit = None
self.__hit_points = None
self.__max_hp = None
self.__spirit = 100
self.max_spirit = 100
self.speed = None
self.inventory = Inventory()
self.feats = []
#location
self.level = None
self.location = ()
#icon
self.icon = None
#internal
self.tick = 0
self.short_term_memory = []
self.__event_listeners = []
self.__update_listeners = []
self.item_memory = {}
self.size = 'medium'
self.attack = None
self.__active_effects = []
self.artificial_intelligence = None
self.__effects_collection = EffectsCollection()
self.__spellbook = SpellBook()
self.cooldowns = {}
self.visited_levels = []
self.enemy_names = []
self.enemies = []
def __str__(self):
return self.name
@log_debug
def receive_event(self, event):
"""
Receives an event from world and enters it into short term memory
:param event: event to receive
:type event: Event
"""
self.short_term_memory.append(event)
for listener in self.__event_listeners:
listener.receive_event(event)
@log_debug
def register_event_listener(self, listener):
"""
Register event listener
:param listener: listener to add
:type listener: Listener
.. versionadded:: 0.4
"""
self.__event_listeners.append(listener)
@log_debug
def register_for_updates(self, listener):
"""
Register listener to receive updates for this entity
:param listener: listener to add
:type listener: Listener
.. versionadded:: 0.5
"""
self.__update_listeners.append(listener)
@log_debug
def remove_from_updates(self, listener):
"""
Remove listener
:param listener: listener to remove
:type listener: Listener
.. versionadded:: 0.5
"""
if listener in self.__update_listeners:
self.__update_listeners.remove(listener)
@log_debug
def notify_update_listeners(self, event):
"""
Notify all listeners registered for update of this entity
:param event: event to relay to update listeners
:type event: Event
.. versionadded:: 0.5
"""
for listener in self.__update_listeners:
listener.receive_update(event)
# @guarded_action
@log_info
def act(self):
"""
Triggers AI of this character
"""
self.artificial_intelligence()
def __get_hp(self):
"""
Current hitpoints
"""
return self.__hit_points
def __set_hp(self, hit_points):
"""
Current hitpoints
"""
old_hit_points = self.__hit_points
new_hit_points = hit_points
self.__hit_points = hit_points
self.raise_event(
new_hit_points_changed_event(character=self,
old_hit_points=old_hit_points,
new_hit_points=new_hit_points))
def __get_spirit(self):
"""
Current spirit points
"""
return self.__spirit
def __set_spirit(self, spirit):
old_spirit = self.__spirit
new_spirit = spirit
self.__spirit = spirit
self.raise_event(
new_spirit_points_changed_event(character=self,
old_spirit=old_spirit,
new_spirit=new_spirit))
def __get_body(self):
"""
Current body attribute
"""
return self.__body
def __set_body(self, body):
"""
Current body attribute
"""
self.__body = body
def __get_finesse(self):
"""
Current finesse attribute
"""
return self.__finesse
def __set_finesse(self, finesse):
"""
Current finesse attribute
"""
self.__finesse = finesse
def __get_mind(self):
"""
Current mind attribute
"""
return self.__mind
def __set_mind(self, mind):
"""
Current mind attribute
"""
self.__mind = mind
def get_attack(self):
"""
Attack attribute of the character
"""
return self.attack
def set_attack(self, attack):
"""
Attack attribute of the character
"""
self.attack = attack
def __get_max_hp(self):
"""
Maximum HP this character can currently have
"""
return self.__max_hp
def __set_max_hp(self, max_hp):
"""
Maximum HP this character can currently have
"""
self.__max_hp = max_hp
@log_debug
def identify_item(self, item):
"""
Identify item
:param item: item to mark as identified
:type item: Item
"""
assert item is not None
self.item_memory[item.name] = item.name
@log_debug
def is_proficient(self, weapon):
"""
Check if this character is proficient with a given weapon
:param weapon: weapon which proficient requirements should be checked
:type weapon: Item
:returns: True if proficient, otherwise False
:rtype: Boolean
"""
assert weapon is not None
if weapon.weapon_data is None:
return True
if True in [
(x.name == 'weapon proficiency'
and x.weapon_type == weapon.weapon_data.weapon_type) and
(x.weapon_name is None or x.weapon_name == weapon.weapon_data.name)
for x in self.feats
]:
return True
else:
return False
def get_location(self):
"""
Returns location of this character
:returns: location
:rtype: (integer, integer)
"""
return self.location
def set_location(self, location):
"""
Sets location of this character
:param location: location to set
:type location: (integer, integer)
"""
self.location = location
@guarded_action
@log_info
def execute_action(self, action_parameters, action_factory):
"""
Execute action defined by action parameters
:param action_parameters: parameters controlling creation of the action
:type action_parameters: ActionParameters
:param action_factory: factory to create actions
:type action_factory: ActionFactory
"""
action = self.create_action(action_parameters, action_factory)
action.execute()
@log_debug
def create_action(self, action_parameters, action_factory):
"""
Create an action by defined by action parameters
:param action_parameters: parameters controlling creation of the action
:type action_parameters: ActionParameters
:param action_factory: factory to create actions
:type action_factory: ActionFactory
:returns: Action
"""
action = action_factory.get_action(action_parameters)
assert action is not None
return action
@log_debug
def raise_event(self, event):
"""
Raise event for other creatures to see
:param event: event to raise
:type event: Event
"""
self.model.raise_event(event)
self.notify_update_listeners(event)
@log_debug
def add_effect_handle(self, effect):
"""
Adds an effect handle to an character
:param effect: effect to add
:type effect: EffectHandle
.. versionadded:: 0.4
"""
self.__effects_collection.add_effect_handle(effect)
@log_debug
def get_effect_handles(self, trigger=None):
"""
Get effect handles
:param trigger: optional trigger type
:type trigger: string
:returns: effect handles
:rtype: [EffectHandle]
.. versionadded:: 0.4
"""
return self.__effects_collection.get_effect_handles(trigger)
@log_debug
def remove_effect_handle(self, handle):
"""
Remove given handle
:param handle: handle to remove
:type handle: EffectHandle
.. versionadded:: 0.4
"""
self.__effects_collection.remove_effect_handle(handle)
@log_debug
def add_effect(self, effect):
"""
Adds effect to this character
:param effect: Effect to add
:type effect: Effect
.. note:: Multiples of same type of effect are not added
.. versionadded:: 0.4
"""
if not effect.multiple_allowed:
if not self.__effects_collection.has_effect(effect):
self.__effects_collection.add_effect(effect)
self.raise_event(effect.get_add_event())
else:
self.__effects_collection.add_effect(effect)
self.raise_event(effect.get_add_event())
@log_debug
def get_effects(self):
"""
Get effects of the character
:returns: effects
:rtype: [Effect]
.. versionadded:: 0.4
"""
effects = []
if self.inventory.boots:
effects.extend(self.inventory.boots.get_effects())
effects.extend(self.__effects_collection.get_effects())
return effects
@log_debug
def remove_expired_effects(self):
"""
Remove all effects that have expired
.. versionadded:: 0.4
"""
removed = self.__effects_collection.get_expired_effects()
if len(removed) > 0:
self.__effects_collection.remove_expired_effects()
for effect in removed:
self.raise_event(effect.get_removal_event())
@log_debug
def add_to_tick(self, cost):
"""
Add cost of action to characters tick,
while taking characters speed into account
:param cost: Cost of action in ticks
:type cost: integer
"""
self.tick = self.tick + (self.speed * cost)
@log_debug
def add_domain_level(self, domain, level=None):
"""
Add level to a spell domain
:param domain: name of domain to learn
:type domain: string
:param level: amount to increment the level
:type level: int
.. note:: if level is None, current level is incremented by one
.. versionadded:: 0.10
"""
self.__spellbook.add_domain_level(domain, level)
@log_debug
def get_domain_level(self, domain):
"""
Get current level of a given domain
:param domain: name of the domain
:type domain: String
:returns: current level, 0 if character does not know the domain
:rtype: int
.. versionadded:: 0.10
"""
return self.__spellbook.get_domain_level(domain)
@log_debug
def add_spell_entry(self, entry):
"""
Add spell entry into characters spellbook
:param entry: entry to add
:type entry: SpellEntry
.. versionadded:: 0.10
"""
self.__spellbook.add_spell_entry(entry)
@log_debug
def get_known_spells(self):
"""
Get a list of known spells
:returns: list of known spells
:rtype: [SpellEntry]
"""
return self.__spellbook.get_known_spells()
@log_debug
def get_location_at_direction(self, direction):
"""
Get location next to this character at given direction
:param direction: direction to check
:type direction: int
:returns: coordinates of location
:rtype: (int, int)
.. note:: values 1 to 8 are supported for direction
"""
assert direction <= 8
assert direction >= 1
offset = [(0, 0), (0, -1), (1, -1), (1, 0), (1, 1), (0, 1), (-1, 1),
(-1, 0), (-1, -1)]
return tuple(x
for x in map(sum, zip(self.location, offset[direction])))
def _repr_pretty_(self, p, cycle):
"""
Pretty print for IPython
:param p: printer to write
:param cycle: has pretty print detected a cycle?
"""
if cycle:
p.text('Character(...)')
else:
p.text('name: {0}'.format(self.name))
p.breakable()
p.text('hitpoints: {0}/{1}'.format(self.__hit_points,
self.__max_hp))
p.breakable()
p.text('body: {0}'.format(self.__body))
p.breakable()
p.text('finesse: {0}'.format(self.__finesse))
p.breakable()
p.text('mind: {0}'.format(self.__mind))
p.breakable()
p.text('location: {0}'.format(self.location))
p.breakable()
p.pretty(self.inventory)
p.breakable()
p.pretty(self.__effects_collection)
p.breakable()
hit_points = property(__get_hp, __set_hp)
spirit = property(__get_spirit, __set_spirit)
max_hp = property(__get_max_hp, __set_max_hp)
body = property(__get_body, __set_body)
finesse = property(__get_finesse, __set_finesse)
mind = property(__get_mind, __set_mind)
class Character():
"""
Represents a character in playing world
"""
@log_debug
def __init__(self, model):
"""
Default constructor
:param model: model where character acts
:type model: Model
"""
super().__init__()
# attributes
self.model = model
self.__body = None
self.__finesse = None
self.__mind = None
self.name = 'prototype'
self.race = None
self.kit = None
self.__hit_points = None
self.__max_hp = None
self.__spirit = 100
self.max_spirit = 100
self.speed = None
self.inventory = Inventory()
self.feats = []
#location
self.level = None
self.location = ()
#icon
self.icon = None
#internal
self.tick = 0
self.short_term_memory = []
self.__event_listeners = []
self.__update_listeners = []
self.item_memory = {}
self.size = 'medium'
self.attack = None
self.__active_effects = []
self.artificial_intelligence = None
self.__effects_collection = EffectsCollection()
self.__spellbook = SpellBook()
self.cooldowns = {}
self.visited_levels = []
self.enemy_names = []
self.enemies = []
def __str__(self):
return self.name
@log_debug
def receive_event(self, event):
"""
Receives an event from world and enters it into short term memory
:param event: event to receive
:type event: Event
"""
self.short_term_memory.append(event)
for listener in self.__event_listeners:
listener.receive_event(event)
@log_debug
def register_event_listener(self, listener):
"""
Register event listener
:param listener: listener to add
:type listener: Listener
.. versionadded:: 0.4
"""
self.__event_listeners.append(listener)
@log_debug
def register_for_updates(self, listener):
"""
Register listener to receive updates for this entity
:param listener: listener to add
:type listener: Listener
.. versionadded:: 0.5
"""
self.__update_listeners.append(listener)
@log_debug
def remove_from_updates(self, listener):
"""
Remove listener
:param listener: listener to remove
:type listener: Listener
.. versionadded:: 0.5
"""
if listener in self.__update_listeners:
self.__update_listeners.remove(listener)
@log_debug
def notify_update_listeners(self, event):
"""
Notify all listeners registered for update of this entity
:param event: event to relay to update listeners
:type event: Event
.. versionadded:: 0.5
"""
for listener in self.__update_listeners:
listener.receive_update(event)
# @guarded_action
@log_info
def act(self):
"""
Triggers AI of this character
"""
self.artificial_intelligence()
def __get_hp(self):
"""
Current hitpoints
"""
return self.__hit_points
def __set_hp(self, hit_points):
"""
Current hitpoints
"""
old_hit_points = self.__hit_points
new_hit_points = hit_points
self.__hit_points = hit_points
self.raise_event(
new_hit_points_changed_event(character=self,
old_hit_points=old_hit_points,
new_hit_points=new_hit_points))
def __get_spirit(self):
"""
Current spirit points
"""
return self.__spirit
def __set_spirit(self, spirit):
old_spirit = self.__spirit
new_spirit = spirit
self.__spirit = spirit
self.raise_event(
new_spirit_points_changed_event(character=self,
old_spirit=old_spirit,
new_spirit=new_spirit))
def __get_body(self):
"""
Current body attribute
"""
return self.__body
def __set_body(self, body):
"""
Current body attribute
"""
self.__body = body
def __get_finesse(self):
"""
Current finesse attribute
"""
return self.__finesse
def __set_finesse(self, finesse):
"""
Current finesse attribute
"""
self.__finesse = finesse
def __get_mind(self):
"""
Current mind attribute
"""
return self.__mind
def __set_mind(self, mind):
"""
Current mind attribute
"""
self.__mind = mind
def get_attack(self):
"""
Attack attribute of the character
"""
return self.attack
def set_attack(self, attack):
"""
Attack attribute of the character
"""
self.attack = attack
def __get_max_hp(self):
"""
Maximum HP this character can currently have
"""
return self.__max_hp
def __set_max_hp(self, max_hp):
"""
Maximum HP this character can currently have
"""
self.__max_hp = max_hp
@log_debug
def identify_item(self, item):
"""
Identify item
:param item: item to mark as identified
:type item: Item
"""
assert item is not None
self.item_memory[item.name] = item.name
@log_debug
def is_proficient(self, weapon):
"""
Check if this character is proficient with a given weapon
:param weapon: weapon which proficient requirements should be checked
:type weapon: Item
:returns: True if proficient, otherwise False
:rtype: Boolean
"""
assert weapon is not None
if weapon.weapon_data is None:
return True
if True in [(x.name == 'weapon proficiency'
and x.weapon_type == weapon.weapon_data.weapon_type)
and (x.weapon_name is None
or x.weapon_name == weapon.weapon_data.name)
for x in self.feats]:
return True
else:
return False
def get_location(self):
"""
Returns location of this character
:returns: location
:rtype: (integer, integer)
"""
return self.location
def set_location(self, location):
"""
Sets location of this character
:param location: location to set
:type location: (integer, integer)
"""
self.location = location
@guarded_action
@log_info
def execute_action(self, action_parameters, action_factory):
"""
Execute action defined by action parameters
:param action_parameters: parameters controlling creation of the action
:type action_parameters: ActionParameters
:param action_factory: factory to create actions
:type action_factory: ActionFactory
"""
action = self.create_action(action_parameters,
action_factory)
action.execute()
@log_debug
def create_action(self, action_parameters, action_factory):
"""
Create an action by defined by action parameters
:param action_parameters: parameters controlling creation of the action
:type action_parameters: ActionParameters
:param action_factory: factory to create actions
:type action_factory: ActionFactory
:returns: Action
"""
action = action_factory.get_action(action_parameters)
assert action is not None
return action
@log_debug
def raise_event(self, event):
"""
Raise event for other creatures to see
:param event: event to raise
:type event: Event
"""
self.model.raise_event(event)
self.notify_update_listeners(event)
@log_debug
def add_effect_handle(self, effect):
"""
Adds an effect handle to an character
:param effect: effect to add
:type effect: EffectHandle
.. versionadded:: 0.4
"""
self.__effects_collection.add_effect_handle(effect)
@log_debug
def get_effect_handles(self, trigger=None):
"""
Get effect handles
:param trigger: optional trigger type
:type trigger: string
:returns: effect handles
:rtype: [EffectHandle]
.. versionadded:: 0.4
"""
return self.__effects_collection.get_effect_handles(trigger)
@log_debug
def remove_effect_handle(self, handle):
"""
Remove given handle
:param handle: handle to remove
:type handle: EffectHandle
.. versionadded:: 0.4
"""
self.__effects_collection.remove_effect_handle(handle)
@log_debug
def add_effect(self, effect):
"""
Adds effect to this character
:param effect: Effect to add
:type effect: Effect
.. note:: Multiples of same type of effect are not added
.. versionadded:: 0.4
"""
if not effect.multiple_allowed:
if not self.__effects_collection.has_effect(effect):
self.__effects_collection.add_effect(effect)
self.raise_event(effect.get_add_event())
else:
self.__effects_collection.add_effect(effect)
self.raise_event(effect.get_add_event())
@log_debug
def get_effects(self):
"""
Get effects of the character
:returns: effects
:rtype: [Effect]
.. versionadded:: 0.4
"""
effects = []
if self.inventory.boots:
effects.extend(self.inventory.boots.get_effects())
effects.extend(self.__effects_collection.get_effects())
return effects
@log_debug
def remove_expired_effects(self):
"""
Remove all effects that have expired
.. versionadded:: 0.4
"""
removed = self.__effects_collection.get_expired_effects()
if len(removed) > 0:
self.__effects_collection.remove_expired_effects()
for effect in removed:
self.raise_event(effect.get_removal_event())
@log_debug
def add_to_tick(self, cost):
"""
Add cost of action to characters tick,
while taking characters speed into account
:param cost: Cost of action in ticks
:type cost: integer
"""
self.tick = self.tick + (self.speed * cost)
@log_debug
def add_domain_level(self, domain, level=None):
"""
Add level to a spell domain
:param domain: name of domain to learn
:type domain: string
:param level: amount to increment the level
:type level: int
.. note:: if level is None, current level is incremented by one
.. versionadded:: 0.10
"""
self.__spellbook.add_domain_level(domain, level)
@log_debug
def get_domain_level(self, domain):
"""
Get current level of a given domain
:param domain: name of the domain
:type domain: String
:returns: current level, 0 if character does not know the domain
:rtype: int
.. versionadded:: 0.10
"""
return self.__spellbook.get_domain_level(domain)
@log_debug
def add_spell_entry(self, entry):
"""
Add spell entry into characters spellbook
:param entry: entry to add
:type entry: SpellEntry
.. versionadded:: 0.10
"""
self.__spellbook.add_spell_entry(entry)
@log_debug
def get_known_spells(self):
"""
Get a list of known spells
:returns: list of known spells
:rtype: [SpellEntry]
"""
return self.__spellbook.get_known_spells()
@log_debug
def get_location_at_direction(self, direction):
"""
Get location next to this character at given direction
:param direction: direction to check
:type direction: int
:returns: coordinates of location
:rtype: (int, int)
.. note:: values 1 to 8 are supported for direction
"""
assert direction <= 8
assert direction >= 1
offset = [(0, 0),
(0, -1), (1, -1), (1, 0), (1, 1),
(0, 1), (-1, 1), (-1, 0), (-1, -1)]
return tuple(x for x in
map(sum, zip(self.location, offset[direction])))
def _repr_pretty_(self, p, cycle):
"""
Pretty print for IPython
:param p: printer to write
:param cycle: has pretty print detected a cycle?
"""
if cycle:
p.text('Character(...)')
else:
p.text('name: {0}'.format(self.name))
p.breakable()
p.text('hitpoints: {0}/{1}'.format(self.__hit_points,
self.__max_hp))
p.breakable()
p.text('body: {0}'.format(self.__body))
p.breakable()
p.text('finesse: {0}'.format(self.__finesse))
p.breakable()
p.text('mind: {0}'.format(self.__mind))
p.breakable()
p.text('location: {0}'.format(self.location))
p.breakable()
p.pretty(self.inventory)
p.breakable()
p.pretty(self.__effects_collection)
p.breakable()
hit_points = property(__get_hp, __set_hp)
spirit = property(__get_spirit, __set_spirit)
max_hp = property(__get_max_hp, __set_max_hp)
body = property(__get_body, __set_body)
finesse = property(__get_finesse, __set_finesse)
mind = property(__get_mind, __set_mind)
