GameScene

GameScene is a critical subsystem that is responsible for core functionality such as initialising other components, creating stages (world, title screen, etc.) and handling the game's main loop.

GameScene

Subsystem
Official name	Yes
Description	Handles the main loop and stages
Init function	Switch 1.5.0: 0x71007D1DD8 Wii U 1.5.0: ???
Debug only	No

Unlike most other subsystems, GameScene is not a singleton: it is a member of the uking::frm::System structure.

Definitions

Stages

Type	Description	Map types
0	Invalid	-
1	Open world stage (except GameTestField)	MainField, AocField
2	Indoor stage	CDungeon, MainFieldSpot, GameTestDungeon
3	Open world stage (GameTestField)	GameTestField
4	MainFieldDungeon	MainFieldDungeon
5	Indoor stage or viewer stage	?

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 units in the same way.

StageBinders

Stage binder types

Type	Description
0	OpenWorldStage
1	IndoorStage (CDungeon, ...)
2	MainFieldDungeonStage
3	TitleStage
4	StartupSaveCheckStage
5	Viewer

Fade types

Type	Description
0
1
2	Show logo

GameScene state strings

List of state strings in 1.5.0 (incomplete)

Name	Description
1st	Demo mode [check]
2nd	Demo mode
初回シーケンス	Initial sequence - New save
TitleMenu	Title menu
Presentation	Demo mode
E3_2016/Presentation	Demo mode
StartupSaveCheckStage
Viewer
CDungeon
MainFieldDungeonStage
MainField
GameTestField
GameTestField2
AocField
GameTestDungeon
MonolithTestDungeon
SrdTestDungeon
MarioClubTestDungeon
TestField
研修用
MonolithTest100enemy
MinimumField
ActorViewer

Init

• GameScene::initialize (0x71007A8014)
  • Load the environment graphics archive (Env.sgenvb)
  • Create the GameScene heap
  • Create the StageBinder heap
  • Start the GameScene TaskMgr (thread)
  • InitializeSubSystem (note: some of the below names are unofficial, see Subsystems for more details)
    • AutoPlacementFlowMgr
    • FadeProgress
    • DungeonPackMgr
    • PlayerInfo
    • PlayerResetPosMgr
    • GameSceneSubsys3
    • GameSceneSubsys4
    • GameSceneSubsys5
    • ActorHeapUtil
    • E3Mgr
    • aoc2
    • aoc3
    • DamageInfoMgr
    • CookingMgr
    • GameSceneSubsys7
    • ActorLimiter
    • GameSceneSubsys9
    • GameSceneSubsys10
    • IceBlockMgr
    • AmiiboMgr
    • GameSceneSubsys11
    • GameSceneSubsys12
    • GameSceneSubsys13
    • GameSceneSubsys14
    • GameSceneSubsys15
    • ResidentActorMgr
    • Create UI heap
    • uiManager
    • Load the Fade screen
    • OnUiActorMgr
    • CreatePlayerEquipActorMgr
    • CreatePlayerTrashActorMgr
    • TipsMgr
    • nxargs
    • GameScene::initializeGraphicsLayer_
    • ErrorViewerTask init
    • Set Get Demo handler
    • Set Check Weapon Free Slot handler (1, 2)
    • ...
    • SaveSystem init
    • Set initial state
    • nn::err::ShowUnacceptableAddOnContentVersionError if needed
    • • [Debug] StarterPackMgr: Load Title pack
      • GlobalParameter
      • GlobalParameter: Load actorpack
      • E3Mgr: Load System/BuildTime.txt (stubbed in release versions)
      • TipsMgr: Load tips
      • ResidentActorMgr: Load configuration (ResidentActors.byml)
      • AutoPlacementFlowMgr: Load auto placement event flows
    • KingEditor: Stubbed
    • E3Mgr: init

Initial state

The initial state the game launches into is determined by GameScene.

const bool isFirstLaunch = SaveSystem::sInstance->isFirstLaunch();
State* state = isFirstLaunch ? &state_NewSave : &state_LunchTitle;

if ( aocManager::sInstance && aocManager::sInstance->flags & 2 )
  nn::err::ShowUnacceptableAddOnContentVersionError();

const bool isDemo = E3Mgr::sInstance && E3Mgr::sInstance->isDemoMode();
if (isDemo)
  state = &state_LunchTitle;

if (!isDemo && isFirstLaunch)
  sIsFirstNonDemoLaunch = 1;

StateMachine::changeState(&this->stateMachine, state);

States

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.

StageTransition

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

LunchTitle

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) when the "common run" status (see below) is 0xa, then calls the "common run" function (with isNewSave=false).

NewSave

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

Main loop

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

Common state run function

Called from StageSelectRun, LunchTitleRun and NewSaveRun.

• Status 0:
  • Start loading
    • Finish startup logo (Switch)
    • If the state string is set to 初回シーケンス, clear the Resource system cache ("ClearAllCaches").
    • Debug stuff.
    • E3 Demo stuff.
    • Show the Fade screen (loading screen) if the state string does not end with "Viewer" or is not any of the following strings: 1st, 2nd, Presentation, TitleMenu, 初回シーケンス, StartupSaveCheckStage
      • And then show the FadeStatus and the LoadSaveIcon screens.
      • Otherwise, only open the Fade screen but do not show loading progress.
    • StageSelect stuff.
    • Stop "resource compaction" and wait for it to be stopped.
    • If the stage string starts with CDungeon or MainFieldDungeonStage, start loading the associated DungeonPack.
    • BaseProcMgr: start ActorCreate initializer thread^[check].
    • FadeProgress: reset internal state, set progress to 0% and mark loading as active.
• Status 2:
  • If the GameScene state machine's current state is StageSelect or NewSave, do something involving LayerMgrTask and the Renderer.^[check]
• Status 0xa:
  • TipsMgr: update tips if the loading screen is visible (not just opened). TipsMgr will load tips depending on the stage that is being loaded.
• Status 0xb:
  • Set GameScene's isNewSave property.
  • Reset status to 0.
  • Change GameScene state to StageTransition.
  • Set stage status to "NeedsGeneration" (2).

Stage generation

• Terrain::sInstance->flags |= 0x180u
• Step 0
  • Reload Title.pack if the stage that needs to be generated is TitleStage (3).
  • StageSelect checks
• Step 1
  • If a pack was loaded by DungeonPackMgr, wait for DungeonPack loading to finish and switch active pack to the dungeon pack.
• Step 2
  • If the stage to load is TitleStage, wait for TitlePack loading to finish and switch active pack to the title pack.
• Step 3: start stage generation
  • PlacementMgr
  • ActorSystem::sInstance->field_13A = 0
  • Update current map flags (e.g. sIsDungeon)
  • Clear BaseProcMgr ActorCreate queue^[check]
  • Create uking::Stage::ForBaseProcDual heap (if not already done), which will be used for actors, ActorCreator and BaseProcMgr
  • ActorSystem::sInstance->field_139 = 0
  • If the state string starts with 初回シーケンス, MainField, GameTestField, GameTestField2, AocField, CDungeon, MainFieldDungeonStage, GameTestDungeon, MonolithTestDungeon, SrdTestDungeon, MarioClubTestDungeon, TestField, 研修用, MonolithTest100enemy, MinimumField, or ActorViewer, call GameScene::startBgProcessing (0x71007B2054)
  • If "new save" was selected, initialize PauseMenuDataMgr data
  • 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, ask EventMgr to call Demo169_0.
  • Some PhysicsMemSys stuff (0x71007ADBE0).
• Step 4
  • Wait for completion of Title BG processing (20% of the loading bar)
  • uiManager (0x71007ACD04)
  • Initialize StatisticsMgr paths depending on current map type.
  • Update aoc2's mapType and mapName fields.
• Step 5
  • PhysicsMemSys stuff (0x71007ACDB8, 0x71007ACDC0, 0x71007ACDD0)
  • BaseProcMgr: request "PreDelete" actors
  • BaseProcMgr: stop ActorCreate initializer thread and clean up internal state^[check]
  • agl::lyr::Renderer and Graphics stuff
• Step 6
  • Load env.genvb binary (gsys::ModelSceneEnv::clearImpl + loadBinaryImpl)
  • If the stage binder type is 0, 1 or 2 (OpenWorldStage, IndoorStage or MainFieldDungeonStage):
    • Set loading progress to 40%.
    • Graphics stuff, again
    • OnUiActorMgr
    • GameScene::loadTera (on a separate thread)
• Step 7
  • If the stage binder type is 0, 1 or 2 (OpenWorldStage, IndoorStage or MainFieldDungeonStage):
    • Wait for Tera to load
• Step 8
  • ...
  • Wait for Tera to generate collision
  • ...
• Step 9
• Step 10
• Step 11
• Step 12
• Step 13