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

Bas

2023-02-22T21:38:38Z

CEObrainz: /* BitIndex */

{{Lowercase}}
<onlyinclude>
'''bas''' files each represent an animation that can be called by an [[actor]] or [[Demo|cutscene]]. They contain a reference to an animation name, but not the animation file itself. They can be found at '''Actor/AS/{EventName}/{AnimationSequenceName}.bas''' in [[Beventpack|beventpacks]] and [[TitleBG.pack]]/Actor/AS, and '''Actor/AS/{AnimationSequenceName}.bas''' in bactorpacks.
</onlyinclude>

==Layout==
Each bas file is made up of one list of elements, named Elements. Each element (Element0, Element1, etc) can be either a test to figure out what animation to play, or a call to play the animation.

===Parameters===
All nodes have Parameters, which determine what kind of node they are. They can be a control node, which helps decide which animation to play, or an animation node, which actually plays the animation.
{| class="wikitable"
!Key
!Key Type
!Description
!Node Type
!Default value
|-
|TypeIndex
|int
|Type of node the Element is. Known types are listed below the table.
| -
| -
|-
|NoSync
|bool
| -
|Control
| -
|-
|JudgeOnce
|bool
|Tells the game to skip evaluating this node (and use the previous result) if the input value has not changed since the last time the node was run.
|Control
|False
|-
|InputLimit
|float
| -
|Control
| -
|-
|FileName
|str64
|Name of the animation to play
|Animation
| -
|-
|Morph
|int
|Time to blend the previous animation into this one. Appears to be measured in frames.
|Animation
| -
|-
|SequenceLoop
|bool
|Determines whether a sequence (Used with TypeIndex 61) is set to repeat
|Control
| -
|-
|}

====Parameter TypeIndex====
Nodes with Blender are generally used to perform the same checks as those with Selector in the name, with a key difference: Blender nodes may evaluate multiple cases as true, and will blend the resulting animations together. Selector nodes will choose only the first case that evaluates to true.{{Check}}
{| class="wikitable"
!Index
!Name <ref>TypeIndex function table in the 1.5.0 [[executable]]</ref>
!Description
!Type
|-
|0
|AbsTemperatureBlender
|Current world temperature. Evaluated by float range.
|Control
|-
|1
|AbsTemperatureSelector
|Current world temperature. Evaluated by float range.
|Control
|-
|2
|ArmorSelector
|What armor is currently equipped. Used only in '''Player_Wait.bas'''. Only observed working values are <code>NoUpper</code>, <code>NoLower</code>, <code>NoAll</code>.{{#tag:ref|Element32 of Player_Wait.bas, WiiU 1.5.0|name=e32pw}} Does not appear to accept armor actor names.
|Control
|-
|3
|ArrowSelector
|Seems to check what arrow Link has equipped. However, the game only ever uses a '''StringArray''' of '''Empty''' and a default case. This is used to check whether Link has arrows in his bow, to determine how to blend his animations or to play different ones.
|Control
|-
|4
|AttentionSelector
| -
|Control
|-
|5
|BoneBlender
| -
|Control
|-
|6
|BoneVisibilityAsset
| -
| -
|-
|7
|BoolSelector
|Boolean evaluator - See [[#BitIndex]]{{#tag:ref|Element1 of Player_CutNinja.bas, WiiU 1.5.0|name=e1pcn}}{{#tag:ref|Element0 of Player_FaceDefault.bas, WiiU 1.5.0|name=e0pfd}}{{#tag:ref|Element2 of Player_FaceDefault.bas, WiiU 1.5.0|name=e2pfd}} If false, the element specified by Child0 is evaluated. If true, Child1 is evaluated.
|Control
|-
|8
|ButtonSelector
| -
|Control
|-
|9
|ChargeSelector
| -
|Control
|-
|10
|ClearMatAnmAsset
| -
| -
|-
|11
|ComboSelector
| -
|Control
|-
|12
|DiffAngleYBlender
| -
|Control
|-
|13
|DiffAngleYSelector
| -
|Control
|-
|14
|DirectionAngleBlender
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|15
|DirectionAngleSelector
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|16
|DistanceBlender
|Compares distance between Link and his current locked target{{#tag:ref|Element2 of Player_CutNinja.bas, WiiU 1.5.0|name=e2pcn}}. Evaluated by float range.
|Control
|-
|17
|DistanceSelector
|Compares distance between Link and his current locked target. Evaluated by float range.
|Control
|-
|18
|DungeonClearSelector
| -
|Control
|-
|19
|DungeonNumberSelector
| -
|Control
|-
|20
|EmotionSelector
| -
|Control
|-
|21
|EventFlagSelector
|Checks whether a GameData flag is true. The StringArray defines the flags to be checked. Known to accept 1 child plus a default case, but in a single instance there's no default case.<ref>Npc_Rito_Hearts_BandVisibilityOff.bas</ref> In another instance, both strings are flags. <ref>UR_M_Teba_Teba_DamageVisibility_On.bas</ref> If both are true, the first case evaluated as true will be run.
|Control
|-
|22
|EyeSelector
| -
|Control
|-
|23
|EyebrowSelector
| -
|Control
|-
|24
|FaceEmotionSelector
| -
|Control
|-
|25
|FootBLLifeSelector
| -
|Control
|-
|26
|FootBRLifeSelector
| -
|Control
|-
|27
|FootFLLifeSelector
| -
|Control
|-
|28
|FootFRLifeSelector
| -
|Control
|-
|29
|ForwardBentBlender
| -
|Control
|-
|30
|ForwardBentSelector
| -
|Control
|-
|31
|GearSelector
| -
|Control
|-
|32
|GenerationSelector
|Int check - Unknown<ref>Element7 of UH_C_Face_Talk.bas and Element3 of UH_C_Face_Default.bas</ref> In both referenced cases (used in NPC actorpacks), Value0 is '''2''', and Value1 is '''-2147483648''', which is the negative 32-bit integer limit.
|Control
|-
|33
|GrabTypeSelector
|Compares the [[Bgparamlist#Liftable|LiftType]] of the actor that is being grabbed/lifted (from its bgparamlist). Known to accept as many as 24 children and a default case.
|Control
|-
|34
|GroundNormalBlender
| -
|Control
|-
|35
|GroundNormalSelector
| -
|Control
|-
|36
|GroundNormalSideBlender
| -
|Control
|-
|37
|GroundNormalSideSelector
| -
|Control
|-
|38
|MaskSelector
|Checks the MaskType parameter of the currently equipped Head armor. Its children reference other elements to jump to if a matching MaskType is found, and a StringArray in its Extend determine the MaskType(s) to check for.
|Control
|-
|39
|MatVisibilityAsset
| -
| -
|-
|40
|MouthSelector
| -
|Control
|-
|41
|NoAnmAsset
|Play no animation. Used to cancel evaluation.
|Animation
|-
|42
|NoLoopStickAngleBlender
| -
|Control
|-
|43
|NoLoopStickAngleSelector
| -
|Control
|-
|44
|NodePosSelector
|Compares name of a bone, takes StrRef of the bone name. Unknown how it decides which bone name to compare the StrRef to.{{#tag:ref|Element0 of Player_LadderJump.bas, WiiU 1.5.0|name=e0plj}} Can be paired with an axis name (e.g. <code>Toe_L,Z</code>) to measure value on that axis. When used in this way, the node chooses the child corresponding to the highest value among those measured.{{#tag:ref|Element8 of UZ_M_Move_End.bas, WiiU 1.5.0|name=e8uzmme}} When no axis name is given, the vector to the origin is measured. {{Check}}
|Control
|-
|45
|PersonalitySelector
| -
|Control
|-
|46
|PostureSelector
| -
|Control
|-
|47
|PreASSelector
|Compares last played animation name, takes StrRef of animation name. Accepts up to 5 children.{{#tag:ref|Element11 of Player_CutChargeWait.bas, WiiU 1.5.0|name=e11pccw}}
|Control
|-
|48
|PreExclusionRandomSelector
| -
|Control
|-
|49
|RandomSelector
|Picks a random node from the given nodes.{{Check}}
|Control
|-
|50
|RideSelector
|Compares the profile of the mount the actor is currently riding. Known to accept one Child, plus a default case, but might accept more or less.{{Check}}
|Control
|-
|51
|RightStickAngleBlender
| -
|Control
|-
|52
|RightStickAngleSelector
| -
|Control
|-
|53
|RightStickValueBlender
| -
|Control
|-
|54
|RightStickValueSelector
| -
|Control
|-
|55
|RightStickXBlender
| -
|Control
|-
|56
|RightStickXSelector
| -
|Control
|-
|57
|RightStickYBlender
| -
|Control
|-
|58
|RightStickYSelector
| -
|Control
|-
|59
|SelfHeightSelector
| -
|Control
|-
|60
|SelfWeightSelector
| -
|Control
|-
|61
|SequencePlayContainer
|Float comparison - Unknown{{#tag:ref|Element0 of Player_Move.bas, WiiU 1.5.0|name=e0pm}}
|Control
|-
|62
|ShaderParamAsset
|Plays material animation, takes StrRef of the animation name. Its Extend uses a secondary animation name for unknown purpose.{{#tag:ref|Element1 of Player_SkinColor.bas, WiiU 1.5.0|name=e1psc}}{{#tag:ref|Element2 of Player_SkinColor.bas, WiiU 1.5.0|name=e2psc}}
|Animation
|-
|63
|ShaderParamColorAsset
| -
| -
|-
|64
|ShaderParamTexSRTAsset
|Plays texture transform animation, takes StrRef of the animation name.
|Animation
|-
|65
|SizeBlender
| -
|Control
|-
|66
|SizeSelector
| -
|Control
|-
|67
|SkeltalAsset
|Plays model animation, takes StrRef of the animation name.
|Animation
|-
|68
|SpeedBlender
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|69
|SpeedSelector
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|70
|StickAngleBlender
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|71
|StickAngleSelector
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|72
|StickValueBlender
|Range evaluation - Unknown{{#tag:ref|Element0 of Player_SwimAtnMove.bas, WiiU 1.5.0|name=e0psam}}
|Control
|-
|73
|StickValueSelector
| -
|Control
|-
|74
|StickXBlender
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|75
|StickXSelector
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|76
|StickYBlender
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|77
|StickYSelector
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|78
|StressBlender
| -
|Control
|-
|79
|StressSelector
| -
|Control
|-
|80
|SyncPlayContainer
|Synchronously plays multiple child elements
|Animation
|-
|81
|TemperatureBlender
| -
|Control
|-
|82
|TemperatureSelector
|Range evaluation - Unknown{{#tag:ref|Element1 of Player_FaceDefault.bas, WiiU 1.5.0|name=e1pfd}}
|Control
|-
|83
|TexturePatternAsset
| -
| -
|-
|84
|TimeSelector
|Checks the current time. Observed values are '''Morning_A''', '''Morning_B''', '''Evening_B''', '''Night_A''', and '''Night_B'''. '''Evening_A''' is never used, but is assumed to exist. Known to accept any number of children along with a default case.
|Control
|-
|85
|TiredBlender
| -
|Control
|-
|86
|TiredSelector
| -
|Control
|-
|87
|UseItemSelector
| -
|Control
|-
|88
|UserAngle2Blender
| -
|Control
|-
|89
|UserAngle2Selector
| -
|Control
|-
|90
|UserAngleBlender
| -
|Control
|-
|91
|UserAngleSelector
| -
|Control
|-
|92
|UserSpeedBlender
| -
|Control
|-
|93
|UserSpeedSelector
| -
|Control
|-
|94
|VariationSelector
| -
|Control
|-
|95
|WallAngleBlender
| -
|Control
|-
|96
|WallAngleSelector
| -
|Control
|-
|97
|WeaponDetailSelector
|Compares actor's equipped weapon subtype (from its bgparamlist [ProfileUser] WeaponSubtype value), takes StrRef of weapon subtype name
|Control
|-
|98
|WeaponSelector
|Compares actor's equipped weapon profile (from its bxml ProfileUser value), takes StrRef of weapon profile name
|Control
|-
|99
|WeatherSelector
| -
|Control
|-
|100
|WeightBlender
| -
|Control
|-
|101
|WeightSelector
| -
|Control
|-
|102
|WindVelocityBlender
| -
|Control
|-
|103
|YSpeedBlender
| -
|Control
|-
|104
|YSpeedSelector
| -
|Control
|-
|105
|ZEx00ExposureBlender
| -
|Control
|-
|106
|ZEx00ExposureSelector
| -
|Control
|-
|}

===Children===
Control nodes will have Children, in addition to Parameters, which determine which Element to go to after the control node is evaluated. The properties of Children will be named Child0, Child1, etc, and each will have a single integer value, which will correspond to the Element number. e.g. <code>Child0: 7</code> points to Element7.

===Extend===
All nodes have an Extend, which contains specific details about the node. Control node Extends will contain details about the comparison being performed, while animation nodes will contain information about the animation being played, such as: during which frames of the animation a weapon will deal damage if it hits something, when user input is ignored, when to draw weapon trails through the air for attack animations, etc.

====Typed Array====
A list of variables of a given type to use for various control comparisons. Corresponds directly to the Children of the node. i.e. if Value0 matches the value being compared against, the code will jump to the Element listed under Child0. If no comparison of a lower Child number has evaluated as true, automatically evaluates a Child whose value is "default" as true.{{#tag:ref|Element0 of Player_CutNinja.bas, WiiU 1.5.0|name=e0pcn}}{{#tag:ref|Element3 of Player_FaceDefault.bas, WiiU 1.5.0|name=e3pfd}}

====BitIndex====
Used with BoolSelector Parameters. Also has TypeIndex, which are used to perform the check.

*2 - Unknown (believed to check if Link has any armor equipped)<ref name="e0pfd" />
*5 - Unknown (believed to check if Link is carrying an object)
*15 - Unknown. Appears in Player_WeaponEquipOn after an Attention Selector and a BitIndex 30 check, implying that it has something to do with shields.
*17 - Unknown (believed to check whether Link is airborne)
*30 - Whether or not Link has a shield equipped. (First Child is False, Second Child is True)<ref name="e1pcn" />
*33 - Unknown (believed to check if Link is tired)<ref name="e2pfd" />
*36 - Unknown (believed to check if Link is locked onto a target)
*37 - Whether IsBlunt is set to true in the equipped weapon’s bgparamlist
*38 - Unknown (believed to check if the current weapon is on fire). (First Child is False, Second Child is True)
*46 - Unknown (believed to check if Link is crouched)

====Ranges====
Used with control nodes that perform a Range evaluation. If the value being compared is above the Start value and below the End value, evaluates as true. Otherwise, moves on to the next value. (Unknown what happens if none of the Ranges evaluate to true, presumably game crash)

====FrameCtrl====
Used with animation nodes. The node itself is required, even if it is empty (i.e. none of the keys are specified)
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|Rate
|float
|Speed at which to play the animation. Higher numbers are faster.
|1.0
|-
|StartFrame
|int
| -
| -
|-
|EndFrame
|int
| -
| -
|-
|LoopStopCount
|int
| -
| -
|-
|LoopStopCountRandom
|int
| -
| -
|-
|UseGlobalFrame
|bool
| -
|false
|-
|ReversePlay
|bool
| -
|false
|-
|Connect
|int
|The only observed values are 1, 2, and 3.
| -
|-
|AnmLoop
|int
|The only observed values are 1 and 2. <ref>Elements 10 and 11 of AncientDoctor_C_Face_Default.bas</ref>
| -
|-
|}

====TriggerEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. Events which are triggered during this animation.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|Frame
|int
|Which frame to fire the event on, relative to the frame numbers of the animation. Can be negative.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Used to play sound effects during animations. Known to accept any attack or enemy attack sound effect, but probably works with other sound files.<ref>Compare Event0 of TriggerEvents and Event0 of HoldEvents for most of Link's attack animations</ref>
*4 - Triggers the animation controller to transition back into the idle stance. The Frame value should be a few before the end of the actual animation, so that the controller can make the blending look natural.<ref>Compare TriggerEvent TypeIndex 4 Frame value for an animation with the number of frames in the actual animation.</ref>
*7 - Call AS. Passes the strRef to the ASList to retrieve an AS file and starts evaluating it from Element0.
*14 - Seems to indicate an enemy has entered a state of being airborne.
*28 - Play audio. Able to play any bfwav file in PlayerVoice.bars.
*29 - Seems to determine when a weapon will bind to a bone. <ref>Player_WeaponEquipOn.bas</ref>

====HoldEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. States that are entered into while the animation is playing.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|StartFrame
|int
|Which frame to start the event on, relative to the frame numbers of the animation. Unknown if it can be negative.
| -
|-
|EndFrame
|int
|Which frame to end the event on, relative to the frame numbers of the animation. A value of -1 is treated as the ending frame of the animation.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Seems to allow Link's attack animations to combo into one another. New attack elements will not combo together if there is no TypeIndex 0 present in the Hold Events.
*2 - Seems to determine when some attacks (entries in Player_CutJumpSt and others) will connect with targets. Removing TypeIndex 2 causes animations to play halfway through. TypeIndex 2 also tends to have a StartFrame somewhere near the middle of the animation, and an end frame of -1.0, indicating that it may be responsible for blending certain attack animations into one another, particularly those that loop or combine.
*3 - Defines when an attack will deal damage. Value is the damage type. Left: slashing. Stab: piercing. Lower: blunt. {{Check}}
*14 - Defines when an animation will block attack damage using Link's equipped shield.
*17 - Unknown
*22 - Unknown. Found in Link's Player_CutShieldRide.bas animation, and seems to correspond to the air effects under the board, but can't be applied to other attack animations.
*25 - Unknown. Appears to have something to do with Bone Control, as it is often observed with the !str32 Value "OnlyEye".
*35 - Unknown
*45 - Defines when to accept input to start the next attack.
*48 - Defines when to display the trails in the air during an attack.
*49 - Believed to define the animation frames during which an actor is resistant to knock back. Notably used during animations where the actor leaves the ground and in most cases, active during frames when actor is airborne.

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

Bas

2023-02-22T21:04:25Z

CEObrainz: /* Ranges */ Added BitIndex 36

{{Lowercase}}
<onlyinclude>
'''bas''' files each represent an animation that can be called by an [[actor]] or [[Demo|cutscene]]. They contain a reference to an animation name, but not the animation file itself. They can be found at '''Actor/AS/{EventName}/{AnimationSequenceName}.bas''' in [[Beventpack|beventpacks]] and [[TitleBG.pack]]/Actor/AS, and '''Actor/AS/{AnimationSequenceName}.bas''' in bactorpacks.
</onlyinclude>

==Layout==
Each bas file is made up of one list of elements, named Elements. Each element (Element0, Element1, etc) can be either a test to figure out what animation to play, or a call to play the animation.

===Parameters===
All nodes have Parameters, which determine what kind of node they are. They can be a control node, which helps decide which animation to play, or an animation node, which actually plays the animation.
{| class="wikitable"
!Key
!Key Type
!Description
!Node Type
!Default value
|-
|TypeIndex
|int
|Type of node the Element is. Known types are listed below the table.
| -
| -
|-
|NoSync
|bool
| -
|Control
| -
|-
|JudgeOnce
|bool
|Tells the game to skip evaluating this node (and use the previous result) if the input value has not changed since the last time the node was run.
|Control
|False
|-
|InputLimit
|float
| -
|Control
| -
|-
|FileName
|str64
|Name of the animation to play
|Animation
| -
|-
|Morph
|int
|Time to blend the previous animation into this one. Appears to be measured in frames.
|Animation
| -
|-
|SequenceLoop
|bool
|Determines whether a sequence (Used with TypeIndex 61) is set to repeat
|Control
| -
|-
|}

====Parameter TypeIndex====
Nodes with Blender are generally used to perform the same checks as those with Selector in the name, with a key difference: Blender nodes may evaluate multiple cases as true, and will blend the resulting animations together. Selector nodes will choose only the first case that evaluates to true.{{Check}}
{| class="wikitable"
!Index
!Name <ref>TypeIndex function table in the 1.5.0 [[executable]]</ref>
!Description
!Type
|-
|0
|AbsTemperatureBlender
|Current world temperature. Evaluated by float range.
|Control
|-
|1
|AbsTemperatureSelector
|Current world temperature. Evaluated by float range.
|Control
|-
|2
|ArmorSelector
|What armor is currently equipped. Used only in '''Player_Wait.bas'''. Only observed working values are <code>NoUpper</code>, <code>NoLower</code>, <code>NoAll</code>.{{#tag:ref|Element32 of Player_Wait.bas, WiiU 1.5.0|name=e32pw}} Does not appear to accept armor actor names.
|Control
|-
|3
|ArrowSelector
|Seems to check what arrow Link has equipped. However, the game only ever uses a '''StringArray''' of '''Empty''' and a default case. This is used to check whether Link has arrows in his bow, to determine how to blend his animations or to play different ones.
|Control
|-
|4
|AttentionSelector
| -
|Control
|-
|5
|BoneBlender
| -
|Control
|-
|6
|BoneVisibilityAsset
| -
| -
|-
|7
|BoolSelector
|Boolean evaluator - See [[#BitIndex]]{{#tag:ref|Element1 of Player_CutNinja.bas, WiiU 1.5.0|name=e1pcn}}{{#tag:ref|Element0 of Player_FaceDefault.bas, WiiU 1.5.0|name=e0pfd}}{{#tag:ref|Element2 of Player_FaceDefault.bas, WiiU 1.5.0|name=e2pfd}} If false, the element specified by Child0 is evaluated. If true, Child1 is evaluated.
|Control
|-
|8
|ButtonSelector
| -
|Control
|-
|9
|ChargeSelector
| -
|Control
|-
|10
|ClearMatAnmAsset
| -
| -
|-
|11
|ComboSelector
| -
|Control
|-
|12
|DiffAngleYBlender
| -
|Control
|-
|13
|DiffAngleYSelector
| -
|Control
|-
|14
|DirectionAngleBlender
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|15
|DirectionAngleSelector
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|16
|DistanceBlender
|Compares distance between Link and his current locked target{{#tag:ref|Element2 of Player_CutNinja.bas, WiiU 1.5.0|name=e2pcn}}. Evaluated by float range.
|Control
|-
|17
|DistanceSelector
|Compares distance between Link and his current locked target. Evaluated by float range.
|Control
|-
|18
|DungeonClearSelector
| -
|Control
|-
|19
|DungeonNumberSelector
| -
|Control
|-
|20
|EmotionSelector
| -
|Control
|-
|21
|EventFlagSelector
|Checks whether a GameData flag is true. The StringArray defines the flags to be checked. Known to accept 1 child plus a default case, but in a single instance there's no default case.<ref>Npc_Rito_Hearts_BandVisibilityOff.bas</ref> In another instance, both strings are flags. <ref>UR_M_Teba_Teba_DamageVisibility_On.bas</ref> If both are true, the first case evaluated as true will be run.
|Control
|-
|22
|EyeSelector
| -
|Control
|-
|23
|EyebrowSelector
| -
|Control
|-
|24
|FaceEmotionSelector
| -
|Control
|-
|25
|FootBLLifeSelector
| -
|Control
|-
|26
|FootBRLifeSelector
| -
|Control
|-
|27
|FootFLLifeSelector
| -
|Control
|-
|28
|FootFRLifeSelector
| -
|Control
|-
|29
|ForwardBentBlender
| -
|Control
|-
|30
|ForwardBentSelector
| -
|Control
|-
|31
|GearSelector
| -
|Control
|-
|32
|GenerationSelector
|Int check - Unknown<ref>Element7 of UH_C_Face_Talk.bas and Element3 of UH_C_Face_Default.bas</ref> In both referenced cases (used in NPC actorpacks), Value0 is '''2''', and Value1 is '''-2147483648''', which is the negative 32-bit integer limit.
|Control
|-
|33
|GrabTypeSelector
|Compares the [[Bgparamlist#Liftable|LiftType]] of the actor that is being grabbed/lifted (from its bgparamlist). Known to accept as many as 24 children and a default case.
|Control
|-
|34
|GroundNormalBlender
| -
|Control
|-
|35
|GroundNormalSelector
| -
|Control
|-
|36
|GroundNormalSideBlender
| -
|Control
|-
|37
|GroundNormalSideSelector
| -
|Control
|-
|38
|MaskSelector
|Checks the MaskType parameter of the currently equipped Head armor. Its children reference other elements to jump to if a matching MaskType is found, and a StringArray in its Extend determine the MaskType(s) to check for.
|Control
|-
|39
|MatVisibilityAsset
| -
| -
|-
|40
|MouthSelector
| -
|Control
|-
|41
|NoAnmAsset
|Play no animation. Used to cancel evaluation.
|Animation
|-
|42
|NoLoopStickAngleBlender
| -
|Control
|-
|43
|NoLoopStickAngleSelector
| -
|Control
|-
|44
|NodePosSelector
|Compares name of a bone, takes StrRef of the bone name. Unknown how it decides which bone name to compare the StrRef to.{{#tag:ref|Element0 of Player_LadderJump.bas, WiiU 1.5.0|name=e0plj}} Can be paired with an axis name (e.g. <code>Toe_L,Z</code>) to measure value on that axis. When used in this way, the node chooses the child corresponding to the highest value among those measured.{{#tag:ref|Element8 of UZ_M_Move_End.bas, WiiU 1.5.0|name=e8uzmme}} When no axis name is given, the vector to the origin is measured. {{Check}}
|Control
|-
|45
|PersonalitySelector
| -
|Control
|-
|46
|PostureSelector
| -
|Control
|-
|47
|PreASSelector
|Compares last played animation name, takes StrRef of animation name. Accepts up to 5 children.{{#tag:ref|Element11 of Player_CutChargeWait.bas, WiiU 1.5.0|name=e11pccw}}
|Control
|-
|48
|PreExclusionRandomSelector
| -
|Control
|-
|49
|RandomSelector
|Picks a random node from the given nodes.{{Check}}
|Control
|-
|50
|RideSelector
|Compares the profile of the mount the actor is currently riding. Known to accept one Child, plus a default case, but might accept more or less.{{Check}}
|Control
|-
|51
|RightStickAngleBlender
| -
|Control
|-
|52
|RightStickAngleSelector
| -
|Control
|-
|53
|RightStickValueBlender
| -
|Control
|-
|54
|RightStickValueSelector
| -
|Control
|-
|55
|RightStickXBlender
| -
|Control
|-
|56
|RightStickXSelector
| -
|Control
|-
|57
|RightStickYBlender
| -
|Control
|-
|58
|RightStickYSelector
| -
|Control
|-
|59
|SelfHeightSelector
| -
|Control
|-
|60
|SelfWeightSelector
| -
|Control
|-
|61
|SequencePlayContainer
|Float comparison - Unknown{{#tag:ref|Element0 of Player_Move.bas, WiiU 1.5.0|name=e0pm}}
|Control
|-
|62
|ShaderParamAsset
|Plays material animation, takes StrRef of the animation name. Its Extend uses a secondary animation name for unknown purpose.{{#tag:ref|Element1 of Player_SkinColor.bas, WiiU 1.5.0|name=e1psc}}{{#tag:ref|Element2 of Player_SkinColor.bas, WiiU 1.5.0|name=e2psc}}
|Animation
|-
|63
|ShaderParamColorAsset
| -
| -
|-
|64
|ShaderParamTexSRTAsset
|Plays texture transform animation, takes StrRef of the animation name.
|Animation
|-
|65
|SizeBlender
| -
|Control
|-
|66
|SizeSelector
| -
|Control
|-
|67
|SkeltalAsset
|Plays model animation, takes StrRef of the animation name.
|Animation
|-
|68
|SpeedBlender
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|69
|SpeedSelector
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|70
|StickAngleBlender
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|71
|StickAngleSelector
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|72
|StickValueBlender
|Range evaluation - Unknown{{#tag:ref|Element0 of Player_SwimAtnMove.bas, WiiU 1.5.0|name=e0psam}}
|Control
|-
|73
|StickValueSelector
| -
|Control
|-
|74
|StickXBlender
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|75
|StickXSelector
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|76
|StickYBlender
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|77
|StickYSelector
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|78
|StressBlender
| -
|Control
|-
|79
|StressSelector
| -
|Control
|-
|80
|SyncPlayContainer
|Synchronously plays multiple child elements
|Animation
|-
|81
|TemperatureBlender
| -
|Control
|-
|82
|TemperatureSelector
|Range evaluation - Unknown{{#tag:ref|Element1 of Player_FaceDefault.bas, WiiU 1.5.0|name=e1pfd}}
|Control
|-
|83
|TexturePatternAsset
| -
| -
|-
|84
|TimeSelector
|Checks the current time. Observed values are '''Morning_A''', '''Morning_B''', '''Evening_B''', '''Night_A''', and '''Night_B'''. '''Evening_A''' is never used, but is assumed to exist. Known to accept any number of children along with a default case.
|Control
|-
|85
|TiredBlender
| -
|Control
|-
|86
|TiredSelector
| -
|Control
|-
|87
|UseItemSelector
| -
|Control
|-
|88
|UserAngle2Blender
| -
|Control
|-
|89
|UserAngle2Selector
| -
|Control
|-
|90
|UserAngleBlender
| -
|Control
|-
|91
|UserAngleSelector
| -
|Control
|-
|92
|UserSpeedBlender
| -
|Control
|-
|93
|UserSpeedSelector
| -
|Control
|-
|94
|VariationSelector
| -
|Control
|-
|95
|WallAngleBlender
| -
|Control
|-
|96
|WallAngleSelector
| -
|Control
|-
|97
|WeaponDetailSelector
|Compares actor's equipped weapon subtype (from its bgparamlist [ProfileUser] WeaponSubtype value), takes StrRef of weapon subtype name
|Control
|-
|98
|WeaponSelector
|Compares actor's equipped weapon profile (from its bxml ProfileUser value), takes StrRef of weapon profile name
|Control
|-
|99
|WeatherSelector
| -
|Control
|-
|100
|WeightBlender
| -
|Control
|-
|101
|WeightSelector
| -
|Control
|-
|102
|WindVelocityBlender
| -
|Control
|-
|103
|YSpeedBlender
| -
|Control
|-
|104
|YSpeedSelector
| -
|Control
|-
|105
|ZEx00ExposureBlender
| -
|Control
|-
|106
|ZEx00ExposureSelector
| -
|Control
|-
|}

===Children===
Control nodes will have Children, in addition to Parameters, which determine which Element to go to after the control node is evaluated. The properties of Children will be named Child0, Child1, etc, and each will have a single integer value, which will correspond to the Element number. e.g. <code>Child0: 7</code> points to Element7.

===Extend===
All nodes have an Extend, which contains specific details about the node. Control node Extends will contain details about the comparison being performed, while animation nodes will contain information about the animation being played, such as: during which frames of the animation a weapon will deal damage if it hits something, when user input is ignored, when to draw weapon trails through the air for attack animations, etc.

====Typed Array====
A list of variables of a given type to use for various control comparisons. Corresponds directly to the Children of the node. i.e. if Value0 matches the value being compared against, the code will jump to the Element listed under Child0. If no comparison of a lower Child number has evaluated as true, automatically evaluates a Child whose value is "default" as true.{{#tag:ref|Element0 of Player_CutNinja.bas, WiiU 1.5.0|name=e0pcn}}{{#tag:ref|Element3 of Player_FaceDefault.bas, WiiU 1.5.0|name=e3pfd}}

====BitIndex====
Used with BoolSelector Parameters. Also has TypeIndex, which are used to perform the check.

*2 - Unknown (believed to check if Link has any armor equipped)<ref name="e0pfd" />
*5 - Unknown (believed to check if Link is carrying an object)
*15 - Unknown. Appears in Player_WeaponEquipOn after an Attention Selector and a BitIndex 30 check, implying that it has something to do with shields.
*17 - Unknown (believed to check whether Link is airborne)
*30 - Whether or not Link has a shield equipped. (First Child is False, Second Child is True)<ref name="e1pcn" />
*33 - Unknown (believed to check if Link is tired)<ref name="e2pfd" />
*36 - Unknown (believed to check if Link is locked onto a target)
*37 - Whether IsBlunt is set to true in the equipped weapon’s bgparamlist
*38 - Unknown (believed to check if the current weapon is on fire)
*46 - Unknown (believed to check if Link is crouched)

====Ranges====
Used with control nodes that perform a Range evaluation. If the value being compared is above the Start value and below the End value, evaluates as true. Otherwise, moves on to the next value. (Unknown what happens if none of the Ranges evaluate to true, presumably game crash)

====FrameCtrl====
Used with animation nodes. The node itself is required, even if it is empty (i.e. none of the keys are specified)
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|Rate
|float
|Speed at which to play the animation. Higher numbers are faster.
|1.0
|-
|StartFrame
|int
| -
| -
|-
|EndFrame
|int
| -
| -
|-
|LoopStopCount
|int
| -
| -
|-
|LoopStopCountRandom
|int
| -
| -
|-
|UseGlobalFrame
|bool
| -
|false
|-
|ReversePlay
|bool
| -
|false
|-
|Connect
|int
|The only observed values are 1, 2, and 3.
| -
|-
|AnmLoop
|int
|The only observed values are 1 and 2. <ref>Elements 10 and 11 of AncientDoctor_C_Face_Default.bas</ref>
| -
|-
|}

====TriggerEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. Events which are triggered during this animation.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|Frame
|int
|Which frame to fire the event on, relative to the frame numbers of the animation. Can be negative.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Used to play sound effects during animations. Known to accept any attack or enemy attack sound effect, but probably works with other sound files.<ref>Compare Event0 of TriggerEvents and Event0 of HoldEvents for most of Link's attack animations</ref>
*4 - Triggers the animation controller to transition back into the idle stance. The Frame value should be a few before the end of the actual animation, so that the controller can make the blending look natural.<ref>Compare TriggerEvent TypeIndex 4 Frame value for an animation with the number of frames in the actual animation.</ref>
*7 - Call AS. Passes the strRef to the ASList to retrieve an AS file and starts evaluating it from Element0.
*14 - Seems to indicate an enemy has entered a state of being airborne.
*28 - Play audio. Able to play any bfwav file in PlayerVoice.bars.
*29 - Seems to determine when a weapon will bind to a bone. <ref>Player_WeaponEquipOn.bas</ref>

====HoldEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. States that are entered into while the animation is playing.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|StartFrame
|int
|Which frame to start the event on, relative to the frame numbers of the animation. Unknown if it can be negative.
| -
|-
|EndFrame
|int
|Which frame to end the event on, relative to the frame numbers of the animation. A value of -1 is treated as the ending frame of the animation.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Seems to allow Link's attack animations to combo into one another. New attack elements will not combo together if there is no TypeIndex 0 present in the Hold Events.
*2 - Seems to determine when some attacks (entries in Player_CutJumpSt and others) will connect with targets. Removing TypeIndex 2 causes animations to play halfway through. TypeIndex 2 also tends to have a StartFrame somewhere near the middle of the animation, and an end frame of -1.0, indicating that it may be responsible for blending certain attack animations into one another, particularly those that loop or combine.
*3 - Defines when an attack will deal damage. Value is the damage type. Left: slashing. Stab: piercing. Lower: blunt. {{Check}}
*14 - Defines when an animation will block attack damage using Link's equipped shield.
*17 - Unknown
*22 - Unknown. Found in Link's Player_CutShieldRide.bas animation, and seems to correspond to the air effects under the board, but can't be applied to other attack animations.
*25 - Unknown. Appears to have something to do with Bone Control, as it is often observed with the !str32 Value "OnlyEye".
*35 - Unknown
*45 - Defines when to accept input to start the next attack.
*48 - Defines when to display the trails in the air during an attack.
*49 - Believed to define the animation frames during which an actor is resistant to knock back. Notably used during animations where the actor leaves the ground and in most cases, active during frames when actor is airborne.

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

Bas

2023-02-11T21:42:37Z

CEObrainz: /* BitIndex */

{{Lowercase}}
<onlyinclude>
'''bas''' files each represent an animation that can be called by an [[actor]] or [[Demo|cutscene]]. They contain a reference to an animation name, but not the animation file itself. They can be found at '''Actor/AS/{EventName}/{AnimationSequenceName}.bas''' in [[Beventpack|beventpacks]] and [[TitleBG.pack]]/Actor/AS, and '''Actor/AS/{AnimationSequenceName}.bas''' in bactorpacks.
</onlyinclude>

==Layout==
Each bas file is made up of one list of elements, named Elements. Each element (Element0, Element1, etc) can be either a test to figure out what animation to play, or a call to play the animation.

===Parameters===
All nodes have Parameters, which determine what kind of node they are. They can be a control node, which helps decide which animation to play, or an animation node, which actually plays the animation.
{| class="wikitable"
!Key
!Key Type
!Description
!Node Type
!Default value
|-
|TypeIndex
|int
|Type of node the Element is. Known types are listed below the table.
| -
| -
|-
|NoSync
|bool
| -
|Control
| -
|-
|JudgeOnce
|bool
|Tells the game to skip evaluating this node (and use the previous result) if the input value has not changed since the last time the node was run.
|Control
|False
|-
|InputLimit
|float
| -
|Control
| -
|-
|FileName
|str64
|Name of the animation to play
|Animation
| -
|-
|Morph
|int
|Time to blend the previous animation into this one. Appears to be measured in frames.
|Animation
| -
|-
|SequenceLoop
|bool
|Determines whether a sequence (Used with TypeIndex 61) is set to repeat
|Control
| -
|-
|}

====Parameter TypeIndex====
Nodes with Blender are generally used to perform the same checks as those with Selector in the name, with a key difference: Blender nodes may evaluate multiple cases as true, and will blend the resulting animations together. Selector nodes will choose only the first case that evaluates to true.{{Check}}
{| class="wikitable"
!Index
!Name <ref>TypeIndex function table in the 1.5.0 [[executable]]</ref>
!Description
!Type
|-
|0
|AbsTemperatureBlender
|Current world temperature. Evaluated by float range.
|Control
|-
|1
|AbsTemperatureSelector
|Current world temperature. Evaluated by float range.
|Control
|-
|2
|ArmorSelector
|What armor is currently equipped. Used only in '''Player_Wait.bas'''. Only observed working values are <code>NoUpper</code>, <code>NoLower</code>, <code>NoAll</code>.{{#tag:ref|Element32 of Player_Wait.bas, WiiU 1.5.0|name=e32pw}} Does not appear to accept armor actor names.
|Control
|-
|3
|ArrowSelector
|Seems to check what arrow Link has equipped. However, the game only ever uses a '''StringArray''' of '''Empty''' and a default case. This is used to check whether Link has arrows in his bow, to determine how to blend his animations or to play different ones.
|Control
|-
|4
|AttentionSelector
| -
|Control
|-
|5
|BoneBlender
| -
|Control
|-
|6
|BoneVisibilityAsset
| -
| -
|-
|7
|BoolSelector
|Boolean evaluator - See [[#BitIndex]]{{#tag:ref|Element1 of Player_CutNinja.bas, WiiU 1.5.0|name=e1pcn}}{{#tag:ref|Element0 of Player_FaceDefault.bas, WiiU 1.5.0|name=e0pfd}}{{#tag:ref|Element2 of Player_FaceDefault.bas, WiiU 1.5.0|name=e2pfd}} If false, the element specified by Child0 is evaluated. If true, Child1 is evaluated.
|Control
|-
|8
|ButtonSelector
| -
|Control
|-
|9
|ChargeSelector
| -
|Control
|-
|10
|ClearMatAnmAsset
| -
| -
|-
|11
|ComboSelector
| -
|Control
|-
|12
|DiffAngleYBlender
| -
|Control
|-
|13
|DiffAngleYSelector
| -
|Control
|-
|14
|DirectionAngleBlender
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|15
|DirectionAngleSelector
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|16
|DistanceBlender
|Compares distance between Link and his current locked target{{#tag:ref|Element2 of Player_CutNinja.bas, WiiU 1.5.0|name=e2pcn}}. Evaluated by float range.
|Control
|-
|17
|DistanceSelector
|Compares distance between Link and his current locked target. Evaluated by float range.
|Control
|-
|18
|DungeonClearSelector
| -
|Control
|-
|19
|DungeonNumberSelector
| -
|Control
|-
|20
|EmotionSelector
| -
|Control
|-
|21
|EventFlagSelector
|Checks whether a GameData flag is true. The StringArray defines the flags to be checked. Known to accept 1 child plus a default case, but in a single instance there's no default case.<ref>Npc_Rito_Hearts_BandVisibilityOff.bas</ref> In another instance, both strings are flags. <ref>UR_M_Teba_Teba_DamageVisibility_On.bas</ref> If both are true, the first case evaluated as true will be run.
|Control
|-
|22
|EyeSelector
| -
|Control
|-
|23
|EyebrowSelector
| -
|Control
|-
|24
|FaceEmotionSelector
| -
|Control
|-
|25
|FootBLLifeSelector
| -
|Control
|-
|26
|FootBRLifeSelector
| -
|Control
|-
|27
|FootFLLifeSelector
| -
|Control
|-
|28
|FootFRLifeSelector
| -
|Control
|-
|29
|ForwardBentBlender
| -
|Control
|-
|30
|ForwardBentSelector
| -
|Control
|-
|31
|GearSelector
| -
|Control
|-
|32
|GenerationSelector
|Int check - Unknown<ref>Element7 of UH_C_Face_Talk.bas and Element3 of UH_C_Face_Default.bas</ref> In both referenced cases (used in NPC actorpacks), Value0 is '''2''', and Value1 is '''-2147483648''', which is the negative 32-bit integer limit.
|Control
|-
|33
|GrabTypeSelector
|Compares the [[Bgparamlist#Liftable|LiftType]] of the actor that is being grabbed/lifted (from its bgparamlist). Known to accept as many as 24 children and a default case.
|Control
|-
|34
|GroundNormalBlender
| -
|Control
|-
|35
|GroundNormalSelector
| -
|Control
|-
|36
|GroundNormalSideBlender
| -
|Control
|-
|37
|GroundNormalSideSelector
| -
|Control
|-
|38
|MaskSelector
|Checks the MaskType parameter of the currently equipped Head armor. Its children reference other elements to jump to if a matching MaskType is found, and a StringArray in its Extend determine the MaskType(s) to check for.
|Control
|-
|39
|MatVisibilityAsset
| -
| -
|-
|40
|MouthSelector
| -
|Control
|-
|41
|NoAnmAsset
|Play no animation. Used to cancel evaluation.
|Animation
|-
|42
|NoLoopStickAngleBlender
| -
|Control
|-
|43
|NoLoopStickAngleSelector
| -
|Control
|-
|44
|NodePosSelector
|Compares name of a bone, takes StrRef of the bone name. Unknown how it decides which bone name to compare the StrRef to.{{#tag:ref|Element0 of Player_LadderJump.bas, WiiU 1.5.0|name=e0plj}} Can be paired with an axis name (e.g. <code>Toe_L,Z</code>) to measure value on that axis. When used in this way, the node chooses the child corresponding to the highest value among those measured.{{#tag:ref|Element8 of UZ_M_Move_End.bas, WiiU 1.5.0|name=e8uzmme}} When no axis name is given, the vector to the origin is measured. {{Check}}
|Control
|-
|45
|PersonalitySelector
| -
|Control
|-
|46
|PostureSelector
| -
|Control
|-
|47
|PreASSelector
|Compares last played animation name, takes StrRef of animation name. Accepts up to 5 children.{{#tag:ref|Element11 of Player_CutChargeWait.bas, WiiU 1.5.0|name=e11pccw}}
|Control
|-
|48
|PreExclusionRandomSelector
| -
|Control
|-
|49
|RandomSelector
|Picks a random node from the given nodes.{{Check}}
|Control
|-
|50
|RideSelector
|Compares the profile of the mount the actor is currently riding. Known to accept one Child, plus a default case, but might accept more or less.{{Check}}
|Control
|-
|51
|RightStickAngleBlender
| -
|Control
|-
|52
|RightStickAngleSelector
| -
|Control
|-
|53
|RightStickValueBlender
| -
|Control
|-
|54
|RightStickValueSelector
| -
|Control
|-
|55
|RightStickXBlender
| -
|Control
|-
|56
|RightStickXSelector
| -
|Control
|-
|57
|RightStickYBlender
| -
|Control
|-
|58
|RightStickYSelector
| -
|Control
|-
|59
|SelfHeightSelector
| -
|Control
|-
|60
|SelfWeightSelector
| -
|Control
|-
|61
|SequencePlayContainer
|Float comparison - Unknown{{#tag:ref|Element0 of Player_Move.bas, WiiU 1.5.0|name=e0pm}}
|Control
|-
|62
|ShaderParamAsset
|Plays material animation, takes StrRef of the animation name. Its Extend uses a secondary animation name for unknown purpose.{{#tag:ref|Element1 of Player_SkinColor.bas, WiiU 1.5.0|name=e1psc}}{{#tag:ref|Element2 of Player_SkinColor.bas, WiiU 1.5.0|name=e2psc}}
|Animation
|-
|63
|ShaderParamColorAsset
| -
| -
|-
|64
|ShaderParamTexSRTAsset
|Plays texture transform animation, takes StrRef of the animation name.
|Animation
|-
|65
|SizeBlender
| -
|Control
|-
|66
|SizeSelector
| -
|Control
|-
|67
|SkeltalAsset
|Plays model animation, takes StrRef of the animation name.
|Animation
|-
|68
|SpeedBlender
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|69
|SpeedSelector
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|70
|StickAngleBlender
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|71
|StickAngleSelector
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|72
|StickValueBlender
|Range evaluation - Unknown{{#tag:ref|Element0 of Player_SwimAtnMove.bas, WiiU 1.5.0|name=e0psam}}
|Control
|-
|73
|StickValueSelector
| -
|Control
|-
|74
|StickXBlender
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|75
|StickXSelector
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|76
|StickYBlender
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|77
|StickYSelector
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|78
|StressBlender
| -
|Control
|-
|79
|StressSelector
| -
|Control
|-
|80
|SyncPlayContainer
|Synchronously plays multiple child elements
|Animation
|-
|81
|TemperatureBlender
| -
|Control
|-
|82
|TemperatureSelector
|Range evaluation - Unknown{{#tag:ref|Element1 of Player_FaceDefault.bas, WiiU 1.5.0|name=e1pfd}}
|Control
|-
|83
|TexturePatternAsset
| -
| -
|-
|84
|TimeSelector
|Checks the current time. Observed values are '''Morning_A''', '''Morning_B''', '''Evening_B''', '''Night_A''', and '''Night_B'''. '''Evening_A''' is never used, but is assumed to exist. Known to accept any number of children along with a default case.
|Control
|-
|85
|TiredBlender
| -
|Control
|-
|86
|TiredSelector
| -
|Control
|-
|87
|UseItemSelector
| -
|Control
|-
|88
|UserAngle2Blender
| -
|Control
|-
|89
|UserAngle2Selector
| -
|Control
|-
|90
|UserAngleBlender
| -
|Control
|-
|91
|UserAngleSelector
| -
|Control
|-
|92
|UserSpeedBlender
| -
|Control
|-
|93
|UserSpeedSelector
| -
|Control
|-
|94
|VariationSelector
| -
|Control
|-
|95
|WallAngleBlender
| -
|Control
|-
|96
|WallAngleSelector
| -
|Control
|-
|97
|WeaponDetailSelector
|Compares actor's equipped weapon subtype (from its bgparamlist [ProfileUser] WeaponSubtype value), takes StrRef of weapon subtype name
|Control
|-
|98
|WeaponSelector
|Compares actor's equipped weapon profile (from its bxml ProfileUser value), takes StrRef of weapon profile name
|Control
|-
|99
|WeatherSelector
| -
|Control
|-
|100
|WeightBlender
| -
|Control
|-
|101
|WeightSelector
| -
|Control
|-
|102
|WindVelocityBlender
| -
|Control
|-
|103
|YSpeedBlender
| -
|Control
|-
|104
|YSpeedSelector
| -
|Control
|-
|105
|ZEx00ExposureBlender
| -
|Control
|-
|106
|ZEx00ExposureSelector
| -
|Control
|-
|}

===Children===
Control nodes will have Children, in addition to Parameters, which determine which Element to go to after the control node is evaluated. The properties of Children will be named Child0, Child1, etc, and each will have a single integer value, which will correspond to the Element number. e.g. <code>Child0: 7</code> points to Element7.

===Extend===
All nodes have an Extend, which contains specific details about the node. Control node Extends will contain details about the comparison being performed, while animation nodes will contain information about the animation being played, such as: during which frames of the animation a weapon will deal damage if it hits something, when user input is ignored, when to draw weapon trails through the air for attack animations, etc.

====Typed Array====
A list of variables of a given type to use for various control comparisons. Corresponds directly to the Children of the node. i.e. if Value0 matches the value being compared against, the code will jump to the Element listed under Child0. If no comparison of a lower Child number has evaluated as true, automatically evaluates a Child whose value is "default" as true.{{#tag:ref|Element0 of Player_CutNinja.bas, WiiU 1.5.0|name=e0pcn}}{{#tag:ref|Element3 of Player_FaceDefault.bas, WiiU 1.5.0|name=e3pfd}}

====BitIndex====
Used with BoolSelector Parameters. Also has TypeIndex, which are used to perform the check.

*2 - Unknown (believed to check if Link has any armor equipped)<ref name="e0pfd" />
*5 - Unknown (believed to check if Link is carrying an object)
*15 - Unknown. Appears in Player_WeaponEquipOn after an Attention Selector and a BitIndex 30 check, implying that it has something to do with shields.
*17 - Unknown (believed to check whether Link is airborne)
*30 - Whether or not Link has a shield equipped. (First Child is False, Second Child is True)<ref name="e1pcn" />
*33 - Unknown (believed to check if Link is tired)<ref name="e2pfd" />
*37 - Whether IsBlunt is set to true in the equipped weapon’s bgparamlist
*38 - Unknown (believed to check if the current weapon is on fire)
*46 - Unknown (believed to check if Link is crouched)

====Ranges====
Used with control nodes that perform a Range evaluation. If the value being compared is above the Start value and below the End value, evaluates as true. Otherwise, moves on to the next value. (Unknown what happens if none of the Ranges evaluate to true, presumably game crash)

====FrameCtrl====
Used with animation nodes. The node itself is required, even if it is empty (i.e. none of the keys are specified)
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|Rate
|float
|Speed at which to play the animation. Higher numbers are faster.
|1.0
|-
|StartFrame
|int
| -
| -
|-
|EndFrame
|int
| -
| -
|-
|LoopStopCount
|int
| -
| -
|-
|LoopStopCountRandom
|int
| -
| -
|-
|UseGlobalFrame
|bool
| -
|false
|-
|ReversePlay
|bool
| -
|false
|-
|Connect
|int
|The only observed values are 1, 2, and 3.
| -
|-
|AnmLoop
|int
|The only observed values are 1 and 2. <ref>Elements 10 and 11 of AncientDoctor_C_Face_Default.bas</ref>
| -
|-
|}

====TriggerEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. Events which are triggered during this animation.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|Frame
|int
|Which frame to fire the event on, relative to the frame numbers of the animation. Can be negative.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Used to play sound effects during animations. Known to accept any attack or enemy attack sound effect, but probably works with other sound files.<ref>Compare Event0 of TriggerEvents and Event0 of HoldEvents for most of Link's attack animations</ref>
*4 - Triggers the animation controller to transition back into the idle stance. The Frame value should be a few before the end of the actual animation, so that the controller can make the blending look natural.<ref>Compare TriggerEvent TypeIndex 4 Frame value for an animation with the number of frames in the actual animation.</ref>
*7 - Call AS. Passes the strRef to the ASList to retrieve an AS file and starts evaluating it from Element0.
*14 - Seems to indicate an enemy has entered a state of being airborne.
*28 - Play audio. Able to play any bfwav file in PlayerVoice.bars.
*29 - Seems to determine when a weapon will bind to a bone. <ref>Player_WeaponEquipOn.bas</ref>

====HoldEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. States that are entered into while the animation is playing.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|StartFrame
|int
|Which frame to start the event on, relative to the frame numbers of the animation. Unknown if it can be negative.
| -
|-
|EndFrame
|int
|Which frame to end the event on, relative to the frame numbers of the animation. A value of -1 is treated as the ending frame of the animation.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Seems to allow Link's attack animations to combo into one another. New attack elements will not combo together if there is no TypeIndex 0 present in the Hold Events.
*2 - Seems to determine when some attacks (entries in Player_CutJumpSt and others) will connect with targets. Removing TypeIndex 2 causes animations to play halfway through. TypeIndex 2 also tends to have a StartFrame somewhere near the middle of the animation, and an end frame of -1.0, indicating that it may be responsible for blending certain attack animations into one another, particularly those that loop or combine.
*3 - Defines when an attack will deal damage. Value is the damage type. Left: slashing. Stab: piercing. Lower: blunt. {{Check}}
*14 - Defines when an animation will block attack damage using Link's equipped shield.
*17 - Unknown
*22 - Unknown. Found in Link's Player_CutShieldRide.bas animation, and seems to correspond to the air effects under the board, but can't be applied to other attack animations.
*25 - Unknown. Appears to have something to do with Bone Control, as it is often observed with the !str32 Value "OnlyEye".
*35 - Unknown
*45 - Defines when to accept input to start the next attack.
*48 - Defines when to display the trails in the air during an attack.
*49 - Believed to define the animation frames during which an actor is resistant to knock back. Notably used during animations where the actor leaves the ground and in most cases, active during frames when actor is airborne.

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

Bas

2023-02-02T12:09:04Z

CEObrainz: /* Parameters */ Added SequenceLoop to Parameters table

{{Lowercase}}
<onlyinclude>
'''bas''' files each represent an animation that can be called by an [[actor]] or [[Demo|cutscene]]. They contain a reference to an animation name, but not the animation file itself. They can be found at '''Actor/AS/{EventName}/{AnimationSequenceName}.bas''' in [[Beventpack|beventpacks]] and [[TitleBG.pack]]/Actor/AS, and '''Actor/AS/{AnimationSequenceName}.bas''' in bactorpacks.
</onlyinclude>

==Layout==
Each bas file is made up of one list of elements, named Elements. Each element (Element0, Element1, etc) can be either a test to figure out what animation to play, or a call to play the animation.

===Parameters===
All nodes have Parameters, which determine what kind of node they are. They can be a control node, which helps decide which animation to play, or an animation node, which actually plays the animation.
{| class="wikitable"
!Key
!Key Type
!Description
!Node Type
!Default value
|-
|TypeIndex
|int
|Type of node the Element is. Known types are listed below the table.
| -
| -
|-
|NoSync
|bool
| -
|Control
| -
|-
|JudgeOnce
|bool
|Tells the game to skip evaluating this node (and use the previous result) if the input value has not changed since the last time the node was run.
|Control
|False
|-
|InputLimit
|float
| -
|Control
| -
|-
|FileName
|str64
|Name of the animation to play
|Animation
| -
|-
|Morph
|int
|Time to blend the previous animation into this one. Appears to be measured in frames.
|Animation
| -
|-
|SequenceLoop
|bool
|Determines whether a sequence (Used with TypeIndex 61) is set to repeat
|Control
| -
|-
|}

====Parameter TypeIndex====
Nodes with Blender are generally used to perform the same checks as those with Selector in the name, with a key difference: Blender nodes may evaluate multiple cases as true, and will blend the resulting animations together. Selector nodes will choose only the first case that evaluates to true.{{Check}}
{| class="wikitable"
!Index
!Name <ref>TypeIndex function table in the 1.5.0 [[executable]]</ref>
!Description
!Type
|-
|0
|AbsTemperatureBlender
|Current world temperature. Evaluated by float range.
|Control
|-
|1
|AbsTemperatureSelector
|Current world temperature. Evaluated by float range.
|Control
|-
|2
|ArmorSelector
|What armor is currently equipped. Used only in '''Player_Wait.bas'''. Only observed working values are <code>NoUpper</code>, <code>NoLower</code>, <code>NoAll</code>.{{#tag:ref|Element32 of Player_Wait.bas, WiiU 1.5.0|name=e32pw}} Does not appear to accept armor actor names.
|Control
|-
|3
|ArrowSelector
|Seems to check what arrow Link has equipped. However, the game only ever uses a '''StringArray''' of '''Empty''' and a default case. This is used to check whether Link has arrows in his bow, to determine how to blend his animations or to play different ones.
|Control
|-
|4
|AttentionSelector
| -
|Control
|-
|5
|BoneBlender
| -
|Control
|-
|6
|BoneVisibilityAsset
| -
| -
|-
|7
|BoolSelector
|Boolean evaluator - See [[#BitIndex]]{{#tag:ref|Element1 of Player_CutNinja.bas, WiiU 1.5.0|name=e1pcn}}{{#tag:ref|Element0 of Player_FaceDefault.bas, WiiU 1.5.0|name=e0pfd}}{{#tag:ref|Element2 of Player_FaceDefault.bas, WiiU 1.5.0|name=e2pfd}} If false, the element specified by Child0 is evaluated. If true, Child1 is evaluated.
|Control
|-
|8
|ButtonSelector
| -
|Control
|-
|9
|ChargeSelector
| -
|Control
|-
|10
|ClearMatAnmAsset
| -
| -
|-
|11
|ComboSelector
| -
|Control
|-
|12
|DiffAngleYBlender
| -
|Control
|-
|13
|DiffAngleYSelector
| -
|Control
|-
|14
|DirectionAngleBlender
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|15
|DirectionAngleSelector
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|16
|DistanceBlender
|Compares distance between Link and his current locked target{{#tag:ref|Element2 of Player_CutNinja.bas, WiiU 1.5.0|name=e2pcn}}. Evaluated by float range.
|Control
|-
|17
|DistanceSelector
|Compares distance between Link and his current locked target. Evaluated by float range.
|Control
|-
|18
|DungeonClearSelector
| -
|Control
|-
|19
|DungeonNumberSelector
| -
|Control
|-
|20
|EmotionSelector
| -
|Control
|-
|21
|EventFlagSelector
|Checks whether a GameData flag is true. The StringArray defines the flags to be checked. Known to accept 1 child plus a default case, but in a single instance there's no default case.<ref>Npc_Rito_Hearts_BandVisibilityOff.bas</ref> In another instance, both strings are flags. <ref>UR_M_Teba_Teba_DamageVisibility_On.bas</ref> If both are true, the first case evaluated as true will be run.
|Control
|-
|22
|EyeSelector
| -
|Control
|-
|23
|EyebrowSelector
| -
|Control
|-
|24
|FaceEmotionSelector
| -
|Control
|-
|25
|FootBLLifeSelector
| -
|Control
|-
|26
|FootBRLifeSelector
| -
|Control
|-
|27
|FootFLLifeSelector
| -
|Control
|-
|28
|FootFRLifeSelector
| -
|Control
|-
|29
|ForwardBentBlender
| -
|Control
|-
|30
|ForwardBentSelector
| -
|Control
|-
|31
|GearSelector
| -
|Control
|-
|32
|GenerationSelector
|Int check - Unknown<ref>Element7 of UH_C_Face_Talk.bas and Element3 of UH_C_Face_Default.bas</ref> In both referenced cases (used in NPC actorpacks), Value0 is '''2''', and Value1 is '''-2147483648''', which is the negative 32-bit integer limit.
|Control
|-
|33
|GrabTypeSelector
|Compares the [[Bgparamlist#Liftable|LiftType]] of the actor that is being grabbed/lifted (from its bgparamlist). Known to accept as many as 24 children and a default case.
|Control
|-
|34
|GroundNormalBlender
| -
|Control
|-
|35
|GroundNormalSelector
| -
|Control
|-
|36
|GroundNormalSideBlender
| -
|Control
|-
|37
|GroundNormalSideSelector
| -
|Control
|-
|38
|MaskSelector
|Checks the MaskType parameter of the currently equipped Head armor. Its children reference other elements to jump to if a matching MaskType is found, and a StringArray in its Extend determine the MaskType(s) to check for.
|Control
|-
|39
|MatVisibilityAsset
| -
| -
|-
|40
|MouthSelector
| -
|Control
|-
|41
|NoAnmAsset
|Play no animation. Used to cancel evaluation.
|Animation
|-
|42
|NoLoopStickAngleBlender
| -
|Control
|-
|43
|NoLoopStickAngleSelector
| -
|Control
|-
|44
|NodePosSelector
|Compares name of a bone, takes StrRef of the bone name. Unknown how it decides which bone name to compare the StrRef to.{{#tag:ref|Element0 of Player_LadderJump.bas, WiiU 1.5.0|name=e0plj}} Can be paired with an axis name (e.g. <code>Toe_L,Z</code>) to measure value on that axis. When used in this way, the node chooses the child corresponding to the highest value among those measured.{{#tag:ref|Element8 of UZ_M_Move_End.bas, WiiU 1.5.0|name=e8uzmme}} When no axis name is given, the vector to the origin is measured. {{Check}}
|Control
|-
|45
|PersonalitySelector
| -
|Control
|-
|46
|PostureSelector
| -
|Control
|-
|47
|PreASSelector
|Compares last played animation name, takes StrRef of animation name. Accepts up to 5 children.{{#tag:ref|Element11 of Player_CutChargeWait.bas, WiiU 1.5.0|name=e11pccw}}
|Control
|-
|48
|PreExclusionRandomSelector
| -
|Control
|-
|49
|RandomSelector
|Picks a random node from the given nodes.{{Check}}
|Control
|-
|50
|RideSelector
|Compares the profile of the mount the actor is currently riding. Known to accept one Child, plus a default case, but might accept more or less.{{Check}}
|Control
|-
|51
|RightStickAngleBlender
| -
|Control
|-
|52
|RightStickAngleSelector
| -
|Control
|-
|53
|RightStickValueBlender
| -
|Control
|-
|54
|RightStickValueSelector
| -
|Control
|-
|55
|RightStickXBlender
| -
|Control
|-
|56
|RightStickXSelector
| -
|Control
|-
|57
|RightStickYBlender
| -
|Control
|-
|58
|RightStickYSelector
| -
|Control
|-
|59
|SelfHeightSelector
| -
|Control
|-
|60
|SelfWeightSelector
| -
|Control
|-
|61
|SequencePlayContainer
|Float comparison - Unknown{{#tag:ref|Element0 of Player_Move.bas, WiiU 1.5.0|name=e0pm}}
|Control
|-
|62
|ShaderParamAsset
|Plays material animation, takes StrRef of the animation name. Its Extend uses a secondary animation name for unknown purpose.{{#tag:ref|Element1 of Player_SkinColor.bas, WiiU 1.5.0|name=e1psc}}{{#tag:ref|Element2 of Player_SkinColor.bas, WiiU 1.5.0|name=e2psc}}
|Animation
|-
|63
|ShaderParamColorAsset
| -
| -
|-
|64
|ShaderParamTexSRTAsset
|Plays texture transform animation, takes StrRef of the animation name.
|Animation
|-
|65
|SizeBlender
| -
|Control
|-
|66
|SizeSelector
| -
|Control
|-
|67
|SkeltalAsset
|Plays model animation, takes StrRef of the animation name.
|Animation
|-
|68
|SpeedBlender
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|69
|SpeedSelector
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|70
|StickAngleBlender
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|71
|StickAngleSelector
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|72
|StickValueBlender
|Range evaluation - Unknown{{#tag:ref|Element0 of Player_SwimAtnMove.bas, WiiU 1.5.0|name=e0psam}}
|Control
|-
|73
|StickValueSelector
| -
|Control
|-
|74
|StickXBlender
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|75
|StickXSelector
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|76
|StickYBlender
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|77
|StickYSelector
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|78
|StressBlender
| -
|Control
|-
|79
|StressSelector
| -
|Control
|-
|80
|SyncPlayContainer
|Synchronously plays multiple child elements
|Animation
|-
|81
|TemperatureBlender
| -
|Control
|-
|82
|TemperatureSelector
|Range evaluation - Unknown{{#tag:ref|Element1 of Player_FaceDefault.bas, WiiU 1.5.0|name=e1pfd}}
|Control
|-
|83
|TexturePatternAsset
| -
| -
|-
|84
|TimeSelector
|Checks the current time. Observed values are '''Morning_A''', '''Morning_B''', '''Evening_B''', '''Night_A''', and '''Night_B'''. '''Evening_A''' is never used, but is assumed to exist. Known to accept any number of children along with a default case.
|Control
|-
|85
|TiredBlender
| -
|Control
|-
|86
|TiredSelector
| -
|Control
|-
|87
|UseItemSelector
| -
|Control
|-
|88
|UserAngle2Blender
| -
|Control
|-
|89
|UserAngle2Selector
| -
|Control
|-
|90
|UserAngleBlender
| -
|Control
|-
|91
|UserAngleSelector
| -
|Control
|-
|92
|UserSpeedBlender
| -
|Control
|-
|93
|UserSpeedSelector
| -
|Control
|-
|94
|VariationSelector
| -
|Control
|-
|95
|WallAngleBlender
| -
|Control
|-
|96
|WallAngleSelector
| -
|Control
|-
|97
|WeaponDetailSelector
|Compares actor's equipped weapon subtype (from its bgparamlist [ProfileUser] WeaponSubtype value), takes StrRef of weapon subtype name
|Control
|-
|98
|WeaponSelector
|Compares actor's equipped weapon profile (from its bxml ProfileUser value), takes StrRef of weapon profile name
|Control
|-
|99
|WeatherSelector
| -
|Control
|-
|100
|WeightBlender
| -
|Control
|-
|101
|WeightSelector
| -
|Control
|-
|102
|WindVelocityBlender
| -
|Control
|-
|103
|YSpeedBlender
| -
|Control
|-
|104
|YSpeedSelector
| -
|Control
|-
|105
|ZEx00ExposureBlender
| -
|Control
|-
|106
|ZEx00ExposureSelector
| -
|Control
|-
|}

===Children===
Control nodes will have Children, in addition to Parameters, which determine which Element to go to after the control node is evaluated. The properties of Children will be named Child0, Child1, etc, and each will have a single integer value, which will correspond to the Element number. e.g. <code>Child0: 7</code> points to Element7.

===Extend===
All nodes have an Extend, which contains specific details about the node. Control node Extends will contain details about the comparison being performed, while animation nodes will contain information about the animation being played, such as: during which frames of the animation a weapon will deal damage if it hits something, when user input is ignored, when to draw weapon trails through the air for attack animations, etc.

====Typed Array====
A list of variables of a given type to use for various control comparisons. Corresponds directly to the Children of the node. i.e. if Value0 matches the value being compared against, the code will jump to the Element listed under Child0. If no comparison of a lower Child number has evaluated as true, automatically evaluates a Child whose value is "default" as true.{{#tag:ref|Element0 of Player_CutNinja.bas, WiiU 1.5.0|name=e0pcn}}{{#tag:ref|Element3 of Player_FaceDefault.bas, WiiU 1.5.0|name=e3pfd}}

====BitIndex====
Used with BoolSelector Parameters. Also has TypeIndex, which are used to perform the check.

*2 - Unknown (believed to check if Link has any armor equipped)<ref name="e0pfd" />
*5 - Unknown (believed to check if Link is carrying an object)
*15 - Unknown. Appears in Player_WeaponEquipOn after an Attention Selector and a BitIndex 30 check, implying that it has something to do with shields.
*17 - Unknown (believed to check whether Link is airborne)
*30 - Whether or not Link has a shield equipped.<ref name="e1pcn" />
*33 - Unknown (believed to check if Link is tired)<ref name="e2pfd" />
*37 - Whether IsBlunt is set to true in the equipped weapon’s bgparamlist
*38 - Unknown (believed to check if the current weapon is on fire)
*46 - Unknown (believed to check if Link is crouched)

====Ranges====
Used with control nodes that perform a Range evaluation. If the value being compared is above the Start value and below the End value, evaluates as true. Otherwise, moves on to the next value. (Unknown what happens if none of the Ranges evaluate to true, presumably game crash)

====FrameCtrl====
Used with animation nodes. The node itself is required, even if it is empty (i.e. none of the keys are specified)
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|Rate
|float
|Speed at which to play the animation. Higher numbers are faster.
|1.0
|-
|StartFrame
|int
| -
| -
|-
|EndFrame
|int
| -
| -
|-
|LoopStopCount
|int
| -
| -
|-
|LoopStopCountRandom
|int
| -
| -
|-
|UseGlobalFrame
|bool
| -
|false
|-
|ReversePlay
|bool
| -
|false
|-
|Connect
|int
|The only observed values are 1, 2, and 3.
| -
|-
|AnmLoop
|int
|The only observed values are 1 and 2. <ref>Elements 10 and 11 of AncientDoctor_C_Face_Default.bas</ref>
| -
|-
|}

====TriggerEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. Events which are triggered during this animation.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|Frame
|int
|Which frame to fire the event on, relative to the frame numbers of the animation. Can be negative.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Used to play sound effects during animations. Known to accept any attack or enemy attack sound effect, but probably works with other sound files.<ref>Compare Event0 of TriggerEvents and Event0 of HoldEvents for most of Link's attack animations</ref>
*4 - Triggers the animation controller to transition back into the idle stance. The Frame value should be a few before the end of the actual animation, so that the controller can make the blending look natural.<ref>Compare TriggerEvent TypeIndex 4 Frame value for an animation with the number of frames in the actual animation.</ref>
*7 - Call AS. Passes the strRef to the ASList to retrieve an AS file and starts evaluating it from Element0.
*14 - Seems to indicate an enemy has entered a state of being airborne.
*28 - Play audio. Able to play any bfwav file in PlayerVoice.bars.
*29 - Seems to determine when a weapon will bind to a bone. <ref>Player_WeaponEquipOn.bas</ref>

====HoldEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. States that are entered into while the animation is playing.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|StartFrame
|int
|Which frame to start the event on, relative to the frame numbers of the animation. Unknown if it can be negative.
| -
|-
|EndFrame
|int
|Which frame to end the event on, relative to the frame numbers of the animation. A value of -1 is treated as the ending frame of the animation.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Seems to allow Link's attack animations to combo into one another. New attack elements will not combo together if there is no TypeIndex 0 present in the Hold Events.
*2 - Seems to determine when some attacks (entries in Player_CutJumpSt and others) will connect with targets. Removing TypeIndex 2 causes animations to play halfway through. TypeIndex 2 also tends to have a StartFrame somewhere near the middle of the animation, and an end frame of -1.0, indicating that it may be responsible for blending certain attack animations into one another, particularly those that loop or combine.
*3 - Defines when an attack will deal damage. Value is the damage type. Left: slashing. Stab: piercing. Lower: blunt. {{Check}}
*14 - Defines when an animation will block attack damage using Link's equipped shield.
*17 - Unknown
*22 - Unknown. Found in Link's Player_CutShieldRide.bas animation, and seems to correspond to the air effects under the board, but can't be applied to other attack animations.
*25 - Unknown. Appears to have something to do with Bone Control, as it is often observed with the !str32 Value "OnlyEye".
*35 - Unknown
*45 - Defines when to accept input to start the next attack.
*48 - Defines when to display the trails in the air during an attack.
*49 - Believed to define the animation frames during which an actor is resistant to knock back. Notably used during animations where the actor leaves the ground and in most cases, active during frames when actor is airborne.

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

Bas

2023-02-02T11:42:12Z

CEObrainz: /* BitIndex */ Added BitIndex 5

{{Lowercase}}
<onlyinclude>
'''bas''' files each represent an animation that can be called by an [[actor]] or [[Demo|cutscene]]. They contain a reference to an animation name, but not the animation file itself. They can be found at '''Actor/AS/{EventName}/{AnimationSequenceName}.bas''' in [[Beventpack|beventpacks]] and [[TitleBG.pack]]/Actor/AS, and '''Actor/AS/{AnimationSequenceName}.bas''' in bactorpacks.
</onlyinclude>

==Layout==
Each bas file is made up of one list of elements, named Elements. Each element (Element0, Element1, etc) can be either a test to figure out what animation to play, or a call to play the animation.

===Parameters===
All nodes have Parameters, which determine what kind of node they are. They can be a control node, which helps decide which animation to play, or an animation node, which actually plays the animation.
{| class="wikitable"
!Key
!Key Type
!Description
!Node Type
!Default value
|-
|TypeIndex
|int
|Type of node the Element is. Known types are listed below the table.
| -
| -
|-
|NoSync
|bool
| -
|Control
| -
|-
|JudgeOnce
|bool
|Tells the game to skip evaluating this node (and use the previous result) if the input value has not changed since the last time the node was run.
|Control
|False
|-
|InputLimit
|float
| -
|Control
| -
|-
|FileName
|str64
|Name of the animation to play
|Animation
| -
|-
|Morph
|int
|Time to blend the previous animation into this one. Appears to be measured in frames.
|Animation
| -
|-
|}

====Parameter TypeIndex====
Nodes with Blender are generally used to perform the same checks as those with Selector in the name, with a key difference: Blender nodes may evaluate multiple cases as true, and will blend the resulting animations together. Selector nodes will choose only the first case that evaluates to true.{{Check}}
{| class="wikitable"
!Index
!Name <ref>TypeIndex function table in the 1.5.0 [[executable]]</ref>
!Description
!Type
|-
|0
|AbsTemperatureBlender
|Current world temperature. Evaluated by float range.
|Control
|-
|1
|AbsTemperatureSelector
|Current world temperature. Evaluated by float range.
|Control
|-
|2
|ArmorSelector
|What armor is currently equipped. Used only in '''Player_Wait.bas'''. Only observed working values are <code>NoUpper</code>, <code>NoLower</code>, <code>NoAll</code>.{{#tag:ref|Element32 of Player_Wait.bas, WiiU 1.5.0|name=e32pw}} Does not appear to accept armor actor names.
|Control
|-
|3
|ArrowSelector
|Seems to check what arrow Link has equipped. However, the game only ever uses a '''StringArray''' of '''Empty''' and a default case. This is used to check whether Link has arrows in his bow, to determine how to blend his animations or to play different ones.
|Control
|-
|4
|AttentionSelector
| -
|Control
|-
|5
|BoneBlender
| -
|Control
|-
|6
|BoneVisibilityAsset
| -
| -
|-
|7
|BoolSelector
|Boolean evaluator - See [[#BitIndex]]{{#tag:ref|Element1 of Player_CutNinja.bas, WiiU 1.5.0|name=e1pcn}}{{#tag:ref|Element0 of Player_FaceDefault.bas, WiiU 1.5.0|name=e0pfd}}{{#tag:ref|Element2 of Player_FaceDefault.bas, WiiU 1.5.0|name=e2pfd}} If false, the element specified by Child0 is evaluated. If true, Child1 is evaluated.
|Control
|-
|8
|ButtonSelector
| -
|Control
|-
|9
|ChargeSelector
| -
|Control
|-
|10
|ClearMatAnmAsset
| -
| -
|-
|11
|ComboSelector
| -
|Control
|-
|12
|DiffAngleYBlender
| -
|Control
|-
|13
|DiffAngleYSelector
| -
|Control
|-
|14
|DirectionAngleBlender
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|15
|DirectionAngleSelector
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|16
|DistanceBlender
|Compares distance between Link and his current locked target{{#tag:ref|Element2 of Player_CutNinja.bas, WiiU 1.5.0|name=e2pcn}}. Evaluated by float range.
|Control
|-
|17
|DistanceSelector
|Compares distance between Link and his current locked target. Evaluated by float range.
|Control
|-
|18
|DungeonClearSelector
| -
|Control
|-
|19
|DungeonNumberSelector
| -
|Control
|-
|20
|EmotionSelector
| -
|Control
|-
|21
|EventFlagSelector
|Checks whether a GameData flag is true. The StringArray defines the flags to be checked. Known to accept 1 child plus a default case, but in a single instance there's no default case.<ref>Npc_Rito_Hearts_BandVisibilityOff.bas</ref> In another instance, both strings are flags. <ref>UR_M_Teba_Teba_DamageVisibility_On.bas</ref> If both are true, the first case evaluated as true will be run.
|Control
|-
|22
|EyeSelector
| -
|Control
|-
|23
|EyebrowSelector
| -
|Control
|-
|24
|FaceEmotionSelector
| -
|Control
|-
|25
|FootBLLifeSelector
| -
|Control
|-
|26
|FootBRLifeSelector
| -
|Control
|-
|27
|FootFLLifeSelector
| -
|Control
|-
|28
|FootFRLifeSelector
| -
|Control
|-
|29
|ForwardBentBlender
| -
|Control
|-
|30
|ForwardBentSelector
| -
|Control
|-
|31
|GearSelector
| -
|Control
|-
|32
|GenerationSelector
|Int check - Unknown<ref>Element7 of UH_C_Face_Talk.bas and Element3 of UH_C_Face_Default.bas</ref> In both referenced cases (used in NPC actorpacks), Value0 is '''2''', and Value1 is '''-2147483648''', which is the negative 32-bit integer limit.
|Control
|-
|33
|GrabTypeSelector
|Compares the [[Bgparamlist#Liftable|LiftType]] of the actor that is being grabbed/lifted (from its bgparamlist). Known to accept as many as 24 children and a default case.
|Control
|-
|34
|GroundNormalBlender
| -
|Control
|-
|35
|GroundNormalSelector
| -
|Control
|-
|36
|GroundNormalSideBlender
| -
|Control
|-
|37
|GroundNormalSideSelector
| -
|Control
|-
|38
|MaskSelector
|Checks the MaskType parameter of the currently equipped Head armor. Its children reference other elements to jump to if a matching MaskType is found, and a StringArray in its Extend determine the MaskType(s) to check for.
|Control
|-
|39
|MatVisibilityAsset
| -
| -
|-
|40
|MouthSelector
| -
|Control
|-
|41
|NoAnmAsset
|Play no animation. Used to cancel evaluation.
|Animation
|-
|42
|NoLoopStickAngleBlender
| -
|Control
|-
|43
|NoLoopStickAngleSelector
| -
|Control
|-
|44
|NodePosSelector
|Compares name of a bone, takes StrRef of the bone name. Unknown how it decides which bone name to compare the StrRef to.{{#tag:ref|Element0 of Player_LadderJump.bas, WiiU 1.5.0|name=e0plj}} Can be paired with an axis name (e.g. <code>Toe_L,Z</code>) to measure value on that axis. When used in this way, the node chooses the child corresponding to the highest value among those measured.{{#tag:ref|Element8 of UZ_M_Move_End.bas, WiiU 1.5.0|name=e8uzmme}} When no axis name is given, the vector to the origin is measured. {{Check}}
|Control
|-
|45
|PersonalitySelector
| -
|Control
|-
|46
|PostureSelector
| -
|Control
|-
|47
|PreASSelector
|Compares last played animation name, takes StrRef of animation name. Accepts up to 5 children.{{#tag:ref|Element11 of Player_CutChargeWait.bas, WiiU 1.5.0|name=e11pccw}}
|Control
|-
|48
|PreExclusionRandomSelector
| -
|Control
|-
|49
|RandomSelector
|Picks a random node from the given nodes.{{Check}}
|Control
|-
|50
|RideSelector
|Compares the profile of the mount the actor is currently riding. Known to accept one Child, plus a default case, but might accept more or less.{{Check}}
|Control
|-
|51
|RightStickAngleBlender
| -
|Control
|-
|52
|RightStickAngleSelector
| -
|Control
|-
|53
|RightStickValueBlender
| -
|Control
|-
|54
|RightStickValueSelector
| -
|Control
|-
|55
|RightStickXBlender
| -
|Control
|-
|56
|RightStickXSelector
| -
|Control
|-
|57
|RightStickYBlender
| -
|Control
|-
|58
|RightStickYSelector
| -
|Control
|-
|59
|SelfHeightSelector
| -
|Control
|-
|60
|SelfWeightSelector
| -
|Control
|-
|61
|SequencePlayContainer
|Float comparison - Unknown{{#tag:ref|Element0 of Player_Move.bas, WiiU 1.5.0|name=e0pm}}
|Control
|-
|62
|ShaderParamAsset
|Plays material animation, takes StrRef of the animation name. Its Extend uses a secondary animation name for unknown purpose.{{#tag:ref|Element1 of Player_SkinColor.bas, WiiU 1.5.0|name=e1psc}}{{#tag:ref|Element2 of Player_SkinColor.bas, WiiU 1.5.0|name=e2psc}}
|Animation
|-
|63
|ShaderParamColorAsset
| -
| -
|-
|64
|ShaderParamTexSRTAsset
|Plays texture transform animation, takes StrRef of the animation name.
|Animation
|-
|65
|SizeBlender
| -
|Control
|-
|66
|SizeSelector
| -
|Control
|-
|67
|SkeltalAsset
|Plays model animation, takes StrRef of the animation name.
|Animation
|-
|68
|SpeedBlender
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|69
|SpeedSelector
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|70
|StickAngleBlender
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|71
|StickAngleSelector
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|72
|StickValueBlender
|Range evaluation - Unknown{{#tag:ref|Element0 of Player_SwimAtnMove.bas, WiiU 1.5.0|name=e0psam}}
|Control
|-
|73
|StickValueSelector
| -
|Control
|-
|74
|StickXBlender
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|75
|StickXSelector
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|76
|StickYBlender
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|77
|StickYSelector
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|78
|StressBlender
| -
|Control
|-
|79
|StressSelector
| -
|Control
|-
|80
|SyncPlayContainer
|Synchronously plays multiple child elements
|Animation
|-
|81
|TemperatureBlender
| -
|Control
|-
|82
|TemperatureSelector
|Range evaluation - Unknown{{#tag:ref|Element1 of Player_FaceDefault.bas, WiiU 1.5.0|name=e1pfd}}
|Control
|-
|83
|TexturePatternAsset
| -
| -
|-
|84
|TimeSelector
|Checks the current time. Observed values are '''Morning_A''', '''Morning_B''', '''Evening_B''', '''Night_A''', and '''Night_B'''. '''Evening_A''' is never used, but is assumed to exist. Known to accept any number of children along with a default case.
|Control
|-
|85
|TiredBlender
| -
|Control
|-
|86
|TiredSelector
| -
|Control
|-
|87
|UseItemSelector
| -
|Control
|-
|88
|UserAngle2Blender
| -
|Control
|-
|89
|UserAngle2Selector
| -
|Control
|-
|90
|UserAngleBlender
| -
|Control
|-
|91
|UserAngleSelector
| -
|Control
|-
|92
|UserSpeedBlender
| -
|Control
|-
|93
|UserSpeedSelector
| -
|Control
|-
|94
|VariationSelector
| -
|Control
|-
|95
|WallAngleBlender
| -
|Control
|-
|96
|WallAngleSelector
| -
|Control
|-
|97
|WeaponDetailSelector
|Compares actor's equipped weapon subtype (from its bgparamlist [ProfileUser] WeaponSubtype value), takes StrRef of weapon subtype name
|Control
|-
|98
|WeaponSelector
|Compares actor's equipped weapon profile (from its bxml ProfileUser value), takes StrRef of weapon profile name
|Control
|-
|99
|WeatherSelector
| -
|Control
|-
|100
|WeightBlender
| -
|Control
|-
|101
|WeightSelector
| -
|Control
|-
|102
|WindVelocityBlender
| -
|Control
|-
|103
|YSpeedBlender
| -
|Control
|-
|104
|YSpeedSelector
| -
|Control
|-
|105
|ZEx00ExposureBlender
| -
|Control
|-
|106
|ZEx00ExposureSelector
| -
|Control
|-
|}

===Children===
Control nodes will have Children, in addition to Parameters, which determine which Element to go to after the control node is evaluated. The properties of Children will be named Child0, Child1, etc, and each will have a single integer value, which will correspond to the Element number. e.g. <code>Child0: 7</code> points to Element7.

===Extend===
All nodes have an Extend, which contains specific details about the node. Control node Extends will contain details about the comparison being performed, while animation nodes will contain information about the animation being played, such as: during which frames of the animation a weapon will deal damage if it hits something, when user input is ignored, when to draw weapon trails through the air for attack animations, etc.

====Typed Array====
A list of variables of a given type to use for various control comparisons. Corresponds directly to the Children of the node. i.e. if Value0 matches the value being compared against, the code will jump to the Element listed under Child0. If no comparison of a lower Child number has evaluated as true, automatically evaluates a Child whose value is "default" as true.{{#tag:ref|Element0 of Player_CutNinja.bas, WiiU 1.5.0|name=e0pcn}}{{#tag:ref|Element3 of Player_FaceDefault.bas, WiiU 1.5.0|name=e3pfd}}

====BitIndex====
Used with BoolSelector Parameters. Also has TypeIndex, which are used to perform the check.

*2 - Unknown (believed to check if Link has any armor equipped)<ref name="e0pfd" />
*5 - Unknown (believed to check if Link is carrying an object)
*15 - Unknown. Appears in Player_WeaponEquipOn after an Attention Selector and a BitIndex 30 check, implying that it has something to do with shields.
*17 - Unknown (believed to check whether Link is airborne)
*30 - Whether or not Link has a shield equipped.<ref name="e1pcn" />
*33 - Unknown (believed to check if Link is tired)<ref name="e2pfd" />
*37 - Whether IsBlunt is set to true in the equipped weapon’s bgparamlist
*38 - Unknown (believed to check if the current weapon is on fire)
*46 - Unknown (believed to check if Link is crouched)

====Ranges====
Used with control nodes that perform a Range evaluation. If the value being compared is above the Start value and below the End value, evaluates as true. Otherwise, moves on to the next value. (Unknown what happens if none of the Ranges evaluate to true, presumably game crash)

====FrameCtrl====
Used with animation nodes. The node itself is required, even if it is empty (i.e. none of the keys are specified)
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|Rate
|float
|Speed at which to play the animation. Higher numbers are faster.
|1.0
|-
|StartFrame
|int
| -
| -
|-
|EndFrame
|int
| -
| -
|-
|LoopStopCount
|int
| -
| -
|-
|LoopStopCountRandom
|int
| -
| -
|-
|UseGlobalFrame
|bool
| -
|false
|-
|ReversePlay
|bool
| -
|false
|-
|Connect
|int
|The only observed values are 1, 2, and 3.
| -
|-
|AnmLoop
|int
|The only observed values are 1 and 2. <ref>Elements 10 and 11 of AncientDoctor_C_Face_Default.bas</ref>
| -
|-
|}

====TriggerEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. Events which are triggered during this animation.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|Frame
|int
|Which frame to fire the event on, relative to the frame numbers of the animation. Can be negative.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Used to play sound effects during animations. Known to accept any attack or enemy attack sound effect, but probably works with other sound files.<ref>Compare Event0 of TriggerEvents and Event0 of HoldEvents for most of Link's attack animations</ref>
*4 - Triggers the animation controller to transition back into the idle stance. The Frame value should be a few before the end of the actual animation, so that the controller can make the blending look natural.<ref>Compare TriggerEvent TypeIndex 4 Frame value for an animation with the number of frames in the actual animation.</ref>
*7 - Call AS. Passes the strRef to the ASList to retrieve an AS file and starts evaluating it from Element0.
*14 - Seems to indicate an enemy has entered a state of being airborne.
*28 - Play audio. Able to play any bfwav file in PlayerVoice.bars.
*29 - Seems to determine when a weapon will bind to a bone. <ref>Player_WeaponEquipOn.bas</ref>

====HoldEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. States that are entered into while the animation is playing.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|StartFrame
|int
|Which frame to start the event on, relative to the frame numbers of the animation. Unknown if it can be negative.
| -
|-
|EndFrame
|int
|Which frame to end the event on, relative to the frame numbers of the animation. A value of -1 is treated as the ending frame of the animation.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Seems to allow Link's attack animations to combo into one another. New attack elements will not combo together if there is no TypeIndex 0 present in the Hold Events.
*2 - Seems to determine when some attacks (entries in Player_CutJumpSt and others) will connect with targets. Removing TypeIndex 2 causes animations to play halfway through. TypeIndex 2 also tends to have a StartFrame somewhere near the middle of the animation, and an end frame of -1.0, indicating that it may be responsible for blending certain attack animations into one another, particularly those that loop or combine.
*3 - Defines when an attack will deal damage. Value is the damage type. Left: slashing. Stab: piercing. Lower: blunt. {{Check}}
*14 - Defines when an animation will block attack damage using Link's equipped shield.
*17 - Unknown
*22 - Unknown. Found in Link's Player_CutShieldRide.bas animation, and seems to correspond to the air effects under the board, but can't be applied to other attack animations.
*25 - Unknown. Appears to have something to do with Bone Control, as it is often observed with the !str32 Value "OnlyEye".
*35 - Unknown
*45 - Defines when to accept input to start the next attack.
*48 - Defines when to display the trails in the air during an attack.
*49 - Believed to define the animation frames during which an actor is resistant to knock back. Notably used during animations where the actor leaves the ground and in most cases, active during frames when actor is airborne.

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

Bas

2023-02-01T18:24:12Z

CEObrainz: Undo revision 11736 by CEObrainz (talk)

{{Lowercase}}
<onlyinclude>
'''bas''' files each represent an animation that can be called by an [[actor]] or [[Demo|cutscene]]. They contain a reference to an animation name, but not the animation file itself. They can be found at '''Actor/AS/{EventName}/{AnimationSequenceName}.bas''' in [[Beventpack|beventpacks]] and [[TitleBG.pack]]/Actor/AS, and '''Actor/AS/{AnimationSequenceName}.bas''' in bactorpacks.
</onlyinclude>

==Layout==
Each bas file is made up of one list of elements, named Elements. Each element (Element0, Element1, etc) can be either a test to figure out what animation to play, or a call to play the animation.

===Parameters===
All nodes have Parameters, which determine what kind of node they are. They can be a control node, which helps decide which animation to play, or an animation node, which actually plays the animation.
{| class="wikitable"
!Key
!Key Type
!Description
!Node Type
!Default value
|-
|TypeIndex
|int
|Type of node the Element is. Known types are listed below the table.
| -
| -
|-
|NoSync
|bool
| -
|Control
| -
|-
|JudgeOnce
|bool
|Tells the game to skip evaluating this node (and use the previous result) if the input value has not changed since the last time the node was run.
|Control
|False
|-
|InputLimit
|float
| -
|Control
| -
|-
|FileName
|str64
|Name of the animation to play
|Animation
| -
|-
|Morph
|int
|Time to blend the previous animation into this one. Appears to be measured in frames.
|Animation
| -
|-
|}

====Parameter TypeIndex====
Nodes with Blender are generally used to perform the same checks as those with Selector in the name, with a key difference: Blender nodes may evaluate multiple cases as true, and will blend the resulting animations together. Selector nodes will choose only the first case that evaluates to true.{{Check}}
{| class="wikitable"
!Index
!Name <ref>TypeIndex function table in the 1.5.0 [[executable]]</ref>
!Description
!Type
|-
|0
|AbsTemperatureBlender
|Current world temperature. Evaluated by float range.
|Control
|-
|1
|AbsTemperatureSelector
|Current world temperature. Evaluated by float range.
|Control
|-
|2
|ArmorSelector
|What armor is currently equipped. Used only in '''Player_Wait.bas'''. Only observed working values are <code>NoUpper</code>, <code>NoLower</code>, <code>NoAll</code>.{{#tag:ref|Element32 of Player_Wait.bas, WiiU 1.5.0|name=e32pw}} Does not appear to accept armor actor names.
|Control
|-
|3
|ArrowSelector
|Seems to check what arrow Link has equipped. However, the game only ever uses a '''StringArray''' of '''Empty''' and a default case. This is used to check whether Link has arrows in his bow, to determine how to blend his animations or to play different ones.
|Control
|-
|4
|AttentionSelector
| -
|Control
|-
|5
|BoneBlender
| -
|Control
|-
|6
|BoneVisibilityAsset
| -
| -
|-
|7
|BoolSelector
|Boolean evaluator - See [[#BitIndex]]{{#tag:ref|Element1 of Player_CutNinja.bas, WiiU 1.5.0|name=e1pcn}}{{#tag:ref|Element0 of Player_FaceDefault.bas, WiiU 1.5.0|name=e0pfd}}{{#tag:ref|Element2 of Player_FaceDefault.bas, WiiU 1.5.0|name=e2pfd}} If false, the element specified by Child0 is evaluated. If true, Child1 is evaluated.
|Control
|-
|8
|ButtonSelector
| -
|Control
|-
|9
|ChargeSelector
| -
|Control
|-
|10
|ClearMatAnmAsset
| -
| -
|-
|11
|ComboSelector
| -
|Control
|-
|12
|DiffAngleYBlender
| -
|Control
|-
|13
|DiffAngleYSelector
| -
|Control
|-
|14
|DirectionAngleBlender
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|15
|DirectionAngleSelector
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|16
|DistanceBlender
|Compares distance between Link and his current locked target{{#tag:ref|Element2 of Player_CutNinja.bas, WiiU 1.5.0|name=e2pcn}}. Evaluated by float range.
|Control
|-
|17
|DistanceSelector
|Compares distance between Link and his current locked target. Evaluated by float range.
|Control
|-
|18
|DungeonClearSelector
| -
|Control
|-
|19
|DungeonNumberSelector
| -
|Control
|-
|20
|EmotionSelector
| -
|Control
|-
|21
|EventFlagSelector
|Checks whether a GameData flag is true. The StringArray defines the flags to be checked. Known to accept 1 child plus a default case, but in a single instance there's no default case.<ref>Npc_Rito_Hearts_BandVisibilityOff.bas</ref> In another instance, both strings are flags. <ref>UR_M_Teba_Teba_DamageVisibility_On.bas</ref> If both are true, the first case evaluated as true will be run.
|Control
|-
|22
|EyeSelector
| -
|Control
|-
|23
|EyebrowSelector
| -
|Control
|-
|24
|FaceEmotionSelector
| -
|Control
|-
|25
|FootBLLifeSelector
| -
|Control
|-
|26
|FootBRLifeSelector
| -
|Control
|-
|27
|FootFLLifeSelector
| -
|Control
|-
|28
|FootFRLifeSelector
| -
|Control
|-
|29
|ForwardBentBlender
| -
|Control
|-
|30
|ForwardBentSelector
| -
|Control
|-
|31
|GearSelector
| -
|Control
|-
|32
|GenerationSelector
|Int check - Unknown<ref>Element7 of UH_C_Face_Talk.bas and Element3 of UH_C_Face_Default.bas</ref> In both referenced cases (used in NPC actorpacks), Value0 is '''2''', and Value1 is '''-2147483648''', which is the negative 32-bit integer limit.
|Control
|-
|33
|GrabTypeSelector
|Compares the [[Bgparamlist#Liftable|LiftType]] of the actor that is being grabbed/lifted (from its bgparamlist). Known to accept as many as 24 children and a default case.
|Control
|-
|34
|GroundNormalBlender
| -
|Control
|-
|35
|GroundNormalSelector
| -
|Control
|-
|36
|GroundNormalSideBlender
| -
|Control
|-
|37
|GroundNormalSideSelector
| -
|Control
|-
|38
|MaskSelector
|Checks the MaskType parameter of the currently equipped Head armor. Its children reference other elements to jump to if a matching MaskType is found, and a StringArray in its Extend determine the MaskType(s) to check for.
|Control
|-
|39
|MatVisibilityAsset
| -
| -
|-
|40
|MouthSelector
| -
|Control
|-
|41
|NoAnmAsset
|Play no animation. Used to cancel evaluation.
|Animation
|-
|42
|NoLoopStickAngleBlender
| -
|Control
|-
|43
|NoLoopStickAngleSelector
| -
|Control
|-
|44
|NodePosSelector
|Compares name of a bone, takes StrRef of the bone name. Unknown how it decides which bone name to compare the StrRef to.{{#tag:ref|Element0 of Player_LadderJump.bas, WiiU 1.5.0|name=e0plj}} Can be paired with an axis name (e.g. <code>Toe_L,Z</code>) to measure value on that axis. When used in this way, the node chooses the child corresponding to the highest value among those measured.{{#tag:ref|Element8 of UZ_M_Move_End.bas, WiiU 1.5.0|name=e8uzmme}} When no axis name is given, the vector to the origin is measured. {{Check}}
|Control
|-
|45
|PersonalitySelector
| -
|Control
|-
|46
|PostureSelector
| -
|Control
|-
|47
|PreASSelector
|Compares last played animation name, takes StrRef of animation name. Accepts up to 5 children.{{#tag:ref|Element11 of Player_CutChargeWait.bas, WiiU 1.5.0|name=e11pccw}}
|Control
|-
|48
|PreExclusionRandomSelector
| -
|Control
|-
|49
|RandomSelector
|Picks a random node from the given nodes.{{Check}}
|Control
|-
|50
|RideSelector
|Compares the profile of the mount the actor is currently riding. Known to accept one Child, plus a default case, but might accept more or less.{{Check}}
|Control
|-
|51
|RightStickAngleBlender
| -
|Control
|-
|52
|RightStickAngleSelector
| -
|Control
|-
|53
|RightStickValueBlender
| -
|Control
|-
|54
|RightStickValueSelector
| -
|Control
|-
|55
|RightStickXBlender
| -
|Control
|-
|56
|RightStickXSelector
| -
|Control
|-
|57
|RightStickYBlender
| -
|Control
|-
|58
|RightStickYSelector
| -
|Control
|-
|59
|SelfHeightSelector
| -
|Control
|-
|60
|SelfWeightSelector
| -
|Control
|-
|61
|SequencePlayContainer
|Float comparison - Unknown{{#tag:ref|Element0 of Player_Move.bas, WiiU 1.5.0|name=e0pm}}
|Control
|-
|62
|ShaderParamAsset
|Plays material animation, takes StrRef of the animation name. Its Extend uses a secondary animation name for unknown purpose.{{#tag:ref|Element1 of Player_SkinColor.bas, WiiU 1.5.0|name=e1psc}}{{#tag:ref|Element2 of Player_SkinColor.bas, WiiU 1.5.0|name=e2psc}}
|Animation
|-
|63
|ShaderParamColorAsset
| -
| -
|-
|64
|ShaderParamTexSRTAsset
|Plays texture transform animation, takes StrRef of the animation name.
|Animation
|-
|65
|SizeBlender
| -
|Control
|-
|66
|SizeSelector
| -
|Control
|-
|67
|SkeltalAsset
|Plays model animation, takes StrRef of the animation name.
|Animation
|-
|68
|SpeedBlender
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|69
|SpeedSelector
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|70
|StickAngleBlender
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|71
|StickAngleSelector
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|72
|StickValueBlender
|Range evaluation - Unknown{{#tag:ref|Element0 of Player_SwimAtnMove.bas, WiiU 1.5.0|name=e0psam}}
|Control
|-
|73
|StickValueSelector
| -
|Control
|-
|74
|StickXBlender
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|75
|StickXSelector
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|76
|StickYBlender
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|77
|StickYSelector
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|78
|StressBlender
| -
|Control
|-
|79
|StressSelector
| -
|Control
|-
|80
|SyncPlayContainer
|Synchronously plays multiple child elements
|Animation
|-
|81
|TemperatureBlender
| -
|Control
|-
|82
|TemperatureSelector
|Range evaluation - Unknown{{#tag:ref|Element1 of Player_FaceDefault.bas, WiiU 1.5.0|name=e1pfd}}
|Control
|-
|83
|TexturePatternAsset
| -
| -
|-
|84
|TimeSelector
|Checks the current time. Observed values are '''Morning_A''', '''Morning_B''', '''Evening_B''', '''Night_A''', and '''Night_B'''. '''Evening_A''' is never used, but is assumed to exist. Known to accept any number of children along with a default case.
|Control
|-
|85
|TiredBlender
| -
|Control
|-
|86
|TiredSelector
| -
|Control
|-
|87
|UseItemSelector
| -
|Control
|-
|88
|UserAngle2Blender
| -
|Control
|-
|89
|UserAngle2Selector
| -
|Control
|-
|90
|UserAngleBlender
| -
|Control
|-
|91
|UserAngleSelector
| -
|Control
|-
|92
|UserSpeedBlender
| -
|Control
|-
|93
|UserSpeedSelector
| -
|Control
|-
|94
|VariationSelector
| -
|Control
|-
|95
|WallAngleBlender
| -
|Control
|-
|96
|WallAngleSelector
| -
|Control
|-
|97
|WeaponDetailSelector
|Compares actor's equipped weapon subtype (from its bgparamlist [ProfileUser] WeaponSubtype value), takes StrRef of weapon subtype name
|Control
|-
|98
|WeaponSelector
|Compares actor's equipped weapon profile (from its bxml ProfileUser value), takes StrRef of weapon profile name
|Control
|-
|99
|WeatherSelector
| -
|Control
|-
|100
|WeightBlender
| -
|Control
|-
|101
|WeightSelector
| -
|Control
|-
|102
|WindVelocityBlender
| -
|Control
|-
|103
|YSpeedBlender
| -
|Control
|-
|104
|YSpeedSelector
| -
|Control
|-
|105
|ZEx00ExposureBlender
| -
|Control
|-
|106
|ZEx00ExposureSelector
| -
|Control
|-
|}

===Children===
Control nodes will have Children, in addition to Parameters, which determine which Element to go to after the control node is evaluated. The properties of Children will be named Child0, Child1, etc, and each will have a single integer value, which will correspond to the Element number. e.g. <code>Child0: 7</code> points to Element7.

===Extend===
All nodes have an Extend, which contains specific details about the node. Control node Extends will contain details about the comparison being performed, while animation nodes will contain information about the animation being played, such as: during which frames of the animation a weapon will deal damage if it hits something, when user input is ignored, when to draw weapon trails through the air for attack animations, etc.

====Typed Array====
A list of variables of a given type to use for various control comparisons. Corresponds directly to the Children of the node. i.e. if Value0 matches the value being compared against, the code will jump to the Element listed under Child0. If no comparison of a lower Child number has evaluated as true, automatically evaluates a Child whose value is "default" as true.{{#tag:ref|Element0 of Player_CutNinja.bas, WiiU 1.5.0|name=e0pcn}}{{#tag:ref|Element3 of Player_FaceDefault.bas, WiiU 1.5.0|name=e3pfd}}

====BitIndex====
Used with BoolSelector Parameters. Also has TypeIndex, which are used to perform the check.

*2 - Unknown (believed to check if Link has any armor equipped)<ref name="e0pfd" />
*15 - Unknown. Appears in Player_WeaponEquipOn after an Attention Selector and a BitIndex 30 check, implying that it has something to do with shields.
*17 - Unknown (believed to check whether Link is airborne)
*30 - Whether or not Link has a shield equipped.<ref name="e1pcn" />
*33 - Unknown (believed to check if Link is tired)<ref name="e2pfd" />
*37 - Whether IsBlunt is set to true in the equipped weapon’s bgparamlist
*38 - Unknown (believed to check if the current weapon is on fire)
*46 - Unknown (believed to check if Link is crouched)

====Ranges====
Used with control nodes that perform a Range evaluation. If the value being compared is above the Start value and below the End value, evaluates as true. Otherwise, moves on to the next value. (Unknown what happens if none of the Ranges evaluate to true, presumably game crash)

====FrameCtrl====
Used with animation nodes. The node itself is required, even if it is empty (i.e. none of the keys are specified)
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|Rate
|float
|Speed at which to play the animation. Higher numbers are faster.
|1.0
|-
|StartFrame
|int
| -
| -
|-
|EndFrame
|int
| -
| -
|-
|LoopStopCount
|int
| -
| -
|-
|LoopStopCountRandom
|int
| -
| -
|-
|UseGlobalFrame
|bool
| -
|false
|-
|ReversePlay
|bool
| -
|false
|-
|Connect
|int
|The only observed values are 1, 2, and 3.
| -
|-
|AnmLoop
|int
|The only observed values are 1 and 2. <ref>Elements 10 and 11 of AncientDoctor_C_Face_Default.bas</ref>
| -
|-
|}

====TriggerEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. Events which are triggered during this animation.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|Frame
|int
|Which frame to fire the event on, relative to the frame numbers of the animation. Can be negative.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Used to play sound effects during animations. Known to accept any attack or enemy attack sound effect, but probably works with other sound files.<ref>Compare Event0 of TriggerEvents and Event0 of HoldEvents for most of Link's attack animations</ref>
*4 - Triggers the animation controller to transition back into the idle stance. The Frame value should be a few before the end of the actual animation, so that the controller can make the blending look natural.<ref>Compare TriggerEvent TypeIndex 4 Frame value for an animation with the number of frames in the actual animation.</ref>
*7 - Call AS. Passes the strRef to the ASList to retrieve an AS file and starts evaluating it from Element0.
*14 - Seems to indicate an enemy has entered a state of being airborne.
*28 - Play audio. Able to play any bfwav file in PlayerVoice.bars.
*29 - Seems to determine when a weapon will bind to a bone. <ref>Player_WeaponEquipOn.bas</ref>

====HoldEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. States that are entered into while the animation is playing.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|StartFrame
|int
|Which frame to start the event on, relative to the frame numbers of the animation. Unknown if it can be negative.
| -
|-
|EndFrame
|int
|Which frame to end the event on, relative to the frame numbers of the animation. A value of -1 is treated as the ending frame of the animation.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Seems to allow Link's attack animations to combo into one another. New attack elements will not combo together if there is no TypeIndex 0 present in the Hold Events.
*2 - Seems to determine when some attacks (entries in Player_CutJumpSt and others) will connect with targets. Removing TypeIndex 2 causes animations to play halfway through. TypeIndex 2 also tends to have a StartFrame somewhere near the middle of the animation, and an end frame of -1.0, indicating that it may be responsible for blending certain attack animations into one another, particularly those that loop or combine.
*3 - Defines when an attack will deal damage. Value is the damage type. Left: slashing. Stab: piercing. Lower: blunt. {{Check}}
*14 - Defines when an animation will block attack damage using Link's equipped shield.
*17 - Unknown
*22 - Unknown. Found in Link's Player_CutShieldRide.bas animation, and seems to correspond to the air effects under the board, but can't be applied to other attack animations.
*25 - Unknown. Appears to have something to do with Bone Control, as it is often observed with the !str32 Value "OnlyEye".
*35 - Unknown
*45 - Defines when to accept input to start the next attack.
*48 - Defines when to display the trails in the air during an attack.
*49 - Believed to define the animation frames during which an actor is resistant to knock back. Notably used during animations where the actor leaves the ground and in most cases, active during frames when actor is airborne.

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

Bas

2023-02-01T17:59:33Z

CEObrainz: /* BitIndex */ Added BitIndex 36

{{Lowercase}}
<onlyinclude>
'''bas''' files each represent an animation that can be called by an [[actor]] or [[Demo|cutscene]]. They contain a reference to an animation name, but not the animation file itself. They can be found at '''Actor/AS/{EventName}/{AnimationSequenceName}.bas''' in [[Beventpack|beventpacks]] and [[TitleBG.pack]]/Actor/AS, and '''Actor/AS/{AnimationSequenceName}.bas''' in bactorpacks.
</onlyinclude>

==Layout==
Each bas file is made up of one list of elements, named Elements. Each element (Element0, Element1, etc) can be either a test to figure out what animation to play, or a call to play the animation.

===Parameters===
All nodes have Parameters, which determine what kind of node they are. They can be a control node, which helps decide which animation to play, or an animation node, which actually plays the animation.
{| class="wikitable"
!Key
!Key Type
!Description
!Node Type
!Default value
|-
|TypeIndex
|int
|Type of node the Element is. Known types are listed below the table.
| -
| -
|-
|NoSync
|bool
| -
|Control
| -
|-
|JudgeOnce
|bool
|Tells the game to skip evaluating this node (and use the previous result) if the input value has not changed since the last time the node was run.
|Control
|False
|-
|InputLimit
|float
| -
|Control
| -
|-
|FileName
|str64
|Name of the animation to play
|Animation
| -
|-
|Morph
|int
|Time to blend the previous animation into this one. Appears to be measured in frames.
|Animation
| -
|-
|}

====Parameter TypeIndex====
Nodes with Blender are generally used to perform the same checks as those with Selector in the name, with a key difference: Blender nodes may evaluate multiple cases as true, and will blend the resulting animations together. Selector nodes will choose only the first case that evaluates to true.{{Check}}
{| class="wikitable"
!Index
!Name <ref>TypeIndex function table in the 1.5.0 [[executable]]</ref>
!Description
!Type
|-
|0
|AbsTemperatureBlender
|Current world temperature. Evaluated by float range.
|Control
|-
|1
|AbsTemperatureSelector
|Current world temperature. Evaluated by float range.
|Control
|-
|2
|ArmorSelector
|What armor is currently equipped. Used only in '''Player_Wait.bas'''. Only observed working values are <code>NoUpper</code>, <code>NoLower</code>, <code>NoAll</code>.{{#tag:ref|Element32 of Player_Wait.bas, WiiU 1.5.0|name=e32pw}} Does not appear to accept armor actor names.
|Control
|-
|3
|ArrowSelector
|Seems to check what arrow Link has equipped. However, the game only ever uses a '''StringArray''' of '''Empty''' and a default case. This is used to check whether Link has arrows in his bow, to determine how to blend his animations or to play different ones.
|Control
|-
|4
|AttentionSelector
| -
|Control
|-
|5
|BoneBlender
| -
|Control
|-
|6
|BoneVisibilityAsset
| -
| -
|-
|7
|BoolSelector
|Boolean evaluator - See [[#BitIndex]]{{#tag:ref|Element1 of Player_CutNinja.bas, WiiU 1.5.0|name=e1pcn}}{{#tag:ref|Element0 of Player_FaceDefault.bas, WiiU 1.5.0|name=e0pfd}}{{#tag:ref|Element2 of Player_FaceDefault.bas, WiiU 1.5.0|name=e2pfd}} If false, the element specified by Child0 is evaluated. If true, Child1 is evaluated.
|Control
|-
|8
|ButtonSelector
| -
|Control
|-
|9
|ChargeSelector
| -
|Control
|-
|10
|ClearMatAnmAsset
| -
| -
|-
|11
|ComboSelector
| -
|Control
|-
|12
|DiffAngleYBlender
| -
|Control
|-
|13
|DiffAngleYSelector
| -
|Control
|-
|14
|DirectionAngleBlender
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|15
|DirectionAngleSelector
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|16
|DistanceBlender
|Compares distance between Link and his current locked target{{#tag:ref|Element2 of Player_CutNinja.bas, WiiU 1.5.0|name=e2pcn}}. Evaluated by float range.
|Control
|-
|17
|DistanceSelector
|Compares distance between Link and his current locked target. Evaluated by float range.
|Control
|-
|18
|DungeonClearSelector
| -
|Control
|-
|19
|DungeonNumberSelector
| -
|Control
|-
|20
|EmotionSelector
| -
|Control
|-
|21
|EventFlagSelector
|Checks whether a GameData flag is true. The StringArray defines the flags to be checked. Known to accept 1 child plus a default case, but in a single instance there's no default case.<ref>Npc_Rito_Hearts_BandVisibilityOff.bas</ref> In another instance, both strings are flags. <ref>UR_M_Teba_Teba_DamageVisibility_On.bas</ref> If both are true, the first case evaluated as true will be run.
|Control
|-
|22
|EyeSelector
| -
|Control
|-
|23
|EyebrowSelector
| -
|Control
|-
|24
|FaceEmotionSelector
| -
|Control
|-
|25
|FootBLLifeSelector
| -
|Control
|-
|26
|FootBRLifeSelector
| -
|Control
|-
|27
|FootFLLifeSelector
| -
|Control
|-
|28
|FootFRLifeSelector
| -
|Control
|-
|29
|ForwardBentBlender
| -
|Control
|-
|30
|ForwardBentSelector
| -
|Control
|-
|31
|GearSelector
| -
|Control
|-
|32
|GenerationSelector
|Int check - Unknown<ref>Element7 of UH_C_Face_Talk.bas and Element3 of UH_C_Face_Default.bas</ref> In both referenced cases (used in NPC actorpacks), Value0 is '''2''', and Value1 is '''-2147483648''', which is the negative 32-bit integer limit.
|Control
|-
|33
|GrabTypeSelector
|Compares the [[Bgparamlist#Liftable|LiftType]] of the actor that is being grabbed/lifted (from its bgparamlist). Known to accept as many as 24 children and a default case.
|Control
|-
|34
|GroundNormalBlender
| -
|Control
|-
|35
|GroundNormalSelector
| -
|Control
|-
|36
|GroundNormalSideBlender
| -
|Control
|-
|37
|GroundNormalSideSelector
| -
|Control
|-
|38
|MaskSelector
|Checks the MaskType parameter of the currently equipped Head armor. Its children reference other elements to jump to if a matching MaskType is found, and a StringArray in its Extend determine the MaskType(s) to check for.
|Control
|-
|39
|MatVisibilityAsset
| -
| -
|-
|40
|MouthSelector
| -
|Control
|-
|41
|NoAnmAsset
|Play no animation. Used to cancel evaluation.
|Animation
|-
|42
|NoLoopStickAngleBlender
| -
|Control
|-
|43
|NoLoopStickAngleSelector
| -
|Control
|-
|44
|NodePosSelector
|Compares name of a bone, takes StrRef of the bone name. Unknown how it decides which bone name to compare the StrRef to.{{#tag:ref|Element0 of Player_LadderJump.bas, WiiU 1.5.0|name=e0plj}} Can be paired with an axis name (e.g. <code>Toe_L,Z</code>) to measure value on that axis. When used in this way, the node chooses the child corresponding to the highest value among those measured.{{#tag:ref|Element8 of UZ_M_Move_End.bas, WiiU 1.5.0|name=e8uzmme}} When no axis name is given, the vector to the origin is measured. {{Check}}
|Control
|-
|45
|PersonalitySelector
| -
|Control
|-
|46
|PostureSelector
| -
|Control
|-
|47
|PreASSelector
|Compares last played animation name, takes StrRef of animation name. Accepts up to 5 children.{{#tag:ref|Element11 of Player_CutChargeWait.bas, WiiU 1.5.0|name=e11pccw}}
|Control
|-
|48
|PreExclusionRandomSelector
| -
|Control
|-
|49
|RandomSelector
|Picks a random node from the given nodes.{{Check}}
|Control
|-
|50
|RideSelector
|Compares the profile of the mount the actor is currently riding. Known to accept one Child, plus a default case, but might accept more or less.{{Check}}
|Control
|-
|51
|RightStickAngleBlender
| -
|Control
|-
|52
|RightStickAngleSelector
| -
|Control
|-
|53
|RightStickValueBlender
| -
|Control
|-
|54
|RightStickValueSelector
| -
|Control
|-
|55
|RightStickXBlender
| -
|Control
|-
|56
|RightStickXSelector
| -
|Control
|-
|57
|RightStickYBlender
| -
|Control
|-
|58
|RightStickYSelector
| -
|Control
|-
|59
|SelfHeightSelector
| -
|Control
|-
|60
|SelfWeightSelector
| -
|Control
|-
|61
|SequencePlayContainer
|Float comparison - Unknown{{#tag:ref|Element0 of Player_Move.bas, WiiU 1.5.0|name=e0pm}}
|Control
|-
|62
|ShaderParamAsset
|Plays material animation, takes StrRef of the animation name. Its Extend uses a secondary animation name for unknown purpose.{{#tag:ref|Element1 of Player_SkinColor.bas, WiiU 1.5.0|name=e1psc}}{{#tag:ref|Element2 of Player_SkinColor.bas, WiiU 1.5.0|name=e2psc}}
|Animation
|-
|63
|ShaderParamColorAsset
| -
| -
|-
|64
|ShaderParamTexSRTAsset
|Plays texture transform animation, takes StrRef of the animation name.
|Animation
|-
|65
|SizeBlender
| -
|Control
|-
|66
|SizeSelector
| -
|Control
|-
|67
|SkeltalAsset
|Plays model animation, takes StrRef of the animation name.
|Animation
|-
|68
|SpeedBlender
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|69
|SpeedSelector
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|70
|StickAngleBlender
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|71
|StickAngleSelector
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|72
|StickValueBlender
|Range evaluation - Unknown{{#tag:ref|Element0 of Player_SwimAtnMove.bas, WiiU 1.5.0|name=e0psam}}
|Control
|-
|73
|StickValueSelector
| -
|Control
|-
|74
|StickXBlender
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|75
|StickXSelector
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|76
|StickYBlender
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|77
|StickYSelector
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|78
|StressBlender
| -
|Control
|-
|79
|StressSelector
| -
|Control
|-
|80
|SyncPlayContainer
|Synchronously plays multiple child elements
|Animation
|-
|81
|TemperatureBlender
| -
|Control
|-
|82
|TemperatureSelector
|Range evaluation - Unknown{{#tag:ref|Element1 of Player_FaceDefault.bas, WiiU 1.5.0|name=e1pfd}}
|Control
|-
|83
|TexturePatternAsset
| -
| -
|-
|84
|TimeSelector
|Checks the current time. Observed values are '''Morning_A''', '''Morning_B''', '''Evening_B''', '''Night_A''', and '''Night_B'''. '''Evening_A''' is never used, but is assumed to exist. Known to accept any number of children along with a default case.
|Control
|-
|85
|TiredBlender
| -
|Control
|-
|86
|TiredSelector
| -
|Control
|-
|87
|UseItemSelector
| -
|Control
|-
|88
|UserAngle2Blender
| -
|Control
|-
|89
|UserAngle2Selector
| -
|Control
|-
|90
|UserAngleBlender
| -
|Control
|-
|91
|UserAngleSelector
| -
|Control
|-
|92
|UserSpeedBlender
| -
|Control
|-
|93
|UserSpeedSelector
| -
|Control
|-
|94
|VariationSelector
| -
|Control
|-
|95
|WallAngleBlender
| -
|Control
|-
|96
|WallAngleSelector
| -
|Control
|-
|97
|WeaponDetailSelector
|Compares actor's equipped weapon subtype (from its bgparamlist [ProfileUser] WeaponSubtype value), takes StrRef of weapon subtype name
|Control
|-
|98
|WeaponSelector
|Compares actor's equipped weapon profile (from its bxml ProfileUser value), takes StrRef of weapon profile name
|Control
|-
|99
|WeatherSelector
| -
|Control
|-
|100
|WeightBlender
| -
|Control
|-
|101
|WeightSelector
| -
|Control
|-
|102
|WindVelocityBlender
| -
|Control
|-
|103
|YSpeedBlender
| -
|Control
|-
|104
|YSpeedSelector
| -
|Control
|-
|105
|ZEx00ExposureBlender
| -
|Control
|-
|106
|ZEx00ExposureSelector
| -
|Control
|-
|}

===Children===
Control nodes will have Children, in addition to Parameters, which determine which Element to go to after the control node is evaluated. The properties of Children will be named Child0, Child1, etc, and each will have a single integer value, which will correspond to the Element number. e.g. <code>Child0: 7</code> points to Element7.

===Extend===
All nodes have an Extend, which contains specific details about the node. Control node Extends will contain details about the comparison being performed, while animation nodes will contain information about the animation being played, such as: during which frames of the animation a weapon will deal damage if it hits something, when user input is ignored, when to draw weapon trails through the air for attack animations, etc.

====Typed Array====
A list of variables of a given type to use for various control comparisons. Corresponds directly to the Children of the node. i.e. if Value0 matches the value being compared against, the code will jump to the Element listed under Child0. If no comparison of a lower Child number has evaluated as true, automatically evaluates a Child whose value is "default" as true.{{#tag:ref|Element0 of Player_CutNinja.bas, WiiU 1.5.0|name=e0pcn}}{{#tag:ref|Element3 of Player_FaceDefault.bas, WiiU 1.5.0|name=e3pfd}}

====BitIndex====
Used with BoolSelector Parameters. Also has TypeIndex, which are used to perform the check.

*2 - Unknown (believed to check if Link has any armor equipped)<ref name="e0pfd" />
*15 - Unknown. Appears in Player_WeaponEquipOn after an Attention Selector and a BitIndex 30 check, implying that it has something to do with shields.
*17 - Unknown (believed to check whether Link is airborne)
*30 - Whether or not Link has a shield equipped.<ref name="e1pcn" />
*33 - Unknown (believed to check if Link is tired)<ref name="e2pfd" />
*36 - Unknown (believed to check if weapon is ignited)
*37 - Whether IsBlunt is set to true in the equipped weapon’s bgparamlist
*38 - Unknown (believed to check if the current weapon is on fire)
*46 - Unknown (believed to check if Link is crouched)

====Ranges====
Used with control nodes that perform a Range evaluation. If the value being compared is above the Start value and below the End value, evaluates as true. Otherwise, moves on to the next value. (Unknown what happens if none of the Ranges evaluate to true, presumably game crash)

====FrameCtrl====
Used with animation nodes. The node itself is required, even if it is empty (i.e. none of the keys are specified)
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|Rate
|float
|Speed at which to play the animation. Higher numbers are faster.
|1.0
|-
|StartFrame
|int
| -
| -
|-
|EndFrame
|int
| -
| -
|-
|LoopStopCount
|int
| -
| -
|-
|LoopStopCountRandom
|int
| -
| -
|-
|UseGlobalFrame
|bool
| -
|false
|-
|ReversePlay
|bool
| -
|false
|-
|Connect
|int
|The only observed values are 1, 2, and 3.
| -
|-
|AnmLoop
|int
|The only observed values are 1 and 2. <ref>Elements 10 and 11 of AncientDoctor_C_Face_Default.bas</ref>
| -
|-
|}

====TriggerEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. Events which are triggered during this animation.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|Frame
|int
|Which frame to fire the event on, relative to the frame numbers of the animation. Can be negative.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Used to play sound effects during animations. Known to accept any attack or enemy attack sound effect, but probably works with other sound files.<ref>Compare Event0 of TriggerEvents and Event0 of HoldEvents for most of Link's attack animations</ref>
*4 - Triggers the animation controller to transition back into the idle stance. The Frame value should be a few before the end of the actual animation, so that the controller can make the blending look natural.<ref>Compare TriggerEvent TypeIndex 4 Frame value for an animation with the number of frames in the actual animation.</ref>
*7 - Call AS. Passes the strRef to the ASList to retrieve an AS file and starts evaluating it from Element0.
*14 - Seems to indicate an enemy has entered a state of being airborne.
*28 - Play audio. Able to play any bfwav file in PlayerVoice.bars.
*29 - Seems to determine when a weapon will bind to a bone. <ref>Player_WeaponEquipOn.bas</ref>

====HoldEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. States that are entered into while the animation is playing.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|StartFrame
|int
|Which frame to start the event on, relative to the frame numbers of the animation. Unknown if it can be negative.
| -
|-
|EndFrame
|int
|Which frame to end the event on, relative to the frame numbers of the animation. A value of -1 is treated as the ending frame of the animation.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Seems to allow Link's attack animations to combo into one another. New attack elements will not combo together if there is no TypeIndex 0 present in the Hold Events.
*2 - Seems to determine when some attacks (entries in Player_CutJumpSt and others) will connect with targets. Removing TypeIndex 2 causes animations to play halfway through. TypeIndex 2 also tends to have a StartFrame somewhere near the middle of the animation, and an end frame of -1.0, indicating that it may be responsible for blending certain attack animations into one another, particularly those that loop or combine.
*3 - Defines when an attack will deal damage. Value is the damage type. Left: slashing. Stab: piercing. Lower: blunt. {{Check}}
*14 - Defines when an animation will block attack damage using Link's equipped shield.
*17 - Unknown
*22 - Unknown. Found in Link's Player_CutShieldRide.bas animation, and seems to correspond to the air effects under the board, but can't be applied to other attack animations.
*25 - Unknown. Appears to have something to do with Bone Control, as it is often observed with the !str32 Value "OnlyEye".
*35 - Unknown
*45 - Defines when to accept input to start the next attack.
*48 - Defines when to display the trails in the air during an attack.
*49 - Believed to define the animation frames during which an actor is resistant to knock back. Notably used during animations where the actor leaves the ground and in most cases, active during frames when actor is airborne.

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

Bshop

2022-11-02T00:05:48Z

CEObrainz: /* [TableName] */

{{lowercase}}
<onlyinclude>
{{Parameter archive infobox|param_type=bshop|version=0|type=xml}}
'''ShopData''' (''bshop'') configures what items can be sold by NPCs, stock numbers and prices.
</onlyinclude>

==Parameter objects==
===Header===
{| class="wikitable"
!Key!!Type!!Description
|-
|TableNum||int||Number of tables
|-
|{{AampIndexedParam|key=Table%02d|start_idx=1}}||str64||Name of the shop table
|}

==={{Placeholder AAMP param name|name=[TableName]}} ===
{| class="wikitable"
!Key!!Type!!Description
|-
|ColumnNum||int||Number of items
|-
|{{AampIndexedParam|key=ItemSort%03d|start_idx=1}}||int||Sort value
|-
|{{AampIndexedParam|key=ItemName%03d|start_idx=1}}||str64||Item actor name
|-
|{{AampIndexedParam|key=ItemNum%03d|start_idx=1}}||int||Maximum stock
|-
|{{AampIndexedParam|key=ItemAdjustPrice%03d|start_idx=1}}||int||Value to add or subtract to the item buying price
|-
|{{AampIndexedParam|key=ItemLookGetFlg%03d|start_idx=1}}||bool||Whether to use IsGet Flag for Shop Table Visibility

This allows the item to be skipped when generating the shop table if the actor's IsGet flag is false
|-
|{{AampIndexedParam|key=ItemAmount%03d|start_idx=1}}||int||{{check}}
|}

==Example==
[[File:NpcShop.jpg|500px|right|Example]]

'''Npc_Road_010.bshop'''
<syntaxhighlight lang="yaml">
!io
version: 0
type: xml
param_root: !list
objects:
Header: !obj {TableNum: 2, Table01: !str64 Normal, Table02: !str64 Rain}
Normal: !obj
ColumnNum: 4
ItemSort001: 0
ItemName001: !str64 Item_Material_07
ItemNum001: 10
ItemAdjustPrice001: 2
ItemLookGetFlg001: false
ItemAmount001: 0
ItemSort002: 1
ItemName002: !str64 Item_Material_03
ItemNum002: 5
ItemAdjustPrice002: 2
ItemLookGetFlg002: false
ItemAmount002: 0
ItemSort003: 3
ItemName003: !str64 Item_Material_06
ItemNum003: 5
ItemAdjustPrice003: 2
ItemLookGetFlg003: false
ItemAmount003: 0
ItemSort004: 5
ItemName004: !str64 Item_Material_04
ItemNum004: 5
ItemAdjustPrice004: 1
ItemLookGetFlg004: false
ItemAmount004: 0
Rain: !obj
ColumnNum: 5
ItemSort001: 0
ItemName001: !str64 Item_Material_07
ItemNum001: 10
ItemAdjustPrice001: 0
ItemLookGetFlg001: false
ItemAmount001: 0
ItemSort002: 1
ItemName002: !str64 Item_Material_03
ItemNum002: 5
ItemAdjustPrice002: 0
ItemLookGetFlg002: false
ItemAmount002: 0
ItemSort003: 2
ItemName003: !str64 Item_Material_05
ItemNum003: 10
ItemAdjustPrice003: 0
ItemLookGetFlg003: false
ItemAmount003: 0
ItemSort004: 3
ItemName004: !str64 Item_Material_01
ItemNum004: 5
ItemAdjustPrice004: 0
ItemLookGetFlg004: false
ItemAmount004: 0
ItemSort005: 4
ItemName005: !str64 Item_Material_02
ItemNum005: 5
ItemAdjustPrice005: 0
ItemLookGetFlg005: false
ItemAmount005: 0
lists: {}
</syntaxhighlight>

[[Category:File extensions]]
[[Category:File extensions (AAMP)]]
[[Category:Actor parameter files]]

Bshop

2022-11-01T20:32:32Z

CEObrainz: /* [TableName] */ Updated ItemLookGetFlg Description

{{lowercase}}
<onlyinclude>
{{Parameter archive infobox|param_type=bshop|version=0|type=xml}}
'''ShopData''' (''bshop'') configures what items can be sold by NPCs, stock numbers and prices.
</onlyinclude>

==Parameter objects==
===Header===
{| class="wikitable"
!Key!!Type!!Description
|-
|TableNum||int||Number of tables
|-
|{{AampIndexedParam|key=Table%02d|start_idx=1}}||str64||Name of the shop table
|}

==={{Placeholder AAMP param name|name=[TableName]}} ===
{| class="wikitable"
!Key!!Type!!Description
|-
|ColumnNum||int||Number of items
|-
|{{AampIndexedParam|key=ItemSort%03d|start_idx=1}}||int||Sort value
|-
|{{AampIndexedParam|key=ItemName%03d|start_idx=1}}||str64||Item actor name
|-
|{{AampIndexedParam|key=ItemNum%03d|start_idx=1}}||int||Maximum stock
|-
|{{AampIndexedParam|key=ItemAdjustPrice%03d|start_idx=1}}||int||Value to add or subtract to the item buying price
|-
|{{AampIndexedParam|key=ItemLookGetFlg%03d|start_idx=1}}||bool||Toggles actor visibility based on related IsGet flag
|-
|{{AampIndexedParam|key=ItemAmount%03d|start_idx=1}}||int||{{check}}
|}

==Example==
[[File:NpcShop.jpg|500px|right|Example]]

'''Npc_Road_010.bshop'''
<syntaxhighlight lang="yaml">
!io
version: 0
type: xml
param_root: !list
objects:
Header: !obj {TableNum: 2, Table01: !str64 Normal, Table02: !str64 Rain}
Normal: !obj
ColumnNum: 4
ItemSort001: 0
ItemName001: !str64 Item_Material_07
ItemNum001: 10
ItemAdjustPrice001: 2
ItemLookGetFlg001: false
ItemAmount001: 0
ItemSort002: 1
ItemName002: !str64 Item_Material_03
ItemNum002: 5
ItemAdjustPrice002: 2
ItemLookGetFlg002: false
ItemAmount002: 0
ItemSort003: 3
ItemName003: !str64 Item_Material_06
ItemNum003: 5
ItemAdjustPrice003: 2
ItemLookGetFlg003: false
ItemAmount003: 0
ItemSort004: 5
ItemName004: !str64 Item_Material_04
ItemNum004: 5
ItemAdjustPrice004: 1
ItemLookGetFlg004: false
ItemAmount004: 0
Rain: !obj
ColumnNum: 5
ItemSort001: 0
ItemName001: !str64 Item_Material_07
ItemNum001: 10
ItemAdjustPrice001: 0
ItemLookGetFlg001: false
ItemAmount001: 0
ItemSort002: 1
ItemName002: !str64 Item_Material_03
ItemNum002: 5
ItemAdjustPrice002: 0
ItemLookGetFlg002: false
ItemAmount002: 0
ItemSort003: 2
ItemName003: !str64 Item_Material_05
ItemNum003: 10
ItemAdjustPrice003: 0
ItemLookGetFlg003: false
ItemAmount003: 0
ItemSort004: 3
ItemName004: !str64 Item_Material_01
ItemNum004: 5
ItemAdjustPrice004: 0
ItemLookGetFlg004: false
ItemAmount004: 0
ItemSort005: 4
ItemName005: !str64 Item_Material_02
ItemNum005: 5
ItemAdjustPrice005: 0
ItemLookGetFlg005: false
ItemAmount005: 0
lists: {}
</syntaxhighlight>

[[Category:File extensions]]
[[Category:File extensions (AAMP)]]
[[Category:Actor parameter files]]

Help:Text modding

2022-08-02T09:17:41Z

CEObrainz: /* Choices */ Tweaks to variable_kind control and choice control's unknown value.

''Breath of the Wild'' uses a very flexible system for implementing the large majority of text features in the game, including but not limited to dialogue, signboards, quest logs, item descriptions, and menus. This guide will explain how to utilize this system.

==Prerequisites==
There are two recommended toolsets for modding text:

*[[Help:Tools/Wild Bits|Wild Bits]]
*[https://github.com/NiceneNerd/Hyrule-Builder Hyrule Builder] and a text editor that supports YAML

==Accessing the files==
All text in the game is located inside the <code>content/Pack/Bootup_xxXX.pack</code> files in what are called [[message archives]]. The <code>xxXX</code> is the locale of the message contents. If you want your mod to support multiple locales, you'll need to make your text changes in every locale file you want to support.

Copy the message pack(s) you want to edit into your mod folder, then either open them with Wild Bits or unbuild your mod folder with Hyrule Builder. (If you use the latter, the new location of the message pack(s) will be <code>content/Message</code>.)

Read about [[message archives]] for more information on what the subfolders are for.

==Editing the files==
If you're modding text for an NPC, signboard, item, etc. '''that already exists''', simply find and open the corresponding file. If you're creating a '''brand-new''' NPC, signboard, or quest, you'll need to create a new file inside of the corresponding folder. The easiest way to do this is by copying an existing message file in the same folder and deleting the entirety of the <code>entries</code> section.

Message files use a key-value system, which marks different strings of text with a unique identifier. When creating new keys, the identifiers can be whatever you want, but ideally, you should make them easy to remember and be consistent. (e.g. Talk01, Talk02)

The <code>attributes</code> section, while not fully understood, seems to label the actor that is speaking the <code>contents</code> section. It is unknown if this has any effect in-game.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L120</ref>

In the game, the nodes within the <code>contents</code> section are played back top-to-bottom.

Here's an example of what a single key looks like in MSYT:<syntaxhighlight lang="yaml">
talk65:
attributes: Npc_AncientDoctor
contents:
- control:
kind: sound
unknown:
- 7
- 0
- text: "This is the "
- control:
kind: set_colour
colour: blue
- text: Hateno Ancient Tech Lab
- control:
kind: reset_colour
- text: "!"
- control:
kind: pause
length: long
- text: "\nClick, snap!"
</syntaxhighlight>

===Text nodes===
A text node is a basic container for text.

Breath of the Wild does not have built-in text wrapping, so line breaks must be specified in the message file itself. You can use [https://lisa-wolfgang.github.io/Bubble-Wrap/ Bubble Wrap] to help visualize and automatically format your text. To fit aesthetically with the game, all dialogue should be wrapped after a certain width, which the tool also does for you. However, text is often wrapped earlier than this to achieve better visual balance, i.e. to prevent there being only one or two words on a single line, or to break up the text in a way that makes sense, i.e. to emphasize an object, location, action, or task.

The game allows three lines of text per bubble for dialogue and signboards. If there are more than three lines, only the first three lines will be shown initially; the game will then prompt the player to advance the dialogue, which will repeat the process with the remaining lines. To display only one or two lines in a bubble but still have text in following bubbles, use multiple consecutive line breaks until the number of lines exceeds three.

In YAML, line breaks and double-quotes have a special structural meaning, so they cannot be used directly in your text. Instead, <code>\n</code> (for line breaks) and <code>\"</code> (for double-quotes) must be used. This is called "escaping" the characters.

When putting spaces or line breaks at the beginning or end of a text node, the entire value of the node must be surrounded by unescaped double-quotes.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L98</ref>

===Control nodes===

====Color====
A color-type control node sets the color that the text is displayed in. (Note the British-English spelling of the value of <code>kind</code> -- "colour".)<syntaxhighlight lang="yaml">
- control:
kind: set_colour
colour: blue
</syntaxhighlight>The value of <code>colour</code> is the name of the color to set: <code>blue</code>, <code>red</code>, <code>grey</code>, <code>light_green1</code>, <code>light_green4</code>, <code>light_grey</code>, or <code>orange</code>.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L62</ref>

The color setting will remain in effect until it is changed again or when the end of the <code>contents</code> section is reached. To set the color back to white, use the <code>reset_colour</code> control node:<syntaxhighlight lang="yaml">
- control:
kind: reset_colour
</syntaxhighlight>From a game design standpoint, <code>blue</code> is used for the most important bits of information in a piece of dialogue. <code>red</code> is used when this pertains to the progression of a quest or when an irreversible action is about to occur, such as a purchase or exchange. <code>grey</code> is used when the NPC talking is supposed to sound quiet, often used in combination with a text size of <code>80</code>. In the unmodded game, the other colors are only used in the menus.

====Font====
A font-type control node sets the font that the text is displayed in.<syntaxhighlight lang="yaml">
- control:
kind: font
font_kind: hylian
</syntaxhighlight>The value of <code>font_kind</code> is the name of the font to set: <code>normal</code> or <code>hylian</code>.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L43</ref>

The font setting will remain in effect until it is changed again or when the end of the <code>contents</code> section is reached.

====Icons====
An icon-type control node displays the specified icon inline with the text.<syntaxhighlight lang="yaml">
- control:
kind: icon
icon: y
</syntaxhighlight>The value of <code>icon</code> is the name of the icon to show. Options include arrows (<code>right_arrow</code>, <code>left_arrow</code>, <code>up_arrow</code>) and controller-related images (<code>gamepad</code>, <code>a</code>, <code>b</code>, <code>x</code>, <code>y</code>, <code>l</code>, <code>r</code>, <code>zl</code>, <code>zr</code>, <code>l_stick_press</code>, <code>l_stick_forward</code>, <code>l_stick_back</code>, <code>r_stick_press</code>, <code>d_pad_down</code>, <code>d_pad_left</code>, <code>d_pad_up</code>, <code>d_pad_right</code>, <code>plus</code>, <code>minus</code>).<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L47</ref>

====Pausing====
A pause-type control node "pauses" for a period of time before playing back the subsequent nodes.<syntaxhighlight lang="yaml">
- control:
kind: pause
length: long
</syntaxhighlight>The value of <code>length</code> is how long to pause for: <code>short</code>, <code>long</code>, or <code>longer</code>.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L54</ref>

The duration of a pause can also be specified in frames by using the <code>frames</code> parameter:<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L58</ref><syntaxhighlight lang="yaml">
- control:
kind: pause
frames: 30
</syntaxhighlight>It has not been tested if this assumes a 30FPS frame rate.

A common use of pauses is to break up sentences auditorily, like one would when speaking in real life. <code>short</code> is typically used after regular sentences while <code>long</code> and <code>longer</code> are used after exclamations, questions, and ponderings. The specific duration depends on the desired emphasis for the preceding sentence.

====Size====
A size-type control node sets the size that the text is displayed in:<syntaxhighlight lang="yaml">
- control:
kind: text_size
percent: 100
</syntaxhighlight>The value of <code>percent</code> is a percentage value relative to the default text size.

In the unmodded game, <code>80</code> is used for any small text, and <code>125</code> is used for any large text. Other values have not been tested for efficacy.

====Variables====
A variable-type control node inserts the value of the specified game variable into the text.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L89</ref> Examples include displaying the score of a minigame, showing the cost of the selected item, etc.<syntaxhighlight lang="yaml">
- control:
kind: variable
variable_kind: 19
name: Gerudo_CarryIce_s
</syntaxhighlight>The purpose of <code>variable_kind</code> refers to the kind of Game Flag that is referenced (this includes strings, int and float values).

The value of <code>name</code> is the name of the variable to insert.

Refer to existing in-game implementations of variables to determine how to use them in your dialogue. Usage of variables requires the associated event to be configured to set them.

===Dialogue-only control nodes===

====Animations====
An animation-type control node plays an animation on the currently speaking NPC.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L24</ref><syntaxhighlight lang="yaml">
- control:
kind: animation
name: Think_00
</syntaxhighlight>The value of <code>name</code> refers to the name of an animation defined in the speaking NPC's <code>.bfres</code> file in <code>content/Model</code>. You can use [[Help:Tools/Switch Toolbox|Switch Toolbox]] to browse the available animations.

====Auto-advance====
An auto-advance-type control node "automatically advances" to the next dialogue bubble (without player input) after a given period of time.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L28</ref><syntaxhighlight lang="yaml">
- control:
kind: auto_advance
frames: 101
</syntaxhighlight>The value of <code>frames</code> is the number of frames to wait before auto-advancing. It has not been tested if this assumes a 30FPS frame rate.

====Choices====
A choice-type control node presents one or more selectable dialogue choices for Link.<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L32</ref><syntaxhighlight lang="yaml">
- control:
kind: choice
choice_labels:
- 9
- 10
- 11
- 12
selected_index: 0
cancel_index: 3
unknown: 8
</syntaxhighlight>If you only want to present one dialogue choice (to make NPC monologues more interactive) use the <code>single_choice</code> control node:<ref>https://github.com/polarbunny/msyt-tools/blob/master/docs/notes.txt#L69</ref><syntaxhighlight lang="yaml">
- control:
kind: single_choice
label: 9
</syntaxhighlight>The text for dialogue choices is not defined directly. It must be defined in keys whose identifiers are four-digit numbers surrounded by double-quotes. (e.g. <code>"0009"</code>, which corresponds with the <code>9</code> under <code>choice_labels</code>)

The value of <code>selected_index</code> is the choice that is selected by default when the choice selector appears, based off of a zero-indexed list (where 0 is first, 1 is second, 2 is third, and 3 is fourth) of the <code>choice_labels</code>. It does '''not''' refer to choices with the same number system as labels. For example, trying to put <code>9</code> as the value of <code>selected_index</code> in the example above would not work because the list is only four items long; in that case, you would want to put <code>0</code>. From a game design standpoint, this should usually refer to the first choice, <code>0</code>.

The value of <code>cancel_index</code> is the choice that is selected when the player presses the B button. It refers to the same zero-indexed list as <code>selected_index</code>. From a game design standpoint, this should usually refer to the last choice.

As implied by its name, the purpose of <code>unknown</code> is not understood. It has been observed that in instances where dialogue choices only include two options, the unknown field is set to <code>6</code>. Similarly for cases where there are 3 or 4 options the values <code>8</code> and <code>10</code> are used respectively.

To implement branching-path dialogue with this control node, the associated event flow must have the switch-type event <code>EventSystemActor::GeneralChoiceX</code>, where <code>X</code> is the number of choices available.

====Sounds====
A sound-type control node plays a sound effect from the currently speaking NPC.<syntaxhighlight lang="yaml">
- control:
kind: sound
unknown:
- 7
- 0
</syntaxhighlight>The numbers under <code>unknown</code> are not fully understood. However, it ''is'' known that with the bottom number set to 0, certain values of the top number have the following behaviors:
{| class="wikitable"
|+
!
!Facial Emotion
!Sound
|-
|0
|Normal
|No
|-
|1
|Pleasure
|No
|-
|2
|Anger
|No
|-
|3
|Sorrow
|No
|-
|4
|Shock
|No
|-
|5
|Thinking
|No
|-
|6
|Normal
|Yes
|-
|7
|Pleasure
|Yes
|-
|8
|Anger
|Yes
|-
|9
|Sorrow
|Yes
|-
|10
|Shock
|Yes
|-
|11
|Thinking
|Yes
|}
There is also a <code>sound2</code> control node. It is unknown how this differs from the <code>sound</code> control node.

==Saving the files==
If you're using Wild Bits, make sure that you save every file you edit. However, this only "saves" to a temporary unsaved version of the message pack. When you're done, '''remember to save the entire pack''' in the SARC tab. Remember to update the mod in your mod-management software.

If you're using Hyrule Builder, simply ensure that your files are saved from the text editor. You'll need to create a new build of your mod folder every time you want to test changes to your mod. Remember to update the mod in your mod-management software.

If you encounter issues, make sure that the indentation in your message files matches the examples in this guide. The YAML format is strict with this because the indentations have special structural meaning.

==References==
<references />

AIDef:Action/ChangeEmotion

2022-07-31T21:01:47Z

CEObrainz: /* DynamicInstParams */

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

== DynamicInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| EmotionType || String || ||
List of Emotion Values:
* Normal
* Thinking
* Sorrow
* Pleasure
* Anger

|-
| IsOnlyFace || Bool || || Whether the Emotion affects only facial animations or the entire model.
|-
|}

== Derived definitions ==
=== Demo_ChangeEmotion (HeroSoulGift_Rito) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=HeroSoulGift_Rito
}}
No overridden parameters.
=== Demo_ChangeEmotion (HiddenKorokAir) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=HiddenKorokAir
}}
No overridden parameters.
=== Demo_ChangeEmotion (HeroSoulGift_Gerudo) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=HeroSoulGift_Gerudo
}}
No overridden parameters.
=== Demo_ChangeEmotion (DemoWaitNpcWithWarpEffect) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=DemoWaitNpcWithWarpEffect
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcHearts) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcHearts
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcRunner) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcRunner
}}
No overridden parameters.
=== Demo_ChangeEmotion (ZoraHeroRelicBattle) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=ZoraHeroRelicBattle
}}
No overridden parameters.
=== Demo_ChangeEmotion (Npc) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=Npc
}}
No overridden parameters.
=== Demo_ChangeEmotion (HeroSoulGift_Zora) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=HeroSoulGift_Zora
}}
No overridden parameters.
=== Demo_ChangeEmotion (DemoNpc) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=DemoNpc
}}
No overridden parameters.
=== Demo_ChangeEmotion (GreatGoddesStatue) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=GreatGoddesStatue
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcTripMaster) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcTripMaster
}}
No overridden parameters.
=== Demo_ChangeEmotion (Npc_Gerudo_Queen) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=Npc_Gerudo_Queen
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcTravelerWarrior) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcTravelerWarrior
}}
No overridden parameters.
=== Demo_ChangeEmotion (HeroSoulGift_Goron) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=HeroSoulGift_Goron
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcTravelerRider) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcTravelerRider
}}
No overridden parameters.
=== Demo_ChangeEmotion (Assassin) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=Assassin
}}
No overridden parameters.
=== Demo_ChangeEmotion (Beacon_CookSet) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=Beacon_CookSet
}}
No overridden parameters.
=== Demo_ChangeEmotion (AncientOven) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=AncientOven
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcHorseGod) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcHorseGod
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcTeba) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcTeba
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcTravelerWarriorRider) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcTravelerWarriorRider
}}
No overridden parameters.
=== Demo_ChangeEmotion (FldObj_DLC_HeroMap_Relief) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=FldObj_DLC_HeroMap_Relief
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcHorseReceptionistDummy) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcHorseReceptionistDummy
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcHorseReceptionist) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcHorseReceptionist
}}
No overridden parameters.
=== Demo_ChangeEmotion (GoronHeroDescendent) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=GoronHeroDescendent
}}
No overridden parameters.
=== Demo_ChangeEmotion (DemoWaitNpc) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=DemoWaitNpc
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcStrangeBeacon2) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcStrangeBeacon2
}}
No overridden parameters.
=== Demo_ChangeEmotion (ArmorProcessingFairy) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=ArmorProcessingFairy
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcUseBasicSignal) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcUseBasicSignal
}}
No overridden parameters.
=== Demo_ChangeEmotion (HiddenKorok) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=HiddenKorok
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcVisibleTogglable) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcVisibleTogglable
}}
No overridden parameters.
=== Demo_ChangeEmotion (BackseatKorok) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=BackseatKorok
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcTebaTraining) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcTebaTraining
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcMamonoShop) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcMamonoShop
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcWarrior) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcWarrior
}}
No overridden parameters.
=== Demo_ChangeEmotion (NPCOnlyWait) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NPCOnlyWait
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcChaseBlueFire) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcChaseBlueFire
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcTraveler) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcTraveler
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcArtist) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcArtist
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcClerk) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcClerk
}}
No overridden parameters.
=== Demo_ChangeEmotion (DemoNpc_DekuTree) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=DemoNpc_DekuTree
}}
No overridden parameters.
=== Demo_ChangeEmotion (NpcUmayadoMaster) ===
{{AIDefDerived
|name=Demo_ChangeEmotion
|group_name=
|derived_from=ChangeEmotion
|aiprog=NpcUmayadoMaster
}}
No overridden parameters.

Help:Sound modding

2022-04-30T19:16:13Z

CEObrainz: /* Prerequisites */ removed link to NW4F Wave converter as GitHub contains Nintendo Copyrighted material.

You'll need to understand the files in this game and how they work to get a good grasp on what you need to do to achieve the goals you want. This guide will show you how replace simple tracks in the game with ones you want. An illustrated guide can be found [https://gamebanana.com/tuts/13088 here] To replace bigger/more complex tracks, follow the advanced guide here (tutorial incomplete/not made yet).

To see what can be done in music modding and have a reference point, there are examples such as [https://gamebanana.com/gamefiles/10178 Lylah's Complete Music Overhaul] which has modded over 210 music files in the game that function just how the base game's files do, employing the methods found here.

==The 4 main sound files==
There are 4 types of files you mostly need to concern yourself with in music modding:

*'''BFSTM''' (.bfstm) "Binary Cafe Stream" files
*'''BFSTP''' (.bfstp) "Binary Cafe Stream Prefetch" files
*'''BFWAV''' (.bfwav) "Binary Cafe Wave" files
*'''Bars''' (.bars) files

BFSTMs are the main music files in this game, which you can find under content/Sound/Resource/Stream in the unpacked base game folder and DLC music in the Update Data folder. When making a mod, always treat it as an 'update' so anything you make goes in one 'content' file structure.

BFSTPs are essentially the precursor of BFSTMs. A lot of BFSTMs can't play immediately as the game has to load them in, so in order to avoid that, there are "prefetch" files for each of these BFSTMs that contain compressed data of their respective file and only play for 1 second before switching over to the BFSTM to play the rest. These are known as BFSTPs.

BFWAVs are another type of music file that are only for smaller sounds, short events, almost every sound effect in the game, etc.

'''All''' BFWAVs and BFSTPs are contained within '''Bars''' files. Bars files are simply containers for these files, and can contain multiple BFSTPs or BFWAVs within them if they concern one object/category (e.g: Guardian sword sfx). These can be found under content/Sound/Resource in the update folder for the game data.

'''IMPORTANT:''' ''This game's sound files have a sample rate '''32000Hz''' for the Wii U version, and '''48000Hz''' for the Switch version. The music you get from Youtube and most MP3s are usually in '''44100Hz''' or above, so make sure to convert before you start working on your new files. All your music mods should be using the appropriate sample rate to avoid distortions and glitches.''

For simple files, such as the one that plays near the Temple of Time, you only need to worry about 1 BFSTM file. In this case: the file would be ''BGM_Spot_TempleOfTime.bfstm''. This goes for other BGM_Spot files you may want to mod. However, if you want to replace the music for things that can start spontaneously, such as a Guardian battle (Stalkers/Skywatchers), that has at least 5 files associated with it: ''BGM_Guardian_main.bfstm'', ''BGM_Guardian_outro.bfstm'', and '''GuardianBGM.bars''' which contains BGM_Guardian_main.'''bfstp''' and BGM_Guardian_outro.'''bfstp'''.
This guide will go through how to replace the Temple of Time music as an example, and then the Guardian BGM later as it needs more steps. To mod only the former, only the 1st and 2nd resources listed below are required, but it is recommended to obtain everything in the list to make modding simpler in the future.

==Prerequisites==

#A music editing software of your choice, e.g: Wavepad Sound Editor or Audacity
#[https://github.com/libertyernie/LoopingAudioConverter/releases Looping Audio Converter]
#[https://github.com/NanobotZ/bfstp-fixer bfstp fixer]
#[https://github.com/aboood40091/BCFSTM-BCFWAV-Converter BCFSTM-BCFWAV Converter]
#Python 3.7
#[https://github.com/NanobotZ/BarsTool/releases Bars Tool]
#VLC Media player for previewing BFSTM files (not necessary but highly recommended)
#NW4F Wave converter for converting Wav files to BFWAV
#[https://www.foobar2000.org/ Foobar2000 Media Player] and [https://www.foobar2000.org/components/view/foo_input_vgmstream vgmStream plugin] for previewing/converting BFWAV files

==Creating a new sound==
Using the Temple of Time as an example, the fundamentals of this guide apply to any future tracks you make in terms of looping.

First, preview the actual original game file you're replacing so that you are aware of how long it is and what constraints you should roughly keep your new file in (there's nothing wrong with making a loop a minute or so longer than normal for BGM_Spots, but it is not recommended for other tracks as it may function abnormaly).

===Creating a loop===
Assuming you have a file or sample you want to use, open it up in a sound editor or software of your choice. This guide uses Wavepad, as it is perfect for this type of editing.
[[File:Wavepad_Demo_1.png|thumb|A file open in Wavepad, the sample rate is 41000Hz, which must be converted to 32000Hz before edits are made.]]

====Editing the sound====
Make the edits as you wish to your file, such as volume adjustment (ideally near the original file's), reverb, fades, equalising, mixing, etc. If the file is very 'droney' (like a choir) with little percussion or fades out, you can do an easy trick as shown below.
[[File:Wavepad_Demo_2,_Selecting_Intro.png|thumb|A zoomed in image of the selection process in Wavepad to create a seamless loop from the outro back into the main song.]]
Select a portion of the beginning of the song, find out precisely what ''sample'' you have selected it to (A sample is the most precise unit of song editing, as milliseconds are too imprecise here), and note it down. Then copy/paste your selection onto a new file and give it a fade in. After that, copy that file and paste mix it into the last part of the original song you are using so the intro fades in while the outro fades out.
Make a note of where your '''new endpoint''' for the song is (in samples, not milliseconds), and delete any excess space after that. If for some reason the editor you're using doesn't show the ''sample'', get as accurate a time as possible (down to the one-thousanths of a second), and multiply that time, in seconds, by the sample rate of the file (e.g. 7.052 seconds * 48000Hz = 338,496 sample).

IMPORTANT: When you are creating a loop, you must ensure that the start point and end point of the loop are ideally when the wave form reaches 0 amplitude, and one wave is coming up while the other is going down, to ensure optimal flow. This is how you achieve seamless loops. Failure to adhere to these principles means skips, clicks, 'pops' or static will be heard when the song loops.

Save your file as a .wav and then open it up in '''Looping Audio Converter'''.

====Entering loop data====
When opening Looping Audio Converter, the setup should remain relatively untouched apart from 3 areas:

*Save directory (can be anywhere you want that's the easiest to access)
*Output Format (should be BFSTM)
*Loop Information option (should be set to 'Ask for all files')

[[File:File_open_in_Looping_Audio_Converter.png|thumb|The parameters highlighted should be the only ones changed to what is seen. The directory can be set to the quickest place to grab the outputted file from (e.g: Desktop)]]
Click 'Start' and then a prompt should appear allowing you to enter your loop data in samples, which will be simple since you made a note of the points earlier. Ensure the 'Enable' and 'Loop' boxes are checked, and click 'Okay'. This should output your wav as a BFSTM with the loop data written onto it. Rename your new track to the original name of the track you wanted to replace. It is now ready to be used in your mod. BFSTMs are stored under content/Sound/Resource/Stream.

====Tracks that require a prefetch (.bfstp)====
Some tracks need to be loaded in by a one-second prefetch that contains compressed data of the BFSTM, and you can find these by analysing the list of .bars file to see if your track has one. All sound effects and battle themes have a bfstp stored inside a respective .bars file, e.g: ''GuardianBGM.bars'' contains the prefetches for the main Guardian theme and outro. Assuming you followed the same looping steps as mentioned above, you should have a Guardian_Main theme that loops, and a Guardian_Outro that does not loop (select 'Keep as non-looping' in Looping Audio Converter). Once the new BFSTMs have been made, you should follow the [https://gamebanana.com/tuts/12856 bfstp fixer] method, where you place bfstpfixer.py, BCFSTM-BCFWAV-Converter, your BFSTMs, and a .bat file with the following code:

'''For Wii U''' 
<nowiki>for /r %%i in (*.bfstm) do python main.py -format FSTP -bom 0 "%%i"</nowiki> 
<nowiki>for /r %%i in (*.bfstp) do python bfstpfixer.py "%%i"</nowiki>

'''For Switch''' 

*'''Important:''' ''The first line is used to also convert your current BFSTM(s) to use a little endian, since Looping Audio Converter converts using a big endian. Be sure to copy the new BFSTMs into your working folder after they've been converted, otherwise your audio won't play ingame.'' 

<nowiki>for /r %%i in (*.bfstm) do python main.py -format FSTM -bom 1 "%%i"</nowiki> 
<nowiki>for /r %%i in (*.bfstm) do python main.py -format FSTP -bom 1 "%%i"</nowiki> 
<nowiki>for /r %%i in (*.bfstp) do python bfstpfixer.py "%%i"</nowiki>

in the same directory and run the .bat file. This should output 2 new files for each BFSTM you had. Keep the .bfstps that have 'fixed' at the end of their name.
[[File:The_directory_of_the_BFSTP_fixer_immediately_after_running_the_.bat_file.png|thumb]]
Make a copy of the .bars file you want to modify and place it somewhere safe to work with to avoid accidentally tampering with the game's core files. Open up the new copy of the .bars file and observe the names of the specific files you want to replace. They should have a similar or identical name to the BFSTMs they are made for. Rename your new files to these names respectively, and then click 'Replace' for every file you are replacing.
[[File:A_file_open_in_Bars_Tool.png|thumb|GuardianBGM.bars open in Bars Tool, showing the various BFSTPs and BFWAVs inside.]]
A backup .bars file will be generated once you do so that contains the bars data before you made any edits, and the original file is now updated with your new data. Place the modified bars file into content/Sound/Resource of your mod folder, and your BFSTMs in content/Sound/Resource/Stream, and you should now have a working music mod without any glitches or abnormalities.

====Sound effects (SFX) and BFWAVs====
Almost every sound effect in the game is in .bfwav format, and are also stored in .bars files. Any replacement BFWAV you make has to be the shorter than or the exact same length as the original file you are modding, which you can check by opening it in Foobar2000. Assuming you have made your new sound effect in .wav format comply with this, you can simply drag it over the NW4FWaveConverter.exe and it should output a new bfwav of your file. Then, using the Bars tool as previously mentioned, replace the old bfwav with your new one and implement the new .bars file into your mod.

[[Category:Guides]]

AIDef:Action/EventAppearRupeeAction

2022-04-02T09:57:29Z

CEObrainz: /* DynamicInstParams */

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

== DynamicInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| IsVisible || Int || 0 || 0 to show Rupee Counter or 1 to hide Rupee Counter
|-
|}

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

AIDef:Query/CheckResultOfNPCConflict

2022-03-09T15:56:51Z

CEObrainz:

{{AIDef
|name=CheckResultOfNPCConflict
|type=Query
}}

Used to check the state of an NPC that is in or has recently been in combat.

{| class="wikitable"
|+ CheckResultOfNPCConflict
|-
! Outcome !! Description
|-
| 0 || Saved
|-
| 1 || Saved
|-
| 2 || Failed State (NPC was knocked out)
|-
| 3 || Whilst in combat
|}

== Derived definitions ==
=== CheckResultOfNPCConflict (HiddenKorokAir) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=HiddenKorokAir
}}
No overridden parameters.
=== CheckResultOfNPCConflict (DemoWaitNpcWithWarpEffect) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=DemoWaitNpcWithWarpEffect
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcHearts) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcHearts
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcRunner) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcRunner
}}
No overridden parameters.
=== CheckResultOfNPCConflict (ZoraHeroRelicBattle) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=ZoraHeroRelicBattle
}}
No overridden parameters.
=== CheckResultOfNPCConflict (Npc) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=Npc
}}
No overridden parameters.
=== CheckResultOfNPCConflict (DemoNpc) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=DemoNpc
}}
No overridden parameters.
=== CheckResultOfNPCConflict (GreatGoddesStatue) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=GreatGoddesStatue
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcTripMaster) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcTripMaster
}}
No overridden parameters.
=== CheckResultOfNPCConflict (Npc_Gerudo_Queen) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=Npc_Gerudo_Queen
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcTravelerWarrior) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcTravelerWarrior
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcTravelerRider) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcTravelerRider
}}
No overridden parameters.
=== CheckResultOfNPCConflict (Assassin) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=Assassin
}}
No overridden parameters.
=== CheckResultOfNPCConflict (Beacon_CookSet) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=Beacon_CookSet
}}
No overridden parameters.
=== CheckResultOfNPCConflict (AncientOven) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=AncientOven
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcHorseGod) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcHorseGod
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcTeba) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcTeba
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcTravelerWarriorRider) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcTravelerWarriorRider
}}
No overridden parameters.
=== CheckResultOfNPCConflict (FldObj_DLC_HeroMap_Relief) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=FldObj_DLC_HeroMap_Relief
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcHorseReceptionistDummy) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcHorseReceptionistDummy
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcHorseReceptionist) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcHorseReceptionist
}}
No overridden parameters.
=== CheckResultOfNPCConflict (GoronHeroDescendent) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=GoronHeroDescendent
}}
No overridden parameters.
=== CheckResultOfNPCConflict (DemoWaitNpc) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=DemoWaitNpc
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcStrangeBeacon2) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcStrangeBeacon2
}}
No overridden parameters.
=== CheckResultOfNPCConflict (ArmorProcessingFairy) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=ArmorProcessingFairy
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcUseBasicSignal) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcUseBasicSignal
}}
No overridden parameters.
=== CheckResultOfNPCConflict (HiddenKorok) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=HiddenKorok
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcVisibleTogglable) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcVisibleTogglable
}}
No overridden parameters.
=== CheckResultOfNPCConflict (BackseatKorok) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=BackseatKorok
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcTebaTraining) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcTebaTraining
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcMamonoShop) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcMamonoShop
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcWarrior) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcWarrior
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NPCOnlyWait) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NPCOnlyWait
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcChaseBlueFire) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcChaseBlueFire
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcTraveler) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcTraveler
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcArtist) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcArtist
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcClerk) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcClerk
}}
No overridden parameters.
=== CheckResultOfNPCConflict (DemoNpc_DekuTree) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=DemoNpc_DekuTree
}}
No overridden parameters.
=== CheckResultOfNPCConflict (NpcUmayadoMaster) ===
{{AIDefDerived
|name=CheckResultOfNPCConflict
|group_name=
|derived_from=CheckResultOfNPCConflict
|aiprog=NpcUmayadoMaster
}}
No overridden parameters.

Map unit

2022-03-09T10:43:00Z

CEObrainz: /* Rails */

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

There are two primary types of Rails.
{| class="wikitable"
!Name
!Description
|-
|NavigationMeshRoad
|Used by Actors that are dynamically spawned along a route
|-
|Guide
|Used to send an actor through a pre-set route via RailPoints.
|}
Rails utilize nodes ('''NavigationMeshRoadPoint''' and '''GuidePoint''') depending on the type of Rail in use. Rails are also configured to use a linear or Bezier rail type.
 
{| class="wikitable"
|+Node
!Param
!Description
!Example
!Default Value
|-
|IsAdjustPosAndDirToPoint
|Determines whether the actor will turn and face the next rail point before moving.
|false
|false
|-
|WaitFrame
|How long to wait at the current Rail Point.
|120.0
|0.0
|-
|OnFlagName
|Flag to set to On when the actor arrives at the Rail Point
|FirstOhenro_Point12
|
|-
|WaitASKeyName
|If set to wait, the AS to use whilst waiting.
|Surprised
|
|-
|Next Distance
|The Distance between the current Rail Point and the next one.
|1.0853188
|0.0
|-
|PrevDistance
|The Distance between the current Rail Point and the previous one.
|31.7270927
|0.0
|-
|Scale
|Size of Rail
|
|0, 0, 0
|-
|Rotate
|Rotation of the Rail Point
|
|0, 0, 0
|-
|Translate
|The position of the Rail Point
|[38.73703, 280.20105, -2438.69751]
|0, 0, 0
|-
|ControlPoints
|
|
|
|-
|UnitConfigName
|The Type of Rail Point
|GuidePoint
|
|}

==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||Rigid connection constraint||固定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:Query/CheckSelectPicture

2021-10-02T10:55:41Z

CEObrainz:

{{AIDef
|name=CheckSelectPicture
|type=Query
}}

This function checks whether a photograph of an actor in the player Album matches the search value. For an actor to successfully match is must have the AllRadarActor tag. Matches will occur whether the photograph was taken before or after the quest requiring it was initiated.

== DynamicInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| ActorName || String || ||
|-
|}

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

AIDef:Query/CheckManufactResult

2021-09-22T15:54:07Z

CEObrainz: /* Derived definitions */

{{AIDef
|name=CheckManufactResult
|type=Query
}}

This is used to check how to proceed when a item is selected from the crafting window. Outcome 6 is used when the player presses the cancel button.

{|class="wikitable"
! Result !! Description
|-
| 0 || Can successfully purchase
|-
| 1 || Unknown
|-
| 2 || Unknown
|-
| 3 || Insufficient recipe materials
|-
| 4 || Insufficient rupees
|-
| 5 || No space in inventory
|-
| 6 || Exit
|-
|}

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

AIDef:Query/CheckActorAction13

2021-09-22T13:36:08Z

CEObrainz:

{{AIDef
|name=CheckActorAction13
|type=Query
}}
Used to check the current action being performed by the NPC.

{|class="wikitable"
! Number !! Description
|-
| 0 || Going to Anchor
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 ||
|-
| 6 ||
|-
| 7 ||
|-
| 8 ||
|-
| 9 ||
|-
| 10 || Going to Sleep Anchor
|-
| 11 || Sleeping
|-
|}

== Derived definitions ==
=== CheckActorAction13 (HiddenKorokAir) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=HiddenKorokAir
}}
No overridden parameters.
=== CheckActorAction13 (DemoWaitNpcWithWarpEffect) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=DemoWaitNpcWithWarpEffect
}}
No overridden parameters.
=== CheckActorAction13 (NpcHearts) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcHearts
}}
No overridden parameters.
=== CheckActorAction13 (NpcRunner) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcRunner
}}
No overridden parameters.
=== CheckActorAction13 (ZoraHeroRelicBattle) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=ZoraHeroRelicBattle
}}
No overridden parameters.
=== CheckActorAction13 (Npc) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=Npc
}}
No overridden parameters.
=== CheckActorAction13 (DemoNpc) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=DemoNpc
}}
No overridden parameters.
=== CheckActorAction13 (GreatGoddesStatue) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=GreatGoddesStatue
}}
No overridden parameters.
=== CheckActorAction13 (NpcTripMaster) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcTripMaster
}}
No overridden parameters.
=== CheckActorAction13 (Npc_Gerudo_Queen) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=Npc_Gerudo_Queen
}}
No overridden parameters.
=== CheckActorAction13 (NpcTravelerWarrior) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcTravelerWarrior
}}
No overridden parameters.
=== CheckActorAction13 (NpcTravelerRider) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcTravelerRider
}}
No overridden parameters.
=== CheckActorAction13 (Assassin) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=Assassin
}}
No overridden parameters.
=== CheckActorAction13 (Beacon_CookSet) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=Beacon_CookSet
}}
No overridden parameters.
=== CheckActorAction13 (AncientOven) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=AncientOven
}}
No overridden parameters.
=== CheckActorAction13 (NpcHorseGod) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcHorseGod
}}
No overridden parameters.
=== CheckActorAction13 (NpcTeba) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcTeba
}}
No overridden parameters.
=== CheckActorAction13 (NpcTravelerWarriorRider) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcTravelerWarriorRider
}}
No overridden parameters.
=== CheckActorAction13 (FldObj_DLC_HeroMap_Relief) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=FldObj_DLC_HeroMap_Relief
}}
No overridden parameters.
=== CheckActorAction13 (NpcHorseReceptionistDummy) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcHorseReceptionistDummy
}}
No overridden parameters.
=== CheckActorAction13 (NpcHorseReceptionist) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcHorseReceptionist
}}
No overridden parameters.
=== CheckActorAction13 (GoronHeroDescendent) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=GoronHeroDescendent
}}
No overridden parameters.
=== CheckActorAction13 (DemoWaitNpc) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=DemoWaitNpc
}}
No overridden parameters.
=== CheckActorAction13 (NpcStrangeBeacon2) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcStrangeBeacon2
}}
No overridden parameters.
=== CheckActorAction13 (ArmorProcessingFairy) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=ArmorProcessingFairy
}}
No overridden parameters.
=== CheckActorAction13 (NpcUseBasicSignal) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcUseBasicSignal
}}
No overridden parameters.
=== CheckActorAction13 (HiddenKorok) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=HiddenKorok
}}
No overridden parameters.
=== CheckActorAction13 (NpcVisibleTogglable) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcVisibleTogglable
}}
No overridden parameters.
=== CheckActorAction13 (BackseatKorok) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=BackseatKorok
}}
No overridden parameters.
=== CheckActorAction13 (NpcTebaTraining) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcTebaTraining
}}
No overridden parameters.
=== CheckActorAction13 (NpcMamonoShop) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcMamonoShop
}}
No overridden parameters.
=== CheckActorAction13 (NpcWarrior) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcWarrior
}}
No overridden parameters.
=== CheckActorAction13 (NPCOnlyWait) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NPCOnlyWait
}}
No overridden parameters.
=== CheckActorAction13 (NpcChaseBlueFire) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcChaseBlueFire
}}
No overridden parameters.
=== CheckActorAction13 (NpcTraveler) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcTraveler
}}
No overridden parameters.
=== CheckActorAction13 (NpcArtist) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcArtist
}}
No overridden parameters.
=== CheckActorAction13 (NpcClerk) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcClerk
}}
No overridden parameters.
=== CheckActorAction13 (DemoNpc_DekuTree) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=DemoNpc_DekuTree
}}
No overridden parameters.
=== CheckActorAction13 (NpcUmayadoMaster) ===
{{AIDefDerived
|name=CheckActorAction13
|group_name=
|derived_from=CheckActorAction13
|aiprog=NpcUmayadoMaster
}}
No overridden parameters.

AIDef:Query/CompareGameDataInt

2021-09-20T13:38:07Z

CEObrainz: /* DynamicInstParams */

{{AIDef
|name=CompareGameDataInt
|type=Query
}}

== DynamicInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| GameDataIntName_A || String || || Value to compare against
|-
| GameDataIntName_B || String || || Value to compare
|-
| Operator || String || || Type of comparison
|-
|}

== Derived definitions ==
=== CompareGameDataInt (GameDataCalcMachine) ===
{{AIDefDerived
|name=CompareGameDataInt
|group_name=
|derived_from=CompareGameDataInt
|aiprog=GameDataCalcMachine
}}
No overridden parameters.

AIDef:Query/CheckGameDataInt

2021-09-20T13:16:55Z

CEObrainz: /* DynamicInstParams */

{{AIDef
|name=CheckGameDataInt
|type=Query
}}

== DynamicInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| GameDataIntName || String || ||
|-
| Operator || String || ||
|-
| Value || Int || ||
|-
|}

Breath of the Wild uses basic logical operators when comparing values, when using CheckGameDataInt the output will either be 1 or 0 (depending on whether the operation checked is true or false).

{|class="wikitable"
! Operator !! Description
|-
| Equal || If the GameDataIntName is Equal to the Value
|-
| NotEqual || If the GameDataIntName is not equal to the Value
|-
| GreaterThan || If the GameDataIntName is greater than the Value
|-
| GreaterThanOrEqualTo || If the GameDataIntName is greater than or equal to the Value
|-
| LessThan || If the GameDataIntName is less than the Value
|-
| LessThanOrEqualTo || If the GameDataIntName is less than or equal to the Value
|-
|}

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

AIDef:AI/ForestGiantStoneShootBattle

2021-09-17T11:29:47Z

CEObrainz: /* StaticInstParams */

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

== StaticInstParams ==
{|class="wikitable"
! Name !! Type !! Default value !! Description
|-
| ForceAttackArea || Float || ||
|-
| ShootItemName2 || String || || Actor Name for 2nd thrown item.
|-
| ShootItemRate1 || Int || || The rate at which ShootItemName is used. If set to 0 ShootItemName2 will be used 100% of the time.
|-
| ShootItemName || String || || Actor Name for thrown item.
|-
| AttackAngle || Float || ||
|-
| RetFrmGrdAtkTimer || Int || ||
|-
| RetFrmGrdAtkPrcTimer || Int || ||
|-
| RetFrmDmgAtkTimer || Int || ||
|-
| GlobalNoAtkTime || Int || ||
|-
| GlobalNoAtkTimeRnd || Int || ||
|-
| AttackIntervalIntensity || Float || ||
|-
| DisplayCheckRadius || Float || ||
|-
| IsUpdateNoticeState || Bool || ||
|-
| IsCheckLineReachable || Bool || ||
|-
|}

== Children ==
{|class="wikitable"
! Name !! Description
|-
| 戦闘攻撃 ||
|-
| 戦闘準備 ||
|-
| 近接攻撃 ||
|-
|}

== Derived definitions ==
=== 威嚇 (ForestGiant_Middle, 素手到達不能) ===
{{AIDefDerived
|name=威嚇
|group_name=素手到達不能
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant_Middle
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 100
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 戦闘 (ForestGiant_Middle, 対象高速ギア素手戦闘) ===
{{AIDefDerived
|name=戦闘
|group_name=対象高速ギア素手戦闘
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant_Middle
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 5.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 100
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 素手 (ForestGiant_Middle, 対象泳ぎ) ===
{{AIDefDerived
|name=素手
|group_name=対象泳ぎ
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant_Middle
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 100
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 待機 (ForestGiant_Middle, ナビメッシュ無し) ===
{{AIDefDerived
|name=待機
|group_name=ナビメッシュ無し
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant_Middle
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 100
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 注意 (ForestGiant_Middle, 威嚇帰還) ===
{{AIDefDerived
|name=注意
|group_name=威嚇帰還
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant_Middle
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 100
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 威嚇 (ForestGiant_Senior, 素手到達不能) ===
{{AIDefDerived
|name=威嚇
|group_name=素手到達不能
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant_Senior
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 0
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 戦闘 (ForestGiant_Senior, 対象高速ギア素手戦闘) ===
{{AIDefDerived
|name=戦闘
|group_name=対象高速ギア素手戦闘
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant_Senior
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 5.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 0
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 素手 (ForestGiant_Senior, 対象泳ぎ) ===
{{AIDefDerived
|name=素手
|group_name=対象泳ぎ
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant_Senior
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 0
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 待機 (ForestGiant_Senior, ナビメッシュ無し) ===
{{AIDefDerived
|name=待機
|group_name=ナビメッシュ無し
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant_Senior
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 0
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 注意 (ForestGiant_Senior, 威嚇帰還) ===
{{AIDefDerived
|name=注意
|group_name=威嚇帰還
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant_Senior
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 0
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 威嚇 (ForestGiant, 素手到達不能) ===
{{AIDefDerived
|name=威嚇
|group_name=素手到達不能
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 100
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 戦闘 (ForestGiant, 対象高速ギア素手戦闘) ===
{{AIDefDerived
|name=戦闘
|group_name=対象高速ギア素手戦闘
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 5.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 100
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 素手 (ForestGiant, 対象泳ぎ) ===
{{AIDefDerived
|name=素手
|group_name=対象泳ぎ
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 100
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 待機 (ForestGiant, ナビメッシュ無し) ===
{{AIDefDerived
|name=待機
|group_name=ナビメッシュ無し
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 100
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 注意 (ForestGiant, 威嚇帰還) ===
{{AIDefDerived
|name=注意
|group_name=威嚇帰還
|derived_from=ForestGiantStoneShootBattle
|aiprog=ForestGiant
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 100
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 威嚇 (StalForestGiant, 素手到達不能) ===
{{AIDefDerived
|name=威嚇
|group_name=素手到達不能
|derived_from=ForestGiantStoneShootBattle
|aiprog=StalForestGiant
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 0
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 戦闘 (StalForestGiant, 対象高速ギア素手戦闘) ===
{{AIDefDerived
|name=戦闘
|group_name=対象高速ギア素手戦闘
|derived_from=ForestGiantStoneShootBattle
|aiprog=StalForestGiant
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 5.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 0
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 素手 (StalForestGiant, 対象泳ぎ) ===
{{AIDefDerived
|name=素手
|group_name=対象泳ぎ
|derived_from=ForestGiantStoneShootBattle
|aiprog=StalForestGiant
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 0
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 待機 (StalForestGiant, ナビメッシュ無し) ===
{{AIDefDerived
|name=待機
|group_name=ナビメッシュ無し
|derived_from=ForestGiantStoneShootBattle
|aiprog=StalForestGiant
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 0
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}
=== 注意 (StalForestGiant, 威嚇帰還) ===
{{AIDefDerived
|name=注意
|group_name=威嚇帰還
|derived_from=ForestGiantStoneShootBattle
|aiprog=StalForestGiant
}}
{|class="wikitable"
! Name !! Value
|-
| ForceAttackArea || 3.0
|-
| ShootItemName2 || Giant_Bomb_Weapon
|-
| ShootItemRate1 || 0
|-
| ShootItemName || Giant_Rock_Weapon
|-
| AttackAngle || 0.785398
|-
| RetFrmGrdAtkTimer || 20
|-
| RetFrmGrdAtkPrcTimer || 30
|-
| RetFrmDmgAtkTimer || -1
|-
| GlobalNoAtkTime || 80
|-
| GlobalNoAtkTimeRnd || 16
|-
| AttackIntervalIntensity || 1.0
|-
| DisplayCheckRadius || 0.8
|-
| IsUpdateNoticeState || True
|-
| IsCheckLineReachable || False
|-
|}

Bas

2021-08-03T11:35:08Z

CEObrainz: /* BitIndex */

{{Stub}}{{Lowercase}}
<onlyinclude>
'''bas''' files each represent an animation that can be called by an [[actor]] or [[Demo|cutscene]]. They contain a reference to an animation name, but not the animation file itself. They can be found at '''Actor/AS/{EventName}/{AnimationSequenceName}.bas''' in [[Beventpack|beventpacks]] and [[TitleBG.pack]]/Actor/AS, and '''Actor/AS/{AnimationSequenceName}.bas''' in bactorpacks.
</onlyinclude>

==Layout==
Each bas file is made up of one list of elements, named Elements. Each element (Element0, Element1, etc) can be either a test to figure out what animation to play, or a call to play the animation.

===Parameters===
All nodes have Parameters, which determine what kind of node they are. They can be a control node, which helps decide which animation to play, or an animation node, which actually plays the animation.
{| class="wikitable"
!Key
!Key Type
!Description
!Node Type
!Default value
|-
|TypeIndex
|int
|Type of node the Element is. Known types are listed below the table.
| -
| -
|-
|NoSync
|bool
| -
|Control
| -
|-
|JudgeOnce
|bool
|Tells the game to skip evaluating this node (and use the previous result) if the input value has not changed since the last time the node was run.
|Control
|False
|-
|InputLimit
|float
| -
|Control
| -
|-
|FileName
|str64
|Name of the animation to play
|Animation
| -
|-
|Morph
|int
|Time to blend the previous animation into this one. (Whether this is in milliseconds or frames is currently unknown)
|Animation
| -
|-
|}

====Parameter TypeIndex====
Nodes with Blender are generally used to perform the same checks as those with Selector in the name, with a key difference: Blender nodes may evaluate multiple cases as true, and will blend the resulting animations together. Selector nodes will choose only the first case that evaluates to true.{{Check}}
{| class="wikitable"
!Index
!Name <ref>TypeIndex function table in the 1.5.0 [[executable]]</ref>
!Description
!Type
|-
|0
|AbsTemperatureBlender
|Current world temperature. Evaluated by float range.
|Control
|-
|1
|AbsTemperatureSelector
|Current world temperature. Evaluated by float range.
|Control
|-
|2
|ArmorSelector
|What armor is currently equipped. Only observed working values are <code>NoUpper</code>, <code>NoLower</code>, <code>NoAll</code>.{{#tag:ref|Element32 of Player_Wait.bas, WiiU 1.5.0|name=e32pw}} Believed to work with armor actor names.{{Check}}
|Control
|-
|3
|ArrowSelector
| -
| -
|-
|4
|AttentionSelector
| -
| -
|-
|5
|BoneBlender
| -
| -
|-
|6
|BoneVisibilityAsset
| -
| -
|-
|7
|BoolSelector
|Boolean evaluator - See [[#BitIndex]]{{#tag:ref|Element1 of Player_CutNinja.bas, WiiU 1.5.0|name=e1pcn}}{{#tag:ref|Element0 of Player_FaceDefault.bas, WiiU 1.5.0|name=e0pfd}}{{#tag:ref|Element2 of Player_FaceDefault.bas, WiiU 1.5.0|name=e2pfd}}
|Control
|-
|8
|ButtonSelector
| -
| -
|-
|9
|ChargeSelector
| -
| -
|-
|10
|ClearMatAnmAsset
| -
| -
|-
|11
|ComboSelector
| -
| -
|-
|12
|DiffAngleYBlender
| -
| -
|-
|13
|DiffAngleYSelector
| -
| -
|-
|14
|DirectionAngleBlender
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|15
|DirectionAngleSelector
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|16
|DistanceBlender
|Compares distance between Link and his current locked target{{#tag:ref|Element2 of Player_CutNinja.bas, WiiU 1.5.0|name=e2pcn}}. Evaluated by float range.
|Control
|-
|17
|DistanceSelector
|Compares distance between Link and his current locked target. Evaluated by float range.
|Control
|-
|18
|DungeonClearSelector
| -
| -
|-
|19
|DungeonNumberSelector
| -
| -
|-
|20
|EmotionSelector
| -
| -
|-
|21
|EventFlagSelector
| -
| -
|-
|22
|EyeSelector
| -
| -
|-
|23
|EyebrowSelector
| -
| -
|-
|24
|FaceEmotionSelector
| -
| -
|-
|25
|FootBLLifeSelector
| -
| -
|-
|26
|FootBRLifeSelector
| -
| -
|-
|27
|FootFLLifeSelector
| -
| -
|-
|28
|FootFRLifeSelector
| -
| -
|-
|29
|ForwardBentBlender
| -
| -
|-
|30
|ForwardBentSelector
| -
| -
|-
|31
|GearSelector
| -
| -
|-
|32
|GenerationSelector
| -
| -
|-
|33
|GrabTypeSelector
| -
| -
|-
|34
|GroundNormalBlender
| -
| -
|-
|35
|GroundNormalSelector
| -
| -
|-
|36
|GroundNormalSideBlender
| -
| -
|-
|37
|GroundNormalSideSelector
| -
| -
|-
|38
|MaskSelector
| -
| -
|-
|39
|MatVisibilityAsset
| -
| -
|-
|40
|MouthSelector
| -
| -
|-
|41
|NoAnmAsset
|Play no animation. Used to cancel evaluation.
|Animation
|-
|42
|NoLoopStickAngleBlender
| -
| -
|-
|43
|NoLoopStickAngleSelector
| -
| -
|-
|44
|NodePosSelector
|Compares name of a bone, takes StrRef of the bone name. Unknown how it decides which bone name to compare the StrRef to.{{#tag:ref|Element0 of Player_LadderJump.bas, WiiU 1.5.0|name=e0plj}} Can be paired with an axis name (e.g. <code>Toe_L,Z</code>) to measure value on that axis. When used in this way, the node chooses the child corresponding to the highest value among those measured.{{#tag:ref|Element8 of UZ_M_Move_End.bas, WiiU 1.5.0|name=e8uzmme}} When no axis name is given, the vector to the origin is measured. {{Check}}
|Control
|-
|45
|PersonalitySelector
| -
| -
|-
|46
|PostureSelector
| -
| -
|-
|47
|PreASSelector
|Compares last played animation name, takes StrRef of animation name. Known to accept two Children to test against, plus a default case, but might accept more or less.
|Control
|-
|48
|PreExclusionRandomSelector
| -
| -
|-
|49
|RandomSelector
|Picks a random node from the given nodes.{{Check}}
|Control
|-
|50
|RideSelector
|Compares the profile of the mount the actor is currently riding. Known to accept one Child, plus a default case, but might accept more or less.{{Check}}
|Control
|-
|51
|RightStickAngleBlender
| -
| -
|-
|52
|RightStickAngleSelector
| -
| -
|-
|53
|RightStickValueBlender
| -
| -
|-
|54
|RightStickValueSelector
| -
| -
|-
|55
|RightStickXBlender
| -
| -
|-
|56
|RightStickXSelector
| -
| -
|-
|57
|RightStickYBlender
| -
| -
|-
|58
|RightStickYSelector
| -
| -
|-
|59
|SelfHeightSelector
| -
| -
|-
|60
|SelfWeightSelector
| -
| -
|-
|61
|SequencePlayContainer
|Float comparison - Unknown{{#tag:ref|Element0 of Player_Move.bas, WiiU 1.5.0|name=e0pm}}
|Control
|-
|62
|ShaderParamAsset
|Plays material animation, takes StrRef of the animation name. Its Extend uses a secondary animation name for unknown purpose.{{#tag:ref|Element1 of Player_SkinColor.bas, WiiU 1.5.0|name=e1psc}}{{#tag:ref|Element2 of Player_SkinColor.bas, WiiU 1.5.0|name=e2psc}}
|Animation
|-
|63
|ShaderParamColorAsset
| -
| -
|-
|64
|ShaderParamTexSRTAsset
|Plays texture transform animation, takes StrRef of the animation name.
|Animation
|-
|65
|SizeBlender
| -
| -
|-
|66
|SizeSelector
| -
| -
|-
|67
|SkeltalAsset
|Plays model animation, takes StrRef of the animation name.
|Animation
|-
|68
|SpeedBlender
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|69
|SpeedSelector
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|70
|StickAngleBlender
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|71
|StickAngleSelector
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|72
|StickValueBlender
|Range evaluation - Unknown{{#tag:ref|Element0 of Player_SwimAtnMove.bas, WiiU 1.5.0|name=e0psam}}
|Control
|-
|73
|StickValueSelector
| -
| -
|-
|74
|StickXBlender
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|75
|StickXSelector
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|76
|StickYBlender
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|77
|StickYSelector
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|78
|StressBlender
| -
| -
|-
|79
|StressSelector
| -
| -
|-
|80
|SyncPlayContainer
|Synchronously plays multiple child elements
|Animation
|-
|81
|TemperatureBlender
| -
| -
|-
|82
|TemperatureSelector
|Range evaluation - Unknown{{#tag:ref|Element1 of Player_FaceDefault.bas, WiiU 1.5.0|name=e1pfd}}
|Control
|-
|83
|TexturePatternAsset
| -
| -
|-
|84
|TimeSelector
| -
| -
|-
|85
|TiredBlender
| -
| -
|-
|86
|TiredSelector
| -
| -
|-
|87
|UseItemSelector
| -
| -
|-
|88
|UserAngle2Blender
| -
| -
|-
|89
|UserAngle2Selector
| -
| -
|-
|90
|UserAngleBlender
| -
| -
|-
|91
|UserAngleSelector
| -
| -
|-
|92
|UserSpeedBlender
| -
| -
|-
|93
|UserSpeedSelector
| -
| -
|-
|94
|VariationSelector
| -
| -
|-
|95
|WallAngleBlender
| -
| -
|-
|96
|WallAngleSelector
| -
| -
|-
|97
|WeaponDetailSelector
|Compares actor's equipped weapon subtype (from its bgparamlist [ProfileUser] WeaponSubtype value), takes StrRef of weapon subtype name
|Control
|-
|98
|WeaponSelector
|Compares actor's equipped weapon profile (from its bxml ProfileUser value), takes StrRef of weapon profile name
|Control
|-
|99
|WeatherSelector
| -
| -
|-
|100
|WeightBlender
| -
| -
|-
|101
|WeightSelector
| -
| -
|-
|102
|WindVelocityBlender
| -
| -
|-
|103
|YSpeedBlender
| -
| -
|-
|104
|YSpeedSelector
| -
| -
|-
|105
|ZEx00ExposureBlender
| -
| -
|-
|106
|ZEx00ExposureSelector
| -
| -
|-
|}

===Children===
Control nodes will have Children, in addition to Parameters, which determine which Element to go to after the control node is evaluated. The properties of Children will be named Child0, Child1, etc, and each will have a single integer value, which will correspond to the Element number. e.g. <code>Child0: 7</code> points to Element7.

===Extend===
All nodes have an Extend, which contains specific details about the node. Control node Extends will contain details about the comparison being performed, while animation nodes will contain information about the animation being played, such as: during which frames of the animation a weapon will deal damage if it hits something, when user input is ignored, when to draw weapon trails through the air for attack animations, etc.

====Typed Array====
A list of variables of a given type to use for various control comparisons. Corresponds directly to the Children of the node. i.e. if Value0 matches the value being compared against, the code will jump to the Element listed under Child0. If no comparison of a lower Child number has evaluated as true, automatically evaluates a Child whose value is "default" as true.{{#tag:ref|Element0 of Player_CutNinja.bas, WiiU 1.5.0|name=e0pcn}}{{#tag:ref|Element3 of Player_FaceDefault.bas, WiiU 1.5.0|name=e3pfd}}

====BitIndex====
Used with BoolSelector Parameters. Also has TypeIndex, which are used to perform the check.

*2 - Unknown (believed to check if Link has any armor equipped)<ref name="e0pfd" />
*30 - Whether or not Link has a shield equipped.<ref name="e1pcn" />
*33 - Unknown (believed to check if Link is tired)<ref name="e2pfd" />
*37 - Whether IsBlunt is set to true in the equipped weapon’s bgparamlist
*46 - Unknown (believed to check if Link is crouched)

====Ranges====
Used with control nodes that perform a Range evaluation. If the value being compared is above the Start value and below the End value, evaluates as true. Otherwise, moves on to the next value. (Unknown what happens if none of the Ranges evaluate to true, presumably game crash)

====FrameCtrl====
Used with animation nodes. The node itself is required, even if it is empty (i.e. none of the keys are specified)
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|Rate
|float
|Speed at which to play the animation. Higher numbers are faster.
|1.0
|-
|EndFrame
|int
| -
| -
|-
|}

====TriggerEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. Events which are triggered during this animation.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|Frame
|int
|Which frame to fire the event on, relative to the frame numbers of the animation. Can be negative.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Unknown (believed to define when an attack begins to deal damage)<ref>Compare Event0 of TriggerEvents and Event0 of HoldEvents for most of Link's attack animations</ref>
*4 - Triggers the animation controller to transition back into the idle stance. The Frame value should be a few before the end of the actual animation, so that the controller can make the blending look natural.<ref>Compare TriggerEvent TypeIndex 4 Frame value for an animation with the number of frames in the actual animation.</ref>
*7 - Call AS. Passes the strRef to the ASList to retrieve an AS file and starts evaluating it from Element0.
*14 - Seems to indicate an enemy has entered a state of being airborne.
*28 - Play audio. Only observed with PV%03d as the value, which corresponds to bfwav files in PlayerVoice.bars, but is believed to be able to play other audio files as well.

====HoldEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. States that are entered into while the animation is playing.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|StartFrame
|int
|Which frame to start the event on, relative to the frame numbers of the animation. Unknown if it can be negative.
| -
|-
|EndFrame
|int
|Which frame to end the event on, relative to the frame numbers of the animation. A value of -1 is treated as the ending frame of the animation.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Unknown
*2 - Unknown
*3 - Defines when an attack will deal damage. Value is the damage type. Left: slashing. Stab: piercing. Lower: blunt. {{Check}}
*17 - Unknown
*25 - Unknown
*45 - Defines when to accept input to start the next attack.
*48 - Defines when to display the trails in the air during an attack.

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

QuestProduct.bquestpack

2021-03-22T16:33:52Z

CEObrainz: /* Contents */

{{resloc|locations=[[TitleBG.pack]]|path=Quest/QuestProduct.bquestpack}}
<onlyinclude>'''QuestProduct''' is the configuration file for the [[quest manager]].</onlyinclude>

Contrary to what its file extension would suggest, it is not a [[SARC]] archive, but a standard [[BYML]] file. Like all other [[:Category:Content (BotW, product)|files with "product" in their name]], QuestProduct is a machine generated file with many redundant structures which is not meant to be edited directly.

== Contents ==
The root structure is an array; each element is a dictionary that corresponds to a quest.

{|class="wikitable"
! Key !! Type !! Description
|-
| Location || str ||
|-
| Name || str || Quest name
|-
| NotPostNote || bool ||
|-
| Orderer || str || Actor name of the quest giver
|-
| QuestDependencyFlag || str || Name of Flag
|-
| QuestDependencyFlagType || str || Type of Flag
|-
| StepDependencyFlags || array ||
|-
| Steps || array ([[#Step structure]]) || Steps
|-
| Type || str || Quest type. Valid values:
* Main: Main quest
* Sub: Shrine quest
* Mini: Side quest
|}

=== Step structure ===
{|class="wikitable"
! Key !! Type !! Description
|-
| Actors || array ([[#Actor structure]]) || Quest-related AISchedule overrides when this step is active
|-
| AttentionOff || bool ||
|-
| IndicatorActors || array ([[#Indicator actor structure]]) || Yellow quest markers on the map
|-
| MessageName || str || Message name of the quest description in the UI
|-
| Name || str || Step name
|-
| NextFlag || str || Name of the flag that causes the quest to advance to this step {{check}}
|-
| UpdateStep || bool ||
|}

=== Indicator actor structure ===
{|class="wikitable"
! Key !! Type !! Description
|-
| HasFar || bool || Whether a Far version of the actor exists {{check}}
|-
| InstanceName || str || [Optional] Unique name of the actor {{check}}
|-
| Location || dict (X: float, Y: float, Z: float) || Position of the actor
|-
| Name || str || Actor name
|-
| OffFlag || str || [Optional] ?
|}

=== Actor structure ===
''Not to be confused with event flow timelines.''

{|class="wikitable"
! Key !! Type !! Description
|-
| DefaultTimeline || || See [[ActorParam/AISchedule]]
|-
| ConditionalTimelines || || See [[ActorParam/AISchedule]]
|-
| DisplayDistanceMode || || See [[ActorParam/AISchedule]]
|-
| DisableClipping || bool ||
|-
| Name || str || Name of the actor to which this AISchedule override will be bound
|-
| UniqueName || str || [Optional] Unique name of the actor to which this AISchedule override will be bound
|}

=== Example ===
Example ("Find_Impa" quest):
<source lang="yaml">
- Location: HopesPlateau
Name: Find_Impa
NotPostNote: false
Orderer: Dm_Npc_Hyrule_KingSoul
StepDependencyFlags: []

Steps:
- {AttentionOff: false, MessageName: Desc, Name: Ready, NextFlag: Find_Impa_Activated,
UpdateStep: true}

- Actors:
- <ACTOR_STRUCTURE_1>
- <ACTOR_STRUCTURE_2>
- ...
AttentionOff: false
IndicatorActors:
- HasFar: false
InstanceName: ''
Location: {X: 1772.7099609375, Y: 0.0, Z: 984.3099975585938}
Name: Npc_Kakariko001
OffFlag: ''
MessageName: Finish
Name: Finish
NextFlag: Find_Impa_Finish
UpdateStep: true

- ...
Type: Main
</source>

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

Bumii

2021-03-07T12:57:40Z

CEObrainz: /* personal */

{{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: C
* 1: N
* 2: T
* 3: S
* 4: SK
* 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]]

Normal.bwinfo

2020-11-12T11:27:25Z

CEObrainz: /* {{AampIndexedParam|key=ClimateDefines_%d}} */

{{lowercase}}
{{Resloc|type=file|path=WorldMgr/normal.bwinfo|locations=[[TitleBG.pack]]}}
{{Parameter archive infobox|param_type=bwinfo|version=0|type=winfo}}<onlyinclude>
'''normal.bwinfo''' is an [[AAMP]] file which contains parameters for the game's lighting and climates. It is read by the [[WorldMgr]] (world manager).
</onlyinclude>
= Parameter objects =
{{AampNameWarning}}
{{expand section}}

== {{AampIndexedParam|key=ClimateDefines_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Example value
|-
|WeatherType
|int
|天候状態 0:晴 1:曇 2:雨 3:雪 (0: sunny, 1: cloudy, 2: rain, 3: snow)
|0
|-
|WeatherBlueskyRate
|int
|Determines how often the sky is blue
|60
|-
|WeatherCloudyRate
|int
|Determines how often the weather is cloudy
|20
|-
|WeatherRainRate
|int
|Determines how often it's raining
|10
|-
|WeatherHeavyRainRate
|int
|Determines how often it's raining heavily
|5
|-
|WeatherStormRate
|int
|Determines how often there are thunderstorms
|5
|-
|DayLockBlueSky
|bool
|Force sunny weather during the day
|False
|-
|NightLockBlueSky
|bool
|Force sunny weather at night
|False
|-
|ClimateTemperatureDay_1000
|float
|Temperature to use during daytime if Y (height) >= 1000.0
| -28.0
|-
|ClimateTemperatureDay_0900
|float
|Temperature to use during daytime if 900.0 <= Y < 1000.0
| -28.0
|-
|ClimateTemperatureDay_0800
|float
|...
| -20.0
|-
|ClimateTemperatureDay_0700
|float
|...
| -10.0
|-
|ClimateTemperatureDay_0600
|float
|...
| -5.0
|-
|ClimateTemperatureDay_0500
|float
|...
|3.0
|-
|ClimateTemperatureDay_0400
|float
|...
|9.0
|-
|ClimateTemperatureDay_0300
|float
|...
|15.0
|-
|ClimateTemperatureDay_0200
|float
|...
|18.0
|-
|ClimateTemperatureDay_0100
|float
|...
|20.0
|-
|ClimateTemperatureDay_0000
|float
|...
|25.0
|-
|ClimateTemperatureNight_1000
|float
|Temperature to use during nighttime if Y (height) >= 1000.0
| -28.0
|-
|ClimateTemperatureNight_0900
|float
|Temperature to use during nighttime if 900.0 <= Y < 1000.0
| -28.0
|-
|ClimateTemperatureNight_0800
|float
|...
| -23.0
|-
|ClimateTemperatureNight_0700
|float
|...
| -14.0
|-
|ClimateTemperatureNight_0600
|float
|...
| -5.0
|-
|ClimateTemperatureNight_0500
|float
|...
| -2.0
|-
|ClimateTemperatureNight_0400
|float
|...
|6.0
|-
|ClimateTemperatureNight_0300
|float
|...
|13.0
|-
|ClimateTemperatureNight_0200
|float
|...
|16.0
|-
|ClimateTemperatureNight_0100
|float
|...
|18.0
|-
|ClimateTemperatureNight_0000
|float
|...
|23.0
|-
|MoistureMax
|float
| -
|20.0
|-
|MoistureMin
|float
| -
|2.5
|-
|WindPower
|float
|Power of the Wind (Paragliding, arrows, remote bombs, throwing objects)
|7.5
|-
|IgnitedLevel
|int
|1st effect : Burst to flame effect (Death Mountain effect)
2nd effect : kills monsters and destroys everything that is made of wood and food (weapons included) if activated elsewhere on the field
|0
|-
|FeatureColor
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=1.0)
|-
|CalcRayleigh
|float
| -
|1.0
|-
|CalcMieSymmetrical
|float
| -
|1.0
|-
|CalcMie
|float
| -
|1.0
|-
|CalcSfParamNear
|float
| -
|0.0
|-
|CalcSfParamAttenuation
|float
| -
|0.0
|-
|CalcAmbientIntencity
|float
| -
|1.0
|-
|CalcVolumeMaskIntencity
|float
| -
|1.0
|-
|PaletteSetSelect
|int
| The EnvAttribute to be used
|0
|-
|FogType
|int
| -
|0
|-
|ForbidComeback
|bool
| -
|False
|-
|BlueSkyRainPat
|int
|Activate the Rain Pattern
|1
|-
|}
In 1.5.0, there are 20 climate defines (0-19). Climates are configured for each [[map area]] by [[AreaData.byml]].

== {{AampIndexedParam|key=EnvAttribute_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Example value
|-
|DifUse
|bool
| -
|False
|-
|DifXang
|float
| -
|0.0
|-
|DifYang
|float
| -
|0.0
|-
|PaletteSel00
|int
| -
|0
|-
|PaletteSel01
|int
| -
|1
|-
|PaletteSel02
|int
| -
|2
|-
|PaletteSel03
|int
| -
|3
|-
|PaletteSel04
|int
| -
|4
|-
|PaletteSel05
|int
| -
|5
|-
|PaletteSel06
|int
| -
|6
|-
|PaletteSel07
|int
| -
|7
|-
|}
In 1.5.0, there are 59 EnvAttributes (0-58).

== {{AampIndexedParam|key=WeatherInfluence_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Example value
|-
|FeatureColor
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=1.0)
|-
|FeatureFogColor
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=1.0)
|-
|CalcRayleigh
|float
| -
|1.0
|-
|CalcMieSymmetrical
|float
| -
|1.0
|-
|CalcMie
|float
| -
|1.0
|-
|CalcVolumeMaskIntencity
|float
| -
|1.0
|-
|BloomThreshhold
|float
| -
|1.0
|-
|BloomIntencity
|float
| -
|1.0
|-
|AddMoisture
|float
| -
|15.0
|-
|}
In 1.5.0, there are 4 such objects.

== {{AampIndexedParam|key=Remains_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Example value
|-
|FeatureColor
|color
| -
|Color(r=1.100000023841858, g=1.100000023841858, b=1.600000023841858, a=1.0)
|-
|FeatureFogColor
|color
| -
|Color(r=0.906000018119812, g=0.6140000224113464, b=0.8659999966621399, a=1.0)
|-
|AddFog_near
|float
| -
|10.0
|-
|AddFog_far
|float
| -
|300.0
|-
|AddFog_ratio
|float
| -
|0.4
|-
|SfParam_near
|float
| -
| -50.0
|-
|SfParam_attenuation
|float
| -
|15.0
|-
|CalcRayleigh
|float
| -
|1.5
|-
|CalcMieSymmetrical
|float
| -
|1.0
|-
|CalcMie
|float
| -
|0.5
|-
|BloomThreshhold
|float
| -
|1.0
|-
|BloomIntencity
|float
| -
|1.0
|-
|CalcVolumeMaskIntencity
|float
| -
|1.0
|-
|}
In 1.5.0, there are 7 such objects.

== {{AampIndexedParam|key=EnvPalette_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Example value
|-
|BgDifColor
|color
| -
|Color(r=1.0, g=0.8420000076293945, b=0.6000000238418579, a=1.0)
|-
|BgDifIntencity
|float
| -
|2.0
|-
|FogColor
|color
| -
|Color(r=0.21299999952316284, g=0.2630000114440918, b=0.13899999856948853, a=0.0)
|-
|FogStart
|float
|
|0.0
|-
|FogEnd
|float
| -
|300.0
|-
|YFogColor
|color
|Field Fog Color
|Color(r=0.1889999955892563, g=0.45500001311302185, b=0.2630000114440918, a=0.30000001192092896)
|-
|YFogStart
|float
|Field Fog
|20.0
|-
|SkySunColorNoUse
|uint
|
|0
|-
|SkySunColor
|color
|Sun Color settings
|Color(r=0.29600000381469727, g=0.6317999958992004, b=1.0, a=12.0)
|-
|SkyIsotropicfade
|float
| -
|1.0
|-
|SfParam_near
|float
| -
| -50.0
|-
|SfParam_attenuation
|float
| -
|30.0
|-
|SfParam_horizontal
|float
| -
|2.5
|-
|afParam_attenuationForGrd
|float
| -
|4.0
|-
|afParam_attenuationForSky
|float
| -
|0.0
|-
|SkyRParam_rayleigh_amplifier
|float
| -
|1.0
|-
|SkyRParam_mie_symmetricalProperty
|float
| -
|0.6
|-
|SkyRParam_mie_amplifier
|float
| -
|128.0
|-
|AmplifierForEnvMap
|float
| -
|1.0
|-
|Cloud0_ColorBase
|color
|1st Layer Cloud Base Color
|Color(r=0.10000000149011612, g=0.15299999713897705, b=0.10499999672174454, a=1.0)
|-
|Cloud0_IntencityBase
|float
| -
|0.15
|-
|Cloud0_ColorHilight
|color
| -
|Color(r=1.0, g=0.8352940082550049, b=0.3921569883823395, a=1.0)
|-
|Cloud0_IntencityHilight
|float
| -
|0.0
|-
|Cloud0_ColorShadow
|color
| -
|Color(r=0.10000000149011612, g=0.15299999713897705, b=0.10499999672174454, a=1.0)
|-
|Cloud0_IntencityShadow
|float
| -
|0.15
|-
|Cloud0_ColorBackLight
|color
| -
|Color(r=1.0, g=0.6230000257492065, b=0.1770000010728836, a=1.0)
|-
|Cloud0_BacklightPower
|float
| -
|0.0
|-
|Cloud1_ColorBase
|color
|2nd Layer Cloud Base Color
|Color(r=1.0, g=1.0, b=1.0, a=1.0)
|-
|Cloud1_IntencityBase
|float
| -
|0.0
|-
|Cloud1_ColorHilight
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=1.0)
|-
|Cloud1_IntencityHilight
|float
| -
|0.0
|-
|Cloud1_ColorShadow
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=1.0)
|-
|Cloud1_IntencityShadow
|float
| -
|0.0
|-
|Cloud1_ColorBackLight
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=1.0)
|-
|Cloud1_BacklightPower
|float
| -
|1.6
|-
|Cloud2_ColorBase
|color
|3rd Layer Cloud Base Color
|Color(r=0.10000000149011612, g=0.15299999713897705, b=0.10499999672174454, a=1.0)
|-
|Cloud2_IntencityBase
|float
| -
|0.15
|-
|Cloud2_ColorHilight
|color
| -
|Color(r=1.0, g=0.8352940082550049, b=0.3921569883823395, a=1.0)
|-
|Cloud2_IntencityHilight
|float
| -
|0.0
|-
|Cloud2_ColorShadow
|color
| -
|Color(r=0.10000000149011612, g=0.15299999713897705, b=0.10499999672174454, a=1.0)
|-
|Cloud2_IntencityShadow
|float
| -
|0.15
|-
|Cloud2_ColorBackLight
|color
| -
|Color(r=1.0, g=0.6230000257492065, b=0.1770000010728836, a=1.0)
|-
|Cloud2_BacklightPower
|float
| -
|0.0
|-
|Cloud2NoUse
|uint
|Use Cloud
|1
|-
|CloudShadowOnOff
|bool
| -
|False
|-
|BloomOffsetStart
|float
| -
|19999.0
|-
|BloomOffsetEnd
|float
| -
|20000.0
|-
|BloomOffset
|float
| -
|0.0
|-
|BloomClampedLuminance
|float
| -
|2.0
|-
|BloomThreshhold
|float
| -
|1.0
|-
|BloomIntencity
|float
| -
|0.125
|-
|VolumeMaskColorNoUse
|uint
| -
|0
|-
|VolumeMaskColor
|color
| -
|Color(r=1.0, g=0.7639999985694885, b=0.4230000078678131, a=0.6000000238418579)
|-
|VolumeMaskIntencity
|float
| -
|0.0
|-
|AmbientIntencity
|float
| -
|1.0
|-
|Exposure
|float
| -
|0.0
|-
|}
In 1.5.0, there are 207 EnvPalettes.

== EnvPaletteStatic ==
{| class="wikitable"
!Key
!Type
!Description
!Value
|-
|rayleigh_baseHeigh
|float
| -
|15.0
|-
|mie_baseHeight
|float
| -
|1.0
|-
|mie_scatteringCoeff
|float
| -
|0.0018
|-
|mie_symmetricalPropert
|float
| -
|0.8
|-
|YFogEnd
|float
| -
|160.0
|-
|SfParam_far
|float
| -
|30000.0
|-
|SfParam_density
|float
| -
|0.85
|-
|BloomComposeColorNoUse_8_8
|uint
| -
|0
|-
|BloomLayerColor_8_8
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=0.5)
|-
|BloomLayerColorNoUse_16_16
|uint
| -
|0
|-
|BloomLayerColor_16_16
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=1.0)
|-
|BloomLayerColorNoUse_32_32
|uint
| -
|1
|-
|BloomLayerColor_32_32
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=1.0)
|-
|BloomLayerColorNoUse_64_64
|uint
| -
|1
|-
|BloomLayerColor_64_64
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=0.0)
|-
|BloomComposeColor
|color
| -
|Color(r=1.0, g=1.0, b=1.0, a=1.0)
|-
|}

== {{AampIndexedParam|key=EnvPalette_CdanAddFog%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Value
|-
|DungeonFogFogEnd
|float
| -
|200.0
|-
|DungeonFogVolA
|float
| -
|4.0
|-
|}
In 1.5.0, there are 4 such objects.

== IndoorPalette ==
{| class="wikitable"
!Key
!Type
!Description
!Value
|-
|FeatureColor
|color
| -
|Color(r=0.5, g=0.2750000059604645, b=0.23250000178813934, a=0.699999988079071)
|-
|CalcVolumeMaskIntencity
|float
| -
|0.7
|-
|BloomClampedLuminance
|float
| -
|3.0
|-
|BloomThreshhold
|float
| -
|0.95
|-
|BloomIntencity
|float
| -
|0.26
|-
|IndoorFogRatio
|float
| -
|0.175
|-
|IndoorFogStart
|float
| -
|1.0
|-
|IndoorFogEnd
|float
| -
|12.0
|-
|attenuationForGrd
|float
| -
|1.0
|-
|}

== DofMgrParam ==
{| class="wikitable"
!Key
!Type
!Description
!Value
|-
|DefaultDist
|float
|Depth of Field Default Distance
|3000.0
|-
|DefaultF
|float
| -
|22.0
|-
|DefaultBlur
|float
|Depth of Field Default Blur
|0.7
|-
|RemainsDist
|float
| -
|300.0
|-
|RemainsF
|float
| -
|2.0
|-
|RemainsBlur
|float
| -
|1.0
|-
|LockOnF
|float
| -
|2.5
|-
|LockOnBlur
|float
|Depth of Field Default Lock On Blur
|1.0
|-
|}

== {{AampIndexedParam|key=PrCloud_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Example value
|-
|ScrollSpd
|float
| -
| -0.9
|-
|NoiseAdd1
|float
| -
| -1.0
|-
|NoiseAdd2
|float
| -
| -6.0
|-
|NoiseAdd1_side
|float
| -
| -3.0
|-
|NoiseAdd2_side
|float
| -
|3.0
|-
|PosDensityChgRange
|float
| -
|0.7
|-
|PosDensityChgPower
|float
| -
| -0.425
|-
|PosDensityChgSpeed
|float
| -
|0.001
|-
|WindVecAdd
|float
| -
|0.6
|-
|BaseTextureNo
|int
| -
|0
|-
|NoiseTextureNo
|int
| -
|1
|-
|bCloudTexBlend
|bool
| -
|False
|-
|CloudTexBlendRate
|float
| -
|0.0
|-
|BaseTextureNo_Blend
|int
| -
|2
|-
|NoiseTextureNo_Blend
|int
| -
|1
|-
|}

== {{AampIndexedParam|key=PrCloudV0_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Value
|-
|Distotion
|float
| -
|0.6
|-
|DistotionMax
|float
| -
|0.7
|-
|DistotionMin
|float
| -
|0.5
|-
|DistotionSinSeedAdd
|float
| -
|0.01
|-
|Density
|float
| -
|0.35
|-
|DensityMax
|float
| -
|0.4
|-
|DensityMin
|float
| -
|0.2
|-
|DensitySinSeedAdd
|float
| -
|0.01
|-
|AlphaMul
|float
| -
|0.4
|-
|AlphaMulMax
|float
| -
|0.7
|-
|AlphaMulMin
|float
| -
|0.4
|-
|AlphaMulSinSeedAdd
|float
| -
|0.01
|-
|AlphaThreshold
|float
| -
|0.7
|-
|AlphaThresholdMax
|float
| -
|0.75
|-
|AlphaThresholdMin
|float
| -
|0.5
|-
|AlphaThresholdSinSeedAdd
|float
| -
|0.01
|-
|BaseTexScale
|float
| -
|1.5
|-
|BaseTexScaleMax
|float
| -
|2.25
|-
|BaseTexScaleMin
|float
| -
|1.5
|-
|BaseTexScaleSinSeedAdd
|float
| -
|0.0001
|-
|EmbossWidth
|float
| -
|0.05
|-
|EmbossDensity
|float
| -
| -0.0066
|-
|ShadowPower
|float
| -
|0.1
|-
|HighlightPower
|float
| -
|0.01
|-
|HighlightRange
|float
| -
|1.3
|-
|HighlightAmbient
|float
| -
|0.05
|-
|SkyHeight
|float
| -
|8000.0
|-
|SkyHeightMax
|float
| -
|8500.0
|-
|SkyHeightMin
|float
| -
|7500.0
|-
|SkyHeightSinSeedAdd
|float
| -
|0.01
|-
|BacklightPowe
|float
| -
|1.5
|-
|BacklightRange
|float
| -
|0.5
|-
|BacklightParam0
|float
| -
|0.25
|-
|BacklightParam1
|float
| -
|0.7
|-
|DarkSideNoiseParam
|float
| -
|1.0
|-
|LightSideNoiseParam
|float
| -
|0.25
|-
|}

== {{AampIndexedParam|key=PrCloudV1_%d}} ==
See above.

== SunParam ==
{| class="wikitable"
!Key
!Type
!Description
!Value
|-
|SunSlope
|float
| -
| -1.1
|-
|SunMoonDispDist
|float
| -
| -23000.0
|-
|SunScale
|float
| -
|1800.0
|-
|MoonScale
|float
| -
|2400.0
|-
|SunDirYStop
|float
| -
| -42000.0
|-
|}

== {{AampIndexedParam|key=SkyPalette0_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Example value
|-
|Sky0PosDensityChgPower
|float
| -
|0.0
|-
|Sky0Height
|float
| -
|8000.0
|-
|Sky0Distotion
|float
| -
|0.6
|-
|Sky0Density
|float
| -
|0.3
|-
|Sky0AlphaMul
|float
| -
|0.7
|-
|Sky0AlphaThreshold
|float
| -
|0.65
|-
|Sky0BaseTexScale
|float
| -
|1.75
|-
|Sky0TexBlendRatio
|float
| -
|0.25
|-
|}

== {{AampIndexedParam|key=SkyPalette2_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Value
|-
|Sky2PosDensityChgPower
|float
| -
|0.0
|-
|Sky2Height
|float
| -
|6500.0
|-
|Sky2Distotion
|float
| -
|0.6
|-
|Sky2Density
|float
| -
|0.3
|-
|Sky2AlphaMul
|float
| -
|0.9
|-
|Sky2AlphaThreshold
|float
| -
|0.8
|-
|Sky2BaseTexScale
|float
| -
|2.0
|-
|Sky2TexBlendRatio
|float
| -
|0.0
|-
|}

== {{AampIndexedParam|key=CloudPat0_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Value
|-
|0Height
|float
| -
|7000.0
|-
|0Distotion
|float
| -
|0.6
|-
|0Density
|float
| -
|0.52
|-
|0AlphaMul
|float
| -
|0.95
|-
|0AlphaThreshold
|float
| -
|0.876
|-
|0TexBlendRatio
|float
| -
|0.7
|-
|}

== {{AampIndexedParam|key=CloudPat2_%d}} ==
See above.

== {{AampIndexedParam|key=CloudSpd_%d}} ==
{| class="wikitable"
!Key
!Type
!Description
!Value
|-
|CLOUDPAT_noisePow
|float
| -
|0.5
|-
|CLOUDPAT_windPow
|float
| -
|1.5
|-
|}

= Parameter lists =
{{No AAMP param}}
[[Category:Content (BotW)]]

Bshop

2020-10-09T14:32:09Z

CEObrainz: Typo Fix

{{lowercase}}
<onlyinclude>
{{Parameter archive infobox|param_type=bshop|version=0|type=xml}}
'''ShopData''' (''bshop'') configures what items can be sold by NPCs, stock numbers and prices.
</onlyinclude>
== Parameter objects ==
=== Header ===
{|class="wikitable"
! Key !! Type !! Description
|-
| TableNum || int || Number of tables
|-
| {{AampIndexedParam|key=Table%02d|start_idx=1}} || str64 || Name of the shop table
|}

=== {{Placeholder AAMP param name|name=[TableName]}} ===
{|class="wikitable"
! Key !! Type !! Description
|-
| ColumnNum || int || Number of items
|-
| {{AampIndexedParam|key=ItemSort%03d|start_idx=1}} || int || Sort value
|-
| {{AampIndexedParam|key=ItemName%03d|start_idx=1}} || str64 || Item actor name
|-
| {{AampIndexedParam|key=ItemNum%03d|start_idx=1}} || int || Maximum stock
|-
| {{AampIndexedParam|key=ItemAdjustPrice%03d|start_idx=1}} || int || Value to add or subtract to the item buying price
|-
| {{AampIndexedParam|key=ItemLookGetFlg%03d|start_idx=1}} || bool || Whether the player sees a Get demo after buying {{check}}
|-
| {{AampIndexedParam|key=ItemAmount%03d|start_idx=1}} || int || {{check}}
|}

== Example ==
[[File:NpcShop.jpg|500px|right|Example]]

'''Npc_Road_010.bshop'''
<syntaxhighlight lang="yaml">
!io
version: 0
type: xml
param_root: !list
objects:
Header: !obj {TableNum: 2, Table01: !str64 Normal, Table02: !str64 Rain}
Normal: !obj
ColumnNum: 4
ItemSort001: 0
ItemName001: !str64 Item_Material_07
ItemNum001: 10
ItemAdjustPrice001: 2
ItemLookGetFlg001: false
ItemAmount001: 0
ItemSort002: 1
ItemName002: !str64 Item_Material_03
ItemNum002: 5
ItemAdjustPrice002: 2
ItemLookGetFlg002: false
ItemAmount002: 0
ItemSort003: 3
ItemName003: !str64 Item_Material_06
ItemNum003: 5
ItemAdjustPrice003: 2
ItemLookGetFlg003: false
ItemAmount003: 0
ItemSort004: 5
ItemName004: !str64 Item_Material_04
ItemNum004: 5
ItemAdjustPrice004: 1
ItemLookGetFlg004: false
ItemAmount004: 0
Rain: !obj
ColumnNum: 5
ItemSort001: 0
ItemName001: !str64 Item_Material_07
ItemNum001: 10
ItemAdjustPrice001: 0
ItemLookGetFlg001: false
ItemAmount001: 0
ItemSort002: 1
ItemName002: !str64 Item_Material_03
ItemNum002: 5
ItemAdjustPrice002: 0
ItemLookGetFlg002: false
ItemAmount002: 0
ItemSort003: 2
ItemName003: !str64 Item_Material_05
ItemNum003: 10
ItemAdjustPrice003: 0
ItemLookGetFlg003: false
ItemAmount003: 0
ItemSort004: 3
ItemName004: !str64 Item_Material_01
ItemNum004: 5
ItemAdjustPrice004: 0
ItemLookGetFlg004: false
ItemAmount004: 0
ItemSort005: 4
ItemName005: !str64 Item_Material_02
ItemNum005: 5
ItemAdjustPrice005: 0
ItemLookGetFlg005: false
ItemAmount005: 0
lists: {}
</syntaxhighlight>

[[Category:File extensions]]
[[Category:File extensions (AAMP)]]
[[Category:Actor parameter files]]

AIDef:Query/Check100EnemyActiveTiming

2020-10-01T18:02:19Z

CEObrainz:

{{AIDef
|name=Check100EnemyActiveTiming
|type=Query
}}

Returns 1 if the Trial of the Sword quest should be activated for the first time (2 if the player is in the Korok Forest), and 0 otherwise.

* If the current map is not MainField, or if aocManager::sInstance->version < 0x200, return 0.
* If the quest has already been activated (i.e. if 100enemy_Activated is true), return 0.
* If the Master Sword has been obtained (i.e. if IsGet_Weapon_Sword_070 is true), return 1, otherwise return 0.
* If the player is in the final boss sequence (i.e. if IsPlayed_Demo146_0 is true), return 0.
* If the player's current location is the Korok Forest ("KorogForest"), return 2, otherwise return 1.

tl;dr: The quest is activated if the player is in Hyrule, has the Master Sword, and has not activated Dark Beast Ganon.

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

Help:Setting up tools

2020-09-02T10:26:07Z

CEObrainz: /* MSBT */

''Breath of the Wild'' uses a very flexible game engine, so many aspects of the game can be configured with files. Since BotW uses a lot of custom formats, special tools are required for editing them.

== Common requirements ==
=== Python ===
Many of the tools for these formats require [[wikipedia:Python (programming language)|Python]] 3.7+ ('''64 bit version''') to be installed.

On Linux, Python 3 is surely already installed. Just make sure you have a recent enough version (3.7+). Ubuntu 16.04 and Debian stretch are too old; the latest Ubuntu LTS (18.04) and rolling distros such as Arch and Debian sid have 3.7+ in their repos.

{{alert|class=primary|text= Setup instructions

On Windows, follow the below instructions to install Python:
# Uninstall any existing Python version to avoid conflicts.
# Download the [https://www.python.org/ftp/python/3.7.4/python-3.7.4.exe Python 3.7 installer] (latest version as of July 2019).
# Run the installer: do a ''system-wide install'' and tick the "''add Python to environment variables / PATH''" option. Note that if you install to the Program Files folder, you may occasionally run into permission issues with certain Python programs. To avoid this, install Python somewhere that does not require administrator permissions, such as <code>C:\Python37</code>.
# Verify that <code>py -3 --version</code> works and gives the correct version (3.7 or higher). {{CLI help}}

If you have any trouble installing Python, or need more detailed instructions, you can use [https://www.youtube.com/watch?v=ndrCfBJkkvE this video tutorial].
}}

=== For Windows users: Visual C++ redistributable for Visual Studio 2019 ===
Several tools require the [https://aka.ms/vs/16/release/vc_redist.x64.exe 64-bit Visual C++ redistributable for Visual Studio 2019] to be installed. To be clear, Visual Studio is '''not''' required.

Failure to install the redistributable will cause several Python tools to fail with the error "ImportError: DLL load failed".

== Tools ==
=== Yaz0 ===
Many files in the game are compressed with the [[Yaz0]] format. Compressed files generally have the letter <code>s</code> prefixed to their file extension. Use {{ltool|wszst}} to compress or decompress these files.

=== AAMP ===
[[AAMP]] is used for configuration files, such as [[actor parameters]], the [[normal.bwinfo|world configuration (climate, lighting, ...)]], etc. Convert them to an editable format (and back) with {{ltool|aamp}}. {{ltool|Wild Bits}} can also edit AAMP files.

Note: Unlike most other files, AAMP files are exactly the same on both Wii U and Switch.

=== BYML ===
[[BYML]] files contain game parameters for [[actor]]s, [[map unit]]s, etc. Convert them to an editable format (and back) with {{ltool|byml-v2}}. {{ltool|Wild Bits}} can also edit BYML files.

=== BFRES ===
[[BFRES]] files contain the game's animations, models and textures. The format is different on and on Switch and Wii U. These can be edited on Switch and Wii U using [https://github.com/KillzXGaming/Switch-Toolbox Switch Toolbox] (this tool is still under active development and receives very frequent updates, so expect some bugs in some features). Tutorials on another, older method of editing these for (Wii U only) can be found in [https://drive.google.com/drive/folders/1Z1_A3w0VvPHp22H_Yh_dSdzI5hr4OAv9 Fooni's Tutorials].
* <code>.sbfres</code> files contain models.
* <code>.Tex1.sbfres</code> files contain textures (Wii U).
* <code>.Tex2.sbfres</code> files contain mipmaps for textures (Wii U). They can be edited with Switch Toolbox (when editing a Tex1 manually, it automatically edits any Tex2 in the same folder with the same filename). Alternatively, they can be disabled with [https://github.com/CEObrainz/Botw-AutoMipping Auto MipMap removal] (has the side effect of making the textures take a moment to load correctly).
* <code>.Tex.sbfres</code> files contain both textures and mipmaps (Switch). Unlike on Wii U, mipmaps don't cause any problems here.

=== BFEVFL ===
[[BFEVFL]] is used for in-game events (which includes things like talking to people and also full-blown cutscenes).

Use {{ltool|EventEditor}} to edit event flowcharts.

=== RSTB ===
[[ResourceSizeTable.product.rsizetable]] (known as the RSTB) contains sizes for almost every file in the game (calculated from the non-Yaz0-compressed file sizes). If you edit a file to make its filesize bigger, you'll need to edit this file to prevent errors. The recommended tool for manipulating the RSTB is {{ltool|rstb}}. {{ltool|Wild Bits}} also provides a GUI frontend for <code>rstb</code>.

=== SARC ===
[[SARC]] archives contain collections of other files and folders, like .zip folders.

Use {{ltool|sarc}} to create or modify archives. {{ltool|Wild Bits}} also provides a GUI frontend for <code>sarc</code>.

=== Map units ===
[[Map unit]]s can be edited directly by modifying the map unit [[BYML]]s or with a graphical tool such as Ice-Spear.

For the first method, refer to [[#BYML]].

For the second method, follow [https://gitlab.com/ice-spear-tools/ice-spear-builds the instructions in the official repo for Ice-Spear builds].

=== MSBT ===
[[MSBT]] files contain game texts. Convert them to an editable YAML format (and back) with {{ltool|msyt}} or (built on top of msyt) [https://github.com/polarbunny/msyt-tools msyt-tools]. Wild Bits also provides a GUI frontend for msbt.

== Reverse engineering ==
To reverse engineer the game [[executable]], it is strongly recommended to have a copy of IDA Pro 7.0+ because the main executable is fairly large and IDA is as of September 2018 the only serious option for analysing such binaries. It is also the only tool with a usable decompiler for AArch64 (Switch).

To get a copy of an IDC for Switch 1.5.0, ping [[User:leoetlino|leoetlino]].

[[Category:Guides]]

Bdrop

2020-08-16T21:32:32Z

CEObrainz: /* Table names */

{{lowercase}}
<onlyinclude>
{{Parameter archive infobox|param_type=bdrop|version=0|type=xml}}
'''DropTable''' (''bdrop'') configures item drops for each actor.
</onlyinclude>

== Parameter objects ==

=== Header ===
{| class="wikitable"
!Key
!Type
!Description
|-
|TableNum
|int
|Number of tables
|-
|{{AampIndexedParam|key=Table%02d|start_idx=1}}
|str64
|Name of the drop table
|}

=== {{Placeholder AAMP param name|name=[TableName]}} ===
{| class="wikitable"
!Key
!Type
!Description
|-
|ColumnNum
|int
|Number of items
|-
|RepeatNumMin
|int
|Min number of items that can be dropped (抽選回数最小)
|-
|RepeatNumMax
|int
|Max number of items that can be dropped (抽選回数最大)
|-
|ApproachType
|int
|Drop position and pose (姿勢).

* 0: random
* 1: use the position of the source actor
* 2: random? {{check}}
|-
|OccurrenceSpeedType
|int
|Drop velocity type (発生速度).

* 1: "small"
* 2: "large" (see [[bgparamlist#Global]] for the actual values)
|-
|{{AampIndexedParam|key=ItemName%02d|start_idx=1}}
|str64
|Name of the actor that can be dropped
|-
|{{AampIndexedParam|key=ItemProbability%02d|start_idx=1}}
|float
|Drop probability (0.0 to 100.0)
|}
Note: the sum of all ItemProbabilities should be equal to 100.0, otherwise sometimes no items will be dropped.

== Table names ==
{| class="wikitable"
!Table name
!Description
|-
|Normal
|If enemy is using normal arrows
|-
|Normal2
|Used at same time as Normal
|-
|Normal3
|...
|-
|Normal4
|...
|-
|FireArrow
|If enemy is using fire arrows
|-
|FireArrow2
|...
|-
|FireArrow3
|...
|-
|FireArrow4
|...
|-
|IceArrow
|If enemy is using ice arrows
|-
|IceArrow2
|...
|-
|IceArrow3
|...
|-
|IceArrow4
|...
|-
|ElectricArrow
|If enemy is using shock arrows
|-
|ElectricArrow2
|...
|-
|ElectricArrow3
|...
|-
|ElectricArrow4
|...
|-
|BombArrow_A
|If enemy is using bomb arrows
|-
|BombArrow_A2
|...
|-
|BombArrow_A3
|...
|-
|BombArrow_A4
|...
|}

Normal Drops

{| class="wikitable"
!Table name
!Description
|-
|Normal
|Actor dies via normal means.
|-
|Iced
|Actor dies whilst frozen.
|-
|Electronic
|Actor dies whilst electrocuted.
|-
|Burnout
|Actor dies whilst on fire.
|-
|Boiled
|Actor dies when in hot water.
|}
[[Category:File extensions]]
[[Category:File extensions (AAMP)]]
[[Category:Actor parameter files]]

Bas

2020-08-16T09:38:37Z

CEObrainz: /* TriggerEvents */

{{Stub}}{{Lowercase}}
<onlyinclude>
'''bas''' files each represent an animation that can be called by an [[actor]] or [[Demo|cutscene]]. They contain a reference to an animation name, but not the animation file itself. They can be found at '''Actor/AS/{EventName}/{AnimationSequenceName}.bas''' in [[Beventpack|beventpacks]] and [[TitleBG.pack]]/Actor/AS, and '''Actor/AS/{AnimationSequenceName}.bas''' in bactorpacks.
</onlyinclude>

==Layout==
Each bas file is made up of one list of elements, named Elements. Each element (Element0, Element1, etc) can be either a test to figure out what animation to play, or a call to play the animation.

===Parameters===
All nodes have Parameters, which determine what kind of node they are. They can be a control node, which helps decide which animation to play, or an animation node, which actually plays the animation.
{| class="wikitable"
!Key
!Key Type
!Description
!Node Type
!Default value
|-
|TypeIndex
|int
|Type of node the Element is. Known types are listed below the table.
| -
| -
|-
|NoSync
|bool
| -
|Control
| -
|-
|JudgeOnce
|bool
|Tells the game to skip evaluating this node (and use the previous result) if the input value has not changed since the last time the node was run.
|Control
|False
|-
|InputLimit
|float
| -
|Control
| -
|-
|FileName
|str64
|Name of the animation to play
|Animation
| -
|-
|Morph
|int
|Time to blend the previous animation into this one. (Whether this is in milliseconds or frames is currently unknown)
|Animation
| -
|-
|}

====Parameter TypeIndex====
Nodes with Blender are generally used to perform the same checks as those with Selector in the name, with a key difference: Blender nodes may evaluate multiple cases as true, and will blend the resulting animations together. Selector nodes will choose only the first case that evaluates to true.{{Check}}
{| class="wikitable"
!Index
!Name <ref>TypeIndex function table in the 1.5.0 [[executable]]</ref>
!Description
!Type
|-
|0
|AbsTemperatureBlender
|Current world temperature. Evaluated by float range.
|Control
|-
|1
|AbsTemperatureSelector
|Current world temperature. Evaluated by float range.
|Control
|-
|2
|ArmorSelector
|What armor is currently equipped. Only observed working values are <code>NoUpper</code>, <code>NoLower</code>, <code>NoAll</code>.{{#tag:ref|Element32 of Player_Wait.bas, WiiU 1.5.0|name=e32pw}} Believed to work with armor actor names.{{Check}}
|Control
|-
|3
|ArrowSelector
| -
| -
|-
|4
|AttentionSelector
| -
| -
|-
|5
|BoneBlender
| -
| -
|-
|6
|BoneVisibilityAsset
| -
| -
|-
|7
|BoolSelector
|Boolean evaluator - See [[#BitIndex]]{{#tag:ref|Element1 of Player_CutNinja.bas, WiiU 1.5.0|name=e1pcn}}{{#tag:ref|Element0 of Player_FaceDefault.bas, WiiU 1.5.0|name=e0pfd}}{{#tag:ref|Element2 of Player_FaceDefault.bas, WiiU 1.5.0|name=e2pfd}}
|Control
|-
|8
|ButtonSelector
| -
| -
|-
|9
|ChargeSelector
| -
| -
|-
|10
|ClearMatAnmAsset
| -
| -
|-
|11
|ComboSelector
| -
| -
|-
|12
|DiffAngleYBlender
| -
| -
|-
|13
|DiffAngleYSelector
| -
| -
|-
|14
|DirectionAngleBlender
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|15
|DirectionAngleSelector
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|16
|DistanceBlender
|Compares distance between Link and his current locked target{{#tag:ref|Element2 of Player_CutNinja.bas, WiiU 1.5.0|name=e2pcn}}. Evaluated by float range.
|Control
|-
|17
|DistanceSelector
|Compares distance between Link and his current locked target. Evaluated by float range.
|Control
|-
|18
|DungeonClearSelector
| -
| -
|-
|19
|DungeonNumberSelector
| -
| -
|-
|20
|EmotionSelector
| -
| -
|-
|21
|EventFlagSelector
| -
| -
|-
|22
|EyeSelector
| -
| -
|-
|23
|EyebrowSelector
| -
| -
|-
|24
|FaceEmotionSelector
| -
| -
|-
|25
|FootBLLifeSelector
| -
| -
|-
|26
|FootBRLifeSelector
| -
| -
|-
|27
|FootFLLifeSelector
| -
| -
|-
|28
|FootFRLifeSelector
| -
| -
|-
|29
|ForwardBentBlender
| -
| -
|-
|30
|ForwardBentSelector
| -
| -
|-
|31
|GearSelector
| -
| -
|-
|32
|GenerationSelector
| -
| -
|-
|33
|GrabTypeSelector
| -
| -
|-
|34
|GroundNormalBlender
| -
| -
|-
|35
|GroundNormalSelector
| -
| -
|-
|36
|GroundNormalSideBlender
| -
| -
|-
|37
|GroundNormalSideSelector
| -
| -
|-
|38
|MaskSelector
| -
| -
|-
|39
|MatVisibilityAsset
| -
| -
|-
|40
|MouthSelector
| -
| -
|-
|41
|NoAnmAsset
|Play no animation. Used to cancel evaluation.
|Animation
|-
|42
|NoLoopStickAngleBlender
| -
| -
|-
|43
|NoLoopStickAngleSelector
| -
| -
|-
|44
|NodePosSelector
|Compares name of a bone, takes StrRef of the bone name. Unknown how it decides which bone name to compare the StrRef to.{{#tag:ref|Element0 of Player_LadderJump.bas, WiiU 1.5.0|name=e0plj}} Can be paired with an axis name (e.g. <code>Toe_L,Z</code>) to measure value on that axis. When used in this way, the node chooses the child corresponding to the highest value among those measured.{{#tag:ref|Element8 of UZ_M_Move_End.bas, WiiU 1.5.0|name=e8uzmme}} When no axis name is given, the vector to the origin is measured. {{Check}}
|Control
|-
|45
|PersonalitySelector
| -
| -
|-
|46
|PostureSelector
| -
| -
|-
|47
|PreASSelector
|Compares last played animation name, takes StrRef of animation name. Known to accept two Children to test against, plus a default case, but might accept more or less.
|Control
|-
|48
|PreExclusionRandomSelector
| -
| -
|-
|49
|RandomSelector
|Picks a random node from the given nodes.{{Check}}
|Control
|-
|50
|RideSelector
|Compares the profile of the mount the actor is currently riding. Known to accept one Child, plus a default case, but might accept more or less.{{Check}}
|Control
|-
|51
|RightStickAngleBlender
| -
| -
|-
|52
|RightStickAngleSelector
| -
| -
|-
|53
|RightStickValueBlender
| -
| -
|-
|54
|RightStickValueSelector
| -
| -
|-
|55
|RightStickXBlender
| -
| -
|-
|56
|RightStickXSelector
| -
| -
|-
|57
|RightStickYBlender
| -
| -
|-
|58
|RightStickYSelector
| -
| -
|-
|59
|SelfHeightSelector
| -
| -
|-
|60
|SelfWeightSelector
| -
| -
|-
|61
|SequencePlayContainer
|Float comparison - Unknown{{#tag:ref|Element0 of Player_Move.bas, WiiU 1.5.0|name=e0pm}}
|Control
|-
|62
|ShaderParamAsset
|Plays material animation, takes StrRef of the animation name. Its Extend uses a secondary animation name for unknown purpose.{{#tag:ref|Element1 of Player_SkinColor.bas, WiiU 1.5.0|name=e1psc}}{{#tag:ref|Element2 of Player_SkinColor.bas, WiiU 1.5.0|name=e2psc}}
|Animation
|-
|63
|ShaderParamColorAsset
| -
| -
|-
|64
|ShaderParamTexSRTAsset
|Plays texture transform animation, takes StrRef of the animation name.
|Animation
|-
|65
|SizeBlender
| -
| -
|-
|66
|SizeSelector
| -
| -
|-
|67
|SkeltalAsset
|Plays model animation, takes StrRef of the animation name.
|Animation
|-
|68
|SpeedBlender
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|69
|SpeedSelector
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|70
|StickAngleBlender
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|71
|StickAngleSelector
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|72
|StickValueBlender
|Range evaluation - Unknown{{#tag:ref|Element0 of Player_SwimAtnMove.bas, WiiU 1.5.0|name=e0psam}}
|Control
|-
|73
|StickValueSelector
| -
| -
|-
|74
|StickXBlender
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|75
|StickXSelector
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|76
|StickYBlender
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|77
|StickYSelector
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|78
|StressBlender
| -
| -
|-
|79
|StressSelector
| -
| -
|-
|80
|SyncPlayContainer
|Synchronously plays multiple child elements
|Animation
|-
|81
|TemperatureBlender
| -
| -
|-
|82
|TemperatureSelector
|Range evaluation - Unknown{{#tag:ref|Element1 of Player_FaceDefault.bas, WiiU 1.5.0|name=e1pfd}}
|Control
|-
|83
|TexturePatternAsset
| -
| -
|-
|84
|TimeSelector
| -
| -
|-
|85
|TiredBlender
| -
| -
|-
|86
|TiredSelector
| -
| -
|-
|87
|UseItemSelector
| -
| -
|-
|88
|UserAngle2Blender
| -
| -
|-
|89
|UserAngle2Selector
| -
| -
|-
|90
|UserAngleBlender
| -
| -
|-
|91
|UserAngleSelector
| -
| -
|-
|92
|UserSpeedBlender
| -
| -
|-
|93
|UserSpeedSelector
| -
| -
|-
|94
|VariationSelector
| -
| -
|-
|95
|WallAngleBlender
| -
| -
|-
|96
|WallAngleSelector
| -
| -
|-
|97
|WeaponDetailSelector
|Compares actor's equipped weapon subtype (from its bgparamlist [ProfileUser] WeaponSubtype value), takes StrRef of weapon subtype name
|Control
|-
|98
|WeaponSelector
|Compares actor's equipped weapon profile (from its bxml ProfileUser value), takes StrRef of weapon profile name
|Control
|-
|99
|WeatherSelector
| -
| -
|-
|100
|WeightBlender
| -
| -
|-
|101
|WeightSelector
| -
| -
|-
|102
|WindVelocityBlender
| -
| -
|-
|103
|YSpeedBlender
| -
| -
|-
|104
|YSpeedSelector
| -
| -
|-
|105
|ZEx00ExposureBlender
| -
| -
|-
|106
|ZEx00ExposureSelector
| -
| -
|-
|}

===Children===
Control nodes will have Children, in addition to Parameters, which determine which Element to go to after the control node is evaluated. The properties of Children will be named Child0, Child1, etc, and each will have a single integer value, which will correspond to the Element number. e.g. <code>Child0: 7</code> points to Element7.

===Extend===
All nodes have an Extend, which contains specific details about the node. Control node Extends will contain details about the comparison being performed, while animation nodes will contain information about the animation being played, such as: during which frames of the animation a weapon will deal damage if it hits something, when user input is ignored, when to draw weapon trails through the air for attack animations, etc.

====Typed Array====
A list of variables of a given type to use for various control comparisons. Corresponds directly to the Children of the node. i.e. if Value0 matches the value being compared against, the code will jump to the Element listed under Child0. If no comparison of a lower Child number has evaluated as true, automatically evaluates a Child whose value is "default" as true.{{#tag:ref|Element0 of Player_CutNinja.bas, WiiU 1.5.0|name=e0pcn}}{{#tag:ref|Element3 of Player_FaceDefault.bas, WiiU 1.5.0|name=e3pfd}}

====BitIndex====
Used with BoolSelector Parameters. Also has TypeIndex, which are used to perform the check.

*2 - Unknown (believed to check if Link has any armor equipped)<ref name="e0pfd" />
*30 - Whether or not Link has a shield equipped.<ref name="e1pcn" />
*33 - Unknown<ref name="e2pfd" />
*37 - Whether IsBlunt is set to true in the equipped weapon’s bgparamlist
*46 - Unknown (believed to check if Link is crouched)

====Ranges====
Used with control nodes that perform a Range evaluation. If the value being compared is above the Start value and below the End value, evaluates as true. Otherwise, moves on to the next value. (Unknown what happens if none of the Ranges evaluate to true, presumably game crash)

====FrameCtrl====
Used with animation nodes. The node itself is required, even if it is empty (i.e. none of the keys are specified)
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|Rate
|float
|Speed at which to play the animation. Higher numbers are faster.
|1.0
|-
|EndFrame
|int
| -
| -
|-
|}

====TriggerEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. Events which are triggered during this animation.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|Frame
|int
|Which frame to fire the event on, relative to the frame numbers of the animation. Can be negative.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Unknown (believed to define when an attack begins to deal damage)<ref>Compare Event0 of TriggerEvents and Event0 of HoldEvents for most of Link's attack animations</ref>
*4 - Triggers the animation controller to transition back into the idle stance. The Frame value should be a few before the end of the actual animation, so that the controller can make the blending look natural.<ref>Compare TriggerEvent TypeIndex 4 Frame value for an animation with the number of frames in the actual animation.</ref>
*7 - Call AS. Passes the strRef to the ASList to retrieve an AS file and starts evaluating it from Element0.
*28 - Play audio. Only observed with PV%03d as the value, which corresponds to bfwav files in PlayerVoice.bars, but is believed to be able to play other audio files as well.

====HoldEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. States that are entered into while the animation is playing.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|StartFrame
|int
|Which frame to start the event on, relative to the frame numbers of the animation. Unknown if it can be negative.
| -
|-
|EndFrame
|int
|Which frame to end the event on, relative to the frame numbers of the animation. A value of -1 is treated as the ending frame of the animation.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Unknown
*2 - Unknown
*3 - Defines when an attack will deal damage. Value is the damage type. Left: slashing. Stab: piercing. Lower: blunt. {{Check}}
*17 - Unknown
*25 - Unknown
*45 - Defines when to accept input to start the next attack.
*48 - Defines when to display the trails in the air during an attack.

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

Bas

2020-08-16T09:37:15Z

CEObrainz: /* TriggerEvents */

{{Stub}}{{Lowercase}}
<onlyinclude>
'''bas''' files each represent an animation that can be called by an [[actor]] or [[Demo|cutscene]]. They contain a reference to an animation name, but not the animation file itself. They can be found at '''Actor/AS/{EventName}/{AnimationSequenceName}.bas''' in [[Beventpack|beventpacks]] and [[TitleBG.pack]]/Actor/AS, and '''Actor/AS/{AnimationSequenceName}.bas''' in bactorpacks.
</onlyinclude>

==Layout==
Each bas file is made up of one list of elements, named Elements. Each element (Element0, Element1, etc) can be either a test to figure out what animation to play, or a call to play the animation.

===Parameters===
All nodes have Parameters, which determine what kind of node they are. They can be a control node, which helps decide which animation to play, or an animation node, which actually plays the animation.
{| class="wikitable"
!Key
!Key Type
!Description
!Node Type
!Default value
|-
|TypeIndex
|int
|Type of node the Element is. Known types are listed below the table.
| -
| -
|-
|NoSync
|bool
| -
|Control
| -
|-
|JudgeOnce
|bool
|Tells the game to skip evaluating this node (and use the previous result) if the input value has not changed since the last time the node was run.
|Control
|False
|-
|InputLimit
|float
| -
|Control
| -
|-
|FileName
|str64
|Name of the animation to play
|Animation
| -
|-
|Morph
|int
|Time to blend the previous animation into this one. (Whether this is in milliseconds or frames is currently unknown)
|Animation
| -
|-
|}

====Parameter TypeIndex====
Nodes with Blender are generally used to perform the same checks as those with Selector in the name, with a key difference: Blender nodes may evaluate multiple cases as true, and will blend the resulting animations together. Selector nodes will choose only the first case that evaluates to true.{{Check}}
{| class="wikitable"
!Index
!Name <ref>TypeIndex function table in the 1.5.0 [[executable]]</ref>
!Description
!Type
|-
|0
|AbsTemperatureBlender
|Current world temperature. Evaluated by float range.
|Control
|-
|1
|AbsTemperatureSelector
|Current world temperature. Evaluated by float range.
|Control
|-
|2
|ArmorSelector
|What armor is currently equipped. Only observed working values are <code>NoUpper</code>, <code>NoLower</code>, <code>NoAll</code>.{{#tag:ref|Element32 of Player_Wait.bas, WiiU 1.5.0|name=e32pw}} Believed to work with armor actor names.{{Check}}
|Control
|-
|3
|ArrowSelector
| -
| -
|-
|4
|AttentionSelector
| -
| -
|-
|5
|BoneBlender
| -
| -
|-
|6
|BoneVisibilityAsset
| -
| -
|-
|7
|BoolSelector
|Boolean evaluator - See [[#BitIndex]]{{#tag:ref|Element1 of Player_CutNinja.bas, WiiU 1.5.0|name=e1pcn}}{{#tag:ref|Element0 of Player_FaceDefault.bas, WiiU 1.5.0|name=e0pfd}}{{#tag:ref|Element2 of Player_FaceDefault.bas, WiiU 1.5.0|name=e2pfd}}
|Control
|-
|8
|ButtonSelector
| -
| -
|-
|9
|ChargeSelector
| -
| -
|-
|10
|ClearMatAnmAsset
| -
| -
|-
|11
|ComboSelector
| -
| -
|-
|12
|DiffAngleYBlender
| -
| -
|-
|13
|DiffAngleYSelector
| -
| -
|-
|14
|DirectionAngleBlender
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|15
|DirectionAngleSelector
|Compares to the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|16
|DistanceBlender
|Compares distance between Link and his current locked target{{#tag:ref|Element2 of Player_CutNinja.bas, WiiU 1.5.0|name=e2pcn}}. Evaluated by float range.
|Control
|-
|17
|DistanceSelector
|Compares distance between Link and his current locked target. Evaluated by float range.
|Control
|-
|18
|DungeonClearSelector
| -
| -
|-
|19
|DungeonNumberSelector
| -
| -
|-
|20
|EmotionSelector
| -
| -
|-
|21
|EventFlagSelector
| -
| -
|-
|22
|EyeSelector
| -
| -
|-
|23
|EyebrowSelector
| -
| -
|-
|24
|FaceEmotionSelector
| -
| -
|-
|25
|FootBLLifeSelector
| -
| -
|-
|26
|FootBRLifeSelector
| -
| -
|-
|27
|FootFLLifeSelector
| -
| -
|-
|28
|FootFRLifeSelector
| -
| -
|-
|29
|ForwardBentBlender
| -
| -
|-
|30
|ForwardBentSelector
| -
| -
|-
|31
|GearSelector
| -
| -
|-
|32
|GenerationSelector
| -
| -
|-
|33
|GrabTypeSelector
| -
| -
|-
|34
|GroundNormalBlender
| -
| -
|-
|35
|GroundNormalSelector
| -
| -
|-
|36
|GroundNormalSideBlender
| -
| -
|-
|37
|GroundNormalSideSelector
| -
| -
|-
|38
|MaskSelector
| -
| -
|-
|39
|MatVisibilityAsset
| -
| -
|-
|40
|MouthSelector
| -
| -
|-
|41
|NoAnmAsset
|Play no animation. Used to cancel evaluation.
|Animation
|-
|42
|NoLoopStickAngleBlender
| -
| -
|-
|43
|NoLoopStickAngleSelector
| -
| -
|-
|44
|NodePosSelector
|Compares name of a bone, takes StrRef of the bone name. Unknown how it decides which bone name to compare the StrRef to.{{#tag:ref|Element0 of Player_LadderJump.bas, WiiU 1.5.0|name=e0plj}} Can be paired with an axis name (e.g. <code>Toe_L,Z</code>) to measure value on that axis. When used in this way, the node chooses the child corresponding to the highest value among those measured.{{#tag:ref|Element8 of UZ_M_Move_End.bas, WiiU 1.5.0|name=e8uzmme}} When no axis name is given, the vector to the origin is measured. {{Check}}
|Control
|-
|45
|PersonalitySelector
| -
| -
|-
|46
|PostureSelector
| -
| -
|-
|47
|PreASSelector
|Compares last played animation name, takes StrRef of animation name. Known to accept two Children to test against, plus a default case, but might accept more or less.
|Control
|-
|48
|PreExclusionRandomSelector
| -
| -
|-
|49
|RandomSelector
|Picks a random node from the given nodes.{{Check}}
|Control
|-
|50
|RideSelector
|Compares the profile of the mount the actor is currently riding. Known to accept one Child, plus a default case, but might accept more or less.{{Check}}
|Control
|-
|51
|RightStickAngleBlender
| -
| -
|-
|52
|RightStickAngleSelector
| -
| -
|-
|53
|RightStickValueBlender
| -
| -
|-
|54
|RightStickValueSelector
| -
| -
|-
|55
|RightStickXBlender
| -
| -
|-
|56
|RightStickXSelector
| -
| -
|-
|57
|RightStickYBlender
| -
| -
|-
|58
|RightStickYSelector
| -
| -
|-
|59
|SelfHeightSelector
| -
| -
|-
|60
|SelfWeightSelector
| -
| -
|-
|61
|SequencePlayContainer
|Float comparison - Unknown{{#tag:ref|Element0 of Player_Move.bas, WiiU 1.5.0|name=e0pm}}
|Control
|-
|62
|ShaderParamAsset
|Plays material animation, takes StrRef of the animation name. Its Extend uses a secondary animation name for unknown purpose.{{#tag:ref|Element1 of Player_SkinColor.bas, WiiU 1.5.0|name=e1psc}}{{#tag:ref|Element2 of Player_SkinColor.bas, WiiU 1.5.0|name=e2psc}}
|Animation
|-
|63
|ShaderParamColorAsset
| -
| -
|-
|64
|ShaderParamTexSRTAsset
|Plays texture transform animation, takes StrRef of the animation name.
|Animation
|-
|65
|SizeBlender
| -
| -
|-
|66
|SizeSelector
| -
| -
|-
|67
|SkeltalAsset
|Plays model animation, takes StrRef of the animation name.
|Animation
|-
|68
|SpeedBlender
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|69
|SpeedSelector
|Compares actor's current movement speed. Evaluated by float range.
|Control
|-
|70
|StickAngleBlender
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|71
|StickAngleSelector
|Compares the movement analog stick's current orientation, in degrees, in counter-clockwise fashion. Accepts -359 to 360. (e.g. 270 and -90 both point directly to the right). Evaluated by float range.
|Control
|-
|72
|StickValueBlender
|Range evaluation - Unknown{{#tag:ref|Element0 of Player_SwimAtnMove.bas, WiiU 1.5.0|name=e0psam}}
|Control
|-
|73
|StickValueSelector
| -
| -
|-
|74
|StickXBlender
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|75
|StickXSelector
|Compares the movement analog stick's current horizontal position, as a float value. Fully left is -1.0, fully right is 1.0.
|Control
|-
|76
|StickYBlender
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|77
|StickYSelector
|Compares the movement analog stick's current vertical position, as a float value. Fully down is -1.0, fully up is 1.0.
|Control
|-
|78
|StressBlender
| -
| -
|-
|79
|StressSelector
| -
| -
|-
|80
|SyncPlayContainer
|Synchronously plays multiple child elements
|Animation
|-
|81
|TemperatureBlender
| -
| -
|-
|82
|TemperatureSelector
|Range evaluation - Unknown{{#tag:ref|Element1 of Player_FaceDefault.bas, WiiU 1.5.0|name=e1pfd}}
|Control
|-
|83
|TexturePatternAsset
| -
| -
|-
|84
|TimeSelector
| -
| -
|-
|85
|TiredBlender
| -
| -
|-
|86
|TiredSelector
| -
| -
|-
|87
|UseItemSelector
| -
| -
|-
|88
|UserAngle2Blender
| -
| -
|-
|89
|UserAngle2Selector
| -
| -
|-
|90
|UserAngleBlender
| -
| -
|-
|91
|UserAngleSelector
| -
| -
|-
|92
|UserSpeedBlender
| -
| -
|-
|93
|UserSpeedSelector
| -
| -
|-
|94
|VariationSelector
| -
| -
|-
|95
|WallAngleBlender
| -
| -
|-
|96
|WallAngleSelector
| -
| -
|-
|97
|WeaponDetailSelector
|Compares actor's equipped weapon subtype (from its bgparamlist [ProfileUser] WeaponSubtype value), takes StrRef of weapon subtype name
|Control
|-
|98
|WeaponSelector
|Compares actor's equipped weapon profile (from its bxml ProfileUser value), takes StrRef of weapon profile name
|Control
|-
|99
|WeatherSelector
| -
| -
|-
|100
|WeightBlender
| -
| -
|-
|101
|WeightSelector
| -
| -
|-
|102
|WindVelocityBlender
| -
| -
|-
|103
|YSpeedBlender
| -
| -
|-
|104
|YSpeedSelector
| -
| -
|-
|105
|ZEx00ExposureBlender
| -
| -
|-
|106
|ZEx00ExposureSelector
| -
| -
|-
|}

===Children===
Control nodes will have Children, in addition to Parameters, which determine which Element to go to after the control node is evaluated. The properties of Children will be named Child0, Child1, etc, and each will have a single integer value, which will correspond to the Element number. e.g. <code>Child0: 7</code> points to Element7.

===Extend===
All nodes have an Extend, which contains specific details about the node. Control node Extends will contain details about the comparison being performed, while animation nodes will contain information about the animation being played, such as: during which frames of the animation a weapon will deal damage if it hits something, when user input is ignored, when to draw weapon trails through the air for attack animations, etc.

====Typed Array====
A list of variables of a given type to use for various control comparisons. Corresponds directly to the Children of the node. i.e. if Value0 matches the value being compared against, the code will jump to the Element listed under Child0. If no comparison of a lower Child number has evaluated as true, automatically evaluates a Child whose value is "default" as true.{{#tag:ref|Element0 of Player_CutNinja.bas, WiiU 1.5.0|name=e0pcn}}{{#tag:ref|Element3 of Player_FaceDefault.bas, WiiU 1.5.0|name=e3pfd}}

====BitIndex====
Used with BoolSelector Parameters. Also has TypeIndex, which are used to perform the check.

*2 - Unknown (believed to check if Link has any armor equipped)<ref name="e0pfd" />
*30 - Whether or not Link has a shield equipped.<ref name="e1pcn" />
*33 - Unknown<ref name="e2pfd" />
*37 - Whether IsBlunt is set to true in the equipped weapon’s bgparamlist
*46 - Unknown (believed to check if Link is crouched)

====Ranges====
Used with control nodes that perform a Range evaluation. If the value being compared is above the Start value and below the End value, evaluates as true. Otherwise, moves on to the next value. (Unknown what happens if none of the Ranges evaluate to true, presumably game crash)

====FrameCtrl====
Used with animation nodes. The node itself is required, even if it is empty (i.e. none of the keys are specified)
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|Rate
|float
|Speed at which to play the animation. Higher numbers are faster.
|1.0
|-
|EndFrame
|int
| -
| -
|-
|}

====TriggerEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. Events which are triggered during this animation.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|Frame
|int
|Which frame to fire the event on, relative to the frame numbers of the animation. Can be negative.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Unknown (believed to define when an attack begins to deal damage)<ref>Compare Event0 of TriggerEvents and Event0 of HoldEvents for most of Link's attack animations</ref>
*4 - Triggers the animation controller to transition back into the idle stance. The Frame value should be a few before the end of the actual animation, so that the controller can make the blending look natural.<ref>Compare TriggerEvent TypeIndex 4 Frame value for an animation with the number of frames in the actual animation.</ref>
*7 - Call AS. Passes the strRef to the ASList to retrieve an AS file and starts evaluating it from Element0.
*28 - Play audio. Only observed with PV%03d as the value, which corresponds to bfwav files in PlayerVoice.bars, but is believed to be able to play other audio files as well.
*70 - Triggers end of animation.

====HoldEvents====
Used with Parameter TypeIndex 67. Possibly used with other animation node TypeIndexes, but none have so far been observed. States that are entered into while the animation is playing.
{| class="wikitable"
!Key
!Type
!Description
!Default value
|-
|TypeIndex
|int
|Which type of event to fire. Known events are detailed below
| -
|-
|StartFrame
|int
|Which frame to start the event on, relative to the frame numbers of the animation. Unknown if it can be negative.
| -
|-
|EndFrame
|int
|Which frame to end the event on, relative to the frame numbers of the animation. A value of -1 is treated as the ending frame of the animation.
| -
|-
|Value
|strRef
| -
| -
|-
|}
Known TypeIndex values:

*0 - Unknown
*2 - Unknown
*3 - Defines when an attack will deal damage. Value is the damage type. Left: slashing. Stab: piercing. Lower: blunt. {{Check}}
*17 - Unknown
*25 - Unknown
*45 - Defines when to accept input to start the next attack.
*48 - Defines when to display the trails in the air during an attack.

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

RiddenAnimalType

2020-08-02T13:09:05Z

CEObrainz: Created RiddenAnimalType page

'''RiddenAnimalType''' is a parameter used in the [[bgparamlist]] for [[Actor|actors]] that Link can ride.

This value is referenced when registering a mount at a stable in order to prevent specific mounts from being registered.

== RiddenAnimalType ==
{| class="wikitable"
! Number !! Description
|-
| 0 || Deer
|-
| 1 || Normal Horse
|-
| 2 || Unused{{Check}}
|-
| 3 || White Horse
|-
| 4 || Epona
|-
| 5 || Stalhorse
|-
| 6 || Large Horse
|-
| 7 || Donkey
|-
| 8 || Lynel
|-
| 9 || Lord of the Mountain
|-
| 10 || Bear
|-
| 11 || Master Cycle Zero
|}

ShopGameDataInfo.byml

2020-06-12T09:32:22Z

CEObrainz:

<onlyinclude>
'''ShopGameDataInfo.byml''' (found in Bootup/Gamedata) is a [[Yaz0]]-compressed [[BYML]] file which contains data pertaining to [[Actor|actors]] purchasable from NPC Shops. It is used when purchasing items (actors) from a shop to keep track of items that are "Sold Out".
</onlyinclude>

== Contents ==
===ShopAreaInfo Hashes===
'''ShopAreaInfo Hashes''' is an array of CRC32 hashes of all shop actor-name flags.
The hashed flags are named in the format Npc_Name_Actor_Name.
This array does not need to be sorted. {{Check}}
Similar to tag values, each number is stored as an unsigned int if it is greater than 0x80000000 and as a signed int otherwise.

===ShopAreaInfo Values===

This section contains a list of all items sold by NPCs.

{| class="wikitable"
!Name
!Description
!Example
|-
|Area
|A list of locations where the item is sold when the Dealer and Item are the same.
| [0, 6]
|-
|Dealer
|The name of the actor which sells the item.
|Npc_MamonoShop
|-
|Item
|The name of the actor which is sold.
|Armor_160_Upper
|-
|}

''Example entries:''

- Areas:
- [1, 7]
Dealer: NPC_oasis065
Item: Armor_008_Upper

- Areas:
- [0, 6]
- [1, 2]
- [6, 5]
- [7, 7]
- [8, 0]
- [8, 3]
- [8, 5]
- [9, 2]
Dealer: Npc_MamonoShop
Item: Armor_160_Upper

===SoldOutInfo Hashes===
'''SoldOutInfo Hashes''' is an array of CRC32 hashes of all shop actor-name flags that change state when sold out.
The flags are used in stores where the item is physically shown to the player (e.g A Mannequin displaying Armor).
The hashed flags are named in the format Npc_Name_Actor_Name.
This array does not need to be sorted. {{Check}}
Similar to tag values, each number is stored as an unsigned int if it is greater than 0x80000000 and as a signed int otherwise.

===SoldOutInfo Values===

[[Category:Content (BotW)]]

ShopGameDataInfo.byml

2020-06-12T09:19:54Z

CEObrainz:

ShopGameDataInfo.byml

2020-06-11T23:18:21Z

CEObrainz:

ShopGameDataInfo.byml

2020-06-11T23:11:15Z

CEObrainz: Created page with "<onlyinclude> '''ShopGameDataInfo.byml''' (found in Bootup/Gamedata) is a Yaz0-compressed BYML file which contains data pertaining to actors purchasable from..."