descriptor¶

All the classes that make up Map Descriptors – including the MapDescriptor class itself – live in this module.

Functions

build_map_descriptor_object

This function takes in the filename of a .yaml Map Descriptor file and returns a MapDescriptor object with all of the data easily accessible as Pythonic attributes.

Classes

`AuthorInfo`	A dataclass holding an author's name and homepage information.
`ChangeLogEntry`	A dataclass holding the changelog information.
`CustomMusic`	A dataclass holding the board's music information.
`Description`	A dataclass holding description information.
`DistrictNames`	A dataclass holding District Name information.
`LoopingInfo`	A dataclass holding Looping configuration.
`MapDescriptor`	This class represents the .yaml object, the Map Descriptor.
`Name`	A dataclass holding board's Name information.
`ShopNames`	A dataclass holding Shop Name information.
`SwitchRotationOriginPoints`	A dataclass holding information relating to the Switch's Rotation Origin Points.
`TourModeInfo`	A dataclass holding information relating to the board's Tour Mode settings.
`VentureCardInfo`	A dataclass holding Venture Card information.