VegansDeluxe.core package

Subpackages

• VegansDeluxe.core.Actions package
  • Submodules
  • VegansDeluxe.core.Actions.Action module
    • Action
      • Action.blocked
      • Action.canceled
      • Action.cost
      • Action.execute()
      • Action.func()
      • Action.get_targets()
      • Action.hidden
      • Action.id
      • Action.name
      • Action.priority
      • Action.tags
      • Action.target_type
      • Action.targets
      • Action.type
    • DecisiveAction
      • DecisiveAction.cost
    • FreeAction
      • FreeAction.cost
  • VegansDeluxe.core.Actions.ActionManager module
    • ActionManager
      • ActionManager.action_map
      • ActionManager.action_queue
      • ActionManager.actions
      • ActionManager.attach_action()
      • ActionManager.get_action()
      • ActionManager.get_action_from_all_actions()
      • ActionManager.get_actions()
      • ActionManager.get_attached_actions()
      • ActionManager.get_available_actions()
      • ActionManager.get_queued_entity_actions()
      • ActionManager.get_queued_session_actions()
      • ActionManager.is_action_available()
      • ActionManager.queue_action()
      • ActionManager.queue_action_instance()
      • ActionManager.remove_action()
      • ActionManager.remove_actions_by_tag()
      • ActionManager.reset_removed_actions()
      • ActionManager.update_actions()
      • ActionManager.update_entity_actions()
  • VegansDeluxe.core.Actions.ActionTags module
    • ActionTag
      • ActionTag.ATTACK
      • ActionTag.HARMFUL
      • ActionTag.ITEM
      • ActionTag.MEDICINE
      • ActionTag.RELOAD
      • ActionTag.SKIP
  • VegansDeluxe.core.Actions.EntityActions module
    • ApproachAction
      • ApproachAction.cls
      • ApproachAction.func()
      • ApproachAction.hidden
      • ApproachAction.id
      • ApproachAction.name
      • ApproachAction.target_type
    • ReloadAction
      • ReloadAction.cls
      • ReloadAction.func()
      • ReloadAction.id
      • ReloadAction.name
      • ReloadAction.target_type
    • SkipActionGameEvent
    • SkipTurnAction
      • SkipTurnAction.cls
      • SkipTurnAction.func()
      • SkipTurnAction.id
      • SkipTurnAction.name
      • SkipTurnAction.priority
      • SkipTurnAction.target_type
  • VegansDeluxe.core.Actions.ItemAction module
    • DecisiveItem
      • DecisiveItem.cost
    • FreeItem
      • FreeItem.cost
    • ItemAction
      • ItemAction.id
      • ItemAction.name
  • VegansDeluxe.core.Actions.StateAction module
    • DecisiveStateAction
      • DecisiveStateAction.cost
    • FreeStateAction
      • FreeStateAction.cost
    • StateAction
  • VegansDeluxe.core.Actions.WeaponAction module
    • Attack
      • Attack.attack()
      • Attack.calculate_damage()
      • Attack.func()
      • Attack.id
      • Attack.name
      • Attack.priority
      • Attack.publish_attack_event()
      • Attack.publish_post_attack_event()
      • Attack.send_attack_message()
      • Attack.target_type
    • DamageData
    • DecisiveWeaponAction
    • FreeWeaponAction
    • MeleeAttack
      • MeleeAttack.target_type
    • RangedAttack
      • RangedAttack.target_type
    • WeaponAction
  • Module contents
• VegansDeluxe.core.Engine package
  • Submodules
  • VegansDeluxe.core.Engine.Engine module
  • Module contents
    • Engine
      • Engine.attach_session()
      • Engine.attach_states()
      • Engine.detach_session()
      • Engine.stats()
• VegansDeluxe.core.Entities package
  • Submodules
  • VegansDeluxe.core.Entities.Entity module
    • Entity
      • Entity.attach_state()
      • Entity.dead
      • Entity.energies
      • Entity.energy
      • Entity.get_item()
      • Entity.get_state()
      • Entity.hearts
      • Entity.hit_chance
      • Entity.hp
      • Entity.id
      • Entity.inbound_accuracy_bonus
      • Entity.inbound_dmg
      • Entity.is_ally()
      • Entity.items
      • Entity.map_items_quantity()
      • Entity.max_energy
      • Entity.max_hp
      • Entity.name
      • Entity.nearby_entities
      • Entity.notifications
      • Entity.outbound_accuracy_bonus
      • Entity.outbound_dmg
      • Entity.pre_move()
      • Entity.session_id
      • Entity.skills
      • Entity.states
      • Entity.team
      • Entity.tick_turn()
      • Entity.type
      • Entity.weapon
  • Module contents
• VegansDeluxe.core.Events package
  • Submodules
  • VegansDeluxe.core.Events.DamageEvents module
    • AttackGameEvent
    • DamageGameEvent
    • PostAttackGameEvent
    • PostDamageGameEvent
    • PreDamageGameEvent
  • VegansDeluxe.core.Events.EventHandlers module
    • ConstantEventSubscription
    • EventSubscription
      • EventSubscription.handle()
      • EventSubscription.is_valid_event()
      • EventSubscription.is_valid_filter()
      • EventSubscription.is_valid_turn()
    • ScheduledEventSubscription
      • ScheduledEventSubscription.handle()
      • ScheduledEventSubscription.is_valid_schedule()
    • SingleTurnSubscription
  • VegansDeluxe.core.Events.EventManager module
    • EventManager
      • EventManager.add_subscription()
      • EventManager.after()
      • EventManager.at()
      • EventManager.at_event()
      • EventManager.clean_by_session_id()
      • EventManager.every()
      • EventManager.nearest()
      • EventManager.publish()
      • EventManager.size
  • VegansDeluxe.core.Events.Events module
    • ActionGameEvent
    • AttachSessionEvent
    • AttachStateEvent
    • CallActionsGameEvent
    • DeathGameEvent
    • DeliveryPackageEvent
    • DeliveryRequestEvent
    • Event
    • ExecuteActionEvent
    • GameEvent
    • HPLossGameEvent
    • PostActionsGameEvent
    • PostDamagesGameEvent
    • PostDeathsGameEvent
    • PostTickGameEvent
    • PostUpdateActionsGameEvent
    • PostUpdatesGameEvent
    • PreActionsGameEvent
    • PreDamagesGameEvent
    • PreDeathGameEvent
    • PreMoveGameEvent
    • PreUpdateActionsGameEvent
    • PreUpdatesGameEvent
    • SessionFinishGameEvent
    • SessionStopGameEvent
    • StartSessionEvent
  • Module contents
• VegansDeluxe.core.Items package
  • Submodules
  • VegansDeluxe.core.Items.Item module
    • Item
      • Item.id
      • Item.name
      • Item.type
  • Module contents
• VegansDeluxe.core.Skills package
  • Submodules
  • VegansDeluxe.core.Skills.Skill module
    • Skill
      • Skill.type
  • Module contents
• VegansDeluxe.core.States package
  • Submodules
  • VegansDeluxe.core.States.State module
    • State
      • State.description
      • State.id
      • State.name
      • State.type
  • Module contents
• VegansDeluxe.core.Translator package
  • Submodules
  • VegansDeluxe.core.Translator.Locale module
    • Locale
      • Locale.add_data()
      • Locale.get_string()
  • VegansDeluxe.core.Translator.LocalizedList module
    • LocalizedList
  • VegansDeluxe.core.Translator.LocalizedString module
    • LocalizedString
      • LocalizedString.copy()
      • LocalizedString.format()
      • LocalizedString.insert()
      • LocalizedString.localize()
      • LocalizedString.localize_args()
    • ensure_str()
    • ls
  • VegansDeluxe.core.Translator.Translator module
    • Translator
      • Translator.create_locale()
      • Translator.get_locale()
      • Translator.get_string()
      • Translator.load_folder()
      • Translator.load_json()
      • Translator.update_locale()
  • Module contents
• VegansDeluxe.core.Weapons package
  • Submodules
  • VegansDeluxe.core.Weapons.Weapon module
    • MeleeWeapon
      • MeleeWeapon.ranged
    • RangedWeapon
      • RangedWeapon.ranged
    • Weapon
      • Weapon.accuracy_bonus
      • Weapon.cubes
      • Weapon.damage_bonus
      • Weapon.description
      • Weapon.energy_cost
      • Weapon.hit_chance()
      • Weapon.id
      • Weapon.name
      • Weapon.ranged
      • Weapon.reload_text()
      • Weapon.type
  • Module contents

Submodules

VegansDeluxe.core.ContentManager module

VegansDeluxe.core.ContentManager.After(session_id: str, turns: int, event: type[VegansDeluxe.core.Events.Events.Event] = <class 'VegansDeluxe.core.Events.Events.Event'>, repeats: int = 1, filters=None)

class VegansDeluxe.core.ContentManager.Assignment(func: Callable, desc: str = '')

Bases: object

execute(am: ActionManager)

VegansDeluxe.core.ContentManager.At(session_id: str, turn: int, event: type[VegansDeluxe.core.Events.Events.Event] = <class 'VegansDeluxe.core.Events.Events.Event'>, priority: int = 0, filters=None)

VegansDeluxe.core.ContentManager.AttachedAction(cls: type[VegansDeluxe.core.Entities.Entity.Entity] | type[VegansDeluxe.core.Weapons.Weapon.Weapon] | type[VegansDeluxe.core.States.State.State] | type[VegansDeluxe.core.Items.Item.Item])

cls: Entity, Weapon, State or Item. Action is being attached to it. action: Any Action.

class VegansDeluxe.core.ContentManager.ContentManager

Bases: object

ContentManager is a singleton. It is used by content to register itself for usage and by Engine to retrieve the content properly.

action_map: dict[type[VegansDeluxe.core.Entities.Entity.Entity] | type[VegansDeluxe.core.Weapons.Weapon.Weapon] | type[VegansDeluxe.core.States.State.State] | type[VegansDeluxe.core.Items.Item.Item], list[type[VegansDeluxe.core.Actions.Action.Action]]]

Map of Content classes to Action classes.

add_assignment(assignment: Assignment)

after(session_id: str, turns: int, event: type[VegansDeluxe.core.Events.Events.Event] = <class 'VegansDeluxe.core.Events.Events.Event'>, repeats: int = 1, filters=None)

assignments: list[VegansDeluxe.core.ContentManager.Assignment]

List of event assignments to be completed on Engine initialization.

at(session_id: str, turn: int, event: type[VegansDeluxe.core.Events.Events.Event] = <class 'VegansDeluxe.core.Events.Events.Event'>, priority: int = 0, filters=None)

attach_action_manager(action_manager: ActionManager)

attached_action_managers: list[VegansDeluxe.core.Actions.ActionManager.ActionManager]

List of attached SessionManagers.

every(session_id: str, turns: int, start: int = 1, event: type[VegansDeluxe.core.Events.Events.Event] = <class 'VegansDeluxe.core.Events.Events.Event'>, filters=None)

get_state(state_id: str) → State | None

Retrieve a state by its ID. If no state is found, return an empty state.

get_weapon(weapon_id: str) → Weapon | None

Retrieve a weapon by its ID. If no weapon is found, return an empty weapon.

initialize_action_manager(action_manager: ActionManager)

On AttachSessionEvent, attaches “action calling function” to the Session.

initialize_state_attachment(state: type[VegansDeluxe.core.States.State.State], action_manager: ActionManager)

This method should be called when initializing new Engine.

items: dict[str, VegansDeluxe.core.Items.Item.Item]

Map of Item classes to their IDs.

next(session_id: str, event: type[VegansDeluxe.core.Events.Events.Event] = <class 'VegansDeluxe.core.Events.Events.Event'>, priority=0, filters=None)

register_action(cls: type[VegansDeluxe.core.Entities.Entity.Entity] | type[VegansDeluxe.core.Weapons.Weapon.Weapon] | type[VegansDeluxe.core.States.State.State] | type[VegansDeluxe.core.Items.Item.Item])

cls: Entity, Weapon, State or Item. Action is being attached to it. action: Any Action.

register_action_execution_event(session_id: str = None, unique_type=None, priority=0, filters=None)

Works same as self.register_state, but more complicated. Adds an Assignment to be completed in Engine init.

register_event(session_id: str = None, event: type[VegansDeluxe.core.Events.Events.Event] = <class 'VegansDeluxe.core.Events.Events.Event'>, unique_type=None, priority=0, filters=None)

Works same as self.register_state, but more complicated. Adds an Assignment to be completed in Engine init.

register_item(item: Item)

register_state(state: type[VegansDeluxe.core.States.State.State])

register_weapon(weapon: Weapon)

state_init_map: dict[type[VegansDeluxe.core.States.State.State], Callable]

Map of State classes to their “game inits”.

states: dict[str, VegansDeluxe.core.States.State.State]

Map of State classes to their IDs.

weapons: dict[str, VegansDeluxe.core.Weapons.Weapon.Weapon]

Map of Weapon classes to their IDs.

VegansDeluxe.core.ContentManager.Every(session_id: str, turns: int, start: int = 1, event: type[VegansDeluxe.core.Events.Events.Event] = <class 'VegansDeluxe.core.Events.Events.Event'>, filters=None)

VegansDeluxe.core.ContentManager.Next(session_id: str, event: type[VegansDeluxe.core.Events.Events.Event] = <class 'VegansDeluxe.core.Events.Events.Event'>, priority=0, filters=None)

VegansDeluxe.core.ContentManager.RegisterEvent(session_id: str = None, event: type[VegansDeluxe.core.Events.Events.Event] = <class 'VegansDeluxe.core.Events.Events.Event'>, unique_type=None, priority=0, filters=None)

Works same as self.register_state, but more complicated. Adds an Assignment to be completed in Engine init.

VegansDeluxe.core.ContentManager.RegisterItem(item: Item)

VegansDeluxe.core.ContentManager.RegisterState(state: type[VegansDeluxe.core.States.State.State])

VegansDeluxe.core.ContentManager.RegisterWeapon(weapon: Weapon)

VegansDeluxe.core.Context module

class VegansDeluxe.core.Context.ActionExecutionContext(event: ExecuteActionEvent, session: Session, action_manager: ActionManager)

Bases: Context, Generic

class VegansDeluxe.core.Context.Context

Bases: Generic

class VegansDeluxe.core.Context.EventContext(event: T, session: Session, action_manager: ActionManager)

Bases: Context, Generic

class VegansDeluxe.core.Context.StateContext(event: AttachStateEvent, session: Session, action_manager: ActionManager)

Bases: Context, Generic

VegansDeluxe.core.DamageHolder module

class VegansDeluxe.core.DamageHolder.DamageHolder

Bases: object

add(source, damage: int, turn: int)

cancel(source)

clear()

contributors()

sum()

class VegansDeluxe.core.DamageHolder.DamageLog(source, damage: int, turn: int)

Bases: object

VegansDeluxe.core.SessionManager module

class VegansDeluxe.core.SessionManager.SessionManager(event_manager: EventManager)

Bases: object

async attach_session(session: Session)

delete_session(session_id)

get_session(session_id)

VegansDeluxe.core.TargetType module

class VegansDeluxe.core.TargetType.Aliveness(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ALIVE_ONLY = 1

ANY = 0

DEAD_ONLY = 2

class VegansDeluxe.core.TargetType.Allies(distance=Distance.ANY, aliveness=Aliveness.ALIVE_ONLY)

Bases: TargetType

class VegansDeluxe.core.TargetType.Distance(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ANY = 0

DISTANT_ONLY = 2

NEARBY_ONLY = 1

class VegansDeluxe.core.TargetType.Enemies(distance=Distance.ANY, aliveness=Aliveness.ALIVE_ONLY)

Bases: TargetType

class VegansDeluxe.core.TargetType.Everyone(distance=Distance.ANY, aliveness=Aliveness.ALIVE_ONLY, own=Own.SELF_INCLUDED)

Bases: TargetType

class VegansDeluxe.core.TargetType.Own(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

SELF_EXCLUDED = 2

SELF_INCLUDED = 0

SELF_ONLY = 1

class VegansDeluxe.core.TargetType.OwnOnly

Bases: TargetType

class VegansDeluxe.core.TargetType.TargetType(distance, team, aliveness, own)

Bases: object

class VegansDeluxe.core.TargetType.Team(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ALLIES_ONLY = 1

ANY = 0

ENEMIES_ONLY = 2

VegansDeluxe.core.utils module

class VegansDeluxe.core.utils.MatrixIndexCounter(width: int)

Bases: object

current()

next()

reset(width: int = None)

VegansDeluxe.core.utils.percentage_chance(chance: int)

Module contents

Core module of the library. Contains all core mechanics of the engine.