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

Water.extm

2022-06-25T14:29:03Z

Waikuteru: /* Water Map Data */

{{lowercase}}
<onlyinclude>
[[File:5000000000.water.extm.png|alt=Generated water material map of Hyrule Main Field|thumb|Generated water material map of Hyrule Main Field]]
<code>water.extm</code> files describe the water heightmap and the texture of the main field and add-on content field.
</onlyinclude>

==water.extm File Specification==

===water.extm File Layout===

Each file contains a 64×64 grid. For each vertex there is 8 bytes of data that describe the height of the mesh, the material type and flow speed.

===Water Map Data===

Each entry in the water data table is 8 bytes long.

{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
|0x00
|2
|Unsigned Short
|<code>height</code> (Vertex <code>y</code> component)
|-
|0x02
|2
|Unsigned Short
|<code>xAxisFlowRate 128= no flow</code>
|-
|0x04
|2
|Unsigned Short
|<code>zAxisFlowRate 128= no flow</code>
|-
|0x05
|1
|Unsigned Byte
|<code>materialIndex + 3</code>. This may act as a checksum?
|-
|0x06
|1
|Unsigned Byte
|<code>materialIndex</code>
|}

<code>height</code> and <code>flowSpeed</code> are stored as unsigned shorts, but seem to map to float values. These can be calculated by dividing by the max size of an unsigned short:

<syntaxhighlight lang="c" line="line">
32767 / 0xffff = 0.5
</syntaxhighlight>

<code>height</code> is further multiplied by another constant to get the final height (the constant is unknown at this time, but is close to <code>0x300 / 0xffff</code>).

<code>x</code> and <code>z</code><ref><code>z</code> is expected to be an integer quotient. The <code>floor</code> function can be used if integer division is not supported.</ref> can be calculated, while iterating through the data table:

<syntaxhighlight lang="c" line="line">
for (int index = 0; index < 64 * 64; index++) {
uint x = index % 64;
uint z = index / 64;
}
</syntaxhighlight>

Flow Rates are calculated as <code>(flowRate * 2) - 1</code> and ranges from <code>-1</code> to <code>1</code>. On the x-axis this changes flow direction from East (<code>-1</code>) to West (<code>+1</code>) and on the z-axis from North (<code>-1</code>) to South (<code>+1</code>).

===Material Index===

This data is stored in Terrain.Tex1.bfres.

{| class="wikitable"
!id
!file
!name
!attribute
!attribute_sub
!flag
!Google Translated
|-
|0
|Water
|水
|Water
|Water
|0
|Water
|-
|1
|HotWater
|熱湯
|Water
|Water_Hot
|0
|Hot water
|-
|2
|Poison
|毒水
|Water
|Water_Poison
|0
|Poison water
|-
|3
|Lava
|溶岩
|Lava
|Lava
|0
|Lava
|-
|4
|IceWater
|冷たい水
|Water
|Water_Ice
|0
|Cold water
|-
|5
|Mud
|泥沼
|Bog
|Bog
|0
|Bog
|-
|6
|Clear01
|透明水01
|Water
|Water
|0
|Clear water 01
|-
|7
|Sea
|海
|Water
|Water
|0
|Ocean
|}

<references />

[[Category:File formats]]
[[Category:File extensions]]
[[Category:File extensions (STERA)]]

ActorInfo.product.sbyml

2022-06-17T13:54:28Z

Waikuteru: /* Actors */

<onlyinclude>
{{NoRstb}}
'''ActorInfo.product.sbyml''' (found in the Actor directory) is a [[Yaz0]]-compressed [[BYML]] file which contains general information about all [[Actor|actors]] in the game. It is used when constructing actors, and also used to access actor data efficiently when loading the full [[actor pack]] is unnecessary (e.g. on menu screens). Therefore, in order to add new actors, or to change items' parameters on menu screens, this file must be edited.

ActorInfo is a machine generated file. It is not meant to be edited directly; much of the information it includes are either automatically generated or copied from [[ActorParam]] files (which can be found in the game [[content]]) and other source-only files.
</onlyinclude>

==Contents==

===Actors===
'''Actors''' is an array of dictionaries. It must be sorted in the same order as the Hashes section.

Each actor has its own entry in this array. Each entry has several properties, based on the actor's profile. The following is a list of valid entries for any profile. Any single profile will not require all of these properties.
{| class="wikitable"
!Key
!Type
!Description
!Source
|-
|aabbMax
|float
|Defines the maximum point for the axis-aligned bounding box (AABB) - the most-positive value on each axis that any of the actor's model's vertices inhabits. These values may (and probably do) come from three different vertices.

Can be altered to change the distance for AttentionClients like "Talk", "Examine", etc. to appear.
|sbfres, vertex coordinates
|-
|aabbMin
|float
|Defines the minimum point for the axis-aligned bounding box (AABB) - the most-negative value on each axis that any of the actor's model's vertices inhabits. These values may (and probably do) come from three different vertices.

Can be altered to change the distance for AttentionClients like "Talk", "Examine", etc. to appear.
|sbfres, vertex coordinates
|-
|actorScale
|float
|Multiplier applied to the values of each vertex's coordinates (makes the actor's model larger or smaller)
|sbactorpack, ActorLink, ActorScale param
|-
|armorDefenceAddLevel
|int
|The amount of armor added when this actor is equipped as armor
|sbactorpack, bgparamlist, Armor section, DefenseAddLevel param
|-
|armorEffectAncientPowUp
|bool
|Whether the AncientPowUp (increased damage from ancient weapons) effect is provided by this actor when it is equipped as armor
|sbactorpack, bgparamlist, ArmorEffect section, AncientPowUp param
|-
|armorEffectEffectLevel
|int
|The number of levels of the actor's EffectType that are provided when this actor is equipped as armor
|sbactorpack, bgparamlist, ArmorEffect section, EffectLevel param
|-
|armorEffectEffectType
|str
|The EffectType granted by the actor when it is equipped as armor
|sbactorpack, bgparamlist, ArmorEffect section, EffectType param
|-
|armorEffectEnableClimbWaterfall
|bool
|Whether or not this actor grants the ability to climb waterfalls when it is equipped as armor
|sbactorpack, bgparamlist, ArmorEffect section, EnableClimbWaterfall param
|-
|armorEffectEnableSpinAttack
|bool
|Whether or not this actor grants the ability to perform spin attacks while swimming, when it is equipped as armor
|sbactorpack, bgparamlist, ArmorEffect section, EnableSpinAttack param
|-
|armorHeadMantleType
|int
| -
|sbactorpack, bgparamlist, ArmorHead section, MantleType param
|-
|armorNextRankName
|str
|Name of the actor that this can be upgraded to, by the Great Fairies
|sbactorpack, bgparamlist, Armor section, NextRankName param
|-
|armorStarNum
|int
|Number of stars to display in the inventory, plus 1 (e.g. armorStarNum: 1 will display 0 stars)
|sbactorpack, bgparamlist, Armor section, StarNum param
|-
|armorUpperDisableSelfMantle
|bool
| -
|sbactorpack, bgparamlist, ArmorUpper section, DisableSelfMantle param
|-
|armorUpperUseMantleType
|int
| -
|sbactorpack, bgparamlist, ArmorUpper section, UseMantleType param
|-
|attackPower
|int
|The amount of damage this actor does when used to attack as a weapon
|sbactorpack, bgparamlist, Attack section, Power param
|-
|bfres
|str
|Name of the (s)bfres file that stores this actor's model
|sbactorpack, bmodellist, ModelData list, ModelData_0 list, Base object, Folder param
|-
|boundingForTraverse
|float
| -
| -
|-
|bugMask
|int
|Affects the [[ActorDebug]] interface and probably more things in debug builds.

*& 2: アクターサウンドバグ ("Actor sound bug")<ref>{{addr|a=0x7100D26480|ver=nx-1.5.0}}</ref>
*& 1: アクター挙動バグ ("Actor behavior bug")<ref>{{addr|a=0x7100D26534|ver=nx-1.5.0}}</ref>
|Not found outside ActorInfo.product
|-
|cursorOffsetY
|float
|How much up or down another character actor must tilt their head to look at this actor when this actor has their attention (typically, when Link or an NPC is looking at the actor)
|sbactorpack, bmodellist, Attention section, CursorOffsetY param
|-
|elink
|str
|Determines the name of the actor's entry in the Elink2DB file, used for effects
|sbactorpack, ActorLink, ElinkUser param
|-
|generalLife
|int
|The amount of health this actor has
|sbactorpack, bgparamlist, General section, Life param
|-
|instSize
|int
|Size of the memory heap that will be allocated for an actor instance — if too low, may cause unexpected crashes
| -
|-
|isHasFar
|bool
|Whether or not a separate actor exists, with the same name but with _Far appended, that is used to replace this actor when it is far away
|Presence of a separate actor with the _Far name
|-
|itemBuyingPrice
|int
|Price when buying the actor from a shop
|sbactorpack, bgparamlist, Item section, BuyingPrice param
|-
|itemCreatingPrice
|int
|Price when creating the actor using the ancient oven
|sbactorpack, bgparamlist, Item section, CreatingPrice param
|-
|itemSaleRevivalCount
|int
| -
|sbactorpack, bgparamlist, Item section, SaleRevivalCount param
|-
|itemSellingPrice
|int
|Price when selling the actor to a shop
|sbactorpack, bgparamlist, Item section, SellingPrice param
|-
|itemStainColor
|int
|Index of the color that this actor will dye an armor when used as an ingredient in the dye shop
|sbactorpack, bgparamlist, Item section, StainColor param
|-
|itemUseIconActorName
|str
|The name of the actor whose icon this actor will use when displayed in the inventory. If empty, the actor will use the icon with its own name
|sbactorpack, bgparamlist, Item section, UseIconActorName param
|-
|mainModel
|str
|Name of the model inside the (s)bfres file for this actor
|sbactorpack, bmodellist, ModelData list, ModelData_0 list, Unit list, Unit_0 object, UnitName param
|-
|name
|str
|Actor name
|sbactorpack, ActorLink, Name param (and several other places)
|-
|normal0ItemName%02d
|str
|Names of the actors which are required to upgrade to this actor at a Great Fairy. Corresponds to normal0ItemNum%02d of the same number.
|sbactorpack, brecipe, Normal0 table, ItemName%02d params
|-
|normal0ItemNum%02d
|int
|Quantities of the actors which are required to upgrade to this actor at a Great Fairy. Corresponds to normal0ItemName%02d of the same number.
|sbactorpack, brecipe, Normal0 table, ItemNum%02d params
|-
|normal0ItemStuffNum
|int
|Number of unique actors required to upgrade to this actor at a Great Fairy
|sbactorpack, brecipe, Normal0 table, ColumnNum param
|-
|profile
|str
|Profile name (see [[ActorTemplate]])
|sbactorpack, ActorLink, Profile param
|-
|seriesArmorEnableCompBonus
|bool
|Whether or not this armor counts toward providing its seriesArmorSeriesType bonus
|sbactorpack, bgparamlist, SeriesArmor section, EnableCompBonus param
|-
|seriesArmorSeriesType
|str
|The set bonus that this actor will provide, when equipped with two other actors that have the same seriesArmorSeriesType
|sbactorpack, bgparamlist, SeriesArmor section, SeriesType param
|-
|slink
|str
|Determines the name of the actor's entry in the Slink2DB file, used for effects
|sbactorpack, ActorLink, SlinkUser param
|-
|sortKey
|int
|Determines the order of the actor in the Picture Book and inventory (0 if not needed)
|Not found outside ActorInfo.product
|-
|systemIsGetItemSelf
|bool
|Whether or not this object actor gives an item actor of the same name when activated (used to give Link an Item_Arrow when activated an Obj_Arrow in vanilla)
|sbactorpack, bgparamlist, System section, IsGetItemSelf param
|-
|systemSameGroupActorName
|str
| -
|sbactorpack, bgparamlist, System section, SameGroupActorName param
|-
|tags
|dict
|A dictionary with entries of the form (key=tag%08x, value=crc32_hash) where %08x is the hex representation of the CRC32 hash of the tag name. The value is an unsigned int if it is greater than 0x80000000 and a regular int otherwise.
|sbactorpack, ActorLink, Tags section
|-
|terrainTextures
|array
|An array with entries of the form (value=crc32_hash) which is an unsigned int if it is greater than 0x80000000 and a regular int otherwise.
| -
|-
|traverseDist
|float
| -
| -
|-
|yLimitAlgorithm
|str
|See [[ActorParam/LifeCondition]]. This might not be a required entry. {{check}}
|sbactorpack, blifecondition, YLimitAlgorithm param
|}

===Hashes===
'''Hashes''' is an array of CRC32 hashes of actor names.

This array '''''must''''' be sorted because [[ActorInfoData]] performs a binary search on this array to find actor entries efficiently. As a direct consequence the actor array must be sorted according to the CRC32 hashes of the actor names.

Similar to tag values, each number is stored as an unsigned int if it is greater than 0x80000000 and as a signed int otherwise.
[[Category:Content (BotW)]]
[[Category:Content (BotW, product)]]
<references />

ActorInfo.product.sbyml

2022-06-17T13:53:46Z

Waikuteru: /* Actors */

<onlyinclude>
{{NoRstb}}
'''ActorInfo.product.sbyml''' (found in the Actor directory) is a [[Yaz0]]-compressed [[BYML]] file which contains general information about all [[Actor|actors]] in the game. It is used when constructing actors, and also used to access actor data efficiently when loading the full [[actor pack]] is unnecessary (e.g. on menu screens). Therefore, in order to add new actors, or to change items' parameters on menu screens, this file must be edited.

ActorInfo is a machine generated file. It is not meant to be edited directly; much of the information it includes are either automatically generated or copied from [[ActorParam]] files (which can be found in the game [[content]]) and other source-only files.
</onlyinclude>

==Contents==

===Actors===
'''Actors''' is an array of dictionaries. It must be sorted in the same order as the Hashes section.

Each actor has its own entry in this array. Each entry has several properties, based on the actor's profile. The following is a list of valid entries for any profile. Any single profile will not require all of these properties.
{| class="wikitable"
!Key
!Type
!Description
!Source
|-
|aabbMax
|float
|Defines the maximum point for the axis-aligned bounding box (AABB) - the most-positive value on each axis that any of the actor's model's vertices inhabits. These values may (and probably do) come from three different vertices.

Can be altered to change the distance for AttentionClients like "Talk", "Examine", etc.
|sbfres, vertex coordinates
|-
|aabbMin
|float
|Defines the minimum point for the axis-aligned bounding box (AABB) - the most-negative value on each axis that any of the actor's model's vertices inhabits. These values may (and probably do) come from three different vertices.

Can be altered to change the distance for AttentionClients like "Talk", "Examine", etc.
|sbfres, vertex coordinates
|-
|actorScale
|float
|Multiplier applied to the values of each vertex's coordinates (makes the actor's model larger or smaller)
|sbactorpack, ActorLink, ActorScale param
|-
|armorDefenceAddLevel
|int
|The amount of armor added when this actor is equipped as armor
|sbactorpack, bgparamlist, Armor section, DefenseAddLevel param
|-
|armorEffectAncientPowUp
|bool
|Whether the AncientPowUp (increased damage from ancient weapons) effect is provided by this actor when it is equipped as armor
|sbactorpack, bgparamlist, ArmorEffect section, AncientPowUp param
|-
|armorEffectEffectLevel
|int
|The number of levels of the actor's EffectType that are provided when this actor is equipped as armor
|sbactorpack, bgparamlist, ArmorEffect section, EffectLevel param
|-
|armorEffectEffectType
|str
|The EffectType granted by the actor when it is equipped as armor
|sbactorpack, bgparamlist, ArmorEffect section, EffectType param
|-
|armorEffectEnableClimbWaterfall
|bool
|Whether or not this actor grants the ability to climb waterfalls when it is equipped as armor
|sbactorpack, bgparamlist, ArmorEffect section, EnableClimbWaterfall param
|-
|armorEffectEnableSpinAttack
|bool
|Whether or not this actor grants the ability to perform spin attacks while swimming, when it is equipped as armor
|sbactorpack, bgparamlist, ArmorEffect section, EnableSpinAttack param
|-
|armorHeadMantleType
|int
| -
|sbactorpack, bgparamlist, ArmorHead section, MantleType param
|-
|armorNextRankName
|str
|Name of the actor that this can be upgraded to, by the Great Fairies
|sbactorpack, bgparamlist, Armor section, NextRankName param
|-
|armorStarNum
|int
|Number of stars to display in the inventory, plus 1 (e.g. armorStarNum: 1 will display 0 stars)
|sbactorpack, bgparamlist, Armor section, StarNum param
|-
|armorUpperDisableSelfMantle
|bool
| -
|sbactorpack, bgparamlist, ArmorUpper section, DisableSelfMantle param
|-
|armorUpperUseMantleType
|int
| -
|sbactorpack, bgparamlist, ArmorUpper section, UseMantleType param
|-
|attackPower
|int
|The amount of damage this actor does when used to attack as a weapon
|sbactorpack, bgparamlist, Attack section, Power param
|-
|bfres
|str
|Name of the (s)bfres file that stores this actor's model
|sbactorpack, bmodellist, ModelData list, ModelData_0 list, Base object, Folder param
|-
|boundingForTraverse
|float
| -
| -
|-
|bugMask
|int
|Affects the [[ActorDebug]] interface and probably more things in debug builds.

*& 2: アクターサウンドバグ ("Actor sound bug")<ref>{{addr|a=0x7100D26480|ver=nx-1.5.0}}</ref>
*& 1: アクター挙動バグ ("Actor behavior bug")<ref>{{addr|a=0x7100D26534|ver=nx-1.5.0}}</ref>
|Not found outside ActorInfo.product
|-
|cursorOffsetY
|float
|How much up or down another character actor must tilt their head to look at this actor when this actor has their attention (typically, when Link or an NPC is looking at the actor)
|sbactorpack, bmodellist, Attention section, CursorOffsetY param
|-
|elink
|str
|Determines the name of the actor's entry in the Elink2DB file, used for effects
|sbactorpack, ActorLink, ElinkUser param
|-
|generalLife
|int
|The amount of health this actor has
|sbactorpack, bgparamlist, General section, Life param
|-
|instSize
|int
|Size of the memory heap that will be allocated for an actor instance — if too low, may cause unexpected crashes
| -
|-
|isHasFar
|bool
|Whether or not a separate actor exists, with the same name but with _Far appended, that is used to replace this actor when it is far away
|Presence of a separate actor with the _Far name
|-
|itemBuyingPrice
|int
|Price when buying the actor from a shop
|sbactorpack, bgparamlist, Item section, BuyingPrice param
|-
|itemCreatingPrice
|int
|Price when creating the actor using the ancient oven
|sbactorpack, bgparamlist, Item section, CreatingPrice param
|-
|itemSaleRevivalCount
|int
| -
|sbactorpack, bgparamlist, Item section, SaleRevivalCount param
|-
|itemSellingPrice
|int
|Price when selling the actor to a shop
|sbactorpack, bgparamlist, Item section, SellingPrice param
|-
|itemStainColor
|int
|Index of the color that this actor will dye an armor when used as an ingredient in the dye shop
|sbactorpack, bgparamlist, Item section, StainColor param
|-
|itemUseIconActorName
|str
|The name of the actor whose icon this actor will use when displayed in the inventory. If empty, the actor will use the icon with its own name
|sbactorpack, bgparamlist, Item section, UseIconActorName param
|-
|mainModel
|str
|Name of the model inside the (s)bfres file for this actor
|sbactorpack, bmodellist, ModelData list, ModelData_0 list, Unit list, Unit_0 object, UnitName param
|-
|name
|str
|Actor name
|sbactorpack, ActorLink, Name param (and several other places)
|-
|normal0ItemName%02d
|str
|Names of the actors which are required to upgrade to this actor at a Great Fairy. Corresponds to normal0ItemNum%02d of the same number.
|sbactorpack, brecipe, Normal0 table, ItemName%02d params
|-
|normal0ItemNum%02d
|int
|Quantities of the actors which are required to upgrade to this actor at a Great Fairy. Corresponds to normal0ItemName%02d of the same number.
|sbactorpack, brecipe, Normal0 table, ItemNum%02d params
|-
|normal0ItemStuffNum
|int
|Number of unique actors required to upgrade to this actor at a Great Fairy
|sbactorpack, brecipe, Normal0 table, ColumnNum param
|-
|profile
|str
|Profile name (see [[ActorTemplate]])
|sbactorpack, ActorLink, Profile param
|-
|seriesArmorEnableCompBonus
|bool
|Whether or not this armor counts toward providing its seriesArmorSeriesType bonus
|sbactorpack, bgparamlist, SeriesArmor section, EnableCompBonus param
|-
|seriesArmorSeriesType
|str
|The set bonus that this actor will provide, when equipped with two other actors that have the same seriesArmorSeriesType
|sbactorpack, bgparamlist, SeriesArmor section, SeriesType param
|-
|slink
|str
|Determines the name of the actor's entry in the Slink2DB file, used for effects
|sbactorpack, ActorLink, SlinkUser param
|-
|sortKey
|int
|Determines the order of the actor in the Picture Book and inventory (0 if not needed)
|Not found outside ActorInfo.product
|-
|systemIsGetItemSelf
|bool
|Whether or not this object actor gives an item actor of the same name when activated (used to give Link an Item_Arrow when activated an Obj_Arrow in vanilla)
|sbactorpack, bgparamlist, System section, IsGetItemSelf param
|-
|systemSameGroupActorName
|str
| -
|sbactorpack, bgparamlist, System section, SameGroupActorName param
|-
|tags
|dict
|A dictionary with entries of the form (key=tag%08x, value=crc32_hash) where %08x is the hex representation of the CRC32 hash of the tag name. The value is an unsigned int if it is greater than 0x80000000 and a regular int otherwise.
|sbactorpack, ActorLink, Tags section
|-
|terrainTextures
|array
|An array with entries of the form (value=crc32_hash) which is an unsigned int if it is greater than 0x80000000 and a regular int otherwise.
| -
|-
|traverseDist
|float
| -
| -
|-
|yLimitAlgorithm
|str
|See [[ActorParam/LifeCondition]]. This might not be a required entry. {{check}}
|sbactorpack, blifecondition, YLimitAlgorithm param
|}

===Hashes===
'''Hashes''' is an array of CRC32 hashes of actor names.

This array '''''must''''' be sorted because [[ActorInfoData]] performs a binary search on this array to find actor entries efficiently. As a direct consequence the actor array must be sorted according to the CRC32 hashes of the actor names.

Similar to tag values, each number is stored as an unsigned int if it is greater than 0x80000000 and as a signed int otherwise.
[[Category:Content (BotW)]]
[[Category:Content (BotW, product)]]
<references />

ActorInfo.product.sbyml

2022-06-17T11:17:56Z

Waikuteru: /* Actors */ aabb finally found out!

Bumii

2022-04-16T07:41:03Z

Waikuteru: /* body */

{{lowercase}}
{{stub|what=Needs descriptions.}}
<onlyinclude>
{{Parameter archive infobox|param_type=bumii|version=0|type=xml}}
'''UMii''' (bumii) files configure the physical traits of a NPC.
</onlyinclude>

=Parameter objects=
{{AampNameWarning}}
==ffsd==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|no_use_ffsd||bool||Do not use Mii data (treat as NPC profile)<ref>Miiデータを使用しない(NPCプロフィールとして扱う)</ref>||False
|-
|type||int||Reference first<ref>参照先</ref>||0
|-
|}

==body==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|type||int||
*0: Child
*1: Normal
*2: Traveler
*3: Soldier
*4: Sheikah
*More?
||0
|-
|number||int||Body variant (last part of the model name)||0
|-
|race||int||
*0: Hylia
*1: Korok
*2: Goron
*3: Sheikah
*4: Gerudo
*5: Zora
*6: Rito
*More?
||0
|-
|weight||int||-||1
|-
|height||int||-||0
|-
|}

==personal==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|fav_color||int||-||0
|-
|sub_color_1||int||-||-1
|-
|sub_color_2||int||-||-1
|-
|voice_type||str||-||Hylia_Man_Kid_Normal00
|-
|shoulder_fav_color||int||-||-1
|-
|sex_age||int||
*0: C (Child)
*1: M (Man)
*2: X (Old man){{check}}
*3: Y (Old woman)
*4: W (Woman)
*More?
||0
|-
|personality||str||-||
|-
|head_fav_color||int||-||-1
|-
|shoulder_sub_color_1||int||-||-1
|-
|}

==common==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|backpack||int||-||-1
|-
|hat||int||-||-1
|-
|no_hat_always||bool||-||False
|-
|body_correct||int||-||0
|-
|is_mid_age||bool||-||False
|-
|rot_cravicle||float||-||0.0
|-
|rot_arm||float||-||0.0
|-
|rot_leg||float||-||0.0
|-
|rot_crotch||float||-||0.0
|-
|}

==shape==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|jaw||int||-||0
|-
|wrinkle||int||-||0
|-
|make||int||Makeup

*0: None
*1 - 8: Eyes/Eyebrows
*9:
*10 - 11: beards
||0
|-
|skin_color||int||-||0
|-
|trans_v||float||-||0.0
|-
|scale||float||-||1.0
|-
|}

==hair==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|type||int||Hair variant (last part of the model name)||0
|-
|color||int||Color Animation Pick (1 - 10)||0
|-
|flip||bool||Flip hair model||0
|-
|}

==eye==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|type||int||-||2
|-
|color||int||-||0
|-
|trans_v||float||-||3.0
|-
|trans_u||float||-||2.0
|-
|rotate||float||-||0.0
|-
|scale||float||-||4.0
|-
|aspect||float||-||3.0
|-
|eyeball_trans_u||float||-||0.0
|-
|eyeball_trans_v||float||-||0.0
|-
|eyeball_scale||float||-||0.0
|-
|highlight_bright||int||-||0
|-
|}

==eye_ctrl==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|base_offset||vec3||-||Vec3(x=0.0, y=0.029999999329447746, z=0.0)
|-
|translim_out||float||-||0.2
|-
|translim_in||float||-||0.12
|-
|translim_d||float||-||0.3
|-
|translim_u||float||-||0.1
|-
|neck_offset_ud||float||-||0.0
|-
|}

==eyebrow==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|type||int||-||6
|-
|color||int||-||0
|-
|trans_v||float||-||7.0
|-
|trans_u||float||-||2.0
|-
|rotate||float||-||0.0
|-
|scale||float||-||4.0
|-
|aspect||float||-||3.0
|-
|}

==nose==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|type||int||-||1
|-
|trans_v||float||-||9.0
|-
|scale||float||-||4.0
|-
|}

==mouth==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|type||int||-||3
|-
|color||int||-||0
|-
|trans_v||float||-||13.0
|-
|scale||float||-||4.0
|-
|aspect||float||-||3.0
|-
|}

==beard==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|mustache||int||-||0
|-
|scale||float||-||4.0
|-
|type||int||-||0
|-
|color||int||-||0
|-
|}

==glass==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|type||int||Glasses variant (last part of the model name)||0
|-
|color||int||Color Select (0 - 5)||0
|-
|}

==korog==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|mask||int||Mask variant (last part of the model name)||0
|-
|skin_color||int||-||0
|-
|left_plant||int||-||0
|-
|right_plant||int||-||0
|-
|}

==goron==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|skin_color||int||-||0
|-
|}

==gerudo==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|skin_color||int||-||0
|-
|hair||int||-||0
|-
|hair_color||int||-||0
|-
|lip_color||int||-||0
|-
|glass||int||-||0
|-
|glass_color||int||-||0
|-
|}

==rito==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|body_color||int||
*0:
*1:
*2:
*3:
*4:
*5:
*6:
*7:
*8: Blue (Fyson)
*9: Green
*More...
||0
|-
|hair_color||int||-||-1
|-
|}

==zora==
{| class="wikitable"
!Key!!Type!!Description!!Default value
|-
|body_color||int||-||0
|-
|}

=Parameter lists=
{{No AAMP param}}

[[Category:File extensions]]
[[Category:File extensions (AAMP)]]
[[Category:Actor parameter files]]
<references />

AIDef:AI/ChangeWeatherTagRoot

2022-02-20T08:46:55Z

Waikuteru: /* MapUnitInstParams */

{{AIDef
|name=ChangeWeatherTagRoot
|type=AI
}}

== MapUnitInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| Weather || Int || -1 || Sets the [[WorldMgr#Weather_types|weather type]].
|-
| TemperatureDay || Float || 99999.9 ||
|-
| TemperatureNight || Float || 99999.9 ||
|-
| WeatherEff || Int || -1 || Controls the weather efficienty.
|-
| PaletteSel || Int || -1 || A visual color scheme that can also include changes of fog, clouds, bloom, etc. There are 56 of them if you don't include the default (0).
|-
| PSelSpeed || Int || 0 || Controls the speed change from current PaletteSel to the defined PaletteSel. (''0: Normal Speed; 1: Slower Speed; 2: Very Fast Speed'')
|-
| TemperatureDirectDay || Float || 99999.9 ||
|-
| TemperatureDirectNight || Float || 99999.9 ||
|-
| CloudShadowOff || Bool || False ||
|-
| BluffThunderOff || Bool || False ||
|-
| IgnitedLevel || Int || 0 || Allows to set the environment on fire. (''0: No ignition; 1: Normal ignition; 2: Heavy ignition'')
|-
| FogMinusCorrection || Bool || False ||
|-
|}

== Children ==
{|class="wikitable"
! Name !! Description
|-
| 通知 ||
|-
|}

== Derived definitions ==
=== Root (WeatherChangeTag) ===
{{AIDefDerived
|name=Root
|group_name=
|derived_from=ChangeWeatherTagRoot
|aiprog=WeatherChangeTag
}}
No overridden parameters.

ActorParam/AISchedule

2021-09-05T16:24:04Z

Waikuteru: /* Triggers */

<onlyinclude>
'''AISchedule''' configures actions based on time and other conditions for an actor, as well as the [[AI system|AI states]] or [[Event system|events]] that it can trigger.
</onlyinclude>

==Contents==
<source lang="yaml">
ConditionalTimelines:
- Condition: Npc_Kakariko001_Talk
Nodes:
- <NODE_1>
- <NODE_2>
- ...
TriggerEvents:
- <TRIGGER_EVENT_1>
- <TRIGGER_EVENT_2>
- ...
DefaultTimeline:
Nodes:
- <NODE_1>
- <NODE_2>
- ...
TriggerEvents:
- <TRIGGER_EVENT_1>
- <TRIGGER_EVENT_2>
- ...
DisplayDistanceMode: None
</source>
===Node===
{{expand section}}
Example:
<source lang="yaml">
{ AIName: Action2, CanBeAwaken: 'True', Emotion: Normal, EndTime: 5, IsAlignmentWaitPosition: 'False',
IsEnableMoveNext: false, IsInheritWaitASToTalk: 'False', IsRainAlignmentWaitPosition: 'False',
IsRainInheritWaitASToTalk: 'False', MeetingASName: '', MeetingReactionType: 1,
MoveEquipment: Invisible, MoveGreetingType: NotAndNot, MovePosture: 0, MoveReactionType: 2,
MoveTalkTurn: 2, MoveToAnchorASName: Walk, MoveToAnchorRainASName: '', RainEmotion: Normal,
ReactionToApproach: Quit, ReactionToApproachDist: 5, ReactionToApproachRain: None,
ReactionToApproachTurnASName: Turn, ReactionToApproachWaitASName: Wait, ReturnActionRainTimeAfterTalk: -1,
ReturnActionTimeAfterTalk: -1, ReturnMoveTimeAfterTalk: 60, SleepOnBed: 'True',
StartTime: 0, WaitAnchorASName: Sleep, WaitAnchorRainASName: '', WaitEquipment: Invisible,
WaitForScheduleMoveASName: Wait, WaitGreetingType: NotAndNot, WaitPosture: 0,
WaitRainEquipment: Invisible, WaitRainPosture: 0, WaitRainReactionType: 0, WaitRainTalkTurn: 3,
WaitReactionType: 0, WaitTalkTurn: 2}
</source>

===TriggerEvent===
{{expand section}}
An event that will be triggered when a condition is satisfied.

{| class="wikitable"
!Name!!Type!!Description
|-
|EvflEntry||str||Name of the entry point that will be executed. The event flowchart name is the same as the name of the associated actor or quest (for AISchedule blocks defined in [[QuestProduct]]).
|-
|IsPauseOtherActors||bool||Whether other actors should be paused when the event is triggered
|-
|Trigger||str||Event trigger
|-
|Parameters||dict||
|}

====Triggers====
{{expand section}}
{| class="wikitable"
!Value!!Description
|-
|Talk||When the actor is talked to
|-
|EachFrame||On every frame
|-
|Near||When Link is close to the actor
|-
|StepStart||When the quest step starts (only for [[QuestProduct]])
|}

==Files==
AISchedule information is stored in baischedule files as an [[ActorParam]] resource or as a part of the Actors array in quest steps in [[QuestProduct.bquestpack]].

ActorParam/AISchedule

2021-09-05T16:21:44Z

Waikuteru: /* Triggers */

<onlyinclude>
'''AISchedule''' configures actions based on time and other conditions for an actor, as well as the [[AI system|AI states]] or [[Event system|events]] that it can trigger.
</onlyinclude>

==Contents==
<source lang="yaml">
ConditionalTimelines:
- Condition: Npc_Kakariko001_Talk
Nodes:
- <NODE_1>
- <NODE_2>
- ...
TriggerEvents:
- <TRIGGER_EVENT_1>
- <TRIGGER_EVENT_2>
- ...
DefaultTimeline:
Nodes:
- <NODE_1>
- <NODE_2>
- ...
TriggerEvents:
- <TRIGGER_EVENT_1>
- <TRIGGER_EVENT_2>
- ...
DisplayDistanceMode: None
</source>
===Node===
{{expand section}}
Example:
<source lang="yaml">
{ AIName: Action2, CanBeAwaken: 'True', Emotion: Normal, EndTime: 5, IsAlignmentWaitPosition: 'False',
IsEnableMoveNext: false, IsInheritWaitASToTalk: 'False', IsRainAlignmentWaitPosition: 'False',
IsRainInheritWaitASToTalk: 'False', MeetingASName: '', MeetingReactionType: 1,
MoveEquipment: Invisible, MoveGreetingType: NotAndNot, MovePosture: 0, MoveReactionType: 2,
MoveTalkTurn: 2, MoveToAnchorASName: Walk, MoveToAnchorRainASName: '', RainEmotion: Normal,
ReactionToApproach: Quit, ReactionToApproachDist: 5, ReactionToApproachRain: None,
ReactionToApproachTurnASName: Turn, ReactionToApproachWaitASName: Wait, ReturnActionRainTimeAfterTalk: -1,
ReturnActionTimeAfterTalk: -1, ReturnMoveTimeAfterTalk: 60, SleepOnBed: 'True',
StartTime: 0, WaitAnchorASName: Sleep, WaitAnchorRainASName: '', WaitEquipment: Invisible,
WaitForScheduleMoveASName: Wait, WaitGreetingType: NotAndNot, WaitPosture: 0,
WaitRainEquipment: Invisible, WaitRainPosture: 0, WaitRainReactionType: 0, WaitRainTalkTurn: 3,
WaitReactionType: 0, WaitTalkTurn: 2}
</source>

===TriggerEvent===
{{expand section}}
An event that will be triggered when a condition is satisfied.

{| class="wikitable"
!Name!!Type!!Description
|-
|EvflEntry||str||Name of the entry point that will be executed. The event flowchart name is the same as the name of the associated actor or quest (for AISchedule blocks defined in [[QuestProduct]]).
|-
|IsPauseOtherActors||bool||Whether other actors should be paused when the event is triggered
|-
|Trigger||str||Event trigger
|-
|Parameters||dict||
|}

====Triggers====
{{expand section}}
{| class="wikitable"
!Value!!Description
|-
|Talk||When the actor is talked to
|-
|EachFrame||On every frame
|-
|Near||When Link is close to the actor
|-
|StepStart||When the quest step starts (only for [[QuestProduct]])
|-
|PopUp
|
|}

==Files==
AISchedule information is stored in baischedule files as an [[ActorParam]] resource or as a part of the Actors array in quest steps in [[QuestProduct.bquestpack]].

Map unit

2021-05-03T20:52:35Z

Waikuteru: /* Types */

''Not to be confused with [[map]]s, [[Stage|stages]] or [[Scene|scenes]]''.

<onlyinclude>
'''Map units''' contain placement data for game maps (e.g. MainField/A-1). In other words, they are used to configure fixed object spawns on maps for actors such as scenery and enemies for example, in contrast to the [[AutoPlacement]] system, which dynamically spawns actors.
</onlyinclude>

==Types==
Two types of map units exist: ''Static'' and ''Dynamic''.

'''Static map units''' are loaded during stage generation (see [[GameScene]] for more details). Their name is suffixed with <code>_Static</code>. They can contain both map rails and map objects; furthermore objects can be linked to each other to implement custom game logic using the [[#Link system]]. Static units are always loaded in memory and will be visible if the player is within the actor's <code>TraverseDist</code> (draw distance) set in [[ActorInfo.product.sbyml]]. It's possible to see actors from the top-left to the bottom-right in open-world stages (MainField and AocField) if the <code>TraverseDist</code> is set high enough.

'''Dynamic map units''' are loaded and unloaded on-the-fly. Their name is suffixed with <code>_Dynamic</code>. The dynamic loading capability is only really put to good use for open-world type stages (e.g. MainField and AocField). In such map units, the link system cannot be used and only map objects can be specified. Dynamic units are considered to be loaded once the player is either inside of the map they are placed (always the case for CDungeon and MainFieldDungeon), or the player is (on MainField and AocField) located in one of the map-sections around the map-section the unit is placed in.

'''Example:''' Player is located in H-5 so ''G-4, H-4, I-4, G-5- I-5, G-6, H-6 and I-6'' dynamic units are loaded in memory and will be displayed if the <code>TraverseDist</code> is high enough.

==Contents==

===<code>LocationPosX</code>===
X coordinate of the center of the map unit.

===<code>LocationPosZ</code>===
Y coordinate of the center of the map unit.

===<code>LocationSize</code>===
Size of the map unit (side length of the square).

===<code>Objs</code>===
{{expand section}}
Array of object structures. '''Must be sorted by HashId'''<ref>Technically, sorting is only required for Dynamic (non-group 0) map units. However, not sorting causes the game to fall back to a slower linear search.</ref> because the placement subsystem performs binary searches on the object array in various cases<ref>0x7101256E14</ref>.

===<code>Rails</code>===
{{expand section}}
Array of rail structures. Can only appear in group 0 maps (Static); this section is completely ignored for non-static map units.

==Link system==
'''In static map units only''', map objects can be linked to other objects (up to 255 in a single generation group<ref>"一つの生成グループに 255 以上のアクタが指定されています。テストで無ければプログラマに相談"</ref>). These links allow implementing custom logic and callbacks. For example, DeadUp signals the destination object when the source object dies. This is used to implement enemy chests that only unlock after clearing an enemy camp.

LinkTags and other tag objects are lightweight actors that are used to link objects together.

Objects that are linked together, either directly or via indirect links, are put into the same '''generation group''' and loaded at the same time{{check}}. If the placement system fails to load an actor, the entire generation group is discarded.

===Definitions===
{{expand section}}
Cs means Constraint<ref>SliderCs links are handled by a function {{addr|a=0x7100F70D60|ver=nx-1.5.0}} that is also called by [[AIDef:Action/SwitchStepSliderConstraint]]</ref>.

{| class="wikitable sortable"
!ID!!Name!!Description!!Official description
|-
|4||-AxisX||-||マイナスX軸シグナル
|-
|5||-AxisY||-||マイナスY軸シグナル
|-
|6||-AxisZ||-||マイナスZ軸シグナル
|-
|24||AreaCol||Area collision (link target is an Area object)||エリア(センサ)指定
|-
|1||AxisX||-||X軸シグナル
|-
|2||AxisY||-||Y軸シグナル
|-
|3||AxisZ||-||Z軸シグナル
|-
|37||BAndSCs||Ball & Socket constraint||ボール＆ソケットCS
|-
|38||BAndSLimitAngYCs||Y angular velocity limited Ball & Socket constraint||Y角速度制限付ボール＆ソケットCS
|-
|0||BasicSig||Basic signal||基本シグナル
|-
|9||BasicSigOnOnly||Basic signal [only emits ON signals]||オンのみ基本シグナル
|-
|14||ChangeAtnSig||Signal on Attention change (e.g. picking up a weapon)||アテンション変更時シグナル
|-
|39||CogWheelCs||Gear/cogwheel constraint||歯車CS
|-
|21||CopyWaitRevival||Activate links when the revival flag of the CopyWaitRevival target is set (e.g. can be used with LinkTagAnd to trigger basic signals when a chest is opened)||配置自動セーブ継承
|-
|15||Create||Create a map object. Target objects are not created unless this link is activated.||生成
|-
|11||DeadUp||Signal on death||死んだらオン
|-
|16||Delete||Delete a map object. Target objects are created and stay spawned until this link is activated. Note: the corresponding collision is disabled even for objects that have their collision data extracted to separate Static Compound files.||削除
|-
|29||DemoMember||-||デモ参加
|-
|32||FixedCs||-||固定CS
|-
|26||ForSale||Links a shop item to its seller (target is the seller NPC).||売り物
|-
|19||ForbidAttention||Prevent attention (i.e. interacting with an object, for example picking up a weapon)||アテンションタイプ変更
|-
|18||Freeze||Freeze the target object||凍結
|-
|7||GimmickSuccess||Success signal (used for minigames)||ネタ成功シグナル
|-
|33||HingeCs||Hinge constraint||ヒンジCS
|-
|12||LifeZero||Emit a LifeZero signal when the life of the source object is 0||ライフ0
|-
|34||LimitHingeCs||Limited hinge constraint||制限付ヒンジCS
|-
|27||ModelBind||-||モデルバインド
|-
|17||MtxCopyCreate||-||位置継承生成
|-
|22||OffWaitRevival||Reset the revival flag of the target object||配置自動セーブオフ
|-
|30||PhysSystemGroup||-||物理システムグループ
|-
|28||PlacementLOD||Replace the source object with the link target object at lower level of details||配置LOD
|-
|36||PulleyCs||-||滑車CS
|-
|40||RackAndPinionCs||Rack-and-pinion constraint||ラック＆ピニオンCS
|-
|23||Recreate||Recreates the target object||再生成
|-
|41||Reference||-||参照
|-
|10||Remains||Divine Beast signal||遺物シグナル
|-
|25||SensorBind||-||センサバインド
|-
|35||SliderCs||Slider constraint||スライダーCS
|-
|13||Stable||-||安定
|-
|31||StackLink||-||スタック
|-
|20||SyncLink||Put the destination object and any object that is linked to it into the same generation group||生成グループ
|-
|8||VelocityControl||Velocity control signal||速度制御シグナル
|-
|}

===Link tags===
''Not to be confused with [[actor tag]]s.''

LinkTagAnd, LinkTagOr, LinkTagNAnd, LinkTagNOr, LinkTagXOr, LinkTagCount, LinkTagPulse, LinkTagNone are small objects that are used to implement a basic logic system in map units.

AND, OR, NAND, NOR, XOR LinkTags are logical operators. They can be used to conditionally set or clear GameData flags, or conditionally spawn objects, trigger other objects, etc. A basic signal is emitted when the LinkTag has been triggered by ''all'' of the source links (for LinkTagAnds) or by one of them (for LinkTagOrs), etc.

Count LinkTags are used to increment a GameData flag every time the link tag itself is signalled.

Pulse LinkTags continuously emit a basic signal with a configurable signal duration (PulseLength)<ref>This appears to require a BasicSig input and does not repeat automatically. In order to get this behavior, fire it with a SwitchTimer.</ref>.

None LinkTags have no effect. They are only used to put different map unit objects into the same placement generation group.

Internally, they are all implemented by the same actor class (<code>LinkTag</code>) since they share most of their core functionality, with only small differences in effects. A single link tag can only handle 0x60 incoming links<ref>0x7100D388C4</ref>. Only incoming links with defType <= 0xe are processed<ref>0x7100D389DC</ref>; other links are ignored.

Parameters are documented in [[AIDef:Action/LinkTagBaseAction#MapUnitInstParams]].

==File formats==

===Map unit binary===
In ''Breath of the Wild'', map units are stored in a binary format and given the ''mubin'' (Map Unit Binary) file extension. All map object IDs are replaced with CRC32 hashes as a space optimisation. [[BYML]] is used as the serialisation format.

Map units can be found in the [[Content/Map|Map]] content directory, and use the following naming convention: <code>Map/%s/%s/%s%s.mubin</code> (map type, map name, map name, suffix).

Despite the file extension, <code>Map/%s/Location.mubin</code> and <code>Map/%s/LazyTraverseList.mubin</code> are not actually map units.

===Source map unit===
Source map units have muunt<ref>The executable has remnants of error logging functions that print paths to development map units of the following type: <code>Map/Project/%s/Data/%s/%s.muunt</code></ref> as their file extension and use strings for map object IDs such as <code>F-5_challenge.muunt/obj760</code> instead of CRC32 hashes of the IDs in map unit binaries.
[[Category:Internals]]
<references />
[[Category:File formats]]

Map unit

2021-05-03T20:48:44Z

Waikuteru: /* Types */

''Not to be confused with [[map]]s, [[Stage|stages]] or [[Scene|scenes]]''.

<onlyinclude>
'''Map units''' contain placement data for game maps (e.g. MainField/A-1). In other words, they are used to configure fixed object spawns on maps for actors such as scenery and enemies for example, in contrast to the [[AutoPlacement]] system, which dynamically spawns actors.
</onlyinclude>

==Types==
Two types of map units exist: ''Static'' and ''Dynamic''.

'''Static map units''' are loaded during stage generation (see [[GameScene]] for more details). Their name is suffixed with <code>_Static</code>. They can contain both map rails and map objects; furthermore objects can be linked to each other to implement custom game logic using the [[#Link system]]. Static actors are always loaded in memory and will be visible if the player is within the actor's <code>TraverseDist</code> (draw distance) set in [[ActorInfo.product.sbyml]]. It's possible to see actors from the top-left to the bottom-right in open-world stages (MainField and AocField) if the <code>TraverseDist</code> is set high enough.

'''Dynamic map units''' are loaded and unloaded on-the-fly. Their name is suffixed with <code>_Dynamic</code>. The dynamic loading capability is only really put to good use for open-world type stages (e.g. MainField and AocField). In such map units, the link system cannot be used and only map objects can be specified. Dynamic actors are considered to be loaded once the player is either inside of the map it's placed (always the case for CDungeon and MainFieldDungeon), or the player is (on MainField and AocField) located in one of the map-sections around the map-section the actor is placed in.

'''Example:''' Player is located in H-5 so ''G-4, H-4, I-4, G-5- I-5, G-6, H-6 and I-6'' dynamic actors are loaded in memory and will be displayed if the <code>TraverseDist</code> is high enough.

==Contents==

===<code>LocationPosX</code>===
X coordinate of the center of the map unit.

===<code>LocationPosZ</code>===
Y coordinate of the center of the map unit.

===<code>LocationSize</code>===
Size of the map unit (side length of the square).

===<code>Objs</code>===
{{expand section}}
Array of object structures. '''Must be sorted by HashId'''<ref>Technically, sorting is only required for Dynamic (non-group 0) map units. However, not sorting causes the game to fall back to a slower linear search.</ref> because the placement subsystem performs binary searches on the object array in various cases<ref>0x7101256E14</ref>.

===<code>Rails</code>===
{{expand section}}
Array of rail structures. Can only appear in group 0 maps (Static); this section is completely ignored for non-static map units.

==Link system==
'''In static map units only''', map objects can be linked to other objects (up to 255 in a single generation group<ref>"一つの生成グループに 255 以上のアクタが指定されています。テストで無ければプログラマに相談"</ref>). These links allow implementing custom logic and callbacks. For example, DeadUp signals the destination object when the source object dies. This is used to implement enemy chests that only unlock after clearing an enemy camp.

LinkTags and other tag objects are lightweight actors that are used to link objects together.

Objects that are linked together, either directly or via indirect links, are put into the same '''generation group''' and loaded at the same time{{check}}. If the placement system fails to load an actor, the entire generation group is discarded.

===Definitions===
{{expand section}}
Cs means Constraint<ref>SliderCs links are handled by a function {{addr|a=0x7100F70D60|ver=nx-1.5.0}} that is also called by [[AIDef:Action/SwitchStepSliderConstraint]]</ref>.

{| class="wikitable sortable"
!ID!!Name!!Description!!Official description
|-
|4||-AxisX||-||マイナスX軸シグナル
|-
|5||-AxisY||-||マイナスY軸シグナル
|-
|6||-AxisZ||-||マイナスZ軸シグナル
|-
|24||AreaCol||Area collision (link target is an Area object)||エリア(センサ)指定
|-
|1||AxisX||-||X軸シグナル
|-
|2||AxisY||-||Y軸シグナル
|-
|3||AxisZ||-||Z軸シグナル
|-
|37||BAndSCs||Ball & Socket constraint||ボール＆ソケットCS
|-
|38||BAndSLimitAngYCs||Y angular velocity limited Ball & Socket constraint||Y角速度制限付ボール＆ソケットCS
|-
|0||BasicSig||Basic signal||基本シグナル
|-
|9||BasicSigOnOnly||Basic signal [only emits ON signals]||オンのみ基本シグナル
|-
|14||ChangeAtnSig||Signal on Attention change (e.g. picking up a weapon)||アテンション変更時シグナル
|-
|39||CogWheelCs||Gear/cogwheel constraint||歯車CS
|-
|21||CopyWaitRevival||Activate links when the revival flag of the CopyWaitRevival target is set (e.g. can be used with LinkTagAnd to trigger basic signals when a chest is opened)||配置自動セーブ継承
|-
|15||Create||Create a map object. Target objects are not created unless this link is activated.||生成
|-
|11||DeadUp||Signal on death||死んだらオン
|-
|16||Delete||Delete a map object. Target objects are created and stay spawned until this link is activated. Note: the corresponding collision is disabled even for objects that have their collision data extracted to separate Static Compound files.||削除
|-
|29||DemoMember||-||デモ参加
|-
|32||FixedCs||-||固定CS
|-
|26||ForSale||Links a shop item to its seller (target is the seller NPC).||売り物
|-
|19||ForbidAttention||Prevent attention (i.e. interacting with an object, for example picking up a weapon)||アテンションタイプ変更
|-
|18||Freeze||Freeze the target object||凍結
|-
|7||GimmickSuccess||Success signal (used for minigames)||ネタ成功シグナル
|-
|33||HingeCs||Hinge constraint||ヒンジCS
|-
|12||LifeZero||Emit a LifeZero signal when the life of the source object is 0||ライフ0
|-
|34||LimitHingeCs||Limited hinge constraint||制限付ヒンジCS
|-
|27||ModelBind||-||モデルバインド
|-
|17||MtxCopyCreate||-||位置継承生成
|-
|22||OffWaitRevival||Reset the revival flag of the target object||配置自動セーブオフ
|-
|30||PhysSystemGroup||-||物理システムグループ
|-
|28||PlacementLOD||Replace the source object with the link target object at lower level of details||配置LOD
|-
|36||PulleyCs||-||滑車CS
|-
|40||RackAndPinionCs||Rack-and-pinion constraint||ラック＆ピニオンCS
|-
|23||Recreate||Recreates the target object||再生成
|-
|41||Reference||-||参照
|-
|10||Remains||Divine Beast signal||遺物シグナル
|-
|25||SensorBind||-||センサバインド
|-
|35||SliderCs||Slider constraint||スライダーCS
|-
|13||Stable||-||安定
|-
|31||StackLink||-||スタック
|-
|20||SyncLink||Put the destination object and any object that is linked to it into the same generation group||生成グループ
|-
|8||VelocityControl||Velocity control signal||速度制御シグナル
|-
|}

===Link tags===
''Not to be confused with [[actor tag]]s.''

LinkTagAnd, LinkTagOr, LinkTagNAnd, LinkTagNOr, LinkTagXOr, LinkTagCount, LinkTagPulse, LinkTagNone are small objects that are used to implement a basic logic system in map units.

AND, OR, NAND, NOR, XOR LinkTags are logical operators. They can be used to conditionally set or clear GameData flags, or conditionally spawn objects, trigger other objects, etc. A basic signal is emitted when the LinkTag has been triggered by ''all'' of the source links (for LinkTagAnds) or by one of them (for LinkTagOrs), etc.

Count LinkTags are used to increment a GameData flag every time the link tag itself is signalled.

Pulse LinkTags continuously emit a basic signal with a configurable signal duration (PulseLength)<ref>This appears to require a BasicSig input and does not repeat automatically. In order to get this behavior, fire it with a SwitchTimer.</ref>.

None LinkTags have no effect. They are only used to put different map unit objects into the same placement generation group.

Internally, they are all implemented by the same actor class (<code>LinkTag</code>) since they share most of their core functionality, with only small differences in effects. A single link tag can only handle 0x60 incoming links<ref>0x7100D388C4</ref>. Only incoming links with defType <= 0xe are processed<ref>0x7100D389DC</ref>; other links are ignored.

Parameters are documented in [[AIDef:Action/LinkTagBaseAction#MapUnitInstParams]].

==File formats==

===Map unit binary===
In ''Breath of the Wild'', map units are stored in a binary format and given the ''mubin'' (Map Unit Binary) file extension. All map object IDs are replaced with CRC32 hashes as a space optimisation. [[BYML]] is used as the serialisation format.

Map units can be found in the [[Content/Map|Map]] content directory, and use the following naming convention: <code>Map/%s/%s/%s%s.mubin</code> (map type, map name, map name, suffix).

Despite the file extension, <code>Map/%s/Location.mubin</code> and <code>Map/%s/LazyTraverseList.mubin</code> are not actually map units.

===Source map unit===
Source map units have muunt<ref>The executable has remnants of error logging functions that print paths to development map units of the following type: <code>Map/Project/%s/Data/%s/%s.muunt</code></ref> as their file extension and use strings for map object IDs such as <code>F-5_challenge.muunt/obj760</code> instead of CRC32 hashes of the IDs in map unit binaries.
[[Category:Internals]]
<references />
[[Category:File formats]]

AIDef:Action/ChangeScene

2021-02-23T06:18:25Z

Waikuteru: /* DynamicInstParams */

{{AIDef
|name=ChangeScene
|type=Action
}}

== DynamicInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| WarpDestMapName || String || ||
Destination map. Format: {MapType}/{Map}

Example: "MainFieldDungeon/RemainsFire", "MainField/A-1"
|-
| WarpDestPosName || String || ||
Destination position (defined in [[Static.mubin]] for each map type)

Example: "StartR"
|-
| FadeType || Int || ||
* 0: Full loading screen (visible Fade and FadeStatus screens)
* 1: Loading icon on a white background
* 2: Loading icon on a black background
|-
| StartType || Int || ||
* 0: Camera behind Link on spawn.
* 1: Camera behind Link (closer) on spawn.
* 2: Camera in front of Link on spawn.
|-
| EvflName || String || || Name of the event flow to start after warp is complete
Example: Demo622_1
|-
| EntryPointName || String || || Name of the entry point in the event flow
Example: Demo622_1
|-
|}

== Derived definitions ==
=== Demo_ChangeScene (EventSystemActor) ===
{{AIDefDerived
|name=Demo_ChangeScene
|group_name=
|derived_from=ChangeScene
|aiprog=EventSystemActor
}}
No overridden parameters.

== See also ==
* [[Scene]]
* [[AIDef:Action/AreaRoot]] for area-based scene change triggers
* [[AIDef:Action/FromCDungeonToMainField]]
* [[AIDef:Action/ToCDungeon]]

GameScene

2021-01-16T20:48:40Z

Waikuteru: /* GameScene state strings */

{{Subsystem infobox|name=GameScene|is_name_official=1|description=Handles the main loop and stages|init_addr_switch150=0x71007D1DD8}}

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

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

==Definitions==
===Stages===
Also called scenes in XLink code.
{| class="wikitable"
!Type
!Description
!Map types
|-
|0
|Invalid ("None")
| -
|-
|1
|Open world stage (except GameTestField) ("オープンワールド")
|MainField, AocField
|-
|2
|Indoor stage ("Cダンジョン")
|CDungeon, MainFieldSpot, GameTestDungeon
|-
|3
|Open world stage (GameTestField) ("GameTset")
|GameTestField
|-
|4
|MainFieldDungeon ("四大遺物")
|MainFieldDungeon
|-
|5
|Indoor stage or viewer stage ("ビューワー")
|ActorViewer
|}
Maps that have the same stage type typically use the same subsystems and share most characteristics. For example, all open world stages use the [[Tera]] height map terrain system and load [[Map unit|map units]] in the same way.

===StageBinders===
{| class="wikitable"
|+Stage binder types<ref>As returned by the first virtual function in the StageBinderBase interface</ref>
!Type!!Description
|-
|0||OpenWorldStage
|-
|1||IndoorStage (CDungeon, ...)
|-
|2||MainFieldDungeonStage
|-
|3||TitleStage
|-
|4||StartupSaveCheckStage
|-
|5||Viewer
|}

===Fade types===
{| class="wikitable"
!Type!!Description
|-
|0||
|-
|1||
|-
|2||Show logo<ref>See 0x71007B8CD0 and [[AIDef:Action/ExitGame]]</ref>
|}

===GameScene state strings===
{| class="wikitable"
|+List of state strings in 1.5.0 (incomplete)<ref>The state string is a sead::FixedSafeString<0x100> stored in GameScene @ 0x720.</ref>
!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||Shrine world
|-
|MainFieldDungeonStage||Divine beasts and final trial
|-
|MainField||The normal overworld
|-
|GameTestField||
|-
|GameTestField2||
|-
|AocField||Trial of the Sword world
|-
|GameTestDungeon||
|-
|MonolithTestDungeon||
|-
|SrdTestDungeon||
|-
|MarioClubTestDungeon||
|-
|TestField||
|-
|研修用||
|-
|MonolithTest100enemy||
|-
|MinimumField||
|-
|ActorViewer||
|}

==Init==

*'''GameScene::initialize''' (0x71007A8014)
**Load the environment graphics archive ([[Content/Env/env.genvb|env.genvb]])
**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]]
***[[GameSceneSubsys2]]
***[[Resetter]]
***[[GameSceneSubsys4]]
***[[GameSceneSubsys5]]
***[[ActorHeapUtil]]
***[[E3Mgr]]
***[[aoc2]]
***[[aoc3]]
***[[GameSceneSubsys6]]
***[[CookingMgr]]
***[[GameSceneSubsys7]]
***[[ActorLimiter]]
***[[RuneMgr]]
***[[StasisMgr]]
***[[IceBlockMgr]]
***[[AmiiboMgr]]
***[[DropMgr]]
***[[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|initial state]]
***nn::err::ShowUnacceptableAddOnContentVersionError if needed
****[Debug] StarterPackMgr: Load Title pack
****[[GlobalParameter]]
****GlobalParameter: Load [[actorpack]]
****E3Mgr: Load [[Content/System/BuildTime.txt|System/BuildTime.txt]] (stubbed in release versions)
****TipsMgr: Load tips
****ResidentActorMgr: Load configuration ([[ResidentActors.byml]])
****AutoPlacementFlowMgr: Load auto placement [[event flow]]s
***KingEditor: Stubbed
***E3Mgr: init

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

<source lang="cpp">
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);
</source>

==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<ref>StageBinder::initAndReportDungeonLeaveEnter{{un}} at 0x71007B79A8</ref>.

===StageMgr===
{{empty section}}
===StageSelect===
{{empty section}}
===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<ref>0x71007B47D8</ref>) when the "common run" status (see below) is 0xa, then calls the "common run" function (with isNewSave=false<ref>0x71007B47F4</ref>).

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

===PatchError===
{{empty section}}

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

===precalc===

*FadeProgress: Update the progress gauge on the Fade screen (animated).
*Update current map name based on player position (when Link is not in a dungeon).
*Run StageMgr and StageSelect code.
*If a flag is set, run the final step of stage generation. (Unused?)
*If stage status is "NeedsGeneration":
**Call some [[MCMgr]] function at 0x71007A9198.
**Run save upload subsystem if needed.
**Call GameScene::genStage with second argument being <code>!EventMgr::sInstance->hasActiveEvent() || EventMgr::sInstance->getActiveEvent()->name != "Demo169_0"</code>.
*If stage status is "NeedsUnload":
**Call some [[MCMgr]] function at 0x71007A9198.
**Run save upload subsystem if needed.
**Call GameScene::unloadStage.
*If no stage is being unloaded, call <code>this->activeStageBinder->getStage()->preCalc</code>.
*??? (something involving GameScene Subsystem #12)
*Call some [[MCMgr]] function at 0x71007A9198, again.
*If the current state is StageMgr:
**Reset the current stage binder by setting a flag for StageMgr if needed (after a Blood Moon{{check}})
**If a forced blood moon is ready
***If panic blood moons can be triggered (see [[Blood moon#Panic blood moon inhibitors]]), call the Blood Moon demo (Demo011_0).
***Report the panic blood moon via the [[telemetry]] system.
**If any [[Blood moon#Panic Blood Moons|panic condition]] is true, and if panic blood moons are enabled<ref>GameConfig::sInstance->disablePanicBloodMoons (@ 0x3da on Switch 1.5.0) must be false.</ref>, request a panic blood moon by setting a SkyMgr flag. SkyMgr will start a 90 frame timer (3 seconds) and set a ready flag once it has expired. The timer is reset every time the panic blood moon is temporarily inhibited.

===calc===
{{empty section}}
===postcalc===
{{empty section}}

==Common state run function==
Called from StageSelectRun, LunchTitleRun and NewSaveRun.

*Status 0:
**Start loading
***Finish startup logo (Switch)<ref>0x71007AF6F8</ref>
***If the state string is set to 初回シーケンス, clear the Resource system cache ("ClearAllCaches")<ref>0x71007AFBDC</ref>.
***Debug stuff<ref>0x71007AFDE4</ref>.
***E3 Demo stuff<ref>0x71007AFEF4</ref>.
***Show the Fade screen (loading screen) if the state string does ''not''<ref>0x71007AFF08</ref> end with "Viewer" or is ''not'' any of the following strings: 1st, 2nd, Presentation, TitleMenu, 初回シーケンス, StartupSaveCheckStage
****And then show the FadeStatus<ref>0x71007AFFC4</ref> and the LoadSaveIcon screens<ref>0x71007AFFCC</ref>.
****Otherwise, only open the Fade screen but do not show loading progress<ref>See function at 0x71007B0C60</ref>.
***StageSelect stuff<ref>0x71007B0000</ref>.
***Stop "resource compaction" and wait for it to be stopped<ref>0x71007B00B4 (stop compaction) to 0x71007B010C (end of the busy loop)</ref>.
***If the stage string starts with CDungeon<ref>0x71007B0124</ref> or MainFieldDungeonStage<ref>0x71007B0160</ref>, start loading the associated DungeonPack<ref>0x71007B0190</ref>.
***BaseProcMgr: start ActorCreate initializer thread<ref>0x71011BF1C4</ref>{{check}}.
***FadeProgress: reset internal state<ref>0x71007B01D4</ref>, set progress to 0%<ref>0x71007B01E0</ref> and mark loading as active<ref>0x71007B01E8</ref>.
*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<ref>0x71007B1058</ref>.
**Set stage status to "NeedsGeneration" (2)<ref>0x71007B105C</ref>.

==Stage generation==

*Terrain::sInstance->flags |= 0x180u
*Step 0
**Reload Title.pack if the stage that needs to be generated is TitleStage (3)<ref>0x71007AC8A0</ref>.
**StageSelect checks<ref>0x71007AD3AC</ref>
*Step 1
**If a pack was loaded by DungeonPackMgr, wait for DungeonPack loading to finish<ref>DungeonPack読み込み待ち</ref> and switch active pack to the [[dungeon pack]].
*Step 2
**If the stage to load is TitleStage, wait for TitlePack loading to finish<ref>TitlePack読み込み待ち</ref> and switch active pack to the title pack.
*Step 3: start stage generation<ref>ステージ生成開始</ref>
**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 strings|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<ref>0x71007ADB3C</ref>, 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<ref>0x71007ACDE4</ref>
**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<ref>tera読み込み待ち</ref>
*Step 8
**...{{check}}
**Wait for Tera to generate collision
**...{{check}}
*Step 9
**Initialize [[QuestMgr]].
**'''Set loading progress to 60%.'''
*Step 10
**Load stage specific resources<ref>ステージ固有リソースの読み込み待ち</ref>: if the binder type is StageBinderType::Title (3), the Title layout archive is loaded by [[LayoutResourceMgr]]. Otherwise, nothing happens.
*Step 11
**[[#Stage generation step 11]]
**Update player saved position, map type, map name, ...
**Change GameScene state to StageSelect or StageMgr (step 11-6 sets the state pointer to StageMgr).
**Terrain stuff{{check}}
**DungeonPackMgr: clean up state (destroy arena and heap) and unregister entry factory.
**Set flag 0xa25 (genStageStep12Reached?{{check}}) on the Fade screen instance.
**Stop resource compaction and set some flags on the TextureHandleMgr.
*Step 12
**Set aoc2 flag 0x4 if <code>isNewSave || !isShrine || isStageDebug</code> and clear it otherwise.
**[[#Stage generation step 12]]
**Terrain stuff again{{check}}
*Step 13 (final)
**[[#Stage generation final step]]
**Various flags are set upon completion, for example GameScene stage status is set to 0, isInitializingStage is set to false, etc.
**FadeProgress is reset.
**Stage generation debug timer is stopped.
**aoc2: IsLastPlayHardMode is updated.
**GameScene::sNeedsOptionLoad is set to true.

===Stage generation step 11===

*Step 0: init before stage gen (ステージ生成前の初期化処理)<ref>The function can be found at 0x71007B15A8 in Switch 1.5.0.</ref>
**Various flags are set (GameScene, BaseProcMgr, Awareness, EventMgr), in particular field 0x1d12a is set to true if <code>!isNewSave</code>.
**Set initial position based on the stage binder. This may be overridden with a saved position or an event position later on.
**GameSceneSubsys2, ActorSystem: set some flags
**GameSceneSubsys14: Update current location name (game data flag: SaveLocationName). The flag is written to if the player is in a shrine or a Divine Beast. Otherwise, it's read.
**PhysicsMemSys: set indoor flag if the stage binder type is Indoor (1)
**aoc2: Set flag 0x1 (IsLastPlayHardMode) if the corresponding game data flag is set. This is what the rest of the game uses to determine if Master Mode is enabled.
**Effect, Reaction, PhysicsMemSys, EventMgr
**PlacementMgr, LODMgr, EventMgr, WorldMgr, Awareness, Effect, XLink, VFR
**aocManager: set latest version played and HasAocVer{1,2,3} flags.
**Terrain
**Initialize the sound system and the UI manager
**If the stage binder type is OpenWorld (0) or the map name is ActorViewer or the current stage is a debug map:
***Create the HorseMgr instance, initialize it and create the horse actor.
***Create the WolfLinkMgr instance and initialize it.
***Create the MotorcycleMgr instance and initialize it.
**GameSceneSubsys5, GameSceneSubsys4: ? {{check}}
**If a flag is set (GameScene @ 0x6e5), SaveSystem::startLoad is called.
**TipsMgr: Initialize the TipsSystemActor.
*Step 1: wait for horse generation (馬の生成待ち)
*Step 2: if the stage binder type is not Title and not Viewer and not StartupSaveCheck, initialize PauseMenuDataMgr (PauseMenuDataMgr::fromSaveData).
*Step 3: wait for player equipment actor generation to complete (プレイヤーの装備アクターの生成完了待ち): CreatePlayerEquipActorMgr
*Step 4
**aocManager: parse MainField static map unit (if aocManager exists)
**Something involving vectors and calculations{{check}}
*Step 5
**Update FadeProgress based on the queue size of the BaseProcMgr actor create initializer{{check}} and PlacementMgr load progress{{check}}. This step represents the '''last 40% of the progress bar'''.
**Start [[#Stage generation step 11-5b]] as an async task<ref>0x71007B2C78</ref> and wait for it to complete.
**Stop the Fade screen "color animator".
**Call this->stage->initForStageGen (vtable @ 0x60). For most stages, this calls WorldMgr's SkyMgr::update.
**Graphics, uiManager, agl::lyr::Renderer: ?{{check}}
**Set this->activeStageBinder (@ 0x2a0) to this->stageBinder (@ 0x2a8)<ref>0x71007B1A88</ref>.
*Step 6
**Set next GameScene state to StageMgr.
**qword_71025D16C0: ?{{check}}
**If the binder type is Title (3):
***If the ROM type is "RID_Demo": reset some internal state in SaveMgr and SaveSystem.
***If aoc3 is initialized, set Blight rematch counters to 0 for all four blights.
**PauseMenuDataMgr: Update IsOpenItemCategory flags if necessary.
*Step 7: wait for save data upload to finish (if an upload is in progress).
*Step 8: BaseProcMgr: wait for some actor create initializer event and reset it{{check}}

====Stage generation step 11-5b====

*ProductReporter: reset scene work time (the amount of time since the last scene generation) and reset the blood moon reporter.
*Destroy the previous stage binder (this->activeStageBinder) if it's different from the current binder (this->stageBinder), and also set this->stage to nullptr.
*''Set the scene change event flow and entry point names'':
**If the binder type is Title: Demo025_2<Demo025_2>
**If aocManager::sInstance->version >= 0x200 and !100enemy_Activated and IsGet_Weapon_Sword_070 and !IsPlayed_Demo146_0:
***If the current [[map area]] is 14 (Korok Forest):
****If [[BalladOfHeroActiveTiming]] is 1: Aoc2Resident<InForrest>
****If [[BalladOfHeroActiveTiming]] is 0: Demo201_0<Demo201_0>
***Otherwise:
****If [[BalladOfHeroActiveTiming]] is 2: Aoc2Resident<InShrineOfResurrection>
****If [[BalladOfHeroActiveTiming]] is 1: Aoc2Resident<InOtherArea>
****If [[BalladOfHeroActiveTiming]] is 0: Demo200_0<Demo200_0>
**Otherwise, if the map type is MainField:
***If [[BalladOfHeroActiveTiming]] is 2: Demo600_1<Demo600_1>
***If [[BalladOfHeroActiveTiming]] is 1: Demo600_1<Demo600_0>
***Otherwise: Demo025_0<Demo025_0>
**If the map type is CDungeon or MarioClubTestDungeon: Demo008_2<Demo008_2>
*WorldMgr ShootingStarMgr: Update the isMainField flag.
*AmiiboMgr: Set flag 0x40 if the map name is MainField, otherwise clear it.
*'''Create the stage'''<ref>0x71007B3C5C</ref>.
**The stage class is automatically selected based on the stage binder type.
**stage->init and stage->postInit are called here<ref>0x71007CC024</ref>.

===Stage generation step 12===

*Step 0:
**[1.4.0+] If BalladOfHeroes_Step02 is false or BalladOfHeroes_Step03 is true, and if the player's equipped weapon (category 0) is Weapon_Sword_502 (One-Hit Obliterator), that weapon is removed from the inventory.
**'''FadeProgress is set to 100%'''.
*Step 1: Wait for environment map, grass, etc. (環境マップや草などの準備待ち) and set various flags (GameScene globals, Fade, BaseProcMgr).
*Step 2: Wait for 3 game ticks.
*Step 3: Terrain stuff{{check}}
*Step 4: ?{{check}}
*Step 5: Call the scene start event flow.
*Step 6:
**Wait for the scene start event flow (シーン開始イベントスタート待ち)
**Set some flags (Player, WorldMgr, PlacementMgr, ActorSystem)

===Stage generation final step===

*Sound, qword_71025D04F0, qword_71025D16C0, qword_71025D1740: ? {{check}}
*Clear the temporary stage binder pointer (which was used only during generation).
*Close the Fade and the FadeStatus screens. This effectively hides the loading screen.
*TipsMgr: TipsSystemActor is reset and the current date is stored.
*In dev mode, write a list of all loaded resources to %PROJECT_ROOT%/Log/BootupPatrol/res_title.csv.
*If the active stage binder type is Title (3) and resident actors haven't been loaded yet, start title background processing.
*Clear the "has played awakening demo" flag (not the game data flag!) if there is no active event or if the active event is not Demo169_0.
*Set this->stageGenerated to 1<ref>0x71007B2038</ref>.

==References==
<references />
[[Category:Internals]]
[[Category:Subsystems (BotW)]]

GameScene

2021-01-16T20:47:48Z

Waikuteru: /* GameScene state strings */

{{Subsystem infobox|name=GameScene|is_name_official=1|description=Handles the main loop and stages|init_addr_switch150=0x71007D1DD8}}

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

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

==Definitions==
===Stages===
Also called scenes in XLink code.
{| class="wikitable"
!Type
!Description
!Map types
|-
|0
|Invalid ("None")
| -
|-
|1
|Open world stage (except GameTestField) ("オープンワールド")
|MainField, AocField
|-
|2
|Indoor stage ("Cダンジョン")
|CDungeon, MainFieldSpot, GameTestDungeon
|-
|3
|Open world stage (GameTestField) ("GameTset")
|GameTestField
|-
|4
|MainFieldDungeon ("四大遺物")
|MainFieldDungeon
|-
|5
|Indoor stage or viewer stage ("ビューワー")
|ActorViewer
|}
Maps that have the same stage type typically use the same subsystems and share most characteristics. For example, all open world stages use the [[Tera]] height map terrain system and load [[Map unit|map units]] in the same way.

===StageBinders===
{| class="wikitable"
|+Stage binder types<ref>As returned by the first virtual function in the StageBinderBase interface</ref>
!Type!!Description
|-
|0||OpenWorldStage
|-
|1||IndoorStage (CDungeon, ...)
|-
|2||MainFieldDungeonStage
|-
|3||TitleStage
|-
|4||StartupSaveCheckStage
|-
|5||Viewer
|}

===Fade types===
{| class="wikitable"
!Type!!Description
|-
|0||
|-
|1||
|-
|2||Show logo<ref>See 0x71007B8CD0 and [[AIDef:Action/ExitGame]]</ref>
|}

===GameScene state strings===
{| class="wikitable"
|+List of state strings in 1.5.0 (incomplete)<ref>The state string is a sead::FixedSafeString<0x100> stored in GameScene @ 0x720.</ref>
!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||Shrine world
|-
|MainFieldDungeonStage||Divine beasts and final trial
|-
|MainField||The normal overworld
|-
|GameTestField||
|-
|GameTestField2||
|-
|AocField||Trial of the Word world
|-
|GameTestDungeon||
|-
|MonolithTestDungeon||
|-
|SrdTestDungeon||
|-
|MarioClubTestDungeon||
|-
|TestField||
|-
|研修用||
|-
|MonolithTest100enemy||
|-
|MinimumField||
|-
|ActorViewer||
|}

==Init==

*'''GameScene::initialize''' (0x71007A8014)
**Load the environment graphics archive ([[Content/Env/env.genvb|env.genvb]])
**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]]
***[[GameSceneSubsys2]]
***[[Resetter]]
***[[GameSceneSubsys4]]
***[[GameSceneSubsys5]]
***[[ActorHeapUtil]]
***[[E3Mgr]]
***[[aoc2]]
***[[aoc3]]
***[[GameSceneSubsys6]]
***[[CookingMgr]]
***[[GameSceneSubsys7]]
***[[ActorLimiter]]
***[[RuneMgr]]
***[[StasisMgr]]
***[[IceBlockMgr]]
***[[AmiiboMgr]]
***[[DropMgr]]
***[[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|initial state]]
***nn::err::ShowUnacceptableAddOnContentVersionError if needed
****[Debug] StarterPackMgr: Load Title pack
****[[GlobalParameter]]
****GlobalParameter: Load [[actorpack]]
****E3Mgr: Load [[Content/System/BuildTime.txt|System/BuildTime.txt]] (stubbed in release versions)
****TipsMgr: Load tips
****ResidentActorMgr: Load configuration ([[ResidentActors.byml]])
****AutoPlacementFlowMgr: Load auto placement [[event flow]]s
***KingEditor: Stubbed
***E3Mgr: init

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

<source lang="cpp">
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);
</source>

==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<ref>StageBinder::initAndReportDungeonLeaveEnter{{un}} at 0x71007B79A8</ref>.

===StageMgr===
{{empty section}}
===StageSelect===
{{empty section}}
===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<ref>0x71007B47D8</ref>) when the "common run" status (see below) is 0xa, then calls the "common run" function (with isNewSave=false<ref>0x71007B47F4</ref>).

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

===PatchError===
{{empty section}}

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

===precalc===

*FadeProgress: Update the progress gauge on the Fade screen (animated).
*Update current map name based on player position (when Link is not in a dungeon).
*Run StageMgr and StageSelect code.
*If a flag is set, run the final step of stage generation. (Unused?)
*If stage status is "NeedsGeneration":
**Call some [[MCMgr]] function at 0x71007A9198.
**Run save upload subsystem if needed.
**Call GameScene::genStage with second argument being <code>!EventMgr::sInstance->hasActiveEvent() || EventMgr::sInstance->getActiveEvent()->name != "Demo169_0"</code>.
*If stage status is "NeedsUnload":
**Call some [[MCMgr]] function at 0x71007A9198.
**Run save upload subsystem if needed.
**Call GameScene::unloadStage.
*If no stage is being unloaded, call <code>this->activeStageBinder->getStage()->preCalc</code>.
*??? (something involving GameScene Subsystem #12)
*Call some [[MCMgr]] function at 0x71007A9198, again.
*If the current state is StageMgr:
**Reset the current stage binder by setting a flag for StageMgr if needed (after a Blood Moon{{check}})
**If a forced blood moon is ready
***If panic blood moons can be triggered (see [[Blood moon#Panic blood moon inhibitors]]), call the Blood Moon demo (Demo011_0).
***Report the panic blood moon via the [[telemetry]] system.
**If any [[Blood moon#Panic Blood Moons|panic condition]] is true, and if panic blood moons are enabled<ref>GameConfig::sInstance->disablePanicBloodMoons (@ 0x3da on Switch 1.5.0) must be false.</ref>, request a panic blood moon by setting a SkyMgr flag. SkyMgr will start a 90 frame timer (3 seconds) and set a ready flag once it has expired. The timer is reset every time the panic blood moon is temporarily inhibited.

===calc===
{{empty section}}
===postcalc===
{{empty section}}

==Common state run function==
Called from StageSelectRun, LunchTitleRun and NewSaveRun.

*Status 0:
**Start loading
***Finish startup logo (Switch)<ref>0x71007AF6F8</ref>
***If the state string is set to 初回シーケンス, clear the Resource system cache ("ClearAllCaches")<ref>0x71007AFBDC</ref>.
***Debug stuff<ref>0x71007AFDE4</ref>.
***E3 Demo stuff<ref>0x71007AFEF4</ref>.
***Show the Fade screen (loading screen) if the state string does ''not''<ref>0x71007AFF08</ref> end with "Viewer" or is ''not'' any of the following strings: 1st, 2nd, Presentation, TitleMenu, 初回シーケンス, StartupSaveCheckStage
****And then show the FadeStatus<ref>0x71007AFFC4</ref> and the LoadSaveIcon screens<ref>0x71007AFFCC</ref>.
****Otherwise, only open the Fade screen but do not show loading progress<ref>See function at 0x71007B0C60</ref>.
***StageSelect stuff<ref>0x71007B0000</ref>.
***Stop "resource compaction" and wait for it to be stopped<ref>0x71007B00B4 (stop compaction) to 0x71007B010C (end of the busy loop)</ref>.
***If the stage string starts with CDungeon<ref>0x71007B0124</ref> or MainFieldDungeonStage<ref>0x71007B0160</ref>, start loading the associated DungeonPack<ref>0x71007B0190</ref>.
***BaseProcMgr: start ActorCreate initializer thread<ref>0x71011BF1C4</ref>{{check}}.
***FadeProgress: reset internal state<ref>0x71007B01D4</ref>, set progress to 0%<ref>0x71007B01E0</ref> and mark loading as active<ref>0x71007B01E8</ref>.
*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<ref>0x71007B1058</ref>.
**Set stage status to "NeedsGeneration" (2)<ref>0x71007B105C</ref>.

==Stage generation==

*Terrain::sInstance->flags |= 0x180u
*Step 0
**Reload Title.pack if the stage that needs to be generated is TitleStage (3)<ref>0x71007AC8A0</ref>.
**StageSelect checks<ref>0x71007AD3AC</ref>
*Step 1
**If a pack was loaded by DungeonPackMgr, wait for DungeonPack loading to finish<ref>DungeonPack読み込み待ち</ref> and switch active pack to the [[dungeon pack]].
*Step 2
**If the stage to load is TitleStage, wait for TitlePack loading to finish<ref>TitlePack読み込み待ち</ref> and switch active pack to the title pack.
*Step 3: start stage generation<ref>ステージ生成開始</ref>
**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 strings|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<ref>0x71007ADB3C</ref>, 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<ref>0x71007ACDE4</ref>
**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<ref>tera読み込み待ち</ref>
*Step 8
**...{{check}}
**Wait for Tera to generate collision
**...{{check}}
*Step 9
**Initialize [[QuestMgr]].
**'''Set loading progress to 60%.'''
*Step 10
**Load stage specific resources<ref>ステージ固有リソースの読み込み待ち</ref>: if the binder type is StageBinderType::Title (3), the Title layout archive is loaded by [[LayoutResourceMgr]]. Otherwise, nothing happens.
*Step 11
**[[#Stage generation step 11]]
**Update player saved position, map type, map name, ...
**Change GameScene state to StageSelect or StageMgr (step 11-6 sets the state pointer to StageMgr).
**Terrain stuff{{check}}
**DungeonPackMgr: clean up state (destroy arena and heap) and unregister entry factory.
**Set flag 0xa25 (genStageStep12Reached?{{check}}) on the Fade screen instance.
**Stop resource compaction and set some flags on the TextureHandleMgr.
*Step 12
**Set aoc2 flag 0x4 if <code>isNewSave || !isShrine || isStageDebug</code> and clear it otherwise.
**[[#Stage generation step 12]]
**Terrain stuff again{{check}}
*Step 13 (final)
**[[#Stage generation final step]]
**Various flags are set upon completion, for example GameScene stage status is set to 0, isInitializingStage is set to false, etc.
**FadeProgress is reset.
**Stage generation debug timer is stopped.
**aoc2: IsLastPlayHardMode is updated.
**GameScene::sNeedsOptionLoad is set to true.

===Stage generation step 11===

*Step 0: init before stage gen (ステージ生成前の初期化処理)<ref>The function can be found at 0x71007B15A8 in Switch 1.5.0.</ref>
**Various flags are set (GameScene, BaseProcMgr, Awareness, EventMgr), in particular field 0x1d12a is set to true if <code>!isNewSave</code>.
**Set initial position based on the stage binder. This may be overridden with a saved position or an event position later on.
**GameSceneSubsys2, ActorSystem: set some flags
**GameSceneSubsys14: Update current location name (game data flag: SaveLocationName). The flag is written to if the player is in a shrine or a Divine Beast. Otherwise, it's read.
**PhysicsMemSys: set indoor flag if the stage binder type is Indoor (1)
**aoc2: Set flag 0x1 (IsLastPlayHardMode) if the corresponding game data flag is set. This is what the rest of the game uses to determine if Master Mode is enabled.
**Effect, Reaction, PhysicsMemSys, EventMgr
**PlacementMgr, LODMgr, EventMgr, WorldMgr, Awareness, Effect, XLink, VFR
**aocManager: set latest version played and HasAocVer{1,2,3} flags.
**Terrain
**Initialize the sound system and the UI manager
**If the stage binder type is OpenWorld (0) or the map name is ActorViewer or the current stage is a debug map:
***Create the HorseMgr instance, initialize it and create the horse actor.
***Create the WolfLinkMgr instance and initialize it.
***Create the MotorcycleMgr instance and initialize it.
**GameSceneSubsys5, GameSceneSubsys4: ? {{check}}
**If a flag is set (GameScene @ 0x6e5), SaveSystem::startLoad is called.
**TipsMgr: Initialize the TipsSystemActor.
*Step 1: wait for horse generation (馬の生成待ち)
*Step 2: if the stage binder type is not Title and not Viewer and not StartupSaveCheck, initialize PauseMenuDataMgr (PauseMenuDataMgr::fromSaveData).
*Step 3: wait for player equipment actor generation to complete (プレイヤーの装備アクターの生成完了待ち): CreatePlayerEquipActorMgr
*Step 4
**aocManager: parse MainField static map unit (if aocManager exists)
**Something involving vectors and calculations{{check}}
*Step 5
**Update FadeProgress based on the queue size of the BaseProcMgr actor create initializer{{check}} and PlacementMgr load progress{{check}}. This step represents the '''last 40% of the progress bar'''.
**Start [[#Stage generation step 11-5b]] as an async task<ref>0x71007B2C78</ref> and wait for it to complete.
**Stop the Fade screen "color animator".
**Call this->stage->initForStageGen (vtable @ 0x60). For most stages, this calls WorldMgr's SkyMgr::update.
**Graphics, uiManager, agl::lyr::Renderer: ?{{check}}
**Set this->activeStageBinder (@ 0x2a0) to this->stageBinder (@ 0x2a8)<ref>0x71007B1A88</ref>.
*Step 6
**Set next GameScene state to StageMgr.
**qword_71025D16C0: ?{{check}}
**If the binder type is Title (3):
***If the ROM type is "RID_Demo": reset some internal state in SaveMgr and SaveSystem.
***If aoc3 is initialized, set Blight rematch counters to 0 for all four blights.
**PauseMenuDataMgr: Update IsOpenItemCategory flags if necessary.
*Step 7: wait for save data upload to finish (if an upload is in progress).
*Step 8: BaseProcMgr: wait for some actor create initializer event and reset it{{check}}

====Stage generation step 11-5b====

*ProductReporter: reset scene work time (the amount of time since the last scene generation) and reset the blood moon reporter.
*Destroy the previous stage binder (this->activeStageBinder) if it's different from the current binder (this->stageBinder), and also set this->stage to nullptr.
*''Set the scene change event flow and entry point names'':
**If the binder type is Title: Demo025_2<Demo025_2>
**If aocManager::sInstance->version >= 0x200 and !100enemy_Activated and IsGet_Weapon_Sword_070 and !IsPlayed_Demo146_0:
***If the current [[map area]] is 14 (Korok Forest):
****If [[BalladOfHeroActiveTiming]] is 1: Aoc2Resident<InForrest>
****If [[BalladOfHeroActiveTiming]] is 0: Demo201_0<Demo201_0>
***Otherwise:
****If [[BalladOfHeroActiveTiming]] is 2: Aoc2Resident<InShrineOfResurrection>
****If [[BalladOfHeroActiveTiming]] is 1: Aoc2Resident<InOtherArea>
****If [[BalladOfHeroActiveTiming]] is 0: Demo200_0<Demo200_0>
**Otherwise, if the map type is MainField:
***If [[BalladOfHeroActiveTiming]] is 2: Demo600_1<Demo600_1>
***If [[BalladOfHeroActiveTiming]] is 1: Demo600_1<Demo600_0>
***Otherwise: Demo025_0<Demo025_0>
**If the map type is CDungeon or MarioClubTestDungeon: Demo008_2<Demo008_2>
*WorldMgr ShootingStarMgr: Update the isMainField flag.
*AmiiboMgr: Set flag 0x40 if the map name is MainField, otherwise clear it.
*'''Create the stage'''<ref>0x71007B3C5C</ref>.
**The stage class is automatically selected based on the stage binder type.
**stage->init and stage->postInit are called here<ref>0x71007CC024</ref>.

===Stage generation step 12===

*Step 0:
**[1.4.0+] If BalladOfHeroes_Step02 is false or BalladOfHeroes_Step03 is true, and if the player's equipped weapon (category 0) is Weapon_Sword_502 (One-Hit Obliterator), that weapon is removed from the inventory.
**'''FadeProgress is set to 100%'''.
*Step 1: Wait for environment map, grass, etc. (環境マップや草などの準備待ち) and set various flags (GameScene globals, Fade, BaseProcMgr).
*Step 2: Wait for 3 game ticks.
*Step 3: Terrain stuff{{check}}
*Step 4: ?{{check}}
*Step 5: Call the scene start event flow.
*Step 6:
**Wait for the scene start event flow (シーン開始イベントスタート待ち)
**Set some flags (Player, WorldMgr, PlacementMgr, ActorSystem)

===Stage generation final step===

*Sound, qword_71025D04F0, qword_71025D16C0, qword_71025D1740: ? {{check}}
*Clear the temporary stage binder pointer (which was used only during generation).
*Close the Fade and the FadeStatus screens. This effectively hides the loading screen.
*TipsMgr: TipsSystemActor is reset and the current date is stored.
*In dev mode, write a list of all loaded resources to %PROJECT_ROOT%/Log/BootupPatrol/res_title.csv.
*If the active stage binder type is Title (3) and resident actors haven't been loaded yet, start title background processing.
*Clear the "has played awakening demo" flag (not the game data flag!) if there is no active event or if the active event is not Demo169_0.
*Set this->stageGenerated to 1<ref>0x71007B2038</ref>.

==References==
<references />
[[Category:Internals]]
[[Category:Subsystems (BotW)]]

AIDef:AI/ChangeWeatherTagRoot

2021-01-13T17:30:09Z

Waikuteru: /* MapUnitInstParams */

{{AIDef
|name=ChangeWeatherTagRoot
|type=AI
}}

== MapUnitInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| Weather || Int || -1 || Sets the [[WorldMgr#Weather_types|weather type]].
|-
| TemperatureDay || Float || 99999.9 ||
|-
| TemperatureNight || Float || 99999.9 ||
|-
| WeatherEff || Int || -1 || Controls the weather efficienty.
|-
| PaletteSel || Int || -1 || A visual color scheme that can also include effects like fog, sandstorm, etc. There are various of them (up to 255).
|-
| PSelSpeed || Int || 0 || Controls the speed change from current PaletteSel to the defined PaletteSel. (''0: Normal Speed; 1: Slower Speed; 2: Very Fast Speed'')
|-
| TemperatureDirectDay || Float || 99999.9 ||
|-
| TemperatureDirectNight || Float || 99999.9 ||
|-
| CloudShadowOff || Bool || False ||
|-
| BluffThunderOff || Bool || False ||
|-
| IgnitedLevel || Int || 0 || Allows to set the environment on fire. (''0: No ignition; 1: Normal ignition; 2: Heavy ignition'')
|-
| FogMinusCorrection || Bool || False ||
|-
|}

== Children ==
{|class="wikitable"
! Name !! Description
|-
| 通知 ||
|-
|}

== Derived definitions ==
=== Root (WeatherChangeTag) ===
{{AIDefDerived
|name=Root
|group_name=
|derived_from=ChangeWeatherTagRoot
|aiprog=WeatherChangeTag
}}
No overridden parameters.

AIDef:Action/EventAddGameDataToRupeeAction

2021-01-09T14:48:44Z

Waikuteru: /* DynamicInstParams */

{{AIDef
|name=EventAddGameDataToRupeeAction
|type=Action
}}

== DynamicInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| GameDataIntAddValueName || String || || Add a flag value to the player's rupees.
|-
| IsSignInversion || Bool || || Whether the sign (+ and -) of the flag's value should be inverted.
|-
|}

== Derived definitions ==
=== Demo_AddGameDataToRupee (EventSystemActor) ===
{{AIDefDerived
|name=Demo_AddGameDataToRupee
|group_name=
|derived_from=EventAddGameDataToRupeeAction
|aiprog=EventSystemActor
}}
No overridden parameters.

AIDef:Action/EventAddGameDataToRupeeAction

2021-01-09T14:46:08Z

Waikuteru: /* DynamicInstParams */

{{AIDef
|name=EventAddGameDataToRupeeAction
|type=Action
}}

== DynamicInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| GameDataIntAddValueName || String || Add a flag value to the player's rupees. ||
|-
| IsSignInversion || Bool || Whether the sign (+ and -) of the flag's value should be inverted. ||
|-
|}

== Derived definitions ==
=== Demo_AddGameDataToRupee (EventSystemActor) ===
{{AIDefDerived
|name=Demo_AddGameDataToRupee
|group_name=
|derived_from=EventAddGameDataToRupeeAction
|aiprog=EventSystemActor
}}
No overridden parameters.

AIDef:Action/EventAddGameDataToRupeeAction

2021-01-09T14:27:17Z

Waikuteru: /* DynamicInstParams */

{{AIDef
|name=EventAddGameDataToRupeeAction
|type=Action
}}

== DynamicInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| GameDataIntAddValueName || String || Add a flag value to the player's rupees. ||
|-
| IsSignInversion || Bool || Whether the added value should be positive or negative (''false'': positive; ''true'': negative||
|-
|}

== Derived definitions ==
=== Demo_AddGameDataToRupee (EventSystemActor) ===
{{AIDefDerived
|name=Demo_AddGameDataToRupee
|group_name=
|derived_from=EventAddGameDataToRupeeAction
|aiprog=EventSystemActor
}}
No overridden parameters.

EventInfo.product.sbyml

2021-01-09T14:05:25Z

Waikuteru: /* Common event flow properties */

{{resloc|locations=[[Bootup.pack]]|path=Event/EventInfo.product.byml}}
<onlyinclude>
'''EventInfo.product.sbyml''' is a [[Yaz0]]-compressed [[BYML]] file that stores information about all game [[event]]s. It is used by the [[event manager]] to load events.
</onlyinclude>

EventInfo is a machine generated file. It is not meant to be edited directly; much of the information it includes are either automatically generated or copied from event flows and other source-only files.

The top level node is a map. Each entry corresponds to an event, with the key being <code>EventName<EntryPointName></code> and the value being the associated event properties. The list of properties in this article is known to be complete as of [[version]] 1.6.0.

==Common event flow properties==
{| class="wikitable sortable"
!Name!!Type!!Description
|-
|traverse_limit||float||[For scene change events only]
|-
|is_startable_air||bool||Whether the event can be started when the player is not "grounded for event" (essentially when he is in the air)
|-
|child||array||Event flows that are called by this event and must be loaded ahead-of-time.

This normally only includes [[Demo]] events, which are called using the CallDemo action. Sub-flows are not listed with <code>child</code> but with <code>subfile</code>.

{| class="wikitable sortable"
!Name!!Type!!Description
|-
|file||string||Event name (actually not a file name since this doesn't include the file extension)
|-
|entry||string||Entry point name
|}

|-
|is_timeline||bool||Whether the event is an event timeline (as opposed to an event flowchart) (defaults: false)
|-
|mode||string||Values: Seamless, FullPackage, Load, Async
|-
|next_event||string||
|-
|movie||string||Movile file name (e.g. Demo126_0.mp4)
|-
|always_movie||bool||Whether this event is always played as a movie (probably for development purposes)
|-
|not_found_movie||bool||
|-
|text_only_movie||bool||Is a text only movie (subset of movies)
|-
|exist_fade_in||bool||
|-
|exist_flag_control||bool||
|-
|auto_save||bool||
|-
|exist_gimmick_reset||bool||
|-
|exist_enable_camera_input||bool||
|-
|exist_disable_camera_input||bool||
|-
|is_pause_non_demo_member||bool||Whether the game freezes while the event plays or not - includes the control of Link. (''false'': no freeze; ''true'': freeze).

''false'' also eleminates the 1ms fading out and in of the UI for small custom events that e.g. play a sound.
|-
|is_hide_non_demo_member||bool||
|-
|is_hide_non_demo_member_charactor||bool||(sic)
|-
|fade_in_color||int||
|-
|fade_out_color||int||
|-
|exist_disable_unequip_in_event||bool||
|-
|exist_disable_unlift_in_event||bool||
|-
|exist_enable_squat_in_event||bool||
|-
|exist_disable_getoff_sunaz_in_event||bool||
|-
|disable_event_start_interval||bool||
|-
|demo_event||bool||
|-
|init_camera_pos||vec3||
|-
|init_camera_at||vec3||
|-
|init_camera_fov||float||
|-
|last_camera_pos||vec3||
|-
|last_camera_at||vec3||
|-
|last_player_pos||vec3||
|-
|last_player_dir||vec3||
|-
|last_camera_fov||float||
|-
|special_actor_name||string||
|-
|last_special_actor_pos||vec3||
|-
|last_special_actor_dir||vec3||
|-
|wait_frame||int||
|-
|vanish_motorcycle||bool||Whether the motorcycle (Master Cycle Zero) should despawn when starting the event
|-
|cloth_centererd_at_location||bool||(sic)
|-
|bgm||array||Background music (BGMs)
{| class="wikitable sortable"
!Name!!Type!!Description
|-
|name||string||BGM name
|}

|-
|bgm_stop||string||Values: StopWithFade, NotStop
|-
|no_pause_actors||string||[Only for flowcharts and timelines] List of actors that should not be paused during the event (separated by ,)
|}

==Movie properties==
The following properties are only used for movies (including text only movies):

{| class="wikitable sortable"
!Name!!Type!!Description
|-
|timeline_voice||array||
|-
|xlink_emits||array||
|-
|ui_texts||array||
|-
|fade_outs||array||
|-
|timeline_rumble||array||
|-
|}

==Event flow properties==
The properties in this section are only used for event flows (event timelines and flowcharts, ''not'' movies).

===XLink===
{| class="wikitable sortable"
!Name!!Type!!Description
|-
|elink_user||string||Name of the ELink instance to use. If specified, the game will load Effect/%s.esetlist % (elink_user).
|-
|slink_user||string||Name of the SLink instance to use. If specified, the game will load the [[sound resource]] with that name (from Sound/Resource/%s.bars % (slink_user)).
|-
|xlink_hidden||array||List of SLink objects to hide

{| class="wikitable sortable"
!Name!!Type!!Description
|-
|actor||string||Actor name
|-
|instance||string||XLink instance name{{check}}
|-
|is_effect||bool||
|-
|is_sound||bool||
|-
|key||string||XLink key
|}

|-
|}

===Demos===
An event is considered to be a [[demo]] if the entry point name starts with "Demo".

When loading demo events, EventResource automatically loads "Demo/%s.bdemo" % (entry_name), and a CameraSystem instance is constructed.

{| class="wikitable sortable"
!Name!!Type!!Description
|-
|exist_extra_model||bool||Whether a demo model exists. If true, "Model/%s.bfres" % (entry_name) is loaded.
|-
|}

====CameraSystem====
{| class="wikitable sortable"
!Name!!Type!!Description
|-
|camera||array||List of [[Camera]] files to load.

For each entry, CameraSystem loads "Camera/%s/%s" % (entry name, camera file name).

{| class="wikitable sortable"
!Name!!Type!!Description
|-
|file||string||File name (e.g. C01-0.bcamanim)
|-
|}

|-
|}

====DemoAS====
{| class="wikitable sortable"
!Name!!Type!!Description
|-
|as||array||List of [[AS]] resources to load.

For each entry, DemoASLoader loads "Actor/AS/%s/%s.bas" % (entry name, AS name).

{| class="wikitable sortable"
!Name!!Type!!Description
|-
|file||string||AS name (e.g. Demo117_0-C00-Npc_Rito_Teba-A-0)
|-
|}

|-
|}

===Terrain===
{| class="wikitable sortable"
!Name!!Type!!Description
|-
|terrain_info||array||Terrain information (array length is always 1)
{| class="wikitable sortable"
!Name!!Type!!Description
|-
|center||vec3||
|-
|level||int||
|-
|frame||int||
|}

|-
|}

===Flowchart properties===
The following properties are only used for event [[flowchart]]s:

{| class="wikitable sortable"
!Name!!Type!!Description
|-
|subfile||array||Other flowcharts that are referenced in this flowchart and that must be loaded
{| class="wikitable sortable"
!Name!!Type!!Description
|-
|file||string||Flowchart file name (e.g. Common.bfevfl)
|}

|-
|}

===Timeline properties===
The following properties are only used for event [[timeline]]s:

{| class="wikitable sortable"
!Name!!Type!!Description
|-
|sub_timelines||array||Sub-timelines (see [[BFEVFL]])
{| class="wikitable sortable"
!Name!!Type!!Description
|-
|name||string||Sub-timeline name (e.g. Demo130_0_effect)
|}

|-
|}

[[Category:Content (BotW)]]
[[Category:Content (BotW, product)]]

AutoPlacement event flows

2021-01-09T13:45:10Z

Waikuteru: /* CreateData */

{{stub}}
AutoPlacement event flows are used by the [[AutoPlacementMgr]] to determine whether actors should be dynamically spawned without having to hardcode special logic into the executable.

Such event flows are executed by the same event flow engine but with a different environment: only the "AutoPlacement" pseudo-actor is available for actions and queries. Actions and queries are not mapped to AI system functions as with regular event flows, but are entirely handled by the AutoPlacement code.

A single event flow can be used to handle conditions for several actors (for example, AutoPlacement_Animal handles auto placement logic for all animal actors) and may be called several times, each time with a different actor name, which the event flow can check with the [[#EcoAreaActorName]] query. An actor will only be dynamically spawned if CreateData (and NearCreate?{{check}}) is called.

==AutoPlacement actions==
===CreateData===
Allow the actor to spawn.
{| class="wikitable"
!Parameter!!Type!!Description
|-
|MinNum||int||The smallest amount that should be generated of this actor.
|-
|OffsetPosY||float
|
|-
|RideList||string
|
|-
|MaxNum||int||The biggest amount that should be generated of this actor.
|-
|GroupRadius||float
|Allows to configure the size of the auto-picked point where the actor(s) should spawn.
|-
|EquipWeaponActorCount||int
|
|-
|Mimicry||bool||
|}

===NearCreate===
===AppearWeatherRate===
===EquipCategory===

==AutoPlacement queries==
===GroundNorm===
===GroundMat===
Checks the terrain material type.

Returns:

*0: Soil
*1: Stone
*2: Rock
*3: Sand
*4: Metal
*5: Grass
*6: Ivy
*7: Wood
*8: Water
*9: Snow
*10: Ice
*11: Lava
*12: HeavySand
*13: Bog
*14: HeavySnow

===TreeRate===
Queries [[StatisticsMgr]] for the forest_density at the current position. Returns 1 if the specified rate is lower than or equal to the result, and 0 otherwise.

{| class="wikitable"
!Parameter!!Type!!Description
|-
|Rate||float||Rate
|}

===PosHeight===
===WaterDepth===
===RouteDistance===
Queries [[StatisticsMgr]] for the route distance at the current position. Returns 1 if the specified distance is lower than or equal to the query result, and 0 otherwise.

{| class="wikitable"
!Parameter!!Type!!Description
|-
|Distance||float||Distance to compare against route distance
|}

===GrassHeight===
Queries the [[Terrain]] system for the grass height at the current position. Returns 1 if the specified height is lower than or equal to the actual height, and 0 otherwise.

{| class="wikitable"
!Parameter!!Type!!Description
|-
|Height||float||Grass height
|}

===WaterSurface===
===PlayerRideHorse===
Returns 1 if the player is riding a horse, and 0 otherwise.

===EcoAreaActorName===
Returns 1 if the specified actor name matches the name of the actor for which the event flow is being executed.

{| class="wikitable"
!Parameter!!Type!!Description
|-
|ActorName||str||Actor name
|}

===WaterSubMat===
Returns the water sub-material type at the current position:

*0: Water
*1: Water_Ice
*2: Water_Hot
*3: Water_Poison

===CheckGameData===
Returns 1 if the specified boolean flag is true, and 0 otherwise.

Returns -1 if the GameDataMgr instance does not exist or if the Label parameter was not specified.

{| class="wikitable"
!Parameter!!Type!!Description
|-
|Label||str||GameData boolean flag name
|}

===CheckPouchItemCount===
===CheckPouchItemCountFromActor===
===TimeType===
Returns the [[WorldMgr]]'s current time division. Analogous to [[AIDef:Query/CheckTimeType]].

===RailDistance===
??? Involves [[PlacementMgr]].

===WaterDistance===
Queries [[StatisticsMgr]] for the water distance at the current position. Returns 1 if the specified distance is lower than or equal to the result multiplied by 200.0, and 0 otherwise.

{| class="wikitable"
!Parameter!!Type!!Description
|-
|Distance||float||Distance to compare against water distance
|}

===NavMeshFace===

[[Category:Internals]]