Scene - Revision history

imported>Leoetlino: add info about Starting event flows

2019-10-12T22:02:46Z

add info about Starting event flows

← Older revision		Revision as of 22:02, 12 October 2019
Line 25:		Line 25:

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

			== Starting event flows ==
			An event flow can be scheduled to start immediately after a scene change is completed, right before control is yielded to the player. For the scene change actions mentioned above, the parameters <code>EvflName</code> and <code>EntryPointName</code> can be used to specify a custom event flow.

			That same system is also used for game-initiated scene changes (e.g. reloading a save or going to the title screen). In such cases, [[GameScene]] automatically determines which event flow and entry point to use during [[GameScene#Stage generation step 11-5b]].

	[[Category:Internals]]		[[Category:Internals]]

imported>Leoetlino at 21:55, 12 October 2019

2019-10-12T21:55:29Z

← Older revision		Revision as of 21:55, 12 October 2019
Line 1:		Line 1:
	Scene changes ~~— which~~ are essentially warps that trigger loading screens ~~—~~ can be explicitly triggered with three different actions: ChangeScene, FromCDungeonToMainField and ToCDungeon.		''Not to be confused with [[map]]s, [[Map unit\|map units]] or [[Stage\|stages]]''.

			<onlyinclude>'''Scenes'''<ref>"SceneWorkTime" @ 0x7100A89528 (Switch 1.5.0)</ref> are active instances of a [[stage]]. By design, exactly one scene is active at a time. The active scene is managed by [[GameScene]], which is responsible for generating and unloading stages and changing to another scene.</onlyinclude>

			== Scene changes ==
			In practice, '''scene changes''' are essentially warps that trigger loading screens. They 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.		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.
Line 5:		Line 10:
	Scene changes can also be triggered from [[AIDef:Action/AreaRoot]].		Scene changes can also be triggered from [[AIDef:Action/AreaRoot]].

	== Actions ==		=== Actions ===
	=== ChangeScene ===		==== ChangeScene ====
	{{link to article\|link=AIDef:Action/ChangeScene}}		{{link to article\|link=AIDef:Action/ChangeScene}}

	=== FromCDungeonToMainField ===		==== FromCDungeonToMainField ====
	{{link to article\|link=AIDef:Action/FromCDungeonToMainField}}		{{link to article\|link=AIDef:Action/FromCDungeonToMainField}}

	=== ToCDungeon ===		==== ToCDungeon ====
	{{link to article\|link=AIDef:Action/ToCDungeon}}		{{link to article\|link=AIDef:Action/ToCDungeon}}

	== Warp cutscene ==		=== Warp cutscene ===

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

imported>Leoetlino: Leoetlino moved page Scene changes to Scene

2019-10-12T21:53:21Z

Leoetlino moved page Scene to Scene

← Older revision	Revision as of 21:53, 12 October 2019
(No difference)

imported>Leoetlino: mention AIDef:Action/AreaRoot

2019-06-02T15:17:33Z

mention AIDef:Action/AreaRoot

← Older revision		Revision as of 15:17, 2 June 2019
Line 2:		Line 2:

	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.		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.

			Scene changes can also be triggered from [[AIDef:Action/AreaRoot]].

	== Actions ==		== Actions ==

imported>Leoetlino at 18:57, 14 October 2018

2018-10-14T18:57:22Z

@@ Line 5: / Line 5: @@
 == Actions ==
 === ChangeScene ===
-{|class="wikitable"
+{{link to article|link=AIDef:Action/ChangeScene}}
 === FromCDungeonToMainField ===
-{|class="wikitable"
+{{link to article|link=AIDef:Action/FromCDungeonToMainField}}
 === ToCDungeon ===
-{|class="wikitable"
+{{link to article|link=AIDef:Action/ToCDungeon}}
 == Warp cutscene ==

imported>Leoetlino at 18:41, 29 September 2018

2018-09-29T18:41:13Z

← Older revision		Revision as of 18:41, 29 September 2018
Line 62:		Line 62:

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

			[[Category:Internals]]

imported>Leoetlino: import from https://github.com/leoetlino/botw-re-notes/blob/master/scene_changes.md

2018-09-29T18:41:04Z

import from https://github.com/leoetlino/botw-re-notes/blob/master/scene_changes.md

New page

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 ===
{|class="wikitable"
! 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 ===
{|class="wikitable"
! 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 <code>CDungeon/%s</code> and <code>Entrance_1</code> respectively.

The dungeon map name is determined from the player’s coordinates and location markers in <code>Map/MainField/Static.mubin</code>. The coordinates of each <code>Dungeon</code> 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 <code>SaveFlag</code> name (e.g. Location_Dungeon051 -> Dungeon051) and used as the warp destination map name.

=== ToCDungeon ===
{|class="wikitable"
! 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 <code>MainField/%s</code> [new map name, e.g. A-1] and <code>%s</code> [current map name, e.g. CDungeon100_1] respectively.

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

== Warp cutscene ==

[[Demo|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 <code>ClearRemains</code> is used when completing a Divine Beast. The main difference between <code>CommonFunc</code> and <code>ClearRemains</code> is the warp effect (sound and visual).