Items Module

The items module defines items, weapons, tools, and consumables.

Base Item

class simulation_framework.src.items.item.Item(id: 'int', name: 'str', item_type: 'str', properties: 'Dict[str, Any]' = <factory>, description: 'str' = '', value: 'int' = 0, weight: 'float' = 1.0, max_stack_size: 'int' = 99)

Bases: object

can_stack() → bool

description: str = ''

classmethod from_dict(data: Dict[str, Any]) → Item

get_property(key: str, default: Any | None = None) → Any

id: int

item_type: str

max_stack_size: int = 99

name: str

properties: Dict[str, Any]

set_property(key: str, value: Any) → None

to_dict() → Dict[str, Any]

value: int = 0

weight: float = 1.0

Weapon

class simulation_framework.src.items.weapon.Weapon(**kwargs)

Bases: Item

classmethod create_bow() → Weapon

classmethod create_staff() → Weapon

classmethod create_sword() → Weapon

get_attack_speed() → float

get_attack_type() → str

get_critical_chance() → float

get_critical_multiplier() → float

get_damage() → int

get_damage_type() → str

get_magic_cost() → int

get_range() → int

get_stamina_cost() → int

Tool

class simulation_framework.src.items.tool.Tool(**kwargs)

Bases: Item

classmethod create_axe() → Tool

classmethod create_fishing_rod() → Tool

classmethod create_hoe() → Tool

classmethod create_pickaxe() → Tool

get_durability() → int

get_durability_percentage() → float

get_efficiency() → float

get_max_durability() → int

get_tool_type() → str

is_broken() → bool

repair(amount: int) → int

use(wear_amount: int = 1) → bool

Consumable

class simulation_framework.src.items.consumable.Consumable(**kwargs)

Bases: Item

consume(entity: Entity) → bool

classmethod create_food(name: str = 'Bread') → Consumable

classmethod create_health_potion() → Consumable

classmethod create_magic_potion() → Consumable

classmethod create_poison() → Consumable

classmethod create_stamina_potion() → Consumable

classmethod create_strength_elixir() → Consumable

get_cooldown() → int

get_effect() → Dict[str, Any]

Loot Table

class simulation_framework.src.items.loot_table.LootEntry(item: Item, probability: float, min_quantity: int = 1, max_quantity: int = 1)

Bases: object

roll_quantity() → int

class simulation_framework.src.items.loot_table.LootTable(entries: List[LootEntry] | None = None)

Bases: object

add_entry(item: Item, probability: float, min_quantity: int = 1, max_quantity: int = 1) → None

classmethod create_basic_monster_loot() → LootTable

classmethod create_rare_monster_loot() → LootTable

classmethod create_resource_node_loot(resource_type: str) → LootTable

generate_loot(luck_modifier: float = 0.0) → List[Tuple[Item, int]]

get_guaranteed_loot() → List[Tuple[Item, int]]

get_possible_loot() → List[Item]

get_total_probability() → float

is_empty() → bool

merge(other: LootTable) → LootTable

Starting Equipment

Starting equipment helper functions for agents. Provides appropriate tools and items based on agent goals and character class.

simulation_framework.src.items.starting_equipment.create_basic_tool_set() → List[Tool]

Create a basic set of tools for testing.

Returns:

List containing one of each basic tool type

simulation_framework.src.items.starting_equipment.equip_agent_for_task(agent: Agent, task: str) → bool

Equip an agent with the appropriate tool for a specific task.

Parameters:

• agent – The agent to equip

• task – The task type (e.g., “woodcutting”, “mining”, “fishing”)

Returns:

True if the agent was successfully equipped, False otherwise

simulation_framework.src.items.starting_equipment.get_class_equipment(class_name: str) → List[Item]

Get starting equipment based on character class.

Parameters:

class_name – Name of the character class

Returns:

List of starting items for the class

simulation_framework.src.items.starting_equipment.get_goal_equipment(goals: List[Goal]) → List[Item]

Get equipment based on agent’s current goals.

Parameters:

goals – List of agent’s current goals

Returns:

List of tools needed for the goals

simulation_framework.src.items.starting_equipment.give_starting_equipment(agent: Agent) → None

Give an agent appropriate starting equipment based on their goals and class.

Parameters:

agent – The agent to equip