GameScene: Difference between revisions

Unlike most other subsystems, GameScene is not a singleton: it is a member of the uking::frm::System structure<ref>uking::frm::System::gameScene @ 0x10 (Switch)</ref>.

Also called scenes in XLink code.

{| class="wikitable"

Maps that have the same stage type typically use the same subsystems and share most characteristics. For example, all open world stages use the [[Tera]] height map terrain system and load [[Map unit|map units]] in the same way.

{| class="wikitable"

|-

|-

|-

|-

|-

|-

|}

|-

|-

|-

|}

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|-

|}

The initial state the game launches into is determined by GameScene<ref>GameScene::initialize, 0x71007A86CC</ref>.

</source>

Note: when the Indoor stage binder is initialised and if the map name changes, a "dungeon" [[telemetry]] report is emitted with "leave" or "enter" as the event name and the old/new map name as additional data<ref>StageBinder::initAndReportDungeonLeaveEnter{{un}} at 0x71007B79A8</ref>.

{{empty section}}

{{empty section}}

Entered before stage generation starts and after Fade (loading screen) has been initialised and made visible. This state machine state is a noop.

LunchTitle (sic) is entered when the game is launched. The internal state string is "TitleMenu" or (in demo mode) "2nd".

The run function is extremely simple: it simply creates the TitleStage binder (with doNotShowLogo=true<ref>0x71007B47D8</ref>) when the "common run" status (see below) is 0xa, then calls the "common run" function (with isNewSave=false<ref>0x71007B47F4</ref>).

{{expand section}}

Entered on the first boot or when the new game option is selected. The associated state string is "初回シーケンス" ("initial sequence").

{{empty section}}

Three GameScene functions are called in a row from RootTask (see [[Executable]]) after initialisation has completed, i.e. in the game's main loop. (Note: these 3 names are unofficial.)

*FadeProgress: Update the progress gauge on the Fade screen (animated).

*Update current map name based on player position (when Link is not in a dungeon).

**If any [[Blood moon#Panic Blood Moons|panic condition]] is true, and if panic blood moons are enabled<ref>GameConfig::sInstance->disablePanicBloodMoons (@ 0x3da on Switch 1.5.0) must be false.</ref>, request a panic blood moon by setting a SkyMgr flag. SkyMgr will start a 90 frame timer (3 seconds) and set a ready flag once it has expired. The timer is reset every time the panic blood moon is temporarily inhibited.

{{empty section}}

{{empty section}}

Called from StageSelectRun, LunchTitleRun and NewSaveRun.

***Finish startup logo (Switch)<ref>0x71007AF6F8</ref>

***If the state string is set to 初回シーケンス, clear the Resource system cache ("ClearAllCaches")<ref>0x71007AFBDC</ref>.

***E3 Demo stuff<ref>0x71007AFEF4</ref>.

***Show the Fade screen (loading screen) if the state string does ''not''<ref>0x71007AFF08</ref> end with "Viewer" or is ''not'' any of the following strings: 1st, 2nd, Presentation, TitleMenu, 初回シーケンス, StartupSaveCheckStage

****Otherwise, only open the Fade screen but do not show loading progress<ref>See function at 0x71007B0C60</ref>.

***StageSelect stuff<ref>0x71007B0000</ref>.

***BaseProcMgr: start ActorCreate initializer thread<ref>0x71011BF1C4</ref>{{check}}.

***FadeProgress: reset internal state<ref>0x71007B01D4</ref>, set progress to 0%<ref>0x71007B01E0</ref> and mark loading as active<ref>0x71007B01E8</ref>.

**If the GameScene state machine's current state is StageSelect or NewSave, do something involving LayerMgrTask and the Renderer.{{check}}

**TipsMgr: update tips if the loading screen is ''visible'' (not just opened). TipsMgr will load tips depending on the stage that is being loaded.

**PlacementMgr

**ActorSystem::sInstance->field_13A = 0

**If the stage to load is TitleStage, load Layout/Title.blarc for ui::LayoutResourceMgr.

**If "new save" was selected and the awakening demo hasn't been played since the game was launched<ref>0x71007ADB3C</ref>, ask [[EventMgr]] to call Demo169_0.

***'''Set loading progress to 40%.'''

***Graphics stuff, again

***OnUiActorMgr

***GameScene::loadTera (on a separate thread)

***Wait for Tera to load<ref>tera読み込み待ち</ref>

**...{{check}}

**Wait for Tera to generate collision

**...{{check}}

**Initialize [[QuestMgr]].

**'''Set loading progress to 60%.'''

**Load stage specific resources<ref>ステージ固有リソースの読み込み待ち</ref>: if the binder type is StageBinderType::Title (3), the Title layout archive is loaded by [[LayoutResourceMgr]]. Otherwise, nothing happens.

**[[#Stage generation step 11]]

**Update player saved position, map type, map name, ...

**Set flag 0xa25 (genStageStep12Reached?{{check}}) on the Fade screen instance.

**Stop resource compaction and set some flags on the TextureHandleMgr.

**Set aoc2 flag 0x4 if <code>isNewSave || !isShrine || isStageDebug</code> and clear it otherwise.

**[[#Stage generation step 12]]

**Terrain stuff again{{check}}

**[[#Stage generation final step]]

**Various flags are set upon completion, for example GameScene stage status is set to 0, isInitializingStage is set to false, etc.

**GameScene::sNeedsOptionLoad is set to true.

**Various flags are set (GameScene, BaseProcMgr, Awareness, EventMgr), in particular field 0x1d12a is set to true if <code>!isNewSave</code>.

**Set initial position based on the stage binder. This may be overridden with a saved position or an event position later on.

**Graphics, uiManager, agl::lyr::Renderer: ?{{check}}

**Set this->activeStageBinder (@ 0x2a0) to this->stageBinder (@ 0x2a8)<ref>0x71007B1A88</ref>.

**Set next GameScene state to StageMgr.

**qword_71025D16C0: ?{{check}}

***If aoc3 is initialized, set Blight rematch counters to 0 for all four blights.

**PauseMenuDataMgr: Update IsOpenItemCategory flags if necessary.

*ProductReporter: reset scene work time (the amount of time since the last scene generation) and reset the blood moon reporter.

*Destroy the previous stage binder (this->activeStageBinder) if it's different from the current binder (this->stageBinder), and also set this->stage to nullptr.

**stage->init and stage->postInit are called here<ref>0x71007CC024</ref>.

*Step 0:

**[1.4.0+] If BalladOfHeroes_Step02 is false or BalladOfHeroes_Step03 is true, and if the player's equipped weapon (category 0) is Weapon_Sword_502 (One-Hit Obliterator), that weapon is removed from the inventory.

**Set some flags (Player, WorldMgr, PlacementMgr, ActorSystem)

*Sound, qword_71025D04F0, qword_71025D16C0, qword_71025D1740: ? {{check}}

*Clear the temporary stage binder pointer (which was used only during generation).

*Set this->stageGenerated to 1<ref>0x71007B2038</ref>.

[[Category:Internals]]

[[Category:Subsystems (BotW)]]