mirror/oot
1
0
Fork 0
mirror of https://github.com/zeldaret/oot synced 2026-06-14 22:29:07 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document ANIM_FLAG_PLAYER_2 as ANIM_FLAG_DISABLE_CHILD_ROOT_ADJUSTMENT (#2001)

Browse Source 
* name ANIM_FLAG_DISABLE_CHILD_ROOT_ADJUSTMENT

* reword

* typo
This commit is contained in:
fig02
2024-07-27 23:47:58 -04:00
committed by GitHub
parent d905e08daf
commit 7fcbf3f4b2
3 changed files with 60 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/z64animation.h
+10 -3
View File
@@ -106,8 +106,15 @@ typedef enum {
// An option is to implement and use `ANIM_FLAG_OVERRIDE_MOVEMENT`.
#define ANIM_FLAG_UPDATE_Y (1 << 1)
// (player-only) Related to scaling an animation from/to child/adult
#define ANIM_FLAG_PLAYER_2 (1 << 2)
// When this flag is set, Player's root limb position adjustment as child is disabled.
// Many of Player's animations are originally created for Adult Link. When playing those
// animations as Child Link without any adjustment, he will appear to be floating in the air.
// To fix this, Child Link's root position is scaled down by default to fit his smaller size.
// However, if an animation is created specifically for Child Link, it is desirable to disable
// this scaling of the root position by using this flag.
// Note that this flag will be ignored if `ANIM_FLAG_UPDATE_XZ` or `ANIM_FLAG_UPDATE_Y` are also
// set. The adjustment will be applied in this case regardless of this flag being enabled.
#define ANIM_FLAG_DISABLE_CHILD_ROOT_ADJUSTMENT (1 << 2)
// (player-only) Call AnimTaskQueue_AddActorMove
#define ANIM_FLAG_PLAYER_SETMOVE (1 << 3)
@@ -123,7 +130,7 @@ typedef enum {
// Some animations have translation data that does not begin at the "origin". This is common when a
// longer sequence of animation is broken up into different parts as seperate animations.
// In this case, when one animation starts its translation at the same position where a different animation
// left off, resetting `prevTransl` is not desireable. This will cause the actor's position to noticeably change
// left off, resetting `prevTransl` is not desirable. This will cause the actor's position to noticeably change
// when the translation data from the first frame of the new animation is applied.
//
// When this flag is used during a transition between two animations, the first frame of movement is not applied.