MapDescriptor¶

class MapDescriptor(name: Name = <factory>, description: Description = <factory>, rule_set: str = '', theme: str = '', initial_cash: str = '', target_amount: str = '', base_salary: str = '', salary_increment: str = '', max_dice_roll: str = '', frbs: list[str] = <factory>, background: str = '', switch_rotation_origin_points: list[SwitchRotationOriginPoints] = <factory>, icon: str = '', music: CustomMusic = <factory>, looping: LoopingInfo = <factory>, tour_mode: TourModeInfo = <factory>, changelog: list[ChangeLogEntry] = <factory>, authors: list[AuthorInfo] = <factory>, venture_cards: VentureCardInfo = <factory>, district_names: DistrictNames = <factory>, shop_names: ShopNames = <factory>, notes: str = '', tags: list[str] = <factory>, yaml_validation_results: CheckResult = <factory>)¶

Bases: object

This class represents the .yaml object, the Map Descriptor.

It contains extended-level preferences for game boards, such as which Background to use, custom music entries, which Venture Cards should be enabled, and more. This is the main returnable when loading just a .yaml file, but when loading a full Board Bundle, this is returned as an element in the larger bundle – bundle.descriptor.

Methods

Attributes

`background`
`base_salary`
`icon`
`initial_cash`
`max_dice_roll`
`notes`
`rule_set`
`salary_increment`
`target_amount`
`theme`
`name`
`description`
`frbs`
`switch_rotation_origin_points`
`music`
`looping`
`tour_mode`
`changelog`
`authors`
`venture_cards`
`district_names`
`shop_names`
`tags`
`yaml_validation_results`