WorldMgr: Difference between revisions

<translate>

{{Subsystem infobox|name=WorldMgr|init_addr_switch150=00000071010F2920|is_name_official=1|description=Manages world state (time, blood moons, climates, weather, etc.)}}

The '''World Manager''' (WorldMgr) is responsible for managing time, blood moons, climates, weather, fog, wind, lighting, procedural generation of clouds, whether the Lord of the Mountain appears, etc.

Because of the massive amount of state to handle, functionality is split across the main WorldMgr and 9 sub-managers.

=== Sub-managers ===

Sub-managers are created in WorldMgr::init (0x71010F43C0) and inserted into a pointer array (@WorldMgr+0x5c0). All names below are unofficial.

{|class="wikitable"

|+ Sub-managers by ID

|}

The main WorldMgr class is responsible for keeping climate related parameters and determining which set of climate settings to use. Strangely enough, WorldMgr uses the position of the Camera actor to figure out which map area the player is in (and thus what climate to use), not the Player actor.

TimeMgr handles everything to do with time, including Blood Moons and the Lord of the Mountain's apparition.

Internally, time of day is stored as a float in the [0.0, 360.0] range.

* Time is set to 78.75 (05:15).

* Time for TotS environment is set to 78.75 (05:15) as well.

* "Bloody Moon end reserve timer" is set to 0.

This is called whenever a stage is unloaded (essentially every time the loading screen is shown).

* Blood Moon checks are delayed.

* The AnimalMaster_Appearance flag is cleared, meaning the Lord of the Mountain will not appear.

This is called every frame.

* (If field 0x14A is set to 99, WM_BloodyDay is set to true. [[AIDef:Action/SetBloodyMoonEnv]] uses this to force a Blood Moon to be scheduled. This feature appears to be unused.)

* If both [[Demo]]103_0 and Demo997_0 have not been played, time of day is reset to 78.75 (05:15).

* [[#Midnight checks]].

* '''Update time of day''': there are several possible update modes. In most cases, the update mode is 0.

{|class="wikitable"

* If the timer is >= 360.0, which means that a day has passed, the game subtracts 360 from the timer.

'''Note''': In this state, the blood moon timer is never updated and its value is never checked either.  

|}

* Update the [[#Day/night time flag]], the [[#Time division, IsMorning, IsNoon, etc.]]

* If the "Bloody Moon end reserve timer" is non zero, decrement it. If the new value is zero, the WM_BloodyDay flag is cleared.

* Update [[#Lord of the Mountain]] flags.

The following actions happen every time the timer reaches 360.0 (midnight).

WM_NumberOfDays is incremented.

'''If a Blood Moon is scheduled''' (WM_BloodyDay is true):

*If Blood Moons are prohibited (see conditions below), set the Blood Moon timer to 2880.0.

*If they are allowed to happen, call [https://eventviewer.zeldamods.org/viewer.html?data=/d/Demo011_0.json&params=1 Demo011_0] and set the Blood Moon timer to 0.0.

'''Scheduling new Blood Moons''':

*If the FirstTouchdown flag is set (i.e. if the player has left the Great Plateau), and if the Blood Moon timer is > 2520.0 (7 in-game days):

* Otherwise, the "Bloody end reserve timer" is set to 150. This ensures that the WM_BloodyDay flag is cleared 5 in-game minutes (= 5 seconds in real life) after a Blood Moon occurs.

If any of the following conditions are true, the Blood Moon cutscene will not be triggered.

* Not on MainField (main overworld)

* IsInHyruleCastleArea is set

* SkyMgr's field_2B4 is set to 15 and field_2B8 >= 1.0

However, these do not prevent the Blood Moon timer from advancing, or the WM_BloodyDay flag from being set.

Note: Vah Rudania is missing from the list. This is normal and blood moons still cannot happen during the Vah Rudania battle sequence because the BloodyMoonProhibition flag is set during it.

From 00:00 to 06:00 (closed interval) and from 18:00 to 00:00 (closed interval), WM_DaytimeFlag is set to false and WM_NighttimeFlag is true.

In any other case, WM_DaytimeFlag is set to true and WM_NighttimeFlag to false.

{|class="wikitable"

! Start !! End !! Division !! Time type (1) !! Time type (2)

Note: all intervals include the start time and exclude the end time.

The moon type is calculated based on the number of in-game days (WM_NumberOfDays). The exact formula is <code>(numberOfDays + x + 1) % 8</code><ref>0x71010E8200</ref>, where x is equal to 1 if the current time is > 180.0 (noon) and % is the modulo operator.

If a moon type was set manually (for instance using [[AIDef:Action/EventSetMoonType]]), that value will be used as the moon type.

The moon type is returned by [[AIDef:Query/WhatMoonName]], which some NPC event flows use to check the current moon phase. However, the moon schedule has nothing to do with the blood moon schedule.

The Lord of the Mountain appears whenever the AnimalMaster_Appearance flag is set. Its value is managed by a simple state machine.

Note that whenever a stage is unloaded, the AnimalMaster_Appearance flag is reset to false.

If the following three conditions are true:

* The [[#Moon type]] is 5 (waxing crescent)

* The current [[map area]] number is not 64 ("HyruleHill", presumably the Satori Mountain area)

then the game generates a random "appearance hour" in the [0 .. 22] interval and goes into state 1.

If the player is in map area 64, the state is reset back to 0.

Otherwise, the game does nothing until the current hour matches the previously generated appearance hour, at which point it sets AnimalMaster_Appearance to true (which allows the LotM to spawn) and goes into state 2.

After one hour has elapsed, the current day of the week is stored and the state is set to 3.

After two week day changes, ''or'' [after the in-game day of the week changes and the current hour is >= the generated appearance hour], the LotM will disappear and the state will be set to 4.

The game waits for the moon type to be 5, before going back to state 0.

{{expand section}}

=== Weather types ===

|}

[[Category:Internals]]

[[Category:Subsystems (BotW)]]

</translate>