Skip to content

Show hint type in spoiler log #2393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: Dev
Choose a base branch
from
Open

Show hint type in spoiler log #2393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec917ed
Show hint type in spoiler log
fenhl Mar 21, 2025
f5724bd
Allow plandoing hints by hint type
fenhl Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions Hints.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,16 @@ def __init__(self, text: str, colors: Optional[list[str]] = None, hinted_locatio
self.colors: Optional[list[str]] = colors
self.hinted_locations: Optional[list[str]] = hinted_locations
self.hinted_items: Optional[list[str]] = hinted_items
self.hint_type: Optional[str] = None

def to_json(self) -> dict:
return {'text': self.text, 'colors': self.colors, 'hinted_locations': self.hinted_locations, 'hinted_items': self.hinted_items}
return {
'text': self.text,
'colors': self.colors,
'hinted_locations': self.hinted_locations,
'hinted_items': self.hinted_items,
'hint_type': self.hint_type,
}

def __str__(self) -> str:
return get_raw_text(line_wrap(color_text(self)))
Expand Down Expand Up @@ -186,7 +193,9 @@ def is_restricted_dungeon_item(item: Item) -> bool:


def add_hint(spoiler: Spoiler, world: World, groups: list[list[int]], gossip_text: GossipText, count: int,
locations: Optional[list[Location]] = None, force_reachable: bool = False, hint_type: str = None) -> bool:
locations: Optional[list[Location]] = None, force_reachable: bool = False, *, hint_type: str) -> bool:
gossip_text.hint_type = hint_type

random.shuffle(groups)
skipped_groups = []
duplicates = []
Expand Down Expand Up @@ -1354,7 +1363,7 @@ def build_world_gossip_hints(spoiler: Spoiler, world: World, checked_locations:

stone_ids = list(gossipLocations.keys())

world.distribution.configure_gossip(spoiler, stone_ids)
world.distribution.configure_gossip(spoiler, world, stone_ids, checked_locations, checked_always_locations)

# If all gossip stones already have plando'd hints, do not roll any more
if len(stone_ids) == 0:
Expand Down
24 changes: 20 additions & 4 deletions Plandomizer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from Entrance import Entrance
from EntranceShuffle import EntranceShuffleError, change_connections, confirm_replacement, validate_world, check_entrances_compatibility
from Fill import FillError
from Hints import HintArea, gossipLocations, GossipText
from Hints import HintArea, gossipLocations, GossipText, hint_func
from Item import ItemFactory, ItemInfo, ItemIterator, is_item, Item
from ItemPool import item_groups, get_junk_item, song_list, trade_items, child_trade_items
from JSONDump import dump_obj, CollapseList, CollapseDict, AlignedDict, SortedDict
Expand Down Expand Up @@ -113,7 +113,9 @@ def __init__(self, src_dict: dict[str, Any]) -> None:
self.colors: Optional[Sequence[str]] = None
self.hinted_locations: Optional[Sequence[str]] = None
self.hinted_items: Optional[Sequence[str]] = None
super().__init__({'text': None, 'colors': None, 'hinted_locations': None, 'hinted_items': None}, src_dict)
self.hint_type: Optional[str] = None

super().__init__({'text': None, 'colors': None, 'hinted_locations': None, 'hinted_items': None, 'hint_type': None}, src_dict)

def to_json(self) -> dict[str, Any]:
if self.colors is not None:
Expand Down Expand Up @@ -1016,7 +1018,7 @@ def cloak(self, worlds: list[World], location_pools: list[list[Location]], model
if can_cloak(location.item, model):
location.item.looks_like_item = model

def configure_gossip(self, spoiler: Spoiler, stone_ids: list[int]) -> None:
def configure_gossip(self, spoiler: Spoiler, world: World, stone_ids: list[int], checked_locations: set[str], checked_always_locations: set[str]) -> None:
for (name, record) in self.pattern_dict_items(self.gossip_stones):
matcher = self.pattern_matcher(name)
stone_id = pull_random_element([stone_ids], lambda id: matcher(gossipLocations[id].name))
Expand All @@ -1027,7 +1029,21 @@ def configure_gossip(self, spoiler: Spoiler, stone_ids: list[int]) -> None:
stone_id = int(match[1], base=16)
else:
raise RuntimeError('Gossip stone unknown or already assigned in world %d: %r. %s' % (self.id + 1, name, build_close_match(name, 'stone')))
spoiler.hints[self.id][stone_id] = GossipText(text=record.text, colors=record.colors, prefix='')
if record.text is not None:
spoiler.hints[self.id][stone_id] = GossipText(text=record.text, colors=record.colors, prefix='')
else:
all_checked_locations = checked_locations | checked_always_locations
if record.hint_type == 'barren':
hint = hint_func[record.hint_type](spoiler, world, checked_locations, all_checked_locations)
else:
hint = hint_func[record.hint_type](spoiler, world, all_checked_locations)
checked_locations.update(all_checked_locations - checked_always_locations)
if hint is None:
raise RuntimeError(f'Attempted to plando unavailable hint type {record.hint_type}')
gossip_text, _ = hint
gossip_text.hint_type = record.hint_type
spoiler.hints[self.id][stone_id] = gossip_text


def give_items(self, world: World, save_context: SaveContext) -> None:
# copy Triforce pieces to all worlds
Expand Down