Scene

From ZeldaMods (Breath of the Wild)
Revision as of 18:41, 29 September 2018 by imported>Leoetlino (import from https://github.com/leoetlino/botw-re-notes/blob/master/scene_changes.md)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Scene changes — which are essentially warps that trigger loading screens — can be explicitly triggered with three different actions: ChangeScene, FromCDungeonToMainField and ToCDungeon.

All three actions are very similar; in fact they share the same base class. However, the first one is the most flexible action since the other two can only be used for shrines.

Actions

ChangeScene

Key Type Example Description
WarpDestMapName str MainFieldDungeon/RemainsFire

MainField/A-1

WarpDestPosName str StartR
FadeType int 0
StartType int 0
EvflName str Demo622_1 Name of the event flow to start after warp is complete
EntryPointName str Demo622_1 Name of the entry point in the event flow

Exported by EventSystemActor as Demo_ChangeScene.

FromCDungeonToMainField

Key Type Example Description
StartType int 0
EvflName str Demo008_4 Name of the event flow to start after warp is complete
EntryPointName str Demo622_1 Name of the entry point in the event flow

Exported by EventSystemActor as Demo_FromCDunToMainField.

Special purpose variant of ChangeScene which automatically sets WarpDestMapName and WarpDestPosName to CDungeon/%s and Entrance_1 respectively.

The dungeon map name is determined from the player’s coordinates and location markers in Map/MainField/Static.mubin. The coordinates of each Dungeon marker are compared with the player’s; if Link is within 100 distance units of (x,y,z) the dungeon name is extracted from the SaveFlag name (e.g. Location_Dungeon051 -> Dungeon051) and used as the warp destination map name.

ToCDungeon

Key Type Example Description
StartType int 0
EvflName str Demo008_2 Name of the event flow to start after warp is complete
EntryPointName str Demo622_1 Name of the entry point in the event flow

Exported by EventSystemActor as Demo_ToCDungeon.

Special purpose variant of ChangeScene which automatically sets WarpDestMapName and WarpDestPosName to MainField/%s [new map name, e.g. A-1] and %s [current map name, e.g. CDungeon100_1] respectively.

The new map name is determined using Map/MainField/Static.mubin and the current map name.

Warp cutscene

Demo005_1 is used as the event flow for most warps, for example when fast travelling to shrines, towers, Travel Medallion and Divine Beasts.

Entry point ClearRemains is used when completing a Divine Beast. The main difference between CommonFunc and ClearRemains is the warp effect (sound and visual).