diff --git a/worlds/generic/Rules.py b/worlds/generic/Rules.py index cc07d491..ed9b5542 100644 --- a/worlds/generic/Rules.py +++ b/worlds/generic/Rules.py @@ -1,4 +1,16 @@ -def locality_rules(world, player): +import typing + +if typing.TYPE_CHECKING: + import BaseClasses + + CollectionRule = typing.Callable[[BaseClasses.CollectionState], bool] + ItemRule = typing.Callable[[BaseClasses.Item], bool] +else: + CollectionRule = typing.Callable[[object], bool] + ItemRule = typing.Callable[[object], bool] + + +def locality_rules(world, player: int): if world.local_items[player].value: for location in world.get_locations(): if location.player != player: @@ -9,18 +21,18 @@ def locality_rules(world, player): forbid_items_for_player(location, world.non_local_items[player].value, player) -def exclusion_rules(world, player: int, exclude_locations: set): +def exclusion_rules(world, player: int, exclude_locations: typing.Set[str]): for loc_name in exclude_locations: location = world.get_location(loc_name, player) add_item_rule(location, lambda i: not (i.advancement or i.never_exclude)) location.excluded = True -def set_rule(spot, rule): +def set_rule(spot, rule: CollectionRule): spot.access_rule = rule -def add_rule(spot, rule, combine='and'): +def add_rule(spot, rule: CollectionRule, combine='and'): old_rule = spot.access_rule if combine == 'or': spot.access_rule = lambda state: rule(state) or old_rule(state) @@ -28,36 +40,36 @@ def add_rule(spot, rule, combine='and'): spot.access_rule = lambda state: rule(state) and old_rule(state) -def forbid_item(location, item, player: int): +def forbid_item(location, item: str, player: int): old_rule = location.item_rule location.item_rule = lambda i: (i.name != item or i.player != player) and old_rule(i) -def forbid_items_for_player(location, items: set, player: int): +def forbid_items_for_player(location, items: typing.Set[str], player: int): old_rule = location.item_rule location.item_rule = lambda i: (i.player != player or i.name not in items) and old_rule(i) -def forbid_items(location, items: set): +def forbid_items(location, items: typing.Set[str]): """unused, but kept as a debugging tool.""" old_rule = location.item_rule location.item_rule = lambda i: i.name not in items and old_rule(i) -def add_item_rule(location, rule): +def add_item_rule(location, rule: ItemRule): old_rule = location.item_rule location.item_rule = lambda item: rule(item) and old_rule(item) -def item_in_locations(state, item, player, locations): +def item_in_locations(state, item: str, player: int, locations: typing.Sequence): for location in locations: if item_name(state, location[0], location[1]) == (item, player): return True return False -def item_name(state, location, player): +def item_name(state, location: str, player: int) -> typing.Optional[typing.Tuple[str, int]]: location = state.world.get_location(location, player) if location.item is None: return None - return (location.item.name, location.item.player) \ No newline at end of file + return location.item.name, location.item.player