ZeldaMods (Breath of the Wild) - User contributions [en]

Time

2023-05-10T10:01:01Z

Chubby Bub:

<languages/>
<translate>

This article documents how '''time''' works in ''Breath of the Wild''.

== Summary == 

=== About time === 


Time starts at 05:15 and will flow normally until 11:00 is reached. Activating the Great Plateau Tower sets the time to 11:00, shows the time on the UI and restores the normal flow of time.


However:


* If the Shrine of Resurrection exit cutscene has not been played, the time of day is set to 05:15 and frozen.
* If that cutscene ''has'' been played, but Link does ''not'' have the ''Isolated Plateau'' quest, time cannot go past 11:00.

=== About scheduled blood moons === 


Blood Moons occur at midnight if and only if the WM_BloodyDay flag is set. There is no way to force blood moons to be scheduled via gameplay actions.


That flag is set the night before at midnight if Link has left the Plateau and if the Blood Moon timer has reached 7 in-game days. Not 7 days and 15 minutes, but exactly 7 days (2520/360 = 7). Also, note that Link does not need to pass time at a campfire after the WM_BloodyDay flag is set.


The Blood Moon timer starts ticking as soon as Link has left the Shrine of Resurrection normally. Any time spent in a state where even the main game timer is paused does not count. However, you do not necessarily need to be in the open world: time spent in shrines, divine beasts, etc. does count.


Passing time at a campfire or sleeping repeatedly does not help trigger a Blood Moon at all. Quite the opposite, as the timer does not advance during cutscenes.

== Details == 


Internally, time of day is stored as a float in the [0.0, 360.0] range. 0.0 is 00:00 and 359.x is 23:59.


When the game starts, time is set to 78.75 (05:15) and the '''Bloody Moon end reserve timer''' is set to 0. If you have an existing save file, the game timer is reloaded from your save.

=== Every game tick === 


If the Shrine of Resurrection exit cutscene (Demo103_0) hasn't played, time is reset to 78.75. This means that if you manage to clip out of the Shrine of Resurrection and skip that cutscene, the game clock will be stuck at 05:15.


Otherwise, if there is no active event/cutscene:


* The game timer is incremented by 0.0083333 × elapsed frames. Effectively, this means that 1 in-game minute = 1 real-life second.
* If Link hasn't received the ''The Isolated Plateau'' quest and if the current time is >= 165.0 (11:00), the time is forcefully set to 11:00. Effectively, this means that time will not get past 11:00 until the Great Plateau Tower is activated and the Old Man cutscene is triggered.
* If the timer reaches 360.0 (midnight), the game performs special checks. See the next section.
* A value called the '''blood moon timer''' is also incremented by 0.0083333 × elapsed frames.


Afterwards, if the "Bloody Moon end reserve timer" is non zero, it is decremented. If the new value is zero, the WM_BloodyDay flag is cleared.

=== Every time the timer reaches 360.0 (midnight) === 


First, WM_NumberOfDays is incremented. This has an effect on the moon cycle.


'''If a Blood Moon is scheduled:'''


If Blood Moons are "prohibited" (see below for a full list of conditions), the timer is set to 2880.0 and nothing happens. Otherwise, the Blood Moon cutscene ([https://eventviewer.zeldamods.org/viewer.html?data=/d/Demo011_0.json&params=1 Demo011_0]) is triggered and the timer is reset to 0.0.


The game then determines whether to '''schedule a Blood Moon''' or not:


If the player has left the Great Plateau and if the Blood Moon timer is > 2520.0 (7 in-game days):


* The WM_BloodyDay flag is set to true, which means that a Blood Moon is scheduled for the next night.
* The Blood Moon timer is reset to 0.0.


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

=== Blood Moon inhibitors === 


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


* Link is not in the main overworld (e.g. in a shrine or Divine Beast)
* Link is in Hyrule Castle (i.e. the Hyrule Castle 3D minimap is visible)
* The BloodyMoonProhibition flag is set: Blood moons are prohibited by an event (cutscene, minigame, etc.).
** This flag is called by the DisableSaveAndWarp function, which used by all minigames, the section of "The Stolen Heirloom" where the Yiga Blademaster is fought, and the Dark Beast Ganon battle.
** The only time the BloodyMoonProhibition flag is set by itself is during the One-Hit Obliterator challenge in the Champions' Ballad, so that saving and warping ''are'' allowed.
* The Vah Medoh battle is active
* The Vah Naboris battle is active
* The Vah Ruta battle is active
* Link is fighting Dark Beast Ganon (for good measure, since BloodyMoonProhibition is already set)
* The environment palette is set to 15, meaning Link is in the Yiga Clan Hideout


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


Note: The Vah Rudania battle is missing from the list. Blood Moons actually can occur during this segment, and will revive the Moblins but not the Sentries (as Sentries have the RevivalNone flag). This is because the event does not call DisableSaveAndWarp, and instead independently sets the WarpProhibition and KillTimeProhibition flags, in order to allow saving. Whether the developers intentionally allowed Blood Moons to happen during this segment, or simply forgot to set the BloodyMoonProhibition flag, is unknown.

=== Special case: passing time at a campfire or sleeping === 


When you pass time at a campfire or sleep, the time is instantly set to the destination time. The game never speeds up or slows down the flow of time.


If the time change causes the clock to cross midnight, the game sets a special flag that causes the Time Manager to run the "handle new day" function once, even if it's not midnight. The game also explicitly checks<ref>[https://eventviewer.zeldamods.org/viewer.html?data=/d/Demo007_1.json&params=1&node=Event53 Demo007_1]</ref> if a Blood Moon was scheduled to happen and triggers the cutscene if needed.

=== Moon type === 


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>{{addr|a=0x71010E8200|ver=nx-1.5.0}}</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. It is unclear whether the game ever sets the moon type manually.


The moon schedule has nothing to do with the blood moon schedule.

==== Moon phases ==== 


Here are the possible values and associated phases:


* 0: Full Moon or Blood Moon or on a Bloody Day after 04:00
* 1: Waning gibbous
* 2: Third quarter
* 3: "26th-day"
* 4: New moon
* 5: Waxing crescent
* 6: "Seven-day"
* 7: "13-day"

== References == 
* For more technical details, read the article on the [[WorldMgr]]. Sections of that article were extracted from it and simplified here.
<references/>
</translate>

[[Category:Game mechanics{{#translation:}}]]

Time

2023-05-08T21:16:50Z

Chubby Bub:

<languages/>
<translate>

This article documents how '''time''' works in ''Breath of the Wild''.

== Summary == 

=== About time === 


Time starts at 05:15 and will flow normally until 11:00 is reached. Activating the Great Plateau Tower sets the time to 11:00, shows the time on the UI and restores the normal flow of time.


However:


* If the Shrine of Resurrection exit cutscene has not been played, the time of day is set to 05:15 and frozen.
* If that cutscene ''has'' been played, but Link does ''not'' have the ''Isolated Plateau'' quest, time cannot go past 11:00.

=== About scheduled blood moons === 


Blood Moons occur at midnight if and only if the WM_BloodyDay flag is set. There is no way to force blood moons to be scheduled via gameplay actions.


That flag is set the night before at midnight if Link has left the Plateau and if the Blood Moon timer has reached 7 in-game days. Not 7 days and 15 minutes, but exactly 7 days (2520/360 = 7). Also, note that Link does not need to pass time at a campfire after the WM_BloodyDay flag is set.


The Blood Moon timer starts ticking as soon as Link has left the Shrine of Resurrection normally. Any time spent in a state where even the main game timer is paused does not count. However, you do not necessarily need to be in the open world: time spent in shrines, divine beasts, etc. does count.


Passing time at a campfire or sleeping repeatedly does not help trigger a Blood Moon at all. Quite the opposite, as the timer does not advance during cutscenes.

== Details == 


Internally, time of day is stored as a float in the [0.0, 360.0] range. 0.0 is 00:00 and 359.x is 23:59.


When the game starts, time is set to 78.75 (05:15) and the '''Bloody Moon end reserve timer''' is set to 0. If you have an existing save file, the game timer is reloaded from your save.

=== Every game tick === 


If the Shrine of Resurrection exit cutscene (Demo103_0) hasn't played, time is reset to 78.75. This means that if you manage to clip out of the Shrine of Resurrection and skip that cutscene, the game clock will be stuck at 05:15.


Otherwise, if there is no active event/cutscene:


* The game timer is incremented by 0.0083333 × elapsed frames. Effectively, this means that 1 in-game minute = 1 real-life second.
* If Link hasn't received the ''The Isolated Plateau'' quest and if the current time is >= 165.0 (11:00), the time is forcefully set to 11:00. Effectively, this means that time will not get past 11:00 until the Great Plateau Tower is activated and the Old Man cutscene is triggered.
* If the timer reaches 360.0 (midnight), the game performs special checks. See the next section.
* A value called the '''blood moon timer''' is also incremented by 0.0083333 × elapsed frames.


Afterwards, if the "Bloody Moon end reserve timer" is non zero, it is decremented. If the new value is zero, the WM_BloodyDay flag is cleared.

=== Every time the timer reaches 360.0 (midnight) === 


First, WM_NumberOfDays is incremented. This has an effect on the moon cycle.


'''If a Blood Moon is scheduled:'''


If Blood Moons are "prohibited" (see below for a full list of conditions), the timer is set to 2880.0 and nothing happens. Otherwise, the Blood Moon cutscene ([https://eventviewer.zeldamods.org/viewer.html?data=/d/Demo011_0.json&params=1 Demo011_0]) is triggered and the timer is reset to 0.0.


The game then determines whether to '''schedule a Blood Moon''' or not:


If the player has left the Great Plateau and if the Blood Moon timer is > 2520.0 (7 in-game days):


* The WM_BloodyDay flag is set to true, which means that a Blood Moon is scheduled for the next night.
* The Blood Moon timer is reset to 0.0.


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

=== Blood Moon inhibitors === 


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


* Link is not in the main overworld (e.g. in a shrine or Divine Beast)
* Link is in Hyrule Castle (i.e. the Hyrule Castle 3D minimap is visible)
* The BloodyMoonProhibition flag is set: Blood moons are prohibited by an event (cutscene, minigame, etc.).
** This flag is called by the DisableSaveAndWarp function, which used by all minigames, the section of "The Stolen Heirloom" where the Yiga Blademaster is fought, and the Dark Beast Ganon battle.
** The only time the BloodyMoonProhibition flag is set by itself is during the One-Hit Obliterator challenge in the Champions' Ballad, so that saving and warping ''are'' allowed.
* Vah Medoh battle
* Vah Naboris battle
* Vah Ruta battle
* Link is fighting Dark Beast Ganon (for good measure, since BloodyMoonProhibition is already set)
* Some condition involving the Sky Manager


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


Note: The Vah Rudania battle is missing from the list. Blood Moons actually can occur during this segment, and will revive the Moblins but not the Sentries (as Sentries have the RevivalNone flag). This is because the event does not call DisableSaveAndWarp, and instead independently sets the WarpProhibition and KillTimeProhibition flags, in order to allow saving. Whether the developers intentionally allowed Blood Moons to happen during this segment, or simply forgot to set the BloodyMoonProhibition flag, is unknown.

=== Special case: passing time at a campfire or sleeping === 


When you pass time at a campfire or sleep, the time is instantly set to the destination time. The game never speeds up or slows down the flow of time.


If the time change causes the clock to cross midnight, the game sets a special flag that causes the Time Manager to run the "handle new day" function once, even if it's not midnight. The game also explicitly checks<ref>[https://eventviewer.zeldamods.org/viewer.html?data=/d/Demo007_1.json&params=1&node=Event53 Demo007_1]</ref> if a Blood Moon was scheduled to happen and triggers the cutscene if needed.

=== Moon type === 


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>{{addr|a=0x71010E8200|ver=nx-1.5.0}}</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. It is unclear whether the game ever sets the moon type manually.


The moon schedule has nothing to do with the blood moon schedule.

==== Moon phases ==== 


Here are the possible values and associated phases:


* 0: Full Moon or Blood Moon or on a Bloody Day after 04:00
* 1: Waning gibbous
* 2: Third quarter
* 3: "26th-day"
* 4: New moon
* 5: Waxing crescent
* 6: "Seven-day"
* 7: "13-day"

== References == 
* For more technical details, read the article on the [[WorldMgr]]. Sections of that article were extracted from it and simplified here.
<references/>
</translate>

[[Category:Game mechanics{{#translation:}}]]

Difficulty scaling

2023-02-03T10:31:14Z

Chubby Bub:

<languages/>
<translate>


'''Difficulty scaling''' is a mechanic in ''Breath of the Wild'' that results in enemies and weapons being progressively replaced by more powerful variants during a playthrough.

== Points == 


The scaling system is based on a point system. Killing enemies is the ''only way'' to receive points.


Whenever an enemy dies, the game increments a flag 'Defeated_{SameGroupActorName}_Num' if all of the following conditions are satisfied:
* The current kill count is < 10.
* The actor does not have the NotCountDefeatedNum [[actor tag]].
* '''For Monk Maz Koshia''': 'Defeated_Priest_Boss_Normal_Num' is 0.
* '''For Dark Beast Ganon''': It is the first time the boss is beaten. (Ganon's Defeated flag has 1 as the maximum value.)
* '''For Blights''': It is the first time the blight is beaten in the Divine Beast, or in the Illusory Realm. Blights fought in Hyrule Castle do not count.
This happens every time ''any'' enemy dies, even if they don't necessarily play a role in the point system (see below) and even if the player is not responsible for their death.


Because enemies have to be killed throughout the main quest and bosses are considered as enemies too, difficulty scaling is unavoidable.


Only the defeated counter flags are stored in the save file. The <code>Ecosystem::LevelSensor</code> subsystem is responsible for [[Difficulty scaling#Ecosystem::LevelSensor::calculatePoints|converting these kill counts to points]] using a [[Difficulty scaling#Ecosystem::LevelSensor::loadByml|configuration file]].


The subsystem provides two functions ([[Difficulty scaling#Ecosystem::LevelSensor::scaleWeapon|<code>scaleWeapon</code>]] and [[Difficulty scaling#Ecosystem::LevelSensor::scaleActor|<code>scaleActor</code>]]) that may be called when a weapon or enemy actor is created.

== Scaling inhibitors == 


Both scaling functions will immediately return without doing anything if:
* [[WorldMgr]]::sInstance->stageType == 1 (Open World [[stage]])
* and WorldMgr::sInstance->isAocField (current map is Trial of the Sword)
* and WorldMgr::sInstance->disableScaling (set to true when entering Trial of the Sword)


This means that scaling is always disabled in the Trial of the Sword.


Scaling will also be skipped if the current [[map area]] is 28. This corresponds to "HateruSea", which is the Eventide Island area.

== Weapons == 


'scaleWeapon' is called (i.e. weapons may be scaled) for a weapon if:
* '''For standalone weapons''': The actor property 'LevelSensorMode' is higher than 1 '''and''' it wasn't already picked up.
* '''For treasure chest drops''': If SharpWeaponJudgeType is not 4, when [[AIDef:AI/TreasureBox]] initialises the drop actor.
* '''For Hinox weapons''': The flag <code>{MapName}_Necklace_{i}_{HinoxName}_{ID}</code> is false.
* '''For other enemy drops''': The flag <code>{MapName}_WeaponDrop_{ID}</code> is false, '''and''' [the actor property 'LevelSensorMode' is higher than 1 ''or'' the enemy is a Guardian Scout ('Enemy_Guardian_Mini')].


Note: Weapons that are bought from a shop cannot receive modifiers because they do not fit into any of the above cases.

== Weapon modifiers == 


Weapon scaling results in weapons being replaced by a different weapon (e.g. a Soldier's Bow which becomes a Royal Bow), or weapons gaining a random, bonus stat boost (e.g. Attack Up, Durability Up, etc.). The range of those boosts is also affected by weapon scaling.


There are two bonus tiers in the game: one for low-level types (which appear in blue/white in the game UI) and another for high-level types (yellow). Those that belong to the Yellow tier are usually superior to the other ones. For instance, ''Attack Up +'' is the superior variant of ''Attack Up'' and it typically grants a higher attack power boost compared to ''Attack Up''.

=== Modifier types === 


Which modifier a weapon receives is random each time Link obtains it. Which modifiers a weapon can possibly have is specific for each in [[ActorParam/GeneralParamList]], and is based on the weapon's type and the modifier tier. Note that certain modifiers can only appear at certain tiers— in particular, this means once a weapon is scaled to yellow modifiers, it can no longer receive the Critical Hit buff.

The odds for each type of modifier is determined by an algorithm in actWeapon which depends on the possible modifiers for a given weapon at a given tier. As such, this algorithm yields the following odds for different types of weapons:
</translate>
{|class="wikitable" style="text-align: center;"
! rowspan=2|Weapon !! rowspan=2|Modifier Tier !! AddAtk !! AddLife !! AddCrit !! AddGuard !! AddThrow !! AddSpreadFire !! AddZoomRapid !! AddRapidFire !! AddSurfMaster
|-
| <translate> Attack Up</translate> || <translate> Durability Up</translate> || <translate> Critical Hit</translate> || <translate> Shield Guard Up</translate> || <translate> Long Throw</translate> || <translate> 5-Shot Burst</translate> || <translate> ''Unused''[[#Notes|[a] ]]</translate> || <translate> Quick Shot</translate> || ''Unused''[[#Notes|[b] ]]
|-
| Most melee weapons || White/Blue || 25% || 33.3̅3̅% || 41.6̅6̅% || - || - || - || - || - || -
|-
| Most melee weapons || Yellow || 25% || 33.3̅3̅% || - || - || 41.6̅6̅% || - || - || - || -
|-
| Traveler's Sword/ Rusty Broadsword || White/Blue || 50% || 50% || Impossible || - || - || - || - || - || -
|-
| Boomerangs, elemental rods and wind items || Yellow || 50% || 50% || - || - || Impossible || - || - || - || -
|-
| Shields || White/Blue || - || 50% || - || 50%[[#Notes|[c] ]] || - || - || - || - || -
|-
| Shields || Yellow || - || 50% || - || 50%[[#Notes|[c] ]] || - || - || - || - || -
|-
| Bows || White/Blue || 50% || 50% || - || - || - || - || - || - || -
|-
| Normal Bows || Yellow || 25% || 33.3̅3̅% || - || - || - || - || - || 41.6̅6̅% || -
|-
| Multi-Shot Bows[[#Notes|[d] ]] || Yellow || 12.5% || 22.2̅2̅% || - || - || - || 29.16̅% || - || 36.1̅1̅% || -
|-
|}

<translate>
==== Notes ==== 
* [a] AddSurfMaster, or "Shield Surf Up" is a bonus that only applies to shields and gives them a lower friction for shield surfing. That bonus type is unused in the game, though if implemented through mods or glitches it uses a yellow shield icon and reads "Shield Surf Up"
* [b] AddZoomRapid is another unused bonus that gives bows a zoom when aimed, similar to the property inherent to the Golden and Phrenic Bows.
* [c] Due to a bug, if "Shield Guard Up" is rolled for an amiibo weapon, "Durability Up" will be applied using that value instead.<ref name="amiiboShield">The bugged code is in function {{addr|a=0x71002df7d8|ver=nx-1.5.0}}.</ref>
* [d] These are for bows which can have the Five-Shot Burst modifier, which are the Forest Dweller's Bow, Lynel Bow, Mighty Lynel Bow, and the Savage Lynel Bow. (Despite shooting multiple arrows, the Duplex Bow and Great Eagle Bow cannot have this modifier.)

====Impossible modifiers====
Some items of a weapon type are furthermore restricted from certain modifiers, or the only ones that can receive it:
*Cannot receive Critical Hit (<code>SharpWeaponAddCrit</code> is false):
** Odd cases: Traveler's Sword, Rusty Broadsword
** Special weapons: Master Sword, One-Hit Obliterator
*Cannot receive Long Throw (<code>PoweredSharpAddThrowMin || PoweredSharpAddThrowMax == 1.0</code>):
** Boomerangs: Boomerang, Giant Boomerang, Lizal Boomerang, Lizal Forked Boomerang, Lizal Tri-Boomerang, Lizalfos Arm, Sea-Breeze Boomerang
** Elemental rods: Fire Rod, Ice Rod, Lightning Rod, Meteor Rod, Blizzard Rod, Thunderstorm Rod
** Wind-blowing weapons: Korok Leaf, Windcleaver
** Special weapons: Master Sword, One-Hit Obliterator
*Can receive Five-Shot Burst (<code>PoweredSharpAddSpreadFire</code> is true):
** Forest Dweller's Bow, Lynel Bow, Mighty Lynel Bow, Savage Lynel Bow
*The Hero's Shield will never recieve Shield Guard up due to only being obtainable from amiibo.

There are also some items that have values for modifiers in their parameters, but in all actual in-game cases have scaling restricted. This is mostly weapons only obtainable through crafting or shops.
*Never seen with any modifiers:
**Only from purchasing: Ancient Short Sword, Ancient Bladesaw, Ancient Shield, Ancient Bow, Spring-Loaded Hammer
**Champions' weapons restricted: Scimitar of the Seven, Daybreaker, Boulder Breaker, Great Eagle Bow, Ceremonial Trident, Lightscale Trident
**Skeleton arms: Bokoblin Arm, Lizalfos Arm, Moblin Arm
**Random items: Farmer's Pitchfork
**Special weapon: Bow of Light
*Never seen with yellow modifiers (only white):
**Random items: Tree Branch, Soup Ladle, Boat Oar, Woodcutter's Axe, Wooden Mop, Pot Lid, Wooden Bow

Finally, there are some items which either have limited instances where scaling is allowed and/or limited modifier availability before they upgrade. A list can be found [https://docs.google.com/spreadsheets/d/1RdV6RsHucg4h22sIZOEBsGSE7Mxk4zUipsADoGIjkOk/pubhtml# here].

=== Modifier values === 


Bonus values (e.g. the actual durability or attack power increase) are determined from [[ActorParam/GeneralParamList]] (with a copy of the information in [[ActorInfoData]]). Valid ranges and bonuses for each weapon are configured in the WeaponCommon section. The possible values for a bonus are generally higher for a yellow tier.

==== Non-amiibo weapons ==== 
</translate>
{|class="wikitable" style="text-align: center;"
! <translate> Modifier chosen</translate> !! Effect if applied !! Bonus Value (White/Blue) !! Bonus Value (Yellow)
|-
| <translate> None</translate> || - || - || -
|-
| <translate> Attack Up</translate> || Attack value boosted by: || Random integer between [SharpWeaponAddAtkMin, SharpWeaponAddAtkMax] || Random integer between [PoweredSharpAddAtkMin, PoweredSharpAddAtkMax]
|-
| <translate> Durability Up</translate> || Durability value boosted by: || Random integer between [SharpWeaponAddLifeMin, SharpWeaponAddLifeMax] || Random integer between [PoweredSharpAddLifeMin, PoweredSharpAddLifeMax]
|-
| Critical Hit || Last hit of a chain does double damage/staggers enemies || - || N/A
|-
| <translate> Shield Guard Up</translate> || Shield guard value boosted by: || Random integer between [SharpWeaponAddGuardMin, SharpWeaponAddGuardMax] || Random integer between [PoweredSharpWeaponAddGuardMin, PoweredSharpWeaponAddGuardMax]
|-
| <translate> Long Throw</translate> || Throw distance multiplied by: || - || Random float between [PoweredSharpAddThrowMin, PoweredSharpAddThrowMax]
|-
| <translate> Multi-Shot Burst</translate> || Bow shoots multiple arrows: || - || 5
|-
| ''AddZoomRapid'' || Reticle zooms when aiming || - || Unknown {{check}}
|-
| <translate> Quick Shot</translate> || Firing rate multiplied by: || - || Random float between [PoweredSharpAddRapidFireMin, PoweredSharpAddRapidFireMax]
|-
| <translate> ''AddSurfMaster''</translate> || Shield surfing friction multiplied by: || - || 0.2 (from [[GlobalParameter]]::ShieldSurfMasterFrictionRatio)
|}

<translate>

In summary, for non-amiibo weapons, a modifier bonus results in a randomized additional value in a certain range for each item.

==== amiibo weapons ==== 


Because of a bug in the game code<ref name="amiiboShield"></ref>, any time the game randomly chooses the "Shield Guard Up" bonus, the actual bonus that gets assigned to the weapon and shows up in the user interface is "Durability Up". For this reason, the extra durability value that is used for shields with the "Durability Up" bonus is either addLifeMax or addGuardMax, depending on which bonus was chosen.
</translate>

{|class="wikitable" style="text-align: center;"
! <translate> Modifier chosen</translate> !! Effect if applied !! Bonus Value (White/Blue) !! Bonus Value (Yellow)
|-
| <translate> None</translate> || - || - || -
|-
| <translate> Attack Up</translate> || Attack value boosted by: || SharpWeaponAddAtkMax || PoweredSharpAddAtkMax
|-
| <translate> Durability Up</translate> || Durability value boosted by: || SharpWeaponAddLifeMax || PoweredSharpAddLifeMax
|-
| Critical Hit || Last hit of a chain does double damage/staggers enemies || - || N/A
|-
| <translate> Shield Guard Up</translate> || '''Durability''' value boosted by: || SharpWeaponAddGuardMax || PoweredSharpWeaponAddGuardMax
|-
| <translate> Long Throw</translate> || Throw distance multiplied by: || - || PoweredSharpAddThrowMax
|-
| <translate> Multi-Shot Burst</translate> || Bow shoots multiple arrows: || - || 5
|-
| ''AddZoomRapid'' || Reticle zooms when aiming || - || Unknown {{check}}
|-
| <translate> Quick Shot</translate> || Firing rate multiplied by: || - || PoweredSharpAddRapidFireMin
|-
| <translate> ''AddSurfMaster''</translate> || Shield surfing friction multiplied by: || - || 0.2 (from [[GlobalParameter]]::ShieldSurfMasterFrictionRatio)
|}

<translate>

In summary, for amiibo weapons, a modifier always yields the highest possible value for that weapon as a bonus, except Quick Shot, which will use the ''lowest'' value.
No randomness is involved, aside from whether the Durability Up bonus comes from the AddLifeMax or AddGuardMax value.

== Enemies == 


When loading enemies, the game will always try to scale enemies.


However, the scaling function won't do anything if 'LevelSensorMode' is < 1 and will leave the enemy and any weapons they may hold unscaled.


Note: Enemies that are not in any upgrade list (such as elemental Lizalfos) will not be scaled, but their weapon can still receive upgrades if:
* 'LevelSensorMode' is non zero.
* Weapon point requirements are satisfied
* ''or'' the modifier tier is overridden using 'SharpWeaponJudgeType'.
[1.3.0] In Master Mode, '''all''' enemies are automatically ranked up one tier by default '''post scaling''', independently of 'LevelSensorMode'. [[Actor]]s can receive two additional parameters:
</translate>
{| class="wikitable"
! <translate> Parameter</translate>
! <translate> Default</translate>
! <translate> Description</translate>
|-
| IsHardModeActor
| false
| <translate> Controls whether an enemy only shows up in Master Mode.</translate>
|-
| DisableRankUpForHardMode
| false
| <translate> Controls whether the automatic rankup applies to an enemy.</translate>
|}
<translate>

In Master Mode, IsHardModeActor, DisableRankUpForHardMode and LevelSensorMode are combined on some actors to keep low-level enemies in the overworld (e.g. Red Bokoblin south of the Great Plateau).

== Properties == 

=== <code>LevelSensorMode</code> === 
This [[actor]] property controls whether scaling is enabled for an enemy or weapon. Also applies to any weapons held by an enemy since 'scaleWeapon' is called when an enemy drops their weapon.


Note that this doesn't apply to weapons that are attached to a Hinox's necklace, because Hinoxes use a different underlying enemy actor which overrides the 'on weapon dropped' function and ignores 'LevelSensorMode'.

=== <code>SharpWeaponJudgeType</code> === 
This actor property controls the ''minimum'' modifier tier that a weapon can receive.


Internally and in assets such as [[Map unit|map units]], the following values are used for modifiers:
</translate>

{| class="wikitable"
! <translate> Value</translate>
! <translate> Description</translate>
|-
| 0
| <translate> '''None''': No modifiers.</translate>
|-
| 1
| <translate> '''RandomBlue''': Weapon will randomly get at least a blue modifier (with <code>weaponCommonSharpWeaponPer</code> being the probability).</translate>
|-
| 2
| <translate> '''Blue''': Weapon will get at least a blue modifier.</translate>
|-
| 3
| <translate> '''Yellow''': Weapon will get at least a yellow modifier.</translate>
|-
| 4
| <translate> '''NoneForced''' (chests only): Weapon will ''never'' spawn with any modifiers. ''This overrides regular scaling.''</translate>
|}

<translate>

If [[Difficulty scaling#LevelSensorMode|scaling]] is enabled, the weapon may receive modifiers from an even higher tier if point requirements are met.


Otherwise, the weapon will get modifiers from exactly the specified tier.


For example, 0 ('None') doesn't mean a weapon will never receive a modifier. It just means that the developers haven't forced the weapon to spawn with a blue/yellow modifier. If scaling requirements are satisfied, the weapon will receive blue or yellow modifiers.

== Scaling algorithm == 

=== <code>Ecosystem::LevelSensor::loadByml</code> === 


This function is called by <code>Ecosystem::init</code> from <code>ksys::InitializeApp</code>


Sets up byml structures for reading Ecosystem/[[LevelSensor.byml]].

=== <code>Ecosystem::LevelSensor::calculatePoints</code> === 


Called by [[PlacementMgr]] when spawning actors.


Calculates weapon and enemy scaling points using a list of flags and configuration values.


All flags that are referenced in the configuration file are of the form <code>Defeated_%s_Num</code>, but technically the configuration format allows for other flags to be specified.


Interestingly, the game calculates a single point value based on the kill counter flags but calculates two separate values for weapons and enemies with two different multipliers. This format makes it possible to easily change the scaling.


<source lang="c++">
float points = 0.0;
for (kill_flag : this->byml["flag"])
int kill_count = GameData::getIntegerFlag(kill_flag["name"]);
points += kill_count * kill_flag["point"];


this->points = points;
this->weapon_points = points * this->byml["setting"].Level2WeaponPower;
this->enemy_points = points * this->byml["setting"].Level2EnemyPower;
</source>


In practice, settings have never been modified. 1.5.0 (which will likely be the last game update) still has the same Level2WeaponPower and Level2EnemyPower.

=== <code>Ecosystem::LevelSensor::scaleWeapon</code> === 


Called from treasure chest code, enemy actors{{Check}}, <code>Ecosystem::LevelSensor::scaleActor</code>


Given a weapon name, its modifier and current point status, this function returns the weapon to actually spawn and the modifier to use (if possible).


If the algorithm fails to find an appropriate weapon that satisfies all conditions (point requirements, weapon series, modifier), the originally specified weapon and modifier will be used directly.


Pseudocode (1.0.0):


<source lang="c++">
bool Ecosystem::LevelSensor::scaleWeapon(const sead::SafeString& weapon_to_look_up,
WeaponModifier required_modifier,
const char** weapon_to_use_name,
WeaponModifier* modifier_to_use,
void* unknown)
{
// some checks using 'unknown' here which seems to be a pointer to the actor
//
for (weapon_table : this->byml["weapon"]) {
// find the first weapon entry for which the player has enough points
// with the specified name and modifier
i = -1;
for (j = 0; j < weapon_table["actors"].size; ++j) {
entry = weapon_table["actors"][j];
float points_for_next_transition = entry["value"];
//
if (this->weapon_points > points_for_next_transition &&
weapon_to_look_up == entry["name"] &&
convert_to_modifier(entry["plus"]) == required_modifier) {
i = j;
break;
}
}
//
if (i == -1)
continue;
//
do {
entry = weapon_table["actors"][i];
//
// not_rank_up means there is no link between weapons;
// this table is just used to look up modifiers.
// so go down the list until there are no more entries for the requested weapon
// or until we reach a modifier that requires more points.
if (weapon_table["not_rank_up"] && entry["name"] != weapon_to_look_up)
break;
//
// otherwise, just go down the list until we reach the end or a weapon which
// requires more points. this will possibly upgrade the weapon (e.g. Knight -> Royal).
if (this->weapon_points <= entry["value"])
break;
//
++i;
} while (i < weapon_table["actors"].size);
//
*weapon_to_use_name = entry["name"];
*modifier_to_use = convert_to_modifier(entry["plus"]);
return true;
}
return false; // cannot scale up
}
</source>

=== <code>Ecosystem::LevelSensor::scaleActor</code> === 


Analogous to <code>LevelSensor::scaleWeapon</code>.


Pseudocode (1.0.0):


<source lang="c++">
if (actor->params["LevelSensorMode"] < 1)
return false;
//
if (actor_name.contains("Enemy")) {
for (enemy_table : this->byml["enemy"]) {
i = -1;
for (j = 0; j < enemy_table["actors"].size; ++j) {
entry = enemy_table["actors"][j];
if (entry["name"] == actor_name && this->enemy_points > entry["value"]) {
i = j;
break;
}
}
//
if (i == -1)
continue;
//
do {
entry = enemy_table["actors"][i];
if (this->enemy_points <= entry["value"])
break;
++i;
} while (i < enemy_table["actors"].size);
//
*actor_to_use = entry["name"];
return true;
}
return false; // cannot scale up
}
//
if (actor_name.contains("Weapon")) {
weapon_name = actor->getWeaponName();
modifier = actor->params["SharpWeaponJudgeType"];
if (modifier == WeaponModifier::RandomBlue)
modifier = get_random_blue_modifier(actor->getWeaponName());
//
if (scaleWeapon(weapon_name, &weapon_to_use, &modifier_to_use)) {
actor->setProperty("SharpWeaponJudgeType", modifier_to_use);
*actor_to_use = weapon_to_use;
return true;
}
return false; // cannot scale up
}
</source>

== The Data == 


To make things easier to understand, here are links to:
* [https://docs.google.com/spreadsheets/d/e/2PACX-1vRSlyOD7FLAn1TUBn64Pu8Pld-WOfgcVByuywHMWvBTEV0j8potD1wkBs-MJJXf-gvEkpfItUCMqMk6/pubhtml kill point, enemy scaling and weapon scaling tables]
* an [https://objmap.zeldamods.org object map with scaling information].
This makes it possible to see both the required points for enemy/weapon upgrades, as well as all of the special cases extremely easily.

== Ganon Blights == 


Ganon blights also have varying difficulty but follow a different system. Their health is determined by the base HP (set in [[ActorParam/GeneralParamList|GeneralParamList]]) and blight defeat flags.


<source lang="c++">__int64 SiteBoss::getInitialHP(SiteBoss *this) // 0x71002D01F4
{
const int baseHp = Enemy::getInitialHP(this);
const int halfBaseHp = baseHp >> 1;
const bool dieGanonWind = hasFlag_Die_PGanonWind(0);
const bool dieGanonWater = hasFlag_Die_PGanonWater(0);
const bool dieGanonFire = hasFlag_Die_PGanonFire(0);
const bool dieGanonElectric = hasFlag_Die_PGanonElectric(0);
const int flags = this->siteBossFlags & 0xFFFFFFFC;
int multiplier;
if ( flags == 4 )
multiplier = 3;
else if ( flags == 8 )
multiplier = 4;
else
multiplier = dieGanonFire + dieGanonWind + dieGanonWater + dieGanonElectric;
return baseHp + multiplier * halfBaseHp;
}</source>


Effectively, this means that the first blight Link fights will have 800+0×400 = 800 HP, the second will have 800+1×400 = 1200 HP, the third 800+2×400 = 1600 HP and the last one 800+3×400 = 2000 HP.

=== Special case 1: Castle Blights === 


Castle blights have <code>IsRemainBoss</code> set to false in their root AI parameters (see [[AIDef:AI/SiteBossSpearRoot]] for example), which sets flag 4.


Thus, blights that are fought in the Castle always have 800+3×400 = 2000 HP regardless of story progression.


If flag 4 is set, the [[AIDef:Action/SiteBossDie]] code will NOT increment the "defeated" counter. This means castle blights do not give any scaling points.

=== Special case 2: DLC2 Blights === 


Illusory Realm blights possess the <code>EnemySiteBoss_R</code> actor tag. This causes flag 8 to be set. So they will always have 500+4×250 = 1500 HP.


Interestingly, the Windblight AI function doesn't check the actor tag but the actor name instead. For flag 8 to be set, the actor name must be <code>Enemy_SiteBoss_Bow_R</code>.

</translate>

<references />
[[Category:Internals{{#translation:}}]]
[[Category:Game mechanics{{#translation:}}]]

Weapon modifier

2023-02-03T02:46:52Z

Chubby Bub: Redirected page to Difficulty scaling#Weapon modifiers

#REDIRECT [[Difficulty scaling#Weapon modifiers]]

Difficulty scaling

2023-02-03T02:45:27Z

Chubby Bub:

<languages/>
<translate>


'''Difficulty scaling''' is a mechanic in ''Breath of the Wild'' that results in enemies and weapons being progressively replaced by more powerful variants during a playthrough.

== Points == 


The scaling system is based on a point system. Killing enemies is the ''only way'' to receive points.


Whenever an enemy dies, the game increments a flag 'Defeated_{SameGroupActorName}_Num' if all of the following conditions are satisfied:
* The current kill count is < 10.
* The actor does not have the NotCountDefeatedNum [[actor tag]].
* '''For Monk Maz Koshia''': 'Defeated_Priest_Boss_Normal_Num' is 0.
* '''For Dark Beast Ganon''': It is the first time the boss is beaten. (Ganon's Defeated flag has 1 as the maximum value.)
* '''For Blights''': It is the first time the blight is beaten in the Divine Beast, or in the Illusory Realm. Blights fought in Hyrule Castle do not count.
This happens every time ''any'' enemy dies, even if they don't necessarily play a role in the point system (see below) and even if the player is not responsible for their death.


Because enemies have to be killed throughout the main quest and bosses are considered as enemies too, difficulty scaling is unavoidable.


Only the defeated counter flags are stored in the save file. The <code>Ecosystem::LevelSensor</code> subsystem is responsible for [[Difficulty scaling#Ecosystem::LevelSensor::calculatePoints|converting these kill counts to points]] using a [[Difficulty scaling#Ecosystem::LevelSensor::loadByml|configuration file]].


The subsystem provides two functions ([[Difficulty scaling#Ecosystem::LevelSensor::scaleWeapon|<code>scaleWeapon</code>]] and [[Difficulty scaling#Ecosystem::LevelSensor::scaleActor|<code>scaleActor</code>]]) that may be called when a weapon or enemy actor is created.

== Scaling inhibitors == 


Both scaling functions will immediately return without doing anything if:
* [[WorldMgr]]::sInstance->stageType == 1 (Open World [[stage]])
* and WorldMgr::sInstance->isAocField (current map is Trial of the Sword)
* and WorldMgr::sInstance->disableScaling (set to true when entering Trial of the Sword)


This means that scaling is always disabled in the Trial of the Sword.


Scaling will also be skipped if the current [[map area]] is 28. This corresponds to "HateruSea", which is the Eventide Island area.

== Weapons == 


'scaleWeapon' is called (i.e. weapons may be scaled) for a weapon if:
* '''For standalone weapons''': The actor property 'LevelSensorMode' is higher than 1 '''and''' it wasn't already picked up.
* '''For treasure chest drops''': If SharpWeaponJudgeType is not 4, when [[AIDef:AI/TreasureBox]] initialises the drop actor.
* '''For Hinox weapons''': The flag <code>{MapName}_Necklace_{i}_{HinoxName}_{ID}</code> is false.
* '''For other enemy drops''': The flag <code>{MapName}_WeaponDrop_{ID}</code> is false, '''and''' [the actor property 'LevelSensorMode' is higher than 1 ''or'' the enemy is a Guardian Scout ('Enemy_Guardian_Mini')].


Note: Weapons that are bought from a shop cannot receive modifiers because they do not fit into any of the above cases.

== Weapon modifiers == 


Weapon scaling results in weapons being replaced by a different weapon (e.g. a Soldier's Bow which becomes a Royal Bow), or weapons gaining a random, bonus stat boost (e.g. Attack Up, Durability Up, etc.). The range of those boosts is also affected by weapon scaling.


There are two bonus tiers in the game: one for low-level types (which appear in blue/white in the game UI) and another for high-level types (yellow). Those that belong to the Yellow tier are usually superior to the other ones. For instance, ''Attack Up +'' is the superior variant of ''Attack Up'' and it typically grants a higher attack power boost compared to ''Attack Up''.

=== Modifier types === 


Which modifier a weapon receives is random each time Link obtains it. Which modifiers a weapon can possibly have is specific for each in [[ActorParam/GeneralParamList]], and is based on the weapon's type and the modifier tier. Note that certain modifiers can only appear at certain tiers— in particular, this means once a weapon is scaled to yellow modifiers, it can no longer receive the Critical Hit buff.

The odds for each type of modifier is determined by an algorithm in actWeapon which depends on the possible modifiers for a given weapon at a given tier. As such, this algorithm yields the following odds for different types of weapons:
</translate>
{|class="wikitable" style="text-align: center;"
! rowspan=2|Weapon !! rowspan=2|Modifier Tier !! AddAtk !! AddLife !! AddCrit !! AddGuard !! AddThrow !! AddSpreadFire !! AddZoomRapid !! AddRapidFire !! AddSurfMaster
|-
| <translate> Attack Up</translate> || <translate> Durability Up</translate> || <translate> Critical Hit</translate> || <translate> Shield Guard Up</translate> || <translate> Long Throw</translate> || <translate> 5-Shot Burst</translate> || <translate> ''Unused''[[#Notes|[a] ]]</translate> || <translate> Quick Shot</translate> || ''Unused''[[#Notes|[b] ]]
|-
| Sword || White/Blue || 25% || 33.3̅3̅%|| 41.6̅6̅% || - || - || - || - || - || -
|-
| Sword || Yellow || 25% || 33.3̅3̅% || - || - || 41.6̅6̅% || - || - || - || -
|-
| Shield || White/Blue || - || 50% || - || 50%[[#Notes|[c] ]] || - || - || - || - || -
|-
| Shield || Yellow || - || 50% || - || 50%[[#Notes|[c] ]] || - || - || - || - || -
|-
| Bow || White/Blue || 50% || 50% || - || - || - || - || - || - || -
|-
| Normal Bow || Yellow || 25% || 33.3̅3̅% || - || - || - || - || - || 41.6̅6̅% || -
|-
| Multi-Shot Bow[[#Notes|[d] ]] || Yellow || 12.5% || 22.2̅2̅% || - || - || - || 29.16̅% || - || 36.1̅1̅% || -
|-
|}

<translate>
==== Notes ==== 
* [a] AddSurfMaster is a bonus that only applies to shields and gives them a lower friction for shield surfing. That bonus type is unused in the game.
* [b] AddZoomRapid is another unused bonus that gives bows a zoom when aimed, similar to the property inherent to the Golden and Phrenic Bows.
* [c] Due to a bug, if "Shield Guard Up" is rolled for an amiibo weapon, "Durability Up" will be applied instead.<ref name="amiiboShield">The bugged code is in function {{addr|a=0x71002df7d8|ver=nx-1.5.0}}.</ref>
* [d] These are for bows which can have the 5-Shot Burst modifier, which are the Forest Dweller's Bow, Mighty Lynel Bow, and the Savage Lynel Bow. (Despite shooting 2 arrows, the Duplex Bow cannot have this modifier.)

=== Modifier values === 


Bonus values (e.g. the actual durability or attack power increase) are determined from [[ActorParam/GeneralParamList]] (with a copy of the information in [[ActorInfoData]]). Valid ranges and bonuses for each weapon are configured in the WeaponCommon section. The possible values for a bonus are generally higher for a yellow tier.

==== Non-amiibo weapons ==== 
</translate>
{|class="wikitable" style="text-align: center;"
! <translate> Modifier chosen</translate> !! Effect if applied !! Bonus Value (White/Blue) !! Bonus Value (Yellow)
|-
| <translate> None</translate> || - || - || -
|-
| <translate> Attack Up</translate> || Attack value boosted by: || Random integer between [SharpWeaponAddAtkMin, SharpWeaponAddAtkMax] || Random integer between [PoweredSharpAddAtkMin, PoweredSharpAddAtkMax]
|-
| <translate> Durability Up</translate> || Durability value boosted by: || Random integer between [SharpWeaponAddLifeMin, SharpWeaponAddLifeMax] || Random integer between [PoweredSharpAddLifeMin, PoweredSharpAddLifeMax]
|-
| Critical Hit || Last hit of a chain does double damage/staggers enemies || - || N/A
|-
| <translate> Shield Guard Up</translate> || Shield guard value boosted by: || Random integer between [SharpWeaponAddGuardMin, SharpWeaponAddGuardMax] || Random integer between [PoweredSharpWeaponAddGuardMin, PoweredSharpWeaponAddGuardMax]
|-
| <translate> Long Throw</translate> || Throw distance multiplied by: || - || Random float between [PoweredSharpAddThrowMin, PoweredSharpAddThrowMax]
|-
| <translate> Multi-Shot Burst</translate> || Bow shoots multiple arrows: || - || 5
|-
| ''AddZoomRapid'' || Reticle zooms when aiming || - || Unknown {{check}}
|-
| <translate> Quick Shot</translate> || Firing rate multiplied by: || - || Random float between [PoweredSharpAddRapidFireMin, PoweredSharpAddRapidFireMax]
|-
| <translate> ''AddSurfMaster''</translate> || Shield surfing friction multiplied by: || - || 0.2 (from [[GlobalParameter]]::ShieldSurfMasterFrictionRatio)
|}

<translate>

In summary, for non-amiibo weapons, a modifier bonus results in a randomized additional value in a certain range for each item.

==== amiibo weapons ==== 


Because of a bug in the game code<ref name="amiiboShield"></ref>, any time the game randomly chooses the "Shield Guard Up" bonus, the actual bonus that gets assigned to the weapon and shows up in the user interface is "Durability Up". For this reason, the extra durability value that is used for shields with the "Durability Up" bonus is either addLifeMax or addGuardMax, depending on which bonus was chosen.
</translate>

{|class="wikitable" style="text-align: center;"
! <translate> Modifier chosen</translate> !! Effect if applied !! Bonus Value (White/Blue) !! Bonus Value (Yellow)
|-
| <translate> None</translate> || - || - || -
|-
| <translate> Attack Up</translate> || Attack value boosted by: || SharpWeaponAddAtkMax || PoweredSharpAddAtkMax
|-
| <translate> Durability Up</translate> || Durability value boosted by: || SharpWeaponAddLifeMax || PoweredSharpAddLifeMax
|-
| Critical Hit || Last hit of a chain does double damage/staggers enemies || - || N/A
|-
| <translate> Shield Guard Up</translate> || '''Durability''' value boosted by: || SharpWeaponAddGuardMax || PoweredSharpWeaponAddGuardMax
|-
| <translate> Long Throw</translate> || Throw distance multiplied by: || - || PoweredSharpAddThrowMax
|-
| <translate> Multi-Shot Burst</translate> || Bow shoots multiple arrows: || - || 5
|-
| ''AddZoomRapid'' || Reticle zooms when aiming || - || Unknown {{check}}
|-
| <translate> Quick Shot</translate> || Firing rate multiplied by: || - || PoweredSharpAddRapidFireMin
|-
| <translate> ''AddSurfMaster''</translate> || Shield surfing friction multiplied by: || - || 0.2 (from [[GlobalParameter]]::ShieldSurfMasterFrictionRatio)
|}

<translate>

In summary, for amiibo weapons, a modifier always yields the highest possible value for that weapon as a bonus, except Quick Shot, which will use the ''lowest'' value.
No randomness is involved, aside from whether the Durability Up bonus comes from the AddLifeMax or AddGuardMax value.

== Enemies == 


When loading enemies, the game will always try to scale enemies.


However, the scaling function won't do anything if 'LevelSensorMode' is < 1 and will leave the enemy and any weapons they may hold unscaled.


Note: Enemies that are not in any upgrade list (such as elemental Lizalfos) will not be scaled, but their weapon can still receive upgrades if:
* 'LevelSensorMode' is non zero.
* Weapon point requirements are satisfied
* ''or'' the modifier tier is overridden using 'SharpWeaponJudgeType'.
[1.3.0] In Master Mode, '''all''' enemies are automatically ranked up one tier by default '''post scaling''', independently of 'LevelSensorMode'. [[Actor]]s can receive two additional parameters:
</translate>
{| class="wikitable"
! <translate> Parameter</translate>
! <translate> Default</translate>
! <translate> Description</translate>
|-
| IsHardModeActor
| false
| <translate> Controls whether an enemy only shows up in Master Mode.</translate>
|-
| DisableRankUpForHardMode
| false
| <translate> Controls whether the automatic rankup applies to an enemy.</translate>
|}
<translate>

In Master Mode, IsHardModeActor, DisableRankUpForHardMode and LevelSensorMode are combined on some actors to keep low-level enemies in the overworld (e.g. Red Bokoblin south of the Great Plateau).

== Properties == 

=== <code>LevelSensorMode</code> === 
This [[actor]] property controls whether scaling is enabled for an enemy or weapon. Also applies to any weapons held by an enemy since 'scaleWeapon' is called when an enemy drops their weapon.


Note that this doesn't apply to weapons that are attached to a Hinox's necklace, because Hinoxes use a different underlying enemy actor which overrides the 'on weapon dropped' function and ignores 'LevelSensorMode'.

=== <code>SharpWeaponJudgeType</code> === 
This actor property controls the ''minimum'' modifier tier that a weapon can receive.


Internally and in assets such as [[Map unit|map units]], the following values are used for modifiers:
</translate>

{| class="wikitable"
! <translate> Value</translate>
! <translate> Description</translate>
|-
| 0
| <translate> '''None''': No modifiers.</translate>
|-
| 1
| <translate> '''RandomBlue''': Weapon will randomly get at least a blue modifier (with <code>weaponCommonSharpWeaponPer</code> being the probability).</translate>
|-
| 2
| <translate> '''Blue''': Weapon will get at least a blue modifier.</translate>
|-
| 3
| <translate> '''Yellow''': Weapon will get at least a yellow modifier.</translate>
|-
| 4
| <translate> '''NoneForced''' (chests only): Weapon will ''never'' spawn with any modifiers. ''This overrides regular scaling.''</translate>
|}

<translate>

If [[Difficulty scaling#LevelSensorMode|scaling]] is enabled, the weapon may receive modifiers from an even higher tier if point requirements are met.


Otherwise, the weapon will get modifiers from exactly the specified tier.


For example, 0 ('None') doesn't mean a weapon will never receive a modifier. It just means that the developers haven't forced the weapon to spawn with a blue/yellow modifier. If scaling requirements are satisfied, the weapon will receive blue or yellow modifiers.

== Scaling algorithm == 

=== <code>Ecosystem::LevelSensor::loadByml</code> === 


This function is called by <code>Ecosystem::init</code> from <code>ksys::InitializeApp</code>


Sets up byml structures for reading Ecosystem/[[LevelSensor.byml]].

=== <code>Ecosystem::LevelSensor::calculatePoints</code> === 


Called by [[PlacementMgr]] when spawning actors.


Calculates weapon and enemy scaling points using a list of flags and configuration values.


All flags that are referenced in the configuration file are of the form <code>Defeated_%s_Num</code>, but technically the configuration format allows for other flags to be specified.


Interestingly, the game calculates a single point value based on the kill counter flags but calculates two separate values for weapons and enemies with two different multipliers. This format makes it possible to easily change the scaling.


<source lang="c++">
float points = 0.0;
for (kill_flag : this->byml["flag"])
int kill_count = GameData::getIntegerFlag(kill_flag["name"]);
points += kill_count * kill_flag["point"];


this->points = points;
this->weapon_points = points * this->byml["setting"].Level2WeaponPower;
this->enemy_points = points * this->byml["setting"].Level2EnemyPower;
</source>


In practice, settings have never been modified. 1.5.0 (which will likely be the last game update) still has the same Level2WeaponPower and Level2EnemyPower.

=== <code>Ecosystem::LevelSensor::scaleWeapon</code> === 


Called from treasure chest code, enemy actors{{Check}}, <code>Ecosystem::LevelSensor::scaleActor</code>


Given a weapon name, its modifier and current point status, this function returns the weapon to actually spawn and the modifier to use (if possible).


If the algorithm fails to find an appropriate weapon that satisfies all conditions (point requirements, weapon series, modifier), the originally specified weapon and modifier will be used directly.


Pseudocode (1.0.0):


<source lang="c++">
bool Ecosystem::LevelSensor::scaleWeapon(const sead::SafeString& weapon_to_look_up,
WeaponModifier required_modifier,
const char** weapon_to_use_name,
WeaponModifier* modifier_to_use,
void* unknown)
{
// some checks using 'unknown' here which seems to be a pointer to the actor
//
for (weapon_table : this->byml["weapon"]) {
// find the first weapon entry for which the player has enough points
// with the specified name and modifier
i = -1;
for (j = 0; j < weapon_table["actors"].size; ++j) {
entry = weapon_table["actors"][j];
float points_for_next_transition = entry["value"];
//
if (this->weapon_points > points_for_next_transition &&
weapon_to_look_up == entry["name"] &&
convert_to_modifier(entry["plus"]) == required_modifier) {
i = j;
break;
}
}
//
if (i == -1)
continue;
//
do {
entry = weapon_table["actors"][i];
//
// not_rank_up means there is no link between weapons;
// this table is just used to look up modifiers.
// so go down the list until there are no more entries for the requested weapon
// or until we reach a modifier that requires more points.
if (weapon_table["not_rank_up"] && entry["name"] != weapon_to_look_up)
break;
//
// otherwise, just go down the list until we reach the end or a weapon which
// requires more points. this will possibly upgrade the weapon (e.g. Knight -> Royal).
if (this->weapon_points <= entry["value"])
break;
//
++i;
} while (i < weapon_table["actors"].size);
//
*weapon_to_use_name = entry["name"];
*modifier_to_use = convert_to_modifier(entry["plus"]);
return true;
}
return false; // cannot scale up
}
</source>

=== <code>Ecosystem::LevelSensor::scaleActor</code> === 


Analogous to <code>LevelSensor::scaleWeapon</code>.


Pseudocode (1.0.0):


<source lang="c++">
if (actor->params["LevelSensorMode"] < 1)
return false;
//
if (actor_name.contains("Enemy")) {
for (enemy_table : this->byml["enemy"]) {
i = -1;
for (j = 0; j < enemy_table["actors"].size; ++j) {
entry = enemy_table["actors"][j];
if (entry["name"] == actor_name && this->enemy_points > entry["value"]) {
i = j;
break;
}
}
//
if (i == -1)
continue;
//
do {
entry = enemy_table["actors"][i];
if (this->enemy_points <= entry["value"])
break;
++i;
} while (i < enemy_table["actors"].size);
//
*actor_to_use = entry["name"];
return true;
}
return false; // cannot scale up
}
//
if (actor_name.contains("Weapon")) {
weapon_name = actor->getWeaponName();
modifier = actor->params["SharpWeaponJudgeType"];
if (modifier == WeaponModifier::RandomBlue)
modifier = get_random_blue_modifier(actor->getWeaponName());
//
if (scaleWeapon(weapon_name, &weapon_to_use, &modifier_to_use)) {
actor->setProperty("SharpWeaponJudgeType", modifier_to_use);
*actor_to_use = weapon_to_use;
return true;
}
return false; // cannot scale up
}
</source>

== The Data == 


To make things easier to understand, here are links to:
* [https://docs.google.com/spreadsheets/d/e/2PACX-1vRSlyOD7FLAn1TUBn64Pu8Pld-WOfgcVByuywHMWvBTEV0j8potD1wkBs-MJJXf-gvEkpfItUCMqMk6/pubhtml kill point, enemy scaling and weapon scaling tables]
* an [https://objmap.zeldamods.org object map with scaling information].
This makes it possible to see both the required points for enemy/weapon upgrades, as well as all of the special cases extremely easily.

== Ganon Blights == 


Ganon blights also have varying difficulty but follow a different system. Their health is determined by the base HP (set in [[ActorParam/GeneralParamList|GeneralParamList]]) and blight defeat flags.


<source lang="c++">__int64 SiteBoss::getInitialHP(SiteBoss *this) // 0x71002D01F4
{
const int baseHp = Enemy::getInitialHP(this);
const int halfBaseHp = baseHp >> 1;
const bool dieGanonWind = hasFlag_Die_PGanonWind(0);
const bool dieGanonWater = hasFlag_Die_PGanonWater(0);
const bool dieGanonFire = hasFlag_Die_PGanonFire(0);
const bool dieGanonElectric = hasFlag_Die_PGanonElectric(0);
const int flags = this->siteBossFlags & 0xFFFFFFFC;
int multiplier;
if ( flags == 4 )
multiplier = 3;
else if ( flags == 8 )
multiplier = 4;
else
multiplier = dieGanonFire + dieGanonWind + dieGanonWater + dieGanonElectric;
return baseHp + multiplier * halfBaseHp;
}</source>


Effectively, this means that the first blight Link fights will have 800+0×400 = 800 HP, the second will have 800+1×400 = 1200 HP, the third 800+2×400 = 1600 HP and the last one 800+3×400 = 2000 HP.

=== Special case 1: Castle Blights === 


Castle blights have <code>IsRemainBoss</code> set to false in their root AI parameters (see [[AIDef:AI/SiteBossSpearRoot]] for example), which sets flag 4.


Thus, blights that are fought in the Castle always have 800+3×400 = 2000 HP regardless of story progression.


If flag 4 is set, the [[AIDef:Action/SiteBossDie]] code will NOT increment the "defeated" counter. This means castle blights do not give any scaling points.

=== Special case 2: DLC2 Blights === 


Illusory Realm blights possess the <code>EnemySiteBoss_R</code> actor tag. This causes flag 8 to be set. So they will always have 500+4×250 = 1500 HP.


Interestingly, the Windblight AI function doesn't check the actor tag but the actor name instead. For flag 8 to be set, the actor name must be <code>Enemy_SiteBoss_Bow_R</code>.

</translate>

<references />
[[Category:Internals{{#translation:}}]]
[[Category:Game mechanics{{#translation:}}]]

Difficulty scaling

2023-02-03T02:44:12Z

Chubby Bub: Detailing probability and effect of each modifier. I calculated these odds from the algorithm and had them verified through in-game testing.

<languages/>
<translate>


'''Difficulty scaling''' is a mechanic in ''Breath of the Wild'' that results in enemies and weapons being progressively replaced by more powerful variants during a playthrough.

== Points == 


The scaling system is based on a point system. Killing enemies is the ''only way'' to receive points.


Whenever an enemy dies, the game increments a flag 'Defeated_{SameGroupActorName}_Num' if all of the following conditions are satisfied:
* The current kill count is < 10.
* The actor does not have the NotCountDefeatedNum [[actor tag]].
* '''For Monk Maz Koshia''': 'Defeated_Priest_Boss_Normal_Num' is 0.
* '''For Dark Beast Ganon''': It is the first time the boss is beaten. (Ganon's Defeated flag has 1 as the maximum value.)
* '''For Blights''': It is the first time the blight is beaten in the Divine Beast, or in the Illusory Realm. Blights fought in Hyrule Castle do not count.
This happens every time ''any'' enemy dies, even if they don't necessarily play a role in the point system (see below) and even if the player is not responsible for their death.


Because enemies have to be killed throughout the main quest and bosses are considered as enemies too, difficulty scaling is unavoidable.


Only the defeated counter flags are stored in the save file. The <code>Ecosystem::LevelSensor</code> subsystem is responsible for [[Difficulty scaling#Ecosystem::LevelSensor::calculatePoints|converting these kill counts to points]] using a [[Difficulty scaling#Ecosystem::LevelSensor::loadByml|configuration file]].


The subsystem provides two functions ([[Difficulty scaling#Ecosystem::LevelSensor::scaleWeapon|<code>scaleWeapon</code>]] and [[Difficulty scaling#Ecosystem::LevelSensor::scaleActor|<code>scaleActor</code>]]) that may be called when a weapon or enemy actor is created.

== Scaling inhibitors == 


Both scaling functions will immediately return without doing anything if:
* [[WorldMgr]]::sInstance->stageType == 1 (Open World [[stage]])
* and WorldMgr::sInstance->isAocField (current map is Trial of the Sword)
* and WorldMgr::sInstance->disableScaling (set to true when entering Trial of the Sword)


This means that scaling is always disabled in the Trial of the Sword.


Scaling will also be skipped if the current [[map area]] is 28. This corresponds to "HateruSea", which is the Eventide Island area.

== Weapons == 


'scaleWeapon' is called (i.e. weapons may be scaled) for a weapon if:
* '''For standalone weapons''': The actor property 'LevelSensorMode' is higher than 1 '''and''' it wasn't already picked up.
* '''For treasure chest drops''': If SharpWeaponJudgeType is not 4, when [[AIDef:AI/TreasureBox]] initialises the drop actor.
* '''For Hinox weapons''': The flag <code>{MapName}_Necklace_{i}_{HinoxName}_{ID}</code> is false.
* '''For other enemy drops''': The flag <code>{MapName}_WeaponDrop_{ID}</code> is false, '''and''' [the actor property 'LevelSensorMode' is higher than 1 ''or'' the enemy is a Guardian Scout ('Enemy_Guardian_Mini')].


Note: Weapons that are bought from a shop cannot receive modifiers because they do not fit into any of the above cases.

== Weapon modifiers == 


Weapon scaling results in weapons being replaced by a different weapon (e.g. a Soldier's Bow which becomes a Royal Bow), or weapons gaining a random, bonus stat boost (e.g. Attack Up, Durability Up, etc.). The range of those boosts is also affected by weapon scaling.


There are two bonus tiers in the game: one for low-level types (which appear in blue/white in the game UI) and another for high-level types (yellow). Those that belong to the Yellow tier are usually superior to the other ones. For instance, ''Attack Up +'' is the superior variant of ''Attack Up'' and it typically grants a higher attack power boost compared to ''Attack Up''.

=== Modifier types === 


Which modifier a weapon receives is random each time Link obtains it. Which modifiers a weapon can possibly have is specific for each in [[ActorParam/GeneralParamList]], and is based on the weapon's type and the modifier tier. Note that certain modifiers can only appear at certain tiers— in particular, this means once a weapon is scaled to yellow modifiers, it can no longer receive the Critical Hit buff.

The odds for each type of modifier is determined by an algorithm in actWeapon which depends on the possible modifiers for a given weapon at a given tier. As such, this algorithm yields the following odds for different types of weapons:
</translate>
{|class="wikitable" style="text-align: center;"
! rowspan=2|Weapon !! rowspan=2|Modifier Tier !! AddAtk !! AddLife !! AddCrit !! AddGuard !! AddThrow !! AddSpreadFire !! AddZoomRapid !! AddRapidFire !! AddSurfMaster
|-
| <translate> Attack Up</translate> || <translate> Durability Up</translate> || <translate> Critical Hit</translate> || <translate> Shield Guard Up</translate> || <translate> Long Throw</translate> || <translate> 5-Shot Burst</translate> || <translate> ''Unused''[[#Notes|[a] ]]</translate> || <translate> Quick Shot</translate> || ''Unused''[[#Notes|[b] ]]
|-
| Sword || White/Blue || 25% || 33.3̅3̅%|| 41.6̅6̅% || - || - || - || - || - || -
|-
| Sword || Yellow || 25% || 33.3̅3̅% || - || - || 41.6̅6̅% || - || - || - || -
|-
| Shield || White/Blue || - || 50% || - || 50%[[#Notes|[c] ]] || - || - || - || - || -
|-
| Shield || Yellow || - || 50% || - || 50%[c] || - || - || - || - || -
|-
| Bow || White/Blue || 50% || 50% || - || - || - || - || - || - || -
|-
| Normal Bow || Yellow || 25% || 33.3̅3̅% || - || - || - || - || - || 41.6̅6̅% || -
|-
| Multi-Shot Bow[[#Notes|[d] ]] || Yellow || 12.5% || 22.2̅2̅% || - || - || - || 29.16̅% || - || 36.1̅1̅% || -
|-
|}

<translate>
==== Notes ==== 
* [a] AddSurfMaster is a bonus that only applies to shields and gives them a lower friction for shield surfing. That bonus type is unused in the game.
* [b] AddZoomRapid is another unused bonus that gives bows a zoom when aimed, similar to the property inherent to the Golden and Phrenic Bows.
* [c] Due to a bug, if "Shield Guard Up" is rolled for an amiibo weapon, "Durability Up" will be applied instead.<ref name="amiiboShield">The bugged code is in function {{addr|a=0x71002df7d8|ver=nx-1.5.0}}.</ref>
* [d] These are for bows which can have the 5-Shot Burst modifier, which are the Forest Dweller's Bow, Mighty Lynel Bow, and the Savage Lynel Bow. (Despite shooting 2 arrows, the Duplex Bow cannot have this modifier.)

=== Modifier values === 


Bonus values (e.g. the actual durability or attack power increase) are determined from [[ActorParam/GeneralParamList]] (with a copy of the information in [[ActorInfoData]]). Valid ranges and bonuses for each weapon are configured in the WeaponCommon section. The possible values for a bonus are generally higher for a yellow tier.

==== Non-amiibo weapons ==== 
</translate>
{|class="wikitable" style="text-align: center;"
! <translate> Modifier chosen</translate> !! Effect if applied !! Bonus Value (White/Blue) !! Bonus Value (Yellow)
|-
| <translate> None</translate> || - || - || -
|-
| <translate> Attack Up</translate> || Attack value boosted by: || Random integer between [SharpWeaponAddAtkMin, SharpWeaponAddAtkMax] || Random integer between [PoweredSharpAddAtkMin, PoweredSharpAddAtkMax]
|-
| <translate> Durability Up</translate> || Durability value boosted by: || Random integer between [SharpWeaponAddLifeMin, SharpWeaponAddLifeMax] || Random integer between [PoweredSharpAddLifeMin, PoweredSharpAddLifeMax]
|-
| Critical Hit || Last hit of a chain does double damage/staggers enemies || - || N/A
|-
| <translate> Shield Guard Up</translate> || Shield guard value boosted by: || Random integer between [SharpWeaponAddGuardMin, SharpWeaponAddGuardMax] || Random integer between [PoweredSharpWeaponAddGuardMin, PoweredSharpWeaponAddGuardMax]
|-
| <translate> Long Throw</translate> || Throw distance multiplied by: || - || Random float between [PoweredSharpAddThrowMin, PoweredSharpAddThrowMax]
|-
| <translate> Multi-Shot Burst</translate> || Bow shoots multiple arrows: || - || 5
|-
| ''AddZoomRapid'' || Reticle zooms when aiming || - || Unknown {{check}}
|-
| <translate> Quick Shot</translate> || Firing rate multiplied by: || - || Random float between [PoweredSharpAddRapidFireMin, PoweredSharpAddRapidFireMax]
|-
| <translate> ''AddSurfMaster''</translate> || Shield surfing friction multiplied by: || - || 0.2 (from [[GlobalParameter]]::ShieldSurfMasterFrictionRatio)
|}

<translate>

In summary, for non-amiibo weapons, a modifier bonus results in a randomized additional value in a certain range for each item.

==== amiibo weapons ==== 


Because of a bug in the game code<ref name="amiiboShield"></ref>, any time the game randomly chooses the "Shield Guard Up" bonus, the actual bonus that gets assigned to the weapon and shows up in the user interface is "Durability Up". For this reason, the extra durability value that is used for shields with the "Durability Up" bonus is either addLifeMax or addGuardMax, depending on which bonus was chosen.
</translate>

{|class="wikitable" style="text-align: center;"
! <translate> Modifier chosen</translate> !! Effect if applied !! Bonus Value (White/Blue) !! Bonus Value (Yellow)
|-
| <translate> None</translate> || - || - || -
|-
| <translate> Attack Up</translate> || Attack value boosted by: || SharpWeaponAddAtkMax || PoweredSharpAddAtkMax
|-
| <translate> Durability Up</translate> || Durability value boosted by: || SharpWeaponAddLifeMax || PoweredSharpAddLifeMax
|-
| Critical Hit || Last hit of a chain does double damage/staggers enemies || - || N/A
|-
| <translate> Shield Guard Up</translate> || '''Durability''' value boosted by: || SharpWeaponAddGuardMax || PoweredSharpWeaponAddGuardMax
|-
| <translate> Long Throw</translate> || Throw distance multiplied by: || - || PoweredSharpAddThrowMax
|-
| <translate> Multi-Shot Burst</translate> || Bow shoots multiple arrows: || - || 5
|-
| ''AddZoomRapid'' || Reticle zooms when aiming || - || Unknown {{check}}
|-
| <translate> Quick Shot</translate> || Firing rate multiplied by: || - || PoweredSharpAddRapidFireMin
|-
| <translate> ''AddSurfMaster''</translate> || Shield surfing friction multiplied by: || - || 0.2 (from [[GlobalParameter]]::ShieldSurfMasterFrictionRatio)
|}

<translate>

In summary, for amiibo weapons, a modifier always yields the highest possible value for that weapon as a bonus, except Quick Shot, which will use the ''lowest'' value.
No randomness is involved, aside from whether the Durability Up bonus comes from the AddLifeMax or AddGuardMax value.

== Enemies == 


When loading enemies, the game will always try to scale enemies.


However, the scaling function won't do anything if 'LevelSensorMode' is < 1 and will leave the enemy and any weapons they may hold unscaled.


Note: Enemies that are not in any upgrade list (such as elemental Lizalfos) will not be scaled, but their weapon can still receive upgrades if:
* 'LevelSensorMode' is non zero.
* Weapon point requirements are satisfied
* ''or'' the modifier tier is overridden using 'SharpWeaponJudgeType'.
[1.3.0] In Master Mode, '''all''' enemies are automatically ranked up one tier by default '''post scaling''', independently of 'LevelSensorMode'. [[Actor]]s can receive two additional parameters:
</translate>
{| class="wikitable"
! <translate> Parameter</translate>
! <translate> Default</translate>
! <translate> Description</translate>
|-
| IsHardModeActor
| false
| <translate> Controls whether an enemy only shows up in Master Mode.</translate>
|-
| DisableRankUpForHardMode
| false
| <translate> Controls whether the automatic rankup applies to an enemy.</translate>
|}
<translate>

In Master Mode, IsHardModeActor, DisableRankUpForHardMode and LevelSensorMode are combined on some actors to keep low-level enemies in the overworld (e.g. Red Bokoblin south of the Great Plateau).

== Properties == 

=== <code>LevelSensorMode</code> === 
This [[actor]] property controls whether scaling is enabled for an enemy or weapon. Also applies to any weapons held by an enemy since 'scaleWeapon' is called when an enemy drops their weapon.


Note that this doesn't apply to weapons that are attached to a Hinox's necklace, because Hinoxes use a different underlying enemy actor which overrides the 'on weapon dropped' function and ignores 'LevelSensorMode'.

=== <code>SharpWeaponJudgeType</code> === 
This actor property controls the ''minimum'' modifier tier that a weapon can receive.


Internally and in assets such as [[Map unit|map units]], the following values are used for modifiers:
</translate>

{| class="wikitable"
! <translate> Value</translate>
! <translate> Description</translate>
|-
| 0
| <translate> '''None''': No modifiers.</translate>
|-
| 1
| <translate> '''RandomBlue''': Weapon will randomly get at least a blue modifier (with <code>weaponCommonSharpWeaponPer</code> being the probability).</translate>
|-
| 2
| <translate> '''Blue''': Weapon will get at least a blue modifier.</translate>
|-
| 3
| <translate> '''Yellow''': Weapon will get at least a yellow modifier.</translate>
|-
| 4
| <translate> '''NoneForced''' (chests only): Weapon will ''never'' spawn with any modifiers. ''This overrides regular scaling.''</translate>
|}

<translate>

If [[Difficulty scaling#LevelSensorMode|scaling]] is enabled, the weapon may receive modifiers from an even higher tier if point requirements are met.


Otherwise, the weapon will get modifiers from exactly the specified tier.


For example, 0 ('None') doesn't mean a weapon will never receive a modifier. It just means that the developers haven't forced the weapon to spawn with a blue/yellow modifier. If scaling requirements are satisfied, the weapon will receive blue or yellow modifiers.

== Scaling algorithm == 

=== <code>Ecosystem::LevelSensor::loadByml</code> === 


This function is called by <code>Ecosystem::init</code> from <code>ksys::InitializeApp</code>


Sets up byml structures for reading Ecosystem/[[LevelSensor.byml]].

=== <code>Ecosystem::LevelSensor::calculatePoints</code> === 


Called by [[PlacementMgr]] when spawning actors.


Calculates weapon and enemy scaling points using a list of flags and configuration values.


All flags that are referenced in the configuration file are of the form <code>Defeated_%s_Num</code>, but technically the configuration format allows for other flags to be specified.


Interestingly, the game calculates a single point value based on the kill counter flags but calculates two separate values for weapons and enemies with two different multipliers. This format makes it possible to easily change the scaling.


<source lang="c++">
float points = 0.0;
for (kill_flag : this->byml["flag"])
int kill_count = GameData::getIntegerFlag(kill_flag["name"]);
points += kill_count * kill_flag["point"];


this->points = points;
this->weapon_points = points * this->byml["setting"].Level2WeaponPower;
this->enemy_points = points * this->byml["setting"].Level2EnemyPower;
</source>


In practice, settings have never been modified. 1.5.0 (which will likely be the last game update) still has the same Level2WeaponPower and Level2EnemyPower.

=== <code>Ecosystem::LevelSensor::scaleWeapon</code> === 


Called from treasure chest code, enemy actors{{Check}}, <code>Ecosystem::LevelSensor::scaleActor</code>


Given a weapon name, its modifier and current point status, this function returns the weapon to actually spawn and the modifier to use (if possible).


If the algorithm fails to find an appropriate weapon that satisfies all conditions (point requirements, weapon series, modifier), the originally specified weapon and modifier will be used directly.


Pseudocode (1.0.0):


<source lang="c++">
bool Ecosystem::LevelSensor::scaleWeapon(const sead::SafeString& weapon_to_look_up,
WeaponModifier required_modifier,
const char** weapon_to_use_name,
WeaponModifier* modifier_to_use,
void* unknown)
{
// some checks using 'unknown' here which seems to be a pointer to the actor
//
for (weapon_table : this->byml["weapon"]) {
// find the first weapon entry for which the player has enough points
// with the specified name and modifier
i = -1;
for (j = 0; j < weapon_table["actors"].size; ++j) {
entry = weapon_table["actors"][j];
float points_for_next_transition = entry["value"];
//
if (this->weapon_points > points_for_next_transition &&
weapon_to_look_up == entry["name"] &&
convert_to_modifier(entry["plus"]) == required_modifier) {
i = j;
break;
}
}
//
if (i == -1)
continue;
//
do {
entry = weapon_table["actors"][i];
//
// not_rank_up means there is no link between weapons;
// this table is just used to look up modifiers.
// so go down the list until there are no more entries for the requested weapon
// or until we reach a modifier that requires more points.
if (weapon_table["not_rank_up"] && entry["name"] != weapon_to_look_up)
break;
//
// otherwise, just go down the list until we reach the end or a weapon which
// requires more points. this will possibly upgrade the weapon (e.g. Knight -> Royal).
if (this->weapon_points <= entry["value"])
break;
//
++i;
} while (i < weapon_table["actors"].size);
//
*weapon_to_use_name = entry["name"];
*modifier_to_use = convert_to_modifier(entry["plus"]);
return true;
}
return false; // cannot scale up
}
</source>

=== <code>Ecosystem::LevelSensor::scaleActor</code> === 


Analogous to <code>LevelSensor::scaleWeapon</code>.


Pseudocode (1.0.0):


<source lang="c++">
if (actor->params["LevelSensorMode"] < 1)
return false;
//
if (actor_name.contains("Enemy")) {
for (enemy_table : this->byml["enemy"]) {
i = -1;
for (j = 0; j < enemy_table["actors"].size; ++j) {
entry = enemy_table["actors"][j];
if (entry["name"] == actor_name && this->enemy_points > entry["value"]) {
i = j;
break;
}
}
//
if (i == -1)
continue;
//
do {
entry = enemy_table["actors"][i];
if (this->enemy_points <= entry["value"])
break;
++i;
} while (i < enemy_table["actors"].size);
//
*actor_to_use = entry["name"];
return true;
}
return false; // cannot scale up
}
//
if (actor_name.contains("Weapon")) {
weapon_name = actor->getWeaponName();
modifier = actor->params["SharpWeaponJudgeType"];
if (modifier == WeaponModifier::RandomBlue)
modifier = get_random_blue_modifier(actor->getWeaponName());
//
if (scaleWeapon(weapon_name, &weapon_to_use, &modifier_to_use)) {
actor->setProperty("SharpWeaponJudgeType", modifier_to_use);
*actor_to_use = weapon_to_use;
return true;
}
return false; // cannot scale up
}
</source>

== The Data == 


To make things easier to understand, here are links to:
* [https://docs.google.com/spreadsheets/d/e/2PACX-1vRSlyOD7FLAn1TUBn64Pu8Pld-WOfgcVByuywHMWvBTEV0j8potD1wkBs-MJJXf-gvEkpfItUCMqMk6/pubhtml kill point, enemy scaling and weapon scaling tables]
* an [https://objmap.zeldamods.org object map with scaling information].
This makes it possible to see both the required points for enemy/weapon upgrades, as well as all of the special cases extremely easily.

== Ganon Blights == 


Ganon blights also have varying difficulty but follow a different system. Their health is determined by the base HP (set in [[ActorParam/GeneralParamList|GeneralParamList]]) and blight defeat flags.


<source lang="c++">__int64 SiteBoss::getInitialHP(SiteBoss *this) // 0x71002D01F4
{
const int baseHp = Enemy::getInitialHP(this);
const int halfBaseHp = baseHp >> 1;
const bool dieGanonWind = hasFlag_Die_PGanonWind(0);
const bool dieGanonWater = hasFlag_Die_PGanonWater(0);
const bool dieGanonFire = hasFlag_Die_PGanonFire(0);
const bool dieGanonElectric = hasFlag_Die_PGanonElectric(0);
const int flags = this->siteBossFlags & 0xFFFFFFFC;
int multiplier;
if ( flags == 4 )
multiplier = 3;
else if ( flags == 8 )
multiplier = 4;
else
multiplier = dieGanonFire + dieGanonWind + dieGanonWater + dieGanonElectric;
return baseHp + multiplier * halfBaseHp;
}</source>


Effectively, this means that the first blight Link fights will have 800+0×400 = 800 HP, the second will have 800+1×400 = 1200 HP, the third 800+2×400 = 1600 HP and the last one 800+3×400 = 2000 HP.

=== Special case 1: Castle Blights === 


Castle blights have <code>IsRemainBoss</code> set to false in their root AI parameters (see [[AIDef:AI/SiteBossSpearRoot]] for example), which sets flag 4.


Thus, blights that are fought in the Castle always have 800+3×400 = 2000 HP regardless of story progression.


If flag 4 is set, the [[AIDef:Action/SiteBossDie]] code will NOT increment the "defeated" counter. This means castle blights do not give any scaling points.

=== Special case 2: DLC2 Blights === 


Illusory Realm blights possess the <code>EnemySiteBoss_R</code> actor tag. This causes flag 8 to be set. So they will always have 500+4×250 = 1500 HP.


Interestingly, the Windblight AI function doesn't check the actor tag but the actor name instead. For flag 8 to be set, the actor name must be <code>Enemy_SiteBoss_Bow_R</code>.

</translate>

<references />
[[Category:Internals{{#translation:}}]]
[[Category:Game mechanics{{#translation:}}]]