[OoT] Cutscene Implementation Update #208

Yanis42 · 2023-01-10T17:17:14Z

Opening this as a draft so people can make suggestions

Current changes:

Added more layout.box() to improve the UI
Updated the command names
Added enums where it's needed (cutscene destination, ocarina action, BGM, fade out player and misc)
Renamed "Cutscene Terminator" to "Cutscene Destination"
Moved the commands before the list tabs to make the UI easier to use
Renamed "Cmd 9" to "Rumble Controller" and changed the icon to a wave-like one
Removed "Cmd Unk" as it's not implemented
Used proper names for rumble command
Used more indentation to improve the C output
Added "custom" option for the enums
Use "0" as the default value for unused/not implemented arguments
Use proper names for commands sub-properties
Used enum names for the music enum
Probably other things I forgot

Notes:

Current renames are mostly on the UI (but not everything has been renamed yet), it will be part of the code later
There's not updater (yet) for older blends
zcamedit merge won't be a part of this PR

Output Example

CutsceneData TEST[] = {
    CS_BEGIN_CUTSCENE(10, 100),
        CS_DESTINATION(CS_DEST_CUSTOM, 99, 100),
        CS_TEXT_LIST(3),
            CS_TEXT(0x0001, 31, 51, CS_TEXT_CUSTOM, 0x0000, 0x0000),
            CS_TEXT_NONE(188, 206),
            CS_TEXT_OCARINA_ACTION(OCARINA_ACTION_CUSTOM, 311, 447, 0x0045),
        CS_TRANSITION(CS_TRANS_CUSTOM, 429, 490),
        CS_LIGHT_SETTING_LIST(1),
            CS_LIGHT_SETTING(154, 2574, 0, 0, 0, 0, 0, 0, 0, 0, 0),
        CS_TIME_LIST(1),
            CS_TIME(0, 112, 0, 10, 25),
        CS_START_SEQ_LIST(1),
            CS_START_SEQ(NA_BGM_CUSTOM1, 2100, 0, 0, 0, 0, 0, 0, 0, 0, 0),
        CS_STOP_SEQ_LIST(1),
            CS_STOP_SEQ(NA_BGM_CUSTOM, 3247, 0, 0, 0, 0, 0, 0, 0, 0, 0),
        CS_FADE_OUT_SEQ_LIST(1),
            CS_FADE_OUT_SEQ(CS_FADE_OUT_BGM_MAIN, 3277, 3066, 0, 0, 0, 0, 0, 0, 0, 0),
        CS_MISC_LIST(1),
            CS_MISC(CS_MISC_CUSTOM, 2437, 4689, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0),
        CS_RUMBLE_CONTROLLER_LIST(1),
            CS_RUMBLE_CONTROLLER(0, 7084, 0, 0x0054, 0x0024, 0x0032, 0, 0),
    CS_END(),
};

As always I'm open to suggestions!

Yanis42 · 2023-01-12T22:40:45Z

New changes:

renamed the old "subprops" (to explain it better, it's organised like this: 1. list of cs commands then 2. lists of command's data and 3. the actual props to set the data, I renamed those props which are called "subprops" in the code)
introduced an upgrade system for old blends, I haven't double checked yet but, as they say, it works on my machine™
other minor changes, like comments and small fixes

…sition, minor ui changes

Yanis42 · 2023-01-13T14:42:27Z

New changes:

renamed cs lists and related things
renamed OOTCutsceneProperty and related things
renamed other classes to have better names
improved the upgrade code
update the readme, added a guide to use the map select to watch cutscenes and updated the names

I think this PR is now ready for review (unless I missed something but I don't think so :thonk:), though I'll wait a bit before marking it ready for review as I want to try things to improve the UI a bit

Also a small note/reminder: in this PR I changed and removed classes and properties, for classes renaming is fine it doesn't break anything it just works™ but for props you need to transfer the data to the new props you want to use (this was introduced with the object list upgrade, see oot_upgrade.py), also enums can't break if you change the identifier since Blender saves the index of the selected element in the item list, but anyway everything seems to work fine for me outside few issues that aren't directly related to this (it just prevents compilation, will fix that soon™)

Yanis42 · 2023-01-13T22:51:21Z

Marking this as ready to review as I don't have anything else to change (I think)

mzxrules · 2023-01-15T19:51:15Z

fast64_internal/oot/scene/exporter/to_c/scene_cutscene.py

                )
+
+            elif list.listType in ["StartSeqList", "StopSeqList", "FadeOutSeqList"]:
+                endFrame = e.endFrame if list.listType == "FadeOutSeqList" else "0"


why do you force endFrame to be 0?

in decomp it says the end frame isn't used so the value doesn't matter at all (unless I misread the line, which is possible)

(https://github.com/zeldaret/oot/blob/9f09505d34619883748a7dab05071883281c14fd/include/z64cutscene_commands.h#L197 & https://github.com/zeldaret/oot/blob/9f09505d34619883748a7dab05071883281c14fd/include/z64cutscene_commands.h#L212)

but yea I guess I can use the default value of the class, those need a small cleanup anyway but idk if I should do it in this PR

It should be noted that decomp's implementation of the cutscene structs doesn't match the original implementation. For example, all evidence suggests that CsCmdMisc, CsCmdLightSetting, CsCmdStartSeq, CsCmdStopSeq CsCmdFadeOutSeq are all the same type as CsCmdActorCue. Decomp just implements them separately so that they can hide editor only properties not read by the game, and give a few properties more specialized names.

endFrame is one such property that all commands have, but isn't always needed by the game. But I don't think it makes any sense to deliberately force the value to 0 just because you can get away with it.

and I don't feel that you should be deliberately generating corrupt data

i understand your point of view a little from the perspective of vanilla data.

but for custom cutscenes, how is it corrupt data? you want the commands that dont use an endframe to have one anyway and be confusing for the user? the ui might as well hide it so people dont need to think about it. cause again, it does not matter

So, with your (mzx) logic we should also use 1 for unused args? It doesn't make sense to me, I mean I understand the point of view, like ok I get it originally it wasn't split etc, but for Fast64 in a modding context where I and other devs try our best to get something easy to use for everyone I don't think consistency should be considered for this particular thing as it's just confusing, alternatively I can accept using a macro but idk it doesn't seem really useful, also I don't really understand how 0 is corrupted data, especially for a frame value where you can actually want 0 to be used (well, ok 0 for a end frame is weird but you get what I mean hopefully)

Tldr I just want Fast64 to be easy to use and understand and having a value for this would be confusing for the users

Two simple reasons:

Storing the endFrame for all commands is a nice thing to have, and the structs already support this.

Given that the structs all call the property endFrame in decomp, it makes zero sense to deliberately generate incorrect data for this property, since the user could have their own reasons for reading the data.

Dragorn421

skimmed through

fast64_internal/oot/README.md

fast64_internal/oot/oot_constants.py

fast64_internal/oot/oot_upgrade.py

Dragorn421 · 2023-01-17T14:36:28Z

fast64_internal/oot/oot_upgrade.py

+                # @TODO: find a way to check properly which seq command it is
+                if newName == "csSeqID":
+                    setattr(data, "csSeqPlayer", "Custom")
+                    setattr(data, "csSeqPlayerCustom", str(oldData))


can't say I understand the todo

like, the seqId value here may be seqPlayer from CS_FADE_OUT_SEQ ?

I should rephrase that but we need a proper way to check if we're dealing with the fade out command or the start/stop one, there's a minor difference between these two, the fade out one doesn't take a seq id but the player type (as defined in sequence.h iirc)

all of this is based on the informations inside z64cutscene_commands.h btw

the main issue at the moment is that we have to use "Custom" when upgrading because everything was assumed to have the same parameters, and now we know for sure this is a wrong assumption

fast64_internal/oot/scene/exporter/to_c/scene_cutscene.py

Dragorn421 · 2023-01-17T14:43:17Z

fast64_internal/oot/scene/properties.py

-    csTermEnd: IntProperty(name="End Frm", min=0, default=100)
+    csUseDestination: BoolProperty(name="Write Terminator (Code Execution)")
+    csDestination: IntProperty(name="Index", min=0)
+    csDestinationStartFrame: IntProperty(name="Start Frm", min=0, default=99)


does frm need to be abbreviated?

that's the deprecated code, I haven't updated it tbh I don't even know if everything still works for that

imo we should completely remove that legacy system and upgrade the things (though I don't have a cs in a scene so I can't really try if it'd work properly)

should we just remove this thing? I'm not sure anyone still using that now idk if it's worth making the code to update properly

Yanis42 · 2023-01-24T19:25:09Z

any updates on this? sorry I just need this to be merged to make things easier with merging zcamedit

Yanis42 · 2023-06-29T10:29:25Z

is there anything holding this? except update that branch I guess

Yanis42 · 2023-10-19T20:47:16Z

most of things I wanted to do are done, I improved the importer and the exporter and fixed some issues

I just want to improve the UI and I think I'm done with this, also I want to remove support for embedded cutscenes, I don't think anyone is using it, and if I do that I'll move files that are inside motion/exporter/motion/importer outside of the folders as this is handling everything now (with the necessary class/other rename)

also I implemented the preview for everything, not only imported cutscenes

edit: I just wanna improve the previewer a bit then I'll be done for real

sauraen

Some nits, otherwise looks good.

Tested importing a vanilla scene and previewing the cutscene in Blender. Also tested exporting a basic scene with several different command types. Both worked with no issues.

fast64_internal/oot/cutscene/classes.py

sauraen · 2023-12-29T04:19:07Z

fast64_internal/oot/cutscene/classes.py

+    actorCueList: list[CutsceneCmdActorCueList] = field(default_factory=list)
+    playerCueList: list[CutsceneCmdActorCueList] = field(default_factory=list)
+    camEyeSplineList: list[CutsceneCmdCamEyeSpline] = field(default_factory=list)
+    camATSplineList: list[CutsceneCmdCamATSpline] = field(default_factory=list)
+    camEyeSplineRelPlayerList: list[CutsceneCmdCamEyeSplineRelToPlayer] = field(default_factory=list)
+    camATSplineRelPlayerList: list[CutsceneCmdCamATSplineRelToPlayer] = field(default_factory=list)
+    camEyeList: list[CutsceneCmdCamEye] = field(default_factory=list)
+    camATList: list[CutsceneCmdCamAT] = field(default_factory=list)
+    miscList: list[CutsceneCmdMiscList] = field(default_factory=list)
+    transitionList: list[CutsceneCmdTransition] = field(default_factory=list)
+    textList: list[CutsceneCmdTextList] = field(default_factory=list)
+    lightSettingsList: list[CutsceneCmdLightSettingList] = field(default_factory=list)
+    timeList: list[CutsceneCmdTimeList] = field(default_factory=list)
+    seqList: list[CutsceneCmdStartStopSeqList] = field(default_factory=list)
+    fadeSeqList: list[CutsceneCmdFadeSeqList] = field(default_factory=list)
+    rumbleList: list[CutsceneCmdRumbleControllerList] = field(default_factory=list)


This approach doesn't preserve the order different types of commands appear in. (e.g. CutsceneCmdActorCueList followed by CutsceneCmdCamEyeSpline vs. the other order). However, I don't think that should ever matter in game, and Fast64 has long since stopped matching on vanilla data import -> export (e.g. exported DLs are sometimes more efficient). So this is probably okay.

I don't think the order actually matters for cutscene commands

sauraen · 2023-12-29T04:21:03Z

fast64_internal/oot/cutscene/constants.py

 ]

+# order here sets order on the UI


Could you reorder ootEnumCSListTypeListC above and csListTypeToIcon below to match this order then?

I'm gonna do the reverse so the UI doesn't change (note that things up to camATList are from the zcamedit merge, so this won't change)

fast64_internal/oot/cutscene/classes.py

sauraen

Thanks!

Yanis42 added 8 commits January 10, 2023 13:45

UI update & other changes

dda75c5

cs C code cleanup + other UI tweaks

cf80723

fixed cs dest custom now showing

44df89f

fixes for ocarina action enum & cs_text

db12ad5

remove debug print

35628f5

wip upgrade system

091c724

renamed subprops

c9db274

finished upgrade system

76a7d0e

Yanis42 added 6 commits January 13, 2023 12:12

more renames/upgrade, "fixed" issues with fade out seq and fixed tran…

3fa16a0

…sition, minor ui changes

fixed export

07c4f85

black

a70f877

OOTCutsceneProperty rename & upgrade and other minor changes

28bc02f

small UI changes, updated oot readme

06bdce5

black

bdd66ea

Merge remote-tracking branch 'upstream/main' into cs_update

1f78ceb

Yanis42 marked this pull request as ready for review January 13, 2023 22:51

Yanis42 changed the title ~~[OoT] (Draft) Cutscene Implementation Update~~ [OoT] Cutscene Implementation Update Jan 13, 2023

mzxrules reviewed Jan 15, 2023

View reviewed changes

Dragorn421 reviewed Jan 17, 2023

View reviewed changes

Yanis42 added 3 commits January 20, 2023 18:38

review

79c45c6

Merge remote-tracking branch 'upstream/main' into cs_update

cae86c6

Merge remote-tracking branch 'upstream/main' into cs_update

70f5cf0

Merge remote-tracking branch 'upstream/main' into cs_update

f0727cc

Yanis42 mentioned this pull request Jul 12, 2023

[OOT] Adapted zcamedit to Fast64 #235

Merged

Merge remote-tracking branch 'upstream/main' into cs_update

a19ea92

Yanis42 added 2 commits October 19, 2023 19:08

improvements part 2

c2b8408

enhanced exporter + fixed issues

0a8714a

Yanis42 added 12 commits October 20, 2023 02:42

ui improvements and import cs destination

6c48377

black

849b464

remove "embedded" code

278338f

fixed extra cutscenes & minor enum issue

c8ad752

move exporter/importer outside motion folder

1c8b678

OOTCSMotion -> CutsceneCmd

7ab85ee

removed "motion" where it's relevant

8400cf2

ui stuff

4f01575

black

f64578e

moved preview settings to a propertygroup

b2688b9

cs seq search op

d74c46d

bugfix

acb4635

Yanis42 added waiting for author Waiting for the author to answer questions, do changes, ... oot Has to do with the Ocarina of Time 64 side labels Nov 8, 2023

Yanis42 added 2 commits December 26, 2023 00:49

Merge remote-tracking branch 'upstream/main' into cs_update

3a08eef

fix order of the cs commands

05408cd

Yanis42 removed the waiting for author Waiting for the author to answer questions, do changes, ... label Dec 26, 2023

Merge remote-tracking branch 'upstream/main' into cs_update

8cc2c85

sauraen requested changes Dec 29, 2023

View reviewed changes

Yanis42 added 3 commits December 29, 2023 12:46

Merge remote-tracking branch 'upstream/main' into cs_update

7ec07f2

review & minor bugfix

b1234f5

black

6566257

sauraen requested changes Dec 29, 2023

View reviewed changes

fast64_internal/oot/cutscene/classes.py Outdated Show resolved Hide resolved

tuple -> list

e7feb88

sauraen approved these changes Dec 29, 2023

View reviewed changes

Yanis42 added the merge soon Will be merged in a few days at most if nothing else comes up label Dec 29, 2023

sauraen merged commit 71225c7 into Fast-64:main Dec 31, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[OoT] Cutscene Implementation Update #208

[OoT] Cutscene Implementation Update #208

Yanis42 commented Jan 10, 2023 •

edited

Loading

Yanis42 commented Jan 12, 2023

Yanis42 commented Jan 13, 2023

Yanis42 commented Jan 13, 2023

mzxrules Jan 15, 2023

Yanis42 Jan 15, 2023 •

edited

Loading

Yanis42 Jan 15, 2023

Yanis42 Jan 15, 2023

mzxrules Jan 15, 2023

mzxrules Jan 15, 2023 •

edited

Loading

fig02 Jan 16, 2023

Yanis42 Jan 16, 2023

Yanis42 Jan 16, 2023

mzxrules Jan 16, 2023

Dragorn421 left a comment

Dragorn421 Jan 17, 2023

Yanis42 Jan 20, 2023

Dragorn421 Jan 17, 2023

Yanis42 Jan 20, 2023 •

edited

Loading

Yanis42 Jun 29, 2023

Yanis42 commented Jan 24, 2023

Yanis42 commented Jun 29, 2023

Yanis42 commented Oct 19, 2023 •

edited

Loading

sauraen left a comment

sauraen Dec 29, 2023

Yanis42 Dec 29, 2023

sauraen Dec 29, 2023

Yanis42 Dec 29, 2023

sauraen left a comment

[OoT] Cutscene Implementation Update #208

[OoT] Cutscene Implementation Update #208

Conversation

Yanis42 commented Jan 10, 2023 • edited Loading

Yanis42 commented Jan 12, 2023

Yanis42 commented Jan 13, 2023

Yanis42 commented Jan 13, 2023

Choose a reason for hiding this comment

Yanis42 Jan 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mzxrules Jan 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dragorn421 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Yanis42 Jan 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Yanis42 commented Jan 24, 2023

Yanis42 commented Jun 29, 2023

Yanis42 commented Oct 19, 2023 • edited Loading

sauraen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sauraen left a comment

Choose a reason for hiding this comment

Yanis42 commented Jan 10, 2023 •

edited

Loading

Yanis42 Jan 15, 2023 •

edited

Loading

mzxrules Jan 15, 2023 •

edited

Loading

Yanis42 Jan 20, 2023 •

edited

Loading

Yanis42 commented Oct 19, 2023 •

edited

Loading