Cutscenes - Revision history

Super Hackio: tools

2026-04-30T18:05:46Z

tools

← Older revision		Revision as of 18:05, 30 April 2026
Line 371:		Line 371:

	==Tools==		==Tools==
	Up to now, there are no tools that allow the cutscenes to be edited directly in a clear interface. Since the cutscenes sheet consists of [[BCSV]] files, they can be edited with any other BCSV editor, like Whitehole. They can also be converted to CSV files and vice versa with Pyjmap.		The tools can be found on the [https://www.lumasworkshop.com/tools/ tools and libraries page].

	The tools can be found on the [~~[Tools_and_Resources\|~~tools and ~~ressources~~ page]].

Super Hackio: /* Player */ MarioAnime not MarioAnim lol

2025-10-15T20:02:06Z

Player: MarioAnime not MarioAnim lol

← Older revision		Revision as of 20:02, 15 October 2025
Line 207:		Line 207:
	\| BckName		\| BckName
	\| style="font-size:12px;" \| STRING_OFFSET		\| style="font-size:12px;" \| STRING_OFFSET
	\| Name of the animation from ~~MarioAnim~~.arc to play. (All other animationtypes than BCK are also supported)		\| Name of the animation from /ObjectData/MarioAnime.arc to play. (All other animationtypes than BCK are also supported)
	\|-		\|-
	\| Visible		\| Visible

Louis Miles: /* Action */

2025-06-19T12:33:51Z

Action

← Older revision		Revision as of 12:33, 19 June 2025
Line 88:		Line 88:
	\| CastName		\| CastName
	\| style="font-size:12px;" \| STRING_OFFSET		\| style="font-size:12px;" \| STRING_OFFSET
	\| Name of the target object. Either Japanese name defined in [[ObjNameTable]], or ''ModelName'' ~~name~~ defined in [[ProductMapObjDataTable]].		\| Name of the target object. Either Japanese name defined in [[ObjNameTable]], or ''ModelName'' defined in [[ProductMapObjDataTable]].
	\|-		\|-
	\| CastID		\| CastID

Louis Miles: /* Action */

2025-06-19T12:28:40Z

Action

← Older revision		Revision as of 12:28, 19 June 2025
Line 88:		Line 88:
	\| CastName		\| CastName
	\| style="font-size:12px;" \| STRING_OFFSET		\| style="font-size:12px;" \| STRING_OFFSET
	\| ~~Japanese~~ Name of the object (defined in [[ObjNameTable]])		\| Name of the target object. Either Japanese name defined in [[ObjNameTable]], or ''ModelName'' name defined in [[ProductMapObjDataTable]].
	\|-		\|-
	\| CastID		\| CastID
	\| style="font-size:12px;" \| LONG		\| style="font-size:12px;" \| LONG
	\| Cast ID of the object		\| Optional Cast ID of the target object. -1 = Deactivated.<br>
			To target a specific object among identical objects that are part of the cutscene.
	\|-		\|-
	\| ActionType		\| ActionType

Super Hackio: /* Camera */

2025-03-21T16:31:03Z

Camera

← Older revision		Revision as of 16:31, 21 March 2025
Line 234:		Line 234:
	\| CameraTargetName		\| CameraTargetName
	\| style="font-size:12px;" \| STRING_OFFSET		\| style="font-size:12px;" \| STRING_OFFSET
	\| Japanese Name of the object the camera is ~~focussed at~~.		\| Japanese Name of the object the camera is focused to. (Primarily uses ObjNameTable names)
	\|-		\|-
	\| CameraTargetCastID		\| CameraTargetCastID
Line 242:		Line 242:
	\| AnimCameraName		\| AnimCameraName
	\| style="font-size:12px;" \| STRING_OFFSET		\| style="font-size:12px;" \| STRING_OFFSET
	\| CANM file name (~~with~~ ".canm" extension) which must be placed in the root of the targeted object's archive.		\| CANM file name (".canm" extension optional) which must be placed in the root of the targeted object's archive.
	\|-		\|-
	\| AnimCameraStartFrame		\| AnimCameraStartFrame
	\| style="font-size:12px;" \| LONG		\| style="font-size:12px;" \| LONG
	\|		\| The part frame to begin the camera on. -1 will have the camera interpolate to the start of the CANM
	\|-		\|-
	\| AnimCameraEndFrame		\| AnimCameraEndFrame

Louis Miles at 12:21, 27 April 2024

2024-04-27T12:21:23Z

← Older revision		Revision as of 12:21, 27 April 2024
Line 18:		Line 18:
	In addition, the demo object has its own cutscene name, which is only used in certain cases (e.g. to load certain sequences for [[Starship Mario]]) and also for camera codes. Certain names can be recognized by the game and then loads additional hardcoded settings such as behavior after scene completion. A list of these names [[Cutscenes#Hardcoded_Cutscene_Names\|can be found below]].		In addition, the demo object has its own cutscene name, which is only used in certain cases (e.g. to load certain sequences for [[Starship Mario]]) and also for camera codes. Certain names can be recognized by the game and then loads additional hardcoded settings such as behavior after scene completion. A list of these names [[Cutscenes#Hardcoded_Cutscene_Names\|can be found below]].

	Objects other than the player object itself can be linked to the cutscene. These then use a cutscene group ID, which on the one hand must match the demo object ID and on the other hand must be entered in the action sheet together with the ~~Japanese~~ name of the object ~~(defined~~ in [[ObjNameTable]]).		Objects other than the player object itself can be linked to the cutscene. These then use a cutscene group ID, which on the one hand must match the demo object ID and on the other hand must be entered in the action sheet together with the object's name. If the object is entered in the [[ObjNameTable]], the name from the Japanese column must be entered instead.

	If there are several identical objects that are part of a cutscene, you can also define a cast group id for one specific object to distinguish it from the other identical objects for the scene.		If there are several identical objects that are part of a cutscene, you can also define a cast group id for one specific object to distinguish it from the other identical objects for the scene.
Line 271:		Line 271:
	\| Bgm		\| Bgm
	\| style="font-size:12px;" \| STRING_OFFSET		\| style="font-size:12px;" \| STRING_OFFSET
	\|		\| [[List_of_Music\|Name of the music]] to play.
	\|-		\|-
	\| SystemSe		\| SystemSe
	\| style="font-size:12px;" \| STRING_OFFSET		\| style="font-size:12px;" \| STRING_OFFSET
	\|		\| [[List_of_Sounds_(SMG2)\|Name of the soundeffect]] to play.
	\|-		\|-
	\| ActionSe		\| ActionSe
Line 287:		Line 287:
	\| BgmWipeoutFrame		\| BgmWipeoutFrame
	\| style="font-size:12px;" \| LONG		\| style="font-size:12px;" \| LONG
	\|		\| Duration in frames for fading out the music. -1 = No fade-out
	\|-		\|-
	\| AllSoundStopFrame		\| AllSoundStopFrame

Super Hackio: Add Action Types for SMG1 (apparently they are just shifted mostly...)

2024-03-16T14:11:03Z

Add Action Types for SMG1 (apparently they are just shifted mostly...)

@@ Line 108: / Line 108: @@
 ====Action Types====
 Note that these action types are not available for any object that registers as a "Simple Demo Cast".
 {| class="wikitable"
 ! ID !! Name !! Description
@@ Line 339: / Line 373: @@
 The tools can be found on the [[Tools_and_Resources|tools and ressources page]].

MTLenz: Created page with "Category:Files Category:Lists {{WIP}} '''Todo:''' Finish the hardcoded cutscene names. More info and research on the use of canm and supported objects. Cutscenes are flexible, complex scenes, which can execute more freedom in contrast to the SimpleDemoExecutor. These scenes consist of individual sequences that are played in order. In each sequence, several actions can be executed from certain frames, such as changing the player's position, came..."

2024-01-23T21:21:39Z

Created page with "Category:Files Category:Lists {{WIP}} '''Todo:''' *Finish the hardcoded cutscene names. *More info and research on the use of canm and supported objects. Cutscenes are flexible, complex scenes, which can execute more freedom in contrast to the SimpleDemoExecutor. These scenes consist of individual sequences that are played in order. In each sequence, several actions can be executed from certain frames, such as changing the player's position, came..."

New page

[[Category:Files]]
[[Category:Lists]]
{{WIP}}
'''Todo:'''
*Finish the hardcoded cutscene names.
*More info and research on the use of canm and supported objects.

Cutscenes are flexible, complex scenes, which can execute more freedom in contrast to the SimpleDemoExecutor.
These scenes consist of individual sequences that are played in order. In each sequence, several actions can be executed from certain frames, such as changing the player's position, camera movements, sound effects, and more. To each sequence (and subsequence) different actions are linked, which are then executed at the time of this sequence.

You can best visualize this in a kind of timeline. The timeline consists of the individual sequences, which consist of several actions. At the same time single subscequences can be executed together with the actual sequences.

==Structure==
[[File:Cutscene_Visual-Representation.png|thumb|A visual representation of the first Yoshi Meets cutscene.]]
A cutscene is activated by a demo object via SW_APPEAR within the map and loads several sheet BCSV files located in the demo.arc archive of the respective galaxy/zone. The demo object loads the bcsv files using its defined sheet name and additional "Demo" in front of the file name of the BSCV attached and a respective sheet type at the end of the file name (e.g. '''Demo'''AfterGameOver'''Time''').

In addition, the demo object has its own cutscene name, which is only used in certain cases (e.g. to load certain sequences for [[Starship Mario]]) and also for camera codes. Certain names can be recognized by the game and then loads additional hardcoded settings such as behavior after scene completion. A list of these names [[Cutscenes#Hardcoded_Cutscene_Names|can be found below]].

Objects other than the player object itself can be linked to the cutscene. These then use a cutscene group ID, which on the one hand must match the demo object ID and on the other hand must be entered in the action sheet together with the Japanese name of the object (defined in [[ObjNameTable]]).

If there are several identical objects that are part of a cutscene, you can also define a cast group id for one specific object to distinguish it from the other identical objects for the scene.

===Time===
Defines the individual sequences with their names and length. They are played in the order they are in the list.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| TotalStep
| style="font-size:12px;" | LONG
| Duration of the sequence in frames
|-
| SuspendFlag
| style="font-size:12px;" | LONG
| If set to 1, pauses the cutscene and resumes gameplay. The cutscene will continue from here next time it is activated.
|-
| WaitUserInputFlag
| style="font-size:12px;" | LONG
|
|}

===SubPart===
Runs additional subsequences in parallel during a sequence.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| SubPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sub sequence
|-
| SubPartTotalStep
| style="font-size:12px;" | LONG
| The length of the sub sequence
|-
| MainPartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the main sequence this sub sequence belongs to
|-
| MainPartStep
| style="font-size:12px;" | LONG
| The frame of the main sequence this sub sequence starts at
|}

===Action===
Picks up objects and can position them to a given GeneralPos and play an animation.

All animation types are supported. For more control you can use [[ActorInfo#ActorInfo|ActorAnimCtrl.bcsv]] for your objects to define multiple animation names of different animation types to the animation name defined in the cutscene.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Sequence Name
|-
| CastName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object (defined in [[ObjNameTable]])
|-
| CastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| ActionType
| style="font-size:12px;" | LONG
| Pick an Action Type from the table below.
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos object for destination location
|-
| AnimName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation, which can be loaded either from the ARC archive object or from a separate ARC archive with the additional name "Anim".
|}
====Action Types====
Note that these action types are not available for any object that registers as a "Simple Demo Cast".
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || Play Animation || Plays the animation that "AnimName" is set to. This happens for all Action Types.
|-
| 1 || Apppear || Makes the object Appear.
|-
| 2 || Kill || Makes the object Disappear (using it's Kill function).
|-
| 3 || Special Function || Executes a function that the object specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 4 || Special Nerve || Sets the objects Nerve to a nerve specifically registered to the cutscene. This is object specific, and not every object has one.
|-
| 5 || On SW_A || The SW_A of this object will be activated.
|-
| 6 || On SW_B || The SW_B of this object will be activated.
|-
| 7 || Show Model || The model of the object will be unhidden.
|-
| 8 || Hide Model || The model of the object will be hidden.
|-
| 9 || Start NPC Message || Start a conversation with an NPC. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 10 || Start NPC Message (Alt) || Start a conversation with an NPC without stopping Mario's current animation. Effectively useless because NPC's do not register their text to cutscenes unless the cutscene has a specific name.
|-
| 11 || Duplicate of 10 || Duplicate of 10.
|-
| 12 || Off SW_A || The SW_A of this object will be deactivated.
|-
| 13 || Off SW_B || The SW_B of this object will be deactivated.
|-
| 14 || Request Movement Off || Tries to pause execution of this object.
|-
| 15 || Request Movement On || Tries to resume execution of this object.
|-
| 16 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 1 as arg.
|-
| 17 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo. Uses 0 as arg.
|-
| 18 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 19 || StoryBookWarpDemo || Unknown. Related to StoryBookWarpDemo.
|-
| 20 || ? || Unknown. Used at the end of the cutscene where Mario meets Yoshi for the first time.
|}

===Player===
Can position Mario/Luigi to a specific GeneralPos and play an animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| PosName
| style="font-size:12px;" | STRING_OFFSET
| Name of the GeneralPos to teleport the player to
|-
| BckName
| style="font-size:12px;" | STRING_OFFSET
| Name of the animation from MarioAnim.arc to play. (All other animationtypes than BCK are also supported)
|-
| Visible
| style="font-size:12px;" | LONG
|
|}

===Camera===
Can play cameras, which can be played one after another. Can use either a camera code from the Map archive's [[Cameras|CameraParam.bcam]] file, or a key frame camera animation which are controlled via [[CANM]] files, which must be located in the object archive of the targeted object.
By default the camera is fixed on Mario/Luigi.

For BCAM usage, the Camera ID name to be used is composed of the ''PartName'' and the ''Cutscenename'' (not the sheet name): '''e:Cutscenename[PartName]'''.

For CANM usage, the name defined in ''AnimCameraName'' must match the CANM file's name and needs to be placed in the root of the targeted object's archive.
Seems to be supported only by certain objects. This has not yet been fully explored.

{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| CameraTargetName
| style="font-size:12px;" | STRING_OFFSET
| Japanese Name of the object the camera is focussed at.
|-
| CameraTargetCastID
| style="font-size:12px;" | LONG
| Cast ID of the object
|-
| AnimCameraName
| style="font-size:12px;" | STRING_OFFSET
| CANM file name (with ".canm" extension) which must be placed in the root of the targeted object's archive.
|-
| AnimCameraStartFrame
| style="font-size:12px;" | LONG
|
|-
| AnimCameraEndFrame
| style="font-size:12px;" | LONG
|
|-
| IsContinuous
| style="font-size:12px;" | LONG
|
|}

===Sound===
Can change music and play sound effects.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| Bgm
| style="font-size:12px;" | STRING_OFFSET
|
|-
| SystemSe
| style="font-size:12px;" | STRING_OFFSET
|
|-
| ActionSe
| style="font-size:12px;" | STRING_OFFSET
|
|-
| ReturnBgm
| style="font-size:12px;" | LONG
|
|-
| BgmWipeoutFrame
| style="font-size:12px;" | LONG
|
|-
| AllSoundStopFrame
| style="font-size:12px;" | LONG
|
|}

===Wipe===
Can perform a fade out animation.
{| class="wikitable"
|-
! Field Name
! Type
! Description
|-
| PartName
| style="font-size:12px;" | STRING_OFFSET
| Name of the sequence
|-
| WipeName
| style="font-size:12px;" | STRING_OFFSET
| The wipe to use. See the [[#WipeName|WipeName]] table below.
|-
| WipeType
| style="font-size:12px;" | LONG
| The function for the Wipe to perform. See the [[#WipeType|WipeType]] table below.
|-
| WipeFrame
| style="font-size:12px;" | LONG
| The amount of frames that the wipe will move for. Higher values = Slower movement
|}

====WipeName====
Below is a list of available WipeName values:
{| class="wikitable"
|-
! Value !! Description
|-
| 円ワイプ || Circle Wipe
|-
| フェードワイプ || Black Fade
|-
| 白フェードワイプ || White Fade
|-
| ゲームオーバー || Game Over
|-
| クッパ || Bowser Face (Death wipe)
|}

''Note: The Mario wipe is missing because the Mario wipe is a System Wipe and not a Scene Wipe. DemoWipes can only be Scene Wipes.''

====WipeType====
Below is the list of Wipe functions. The table below uses the Black Fade as an example.
{| class="wikitable"
|-
! Value !! Description
|-
| 0 || Open Wipe (Fade to Gameplay)
|-
| 1 || Close Wipe (Fade to Black)
|-
| 2 || Force Open Wipe (Cut to Gameplay)
|-
| 3 || Force Close Wipe (Cut to Black)
|}

''Tip: If you need to change wipes while the wipe is closed, use Force Close before using Open for a smoother transition.''

===Hardcoded Cutscene Names===
'''Todo:''' Finish this.
{| class="wikitable"
|-
! Cutscene Name
! Meaning
! Notes
|-
| ベビチコ出会い
| Master Luma Meeting
| -Uses hardcoded cameras -Activates spin after completion when the galaxy uses the StageType "Storybook"
|}

==Tools==
Up to now, there are no tools that allow the cutscenes to be edited directly in a clear interface. Since the cutscenes sheet consists of [[BCSV]] files, they can be edited with any other BCSV editor, like Whitehole. They can also be converted to CSV files and vice versa with Pyjmap.

The tools can be found on the [[Tools_and_Resources|tools and ressources page]].

The on hold level editor ''Takochu'' has a BCSV editor that can open and edit multiple BCSV at once. This can make cutscene editing easier.