From e658bed27e104df46d201c81232d4dcb9d01a00f Mon Sep 17 00:00:00 2001 From: fig02 Date: Fri, 13 Sep 2024 14:49:55 -0400 Subject: Hostile Lock-On (#2193) * document flag and functions * format * adjust comment * make the comment more public-facing-friendly --- src/code/z_player_lib.c | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'src/code/z_player_lib.c') diff --git a/src/code/z_player_lib.c b/src/code/z_player_lib.c index 608423b42..f52068507 100644 --- a/src/code/z_player_lib.c +++ b/src/code/z_player_lib.c @@ -502,8 +502,15 @@ int Player_InCsMode(PlayState* play) { return Player_InBlockingCsMode(play, this) || (this->unk_6AD == 4); } -s32 func_8008E9C4(Player* this) { - return (this->stateFlags1 & PLAYER_STATE1_4); +/** + * Checks if Player is currently locked onto a hostile actor. + * `PLAYER_STATE1_HOSTILE_LOCK_ON` controls Player's "battle" response to hostile actors. + * + * Note that within Player, `Player_UpdateHostileLockOn` exists, which updates the flag and also returns the check. + * Player can use this function instead if the flag should be checked, but not updated. + */ +s32 Player_CheckHostileLockOn(Player* this) { + return (this->stateFlags1 & PLAYER_STATE1_HOSTILE_LOCK_ON); } int Player_IsChildWithHylianShield(Player* this) { -- cgit v1.2.3