Cutscenes - Revision history

Jimmie1717: /* Field of View */

2019-11-16T18:02:04Z

‎Field of View

Jimmie1717: Fix fov variable name.

2019-10-30T22:46:27Z

Fix fov variable name.

Jimmie1717 at 22:41, 30 October 2019

2019-10-30T22:41:11Z

Ostrealava02: /* Camera Entries */

2019-10-30T14:04:16Z

‎Camera Entries

Ostrealava02: /* Camera Entries */

2019-10-30T14:01:57Z

‎Camera Entries

Jimmie1717: /* 0x96 Actions */

2019-10-15T20:38:30Z

‎0x96 Actions

Playtendo: /* Play Song Action Ids */

2016-09-23T02:19:24Z

‎Play Song Action Ids

Playtendo at 14:35, 30 August 2016

2016-08-30T14:35:23Z

Playtendo: Created page with "== Finding Cutscenes == There are a few ways that you can locate a cutscene. === Cutscene Pointer === You can always find the start of a cutscene in memory by watching the cu..."

2016-08-30T13:29:41Z

Created page with "== Finding Cutscenes == There are a few ways that you can locate a cutscene. === Cutscene Pointer === You can always find the start of a cutscene in memory by watching the cu..."

New page

== Finding Cutscenes ==
There are a few ways that you can locate a cutscene.

=== Cutscene Pointer ===
You can always find the start of a cutscene in memory by watching the cutscene pointer with a memory viewer. It's located at 8044A628 in the Debug Rom, 803E8C18 in NTSC-J 1.0, and 803E8A48 in NTSC-U. Be aware that the cutscene pointer does not null itself once the cutscene has finished playing, but as long as you don't leave the immediate area this won't be an issue.

=== Scenes ===
Many, but not all, cutscenes are stored within scene files. These are referenced directly from the scene header.

==== Header References ====
The main scene header can contain a command (the 0x18 command) that defines extra headers for the purpose of creating different variations of the same scene. Some of these extra headers exist with the purpose of playing a single cutscene. This is done by defining the 0x17 command, which in turn points to the start of the cutscene header by a [[bank offset]].

See [[Scenes and Rooms]] for more information on the header commands.

== Cutscene Commands ==

Cutscenes begin with a simple 8 byte header of the following form:

<syntaxhighlight lang="csharp">
/*0x00*/ int Commands; // number of commands in the cutscene.
/*0x04*/ int EndFrame; // Last frame of the cutscene.
</syntaxhighlight>

Notes:
* If the number of commands or end frame variables are negative, the cutscene will not be parsed, and normal play will resume.
* Other commands can (and typically will) terminate the cutscene before the end frame is reached.

Following that are the cutscene commands. Every command is at least 8 bytes long. Valid commands are 0x01-0x90, 0x3E8, and -1

{| class="wikitable"
!Marker
!Description
!Variables
!Usage
!Notes
|-
| <tt>0000000A</tt>
| Textbox
| <tt>0000xxxx</tt>
| '''x''' = Entries
|style="width: 30%"| End Frame waits for text/action to finish before continuing cutscene. The frame counter will be stopped at one less than the End Frame value
|-
|
| No Text
| <tt>FFFFssss eeeeFFFF
FFFFFFFF</tt>
|'''s''' = start frame '''e''' = end frame
|
|-
|
| Display Text
| <tt>iiiissss eeeeoooo
yyyynnnn</tt>
|'''i''' = [[Text Id|message id]] '''s''' = start frame '''e''' = end frame '''o''' = Type. Set 0 for standard dialog, 1 for yes/no branching dialog '''y''' = yes/no top option branch '''n''' = yes/no bottom option branch
|
|-
|
| Learn Song
| <tt>iiiissss eeee0002
mmmmFFFF</tt>
|'''i''' = [[#Play Song Action Ids|Play Song Action]] '''s''' = start frame '''e''' = end frame '''m''' = [[Text Id|message id]] displayed when making a mistake. 088B is used here.
|
|-
| <tt>0000005A</tt>
| Camera Data
| <tt>aaaaaaaa</tt>
|'''a''' = size of block
|See [[#Camera Data|Camera Data]]
|-
| <tt>00000096</tt>
| Performs Various Actions
|<tt>00000001 xxxxyyyy
zzzz[zzzz]</tt>
| '''00000001''' = constant? '''x''' = [[#0x96 Actions|Action]] '''y''' = start frame '''z''' = end frame (seems to be repeated)
|
|-
| <tt>00000097</tt>
| Lighting?
|<tt>00000001 xxxxyyyy
zzzz[zzzz]</tt>
| '''00000001''' = constant? '''x''' = '''y''' = start frame '''z''' = end frame (seems to be repeated)
|
|-
| <tt>00000098</tt>
| Scene Transition Effects?
|<tt>00000001 xxxxyyyy
zzzz[zzzz]</tt>
| '''00000001''' = constant? '''x''' = transition (probably the same as entrance/exit transitions) '''y''' = start frame '''z''' = end frame (seems to be repeated)
|
|-
| <tt>00000099</tt>
| Motion Blur
|<tt>aaaaaaaa
xxxxyyyy zzzz[zzzz]</tt>
| '''a''' = number of entries '''x''' = '''y''' = start frame '''z''' = end frame (seems to be repeated)
| 0001 = on, 0002 = off?
|-
| <tt>0000009A</tt>
| Gives Link Tatl
|<tt>00000001 xxxxyyyy
zzzz[zzzz]</tt>
| '''00000001''' = constant? '''x''' = 0001 only? '''y''' = start frame '''z''' = end frame (seems to be repeated)
|
|-
| <tt>0000009B</tt>
| Black Overlay?
|<tt>00000001 aaaabbbb
ccccdddd dd000000 </tt>
| '''00000001''' = constant? '''a''' = Fade type? '''b''' = start frame '''c''' = end frame (seems to be repeated) '''d''' = RGB Value
|
|-
| <tt>0000009C</tt>
| Unknown
|<tt>00000001 xxxxyyyy
zzzz[zzzz]</tt>
| '''00000001''' = constant? '''x''' = '''y''' = start frame '''z''' = end frame (seems to be repeated)
|
|-
| <tt>0000015E</tt>
| Cutscene Terminator
| <tt>00000001 xxxxyyyy
zzzz[zzzz]</tt>
| '''00000001''' = constant? '''x''' = '''y''' = start frame '''z''' = end frame (seems to be repeated)
|
|-
| <tt>FFFFFFFF</tt>
| Cutscene Terminator
| <tt>00000000</tt>
|
| Commands beyond this one will not be parsed, even if the number of commands is higher
|-
| <tt>0000aaaa</tt>
| Actor Command
| <tt>0000yyyy</tt>
| '''a''' = Marker, where '''a''' relates to a specific actor. '''y''' = Number of entries.
| Marker values are NOT the same numbers used to load an actor in a room.
|-
|
| Actor Path
| <tt>aaaabbbb ccccdddd</tt> <tt>???????? eeeeeeee</tt> <tt>ffffffff gggggggg</tt> <tt>hhhhhhhh iiiiiiii</tt> <tt>jjjjjjjj kkkkkkkk</tt> <tt>llllllll mmmmmmmm</tt>
|'''a''' = Actor Action/Animation '''b''' = Start frame for path. '''c''' = End frame for path. '''d''' = ? '''e''' '''f''' '''g''' = Path start vertex coordinate (x,y,z) '''h''' '''i''' '''j''' = Path end vertex coordinate (x,y,z) '''k''' '''l''' '''m''' = Vertex normal for the path, single precision floats.
|
|}

=== Play Song Action Ids ===

'''xxx'''

=== Camera Data ===

==== Camera Chunk Header ====
<tt>uuuussss llllllll</tt>

'''u''' = unknown (number of entries?) 
'''s''' = size 
'''l''' = length (frames) 

==== Camera Entries ====
First half of data appears to be focus, second half position.

<tt>bbaauuuu xxxxyyyy zzzz0000</tt>

'''b''' = Camera behaviour (use 05 if you don't know what to use) 
'''a''' = Factor (?) 
'''u''' = Unknown 
'''x''' = X-position 
'''y''' = Y-position 
'''z''' = Z-position 

==== Field of View ====

Values after the camera entries deal with the FOV for each entry.

<tt>xxxx0000 yyyy0000</tt>

'''x''' = Time (?) 
'''y''' = Field of View 

=== Actor Entities ===

{|class="wikitable"
! Marker
! Actor
! Action Param (v)
|-
|<tt>0064</tt>
| En_Elfgrp (Broken Great Fairy)
|
|-
|<tt>0065</tt>
| En_Dnp (Deku Princess)
|
|-
|<tt>0066</tt>
| Dm_Zl (Zelda)
|
|-
|<tt>0067</tt>
| Bg_Dy_Yoseizo
|
|-
|<tt>0068</tt>
| Bg_Ctower_Gear
|
|-
|<tt>0069</tt>
| En_Dnq (Deku King)
|
|-
|<tt>006B</tt>
| Dm_Stk (Skullkid)
|
|-
|<tt>006C</tt>
| En_Ge3
|
|-
|<tt>006D</tt>
| Dm_Char05
|
|-
|<tt>0070</tt>
| En_Horse (Epona)
|
|-
|<tt>0071</tt>
| Dm_Char00 (var 0000, Tatl)
|
|-
|<tt>0072</tt>
| Dm_Char00 (var 0001, Tael)
|
|-
|<tt>0073</tt>
| Dm_Opstage
|
|-
|<tt>0077</tt>
| En_Gg
|
|-
|rowspan=2|<tt>0078</tt>
| En_Ma_Yts
|
|-
| En_Ma4 (Romani)
|
|-
|<tt>0079</tt>
| En_Ge1
|
|-
|<tt>007C</tt>
| Bg_Open_Shutter
|
|-
|<tt>007D</tt>
| Bg_Open_Spot
|
|-
|<tt>007E</tt>
| En_Dnk
|
|-
|<tt>007F</tt>
| En_Mk (Professor)
|
|-
|<tt>0082</tt>
| En_Osn (Happy Mask Man)
|
|-
|<tt>0083</tt>
| Dm_Char02
|
|-
|<tt>0084</tt>
| Obj_Tokeidai
|
|-
|<tt>0085</tt>
| En_Fall
|
|-
|<tt>0086</tt>
| Obj_Tokei_Step
|
|-
|<tt>0087</tt>
| Dm_Char01
|
|-
|<tt>0088</tt>
| Dm_Char03 (Happy Mask Man)
|
|-
|<tt>00C8</tt>
| Player (Link)
| See [[#Link Action Parameters|Link Action Parameters]] below
|-
|<tt>00C9</tt>
| En_Elf (Tatl)
| '''0003''' Bounces up and down in a rhythmic pattern
|-
|<tt>01C2</tt>
| En_Fall
|
|-
|<tt>01C5</tt>
| En_Giant
|
|-
|<tt>01C6</tt>
| En_Giant
|
|-
|<tt>01C7</tt>
| En_Giant
|
|-
|<tt>01C8</tt>
| En_Giant
|
|-
|<tt>01C9</tt>
| En_Zoraegg
|
|-
|<tt>01CF</tt>
| Dm_Char06
|
|-
|<tt>01D5</tt>
| Bg_Haka_Curtain
|
|-
|<tt>01D6</tt>
| En_Jg
|
|-
|<tt>01D7</tt>
| En_Zog
|
|-
|<tt>01D8</tt>
| En_Dai
|
|-
|<tt>01D9</tt>
| Dm_Char05
|
|-
|<tt>01DA</tt>
| Dm_Char08
|
|-
|<tt>01DB</tt>
| En_Dno
|
|-
|<tt>01DC</tt>
| En_Ge2
|
|-
|<tt>01DF</tt>
| En_Gk
|
|-
|<tt>01E0</tt>
| Eff_Kamejima_Wave
|
|-
|<tt>01E2</tt>
| En_Po_Composer
|
|-
|<tt>01E3</tt>
| Obj_Hgdoor
|
|-
|<tt>01E4</tt>
| En_Hg
|
|-
|<tt>01E5</tt>
| En_Pamera
|
|-
|<tt>01E6</tt>
| En_Hgo
|
|-
|<tt>01F4</tt>
| En_Zob
|
|-
|<tt>01F5</tt>
| En_Zos
|
|-
|<tt>01F6</tt>
| Eff_Kamejima_Wave
|
|-
|<tt>01F7</tt>
| Dm_Char09
|
|-
|<tt>01F8</tt>
| En_Zov
|
|-
|<tt>01F9</tt>
| En_Test6
|
|-
|<tt>01FA</tt>
| En_Test3 (Kafei)
|
|-
|<tt>01FF</tt>
| Obj_Boat
|
|-
|<tt>0200</tt>
| Eff_Stk
|
|-
|<tt>0201</tt>
| Dm_Stk (Skullkid)
|
|-
|<tt>0202</tt>
| Dm_Tsg
|
|-
|<tt>0203</tt>
| En_Zod
|
|-
|<tt>0206</tt>
| Dm_Char05
|
|-
|<tt>020D</tt>
| En_Toto
|
|-
|<tt>020E</tt>
| En_Gm
|
|-
|<tt>020F</tt>
| Eff_Zoraband
|
|-
|<tt>0214</tt>
| En_Bsb
|
|-
|<tt>0226</tt>
| En_Rz
|
|-
|<tt>0227</tt>
| En_Rz
|
|-
|<tt>0228</tt>
| Obj_Usiyane
|
|-
|<tt>022C</tt>
| En_Ma_Yto (Cremia)
|
|-
|rowspan=3|<tt>022D</tt>
| En_An
|
|-
| Dm_An
|
|-
| Dm_Gm
|
|-
|<tt>022F</tt>
| Dm_Char05 (var 0003, Majora's Mask)
|
|-
|rowspan=3|<tt>0232</tt>
| Dm_Al
|
|-
| Dm_Ah
|
|-
| Dm_Nb
|
|-
|<tt>0235</tt>
| En_And
|
|-
|<tt>0238</tt>
| Dm_Bal
|
|-
|<tt>0239</tt>
| Door_Warp1
|
|-
|<tt>02C8</tt>
| En_Dns (Deku Palace Scrub)
|
|}

==== Link Action Parameters ====

'''0001''' Walking 
'''0002''' Walking 
'''0003''' Surprised 
'''0004''' Standing then stop 
'''0005''' Sleeping 
'''0006''' Turn around shocked 
'''0007''' Standing? 
'''0008''' Standing? 
'''0009''' Walk into warp 
'''000A''' Looking around 
'''000B''' Running from giant deku scrub 
'''000C''' Turns around and starts running 
'''000D''' Getting up? 
'''000E''' Looking down then forward? 
'''000F''' Being blessed by a restored temple fairy, lifted up 
'''0010''' Being blessed by a restored temple fairy, set back down 
'''0011''' Looks behind himself, then shakes head 
'''0012''' Standing, waving 
'''0013''' Staring at tatl 
'''0014''' Looks at ocarina (OoT Leftover?) 
'''0015''' Looks worn out 
'''0016''' Recieve item 
'''0017''' Looks to the side, shaking head 
'''0018''' Standing, frozen? 
'''0019''' Raises hand and shakes head 
'''001A''' Playing Ocarina 
'''001B''' Standing, frozen? 
'''001C''' Bows twice 
'''001D''' Riding epona 
'''001E''' Standing? 
'''001F''' Invisible? 
'''0020''' Standing? 
'''0021''' Standing? 
'''0022''' Sitting down, shaking head, then looks up 
'''0023''' Gets up, groggy 
'''0024''' Trying to catch skullkid 
'''0025''' Looking around 
'''0026''' On epona, looking behind 
'''0027''' Catches onto skullkid riding epona 
'''0028''' Holding onto skullkid riding epona 
'''0029''' On walking epona 
'''002A''' Falls off epona 
'''002B''' Tips over and falls 
'''002C''' Gets up and stares at ground 
'''002D''' Holds hand up in front of face 
'''002E''' Being transformed 
'''002F''' Deku Link shocked at reflection in water 
'''0030''' Runs after skullkid but tatl blocks him 
'''0031''' Unknown deku link animation 
'''0032''' Mask salesman shaking Link? 
'''0033''' Laying face down 
'''0034''' Holds hands, then looks up with arms out to sides (unused?) 
'''0035''' Falling down on back 
'''0036''' Looking around 
'''0037''' Link dazed/confused? 
'''0038''' Shielding face with hands 
'''0039''' Invisible? 
'''003A''' Sitting, looking around 
'''003B''' Looks down scratching back of head 
'''003C''' Charging spin attack 
'''003D''' Slips then falls on butt? 
'''003E''' Doing situps 
'''003F''' Doing situps 
'''0040''' Hands behind back and jumping forward 
'''0041''' Doing pushups 
'''0042''' Leans forward 
'''0043''' Standing, frozen? 
'''0044''' No idea what he's doing 
'''0045''' Pretends to be a scary monster? 
'''0046''' Pulls item out for mailbox 
'''0047''' Being shaken by mask salesman 
'''0048''' Takes out item to show 
'''0049''' Creates elegy of emptiness statue 
'''004A''' Posing in an odd stance 
'''004B''' Gets on epona and looks to the right 
'''004C''' On epona, nods and looks forward 
'''004D''' On epona, stares up, moves backwards? 
'''004E''' Posing in an odd stance 
'''004F''' Posing in an odd stance 
'''0050''' Standing, holding shield up? 
'''0051''' Hugging cremia 
'''0052''' Grabbing something and pulling it towards himself 
'''0053''' Holding something 
'''0054''' Holding something 
'''0055''' Holding something back? 
'''0056''' Sitting down 
'''0057''' Sitting down, looking around 
'''0058''' Sitting down, waving 
'''0059''' Dance learned from kamaro 
'''005A''' Salute 

=== 0x96 Actions ===

'''0014''' Fade in title screen 
'''0015''' Fade out title screen 
'''0021''' Set entered clocktown for the first time flag 
'''0026''' Set day to day 9 

[[Category: Cutscenes| Cutscenes]]

@@ Line 260: / Line 260: @@
 Values after the camera entries deal with the FOV for each entry.
-<tt>xxxxrrrr ffffuuuu</tt>
+<tt>llllrrrr ffffuuuu</tt>
-'''x''' = Time (?)<br>
+'''l''' = Length (in frames)<br>
 '''r''' = Rotation<br>
 '''f''' = Field of View<br>

@@ Line 264: / Line 264: @@
 '''x''' = Time (?)<br>
 '''r''' = Rotation<br>
-'''y''' = Field of View<br>
+'''f''' = Field of View<br>
 '''u''' = Unknown<br>

@@ Line 232: / Line 232: @@
 ==== Camera Chunk Header ====
-<tt>uuuussss llllllll</tt>
+<tt>eeeessss llllllll</tt>
-'''u''' = unknown (number of entries?)<br>
+'''e''' = number of entries<br>
 '''s''' = size<br>
 '''l''' = length (frames)<br>
@@ Line 241: / Line 241: @@
 First half of data appears to be focus, second half position.
-<tt>bbaauuuu xxxxyyyy zzzz0000</tt>
+<tt>ccddeeee xxxxyyyy zzzzaaaa</tt>
-'''b''' = Camera behaviour (use 05 if you don't know what to use)<br>
+'''c''' = Camera behaviour (use 05 if you don't know what to use)<br>
-'''a''' = Factor (?)<br>
+'''d''' = Factor (?)<br>
-'''u''' = Length (in frame)<br>
+'''e''' = End frame<br>
 '''x''' = X-position<br>
 '''y''' = Y-position<br>
 '''z''' = Z-position<br>
 ==== Field of View ====
@@ Line 254: / Line 260: @@
 Values after the camera entries deal with the FOV for each entry.
-<tt>xxxx0000 yyyy0000</tt>
+<tt>xxxxrrrr ffffuuuu</tt>
 '''x''' = Time (?)<br>
 '''y''' = Field of View<br>
 === Actor Entities ===

@@ Line 245: / Line 245: @@
 '''b''' = Camera behaviour (use 05 if you don't know what to use)<br>
 '''a''' = Factor (?)<br>
-'''u''' = Lenght (in frame)<br>
+'''u''' = Length (in frame)<br>
 '''x''' = X-position<br>
 '''y''' = Y-position<br>

@@ Line 245: / Line 245: @@
 '''b''' = Camera behaviour (use 05 if you don't know what to use)<br>
 '''a''' = Factor (?)<br>
-'''u''' = Unknown<br>
+'''u''' = Lenght (in frame)<br>
 '''x''' = X-position<br>
 '''y''' = Y-position<br>

@@ Line 693: / Line 693: @@
 === 0x96 Actions ===
 '''0014''' Fade in title screen<br>
 '''0015''' Fade out title screen<br>
 '''0021''' Set entered clocktown for the first time flag<br>
 '''0026''' Set day to day 9<br>
 [[Category: Cutscenes| Cutscenes]]

@@ Line 212: / Line 212: @@
 | 0020 || Play back part of Goron Lullaby
 |-
-| 0021 || Play back Link's part of Ballad of the Wind Fish
+| 0021 || Play back Ballad of the Wind Fish (Link)
 |-
-| 0022 || Play back Goron Link's part of Ballad of the Wind Fish
+| 0022 || Play back Ballad of the Wind Fish (Goron)
 |-
-| 0023 || Play back Zora Link's part of Ballad of the Wind Fish
+| 0023 || Play back Ballad of the Wind Fish (Zora)
 |-
-| 0024 || Play back Deku Link's part of Ballad of the Wind Fish
+| 0024 || Play back Ballad of the Wind Fish (Deku)
 |-
-| 0025 || Play back Right Right Down A A Down Right A
+| 0025 || Play back Zora Jam Session I
 |-
-| 0026 || Play back Left Left Right Down Down Right Left Down
+| 0026 || Play back Zora Jam Session II
 |-
 | 0027 || Play back Zelda's Lullaby

@@ Line 145: / Line 145: @@
 === Play Song Action Ids ===
-'''xxx'''
+{|class="wikitable"
 === Camera Data ===