Improve documentation for object_do_animation

This commit is contained in:
Ryan Dwyer
2020-02-19 23:24:36 +10:00
parent ae8e7a821d
commit e6c99d2bba
28 changed files with 182 additions and 174 deletions
+13 -5
View File
@@ -2342,14 +2342,22 @@
mkshort(animation),
/**
* Makes the given object do the given animation.
* Makes the given object do the given animation. See the ANIM constants in
* constants.h for known animation IDs.
*
* object may be the tag ID of an object, or 0xff to use the current chr's
* myspecial object. The myspecial object is assigned during chr setup and is
* commonly the chair that they're sitting in.
*
* startframe may be 0 or higher for that frame number, -1 for the first frame
* (ie. same as 0), or -2 for the last frame.
*/
#define object_do_animation(u1, object, u2, u3) \
#define object_do_animation(animation, object, u2, startframe) \
mkshort(0x0112), \
mkshort(u1), \
mkshort(animation), \
object, \
mkshort(u2), \
u3,
u2, \
mkshort(startframe),
/**
* Checks if a cutscene is still running.
+1 -1
View File
@@ -6,7 +6,7 @@
u32 func000233c0(void);
u32 func00023640(void);
u32 func0002373c(void);
s32 func00023768(s16 anim_id);
s32 animGetNumFrames(s16 anim_id);
u32 func00023794(void);
u32 func000237dc(void);
u32 func000237e8(void);