Module katan_ai.katan.roll_yield

Module relating a rolls yield to its source

Classes

class RollYield

A utility class to represent what each player gets from a roll of the dice.

Contains information about where the resources came from as well.

Attributes

total_yield : Dict[Resource, int]

The total yield from this dice roll

all_yields : Set[RollYieldSource]

The sources where the resources came from

Methods

def add_yield(self, resource: Resource, amount: int, source: RollYieldSource) ‑> None

Add a yield to the RollYield.

Also updates total_yield. Use this method instead of directly changing all_yields.

Args

resource

The resource the player has received

amount

The amount of the resource the player has received

class RollYieldSource (resource: Resource, amount: int, building: IntersectionBuilding, hex: Hex)

The source of some resources a player got after rolling the dice.

Attributes

resource

The resource earned,

amount

The amount of the resource earned

building

The building that earned the resources

hex

The hex that the resources came from