More descriptive names for CS_BEGIN_CUTSCENE and CS_END (#2311)

* rename CS_BEGIN_CUTSCENE and CS_END

* matching

* naming consistency for END command, improved comments

* remove CS_CMD_NONE

Co-authored-by: mzxrules <mzxrules@gmail.com>

* remove comma from end of enum

* git subrepo pull --force tools/ZAPD

subrepo:
  subdir:   "tools/ZAPD"
  merged:   "c04562d30"
upstream:
  origin:   "https://github.com/zeldaret/ZAPD.git"
  branch:   "master"
  commit:   "c04562d30"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo.git"
  commit:   "cce3d93"

---------

Co-authored-by: mzxrules <mzxrules@gmail.com>
Co-authored-by: fig02 <fig02srl@gmail.com>
This commit is contained in:
mracsys
2024-12-02 16:50:58 -05:00
committed by GitHub
parent 3f703a39d9
commit bdc774058d
29 changed files with 82 additions and 71 deletions
+2 -2
View File
@@ -22,6 +22,7 @@ typedef enum CutsceneState {
} CutsceneState;
typedef enum CutsceneCmd {
/* 0xFFFF */ CS_CMD_END_OF_SCRIPT = -1,
/* 0x0001 */ CS_CMD_CAM_EYE_SPLINE = 0x01,
/* 0x0002 */ CS_CMD_CAM_AT_SPLINE,
/* 0x0003 */ CS_CMD_MISC,
@@ -149,8 +150,7 @@ typedef enum CutsceneCmd {
/* 0x008E */ CS_CMD_ACTOR_CUE_7_6,
/* 0x008F */ CS_CMD_ACTOR_CUE_9_0,
/* 0x0090 */ CS_CMD_ACTOR_CUE_0_17,
/* 0x03E8 */ CS_CMD_DESTINATION = 0x03E8,
/* 0xFFFF */ CS_CMD_END = 0xFFFF
/* 0x03E8 */ CS_CMD_DESTINATION = 0x03E8
} CutsceneCmd;
typedef enum CutsceneMiscType {
+5 -4
View File
@@ -37,9 +37,10 @@
#endif
/**
* Marks the beginning of a cutscene script.
* Describes the length and the total number of command entries for a cutscene script.
* Required at the beginning of every script.
*/
#define CS_BEGIN_CUTSCENE(totalEntries, frameCount) CMD_W(totalEntries), CMD_W(frameCount)
#define CS_HEADER(totalEntries, frameCount) CMD_W(totalEntries), CMD_W(frameCount)
/**
* Defines data for `CutsceneCameraPoint`, which can be used with any of the `eye` or `at` camera commands.
@@ -267,9 +268,9 @@
CS_CMD_DESTINATION, 1, CMD_HH(destination, startFrame), CMD_HH(endFrame, endFrame)
/**
* Marks the end of a cutscene script.
* Marks the end of a command list in a cutscene script. Processing for the current frame will finish.
*/
#define CS_END() 0xFFFFFFFF, 0x00000000
#define CS_END_OF_SCRIPT() CS_CMD_END_OF_SCRIPT, CMD_W(0)
// most instances of this look like unimplemented actor cues.