Document monster movement and visibility functions #652
Conversation
src/brogue/Monsters.c
Outdated
| /// clairvoyance, telepathy, or entrancement. However, the kind may be unknown (e.g. player is | ||
| // hallucinating or monster is submerged). |
There was a problem hiding this comment.
The kind may be unknown
Hmm, this disagrees with my understanding. Probably applies when hallucinating but in other cases?
There was a problem hiding this comment.
The other case is when the monster is submerged and the player is telepathic but not submerged (doesn't matter if hallucinating or not). The player knows a monster is underwater and where it is, but doesn't know what kind it is. Hovering the monster gives the "small/large" psychic emanation message.
Maybe I should update the comment?
There was a problem hiding this comment.
If the monster is submerged but player isn't, isn't monsterIsHidden(monst, &player) true, meaning canSeeMonster returns false?
There was a problem hiding this comment.
You sir are absolutely correct. I pushed an update. Hope I didn't go overboard.
There was a problem hiding this comment.
It seems you've added more (correct) detail but canSeeMonster is still described as just knowing location and it still says kind may be unknown - which is what I thought we invalidated above ^
There was a problem hiding this comment.
It think we determined that hallucination is the only reason for not knowing the kind. How about this instead? "A monster can be "seen" but its kind unknown due to hallucination."
There was a problem hiding this comment.
Pushed an update. Feel free to reword as you see fit.
There was a problem hiding this comment.
pushed a change, what do you think?
zenzombie
force-pushed
the
monster-move-see-docs
branch
from
5b107ca
to
46fa9d5
Compare
zenzombie
force-pushed
the
monster-move-see-docs
branch
from
46fa9d5
to
b23bad3
Compare
tmewett
force-pushed
the
monster-move-see-docs
branch
from
1403af3
to
49eaae7
Compare
No code changes, just some documentation.