mirror/oot
1
0
Fork 0
mirror of https://github.com/zeldaret/oot.git synced 2025-08-06 22:30:15 +00:00
Code Issues Projects Releases Wiki Activity

Document Mido functions, fields, and animations (#2289)

Browse source 
* Document `func_80AAA250`

new name: `EnMd_ReverseAnimation`

* rename `enum EnMdAnimation` > `enum EnMdAnimIndex`

* Document `struct EnMd` fields (and functions)

the list:

* `func_80AAAC78` -> `EnMd_TrackMessageState`
* `func_80AAAA24` -> `EnMd_UpdateAnimState_WithTalking`

* `func_80AAA92C` -> `EnMd_SetAnimState`
* `func_80AAA93C` -> `EnMd_UpdateAnimState`
* `func_80AAA274` -> `EnMd_UpdateAnimState1`
* `func_80AAA308` -> `EnMd_UpdateAnimState2`
* `func_80AAA39C` -> `EnMd_UpdateAnimState3`
* `func_80AAA474` -> `EnMd_UpdateAnimState4`
* `func_80AAA508` -> `EnMd_UpdateAnimState5`
* `func_80AAA5A4` -> `EnMd_UpdateAnimState6`
* `func_80AAA638` -> `EnMd_UpdateAnimState7`
* `func_80AAA6D4` -> `EnMd_UpdateAnimState8`
* `func_80AAA768` -> `EnMd_UpdateAnimState9`
* `func_80AAA7FC` -> `EnMd_UpdateAnimState10`
* `func_80AAA890` -> `EnMd_UpdateAnimState11`

* Document `func_80AAB158`

new name: `EnMd_UpdateTalking`

* Document `func_80034DD4` @ `z_actor.c`

new name: `Actor_SmoothStep_Attention`

* Document `func_80AAB5A4`

new name: `EnMd_SmoothStep_Attention`

* Document Mido's action functions

the list:
* `func_80AAB874` -> `EnMd_Idle`
* `func_80AAB8F8` -> `EnMd_Watch`
* `func_80AAB948` -> `EnMd_BlockPath`
* `func_80AABC10` -> `EnMd_ListenToOcarina`
* `func_80AABD0C` -> `EnMd_Walk`

* rename flag `temp2` -> `canUpdateTalking`

* (re)document Mido's animations

via blender and fast64

* marginally improve comments

* marginally improve comments

* actually, yes, let's name action functions as such

* Document eye textures as an enum

to clarify for `EnMd_UpdateEyes`

* rename `eyeIdx` -> `eyeTexIndex`

Mido has two eyes and different textures for them

* Undocument eye textures as an enum

i was wrong: `_Draw` function might not follow the eyes texture order
it is its own thing, like `enum EnMdBlinking` or nothing at all, yeah

* ugh, and fix a typo with blinking

rushing is no good

* drop the `Action` suffix

https://github.com/zeldaret/oot/pull/2289#discussion_r1837272286

* rename animation states as sequences

https://github.com/zeldaret/oot/pull/2289#discussion_r1837274923

* `func_80034DD4` -> `Actor_FadeInOut`

https://github.com/zeldaret/oot/pull/2289#discussion_r1837267267

* rename animation states as sequences

a continuation of b11a9e9942

* `func_80034DD4` -> `Actor_UpdateAlphaByDistance`

https://github.com/zeldaret/oot/pull/2289#discussion_r1838398475

* clarify a comment

* Document `actor.params` bits allocation

* apply review suggestions

* apply review suggestions

* apply review suggestions

* apply review suggestions

* apply review suggestions
This commit is contained in:
Leonid Kapitonov 2024-12-09 14:06:05 +01:00 • committed by GitHub
parent e9b165b6e5
commit 9305a71458
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 275 additions and 253 deletions
Download patch file Download diff file Expand all files Collapse all files

22
assets/xml/objects/object_md.xml
View file

@ -71,17 +71,17 @@
<Texture Name="gMidoTex_58F0" OutName="tex_58F0" Format="ci8" Width="8" Height="8" Offset="0x58F0" TlutOffset="0x4C48"/>
<!-- Mido Animations -->
<Animation Name="gMidoHandsOnHipsIdleAnim" Offset="0x02C8"/>
<Animation Name="gMidoSlamAnim" Offset="0x8510"/>
<Animation Name="gMidoAngryHeadTurnAnim" Offset="0x8738"/>
<Animation Name="gMidoAnnoyedPointedHeadIdle1Anim" Offset="0x8E84"/>
<Animation Name="gMidoHandsOnHipsTransitionAnim" Offset="0x8FC0"/>
<Animation Name="gMidoRaiseHand1Anim" Offset="0x917C"/>
<Animation Name="gMidoAnim_92B0" Offset="0x92B0"/>
<Animation Name="gMidoRaiseHand2Anim" Offset="0x95BC"/>
<Animation Name="gMidoAnnoyedPointedHeadIdle2Anim" Offset="0x97F0"/>
<Animation Name="gMidoPutHandDownAnim" Offset="0x9B1C"/>
<Animation Name="gMidoIdleAnim" Offset="0x02C8"/>
<Animation Name="gMidoCuriousToAnnoyedAnim" Offset="0x8510"/>
<Animation Name="gMidoIdleToAnnoyedAnim" Offset="0x8738"/>
<Animation Name="gMidoCuriousAnim" Offset="0x8E84"/>
<Animation Name="gMidoIdleToSurpriseAnim" Offset="0x8FC0"/>
<Animation Name="gMidoIdleToHaltAnim" Offset="0x917C"/>
<Animation Name="gMidoIdleToWalkAnim" Offset="0x92B0"/>
<Animation Name="gMidoAnnoyedToHaltAnim" Offset="0x95BC"/>
<Animation Name="gMidoAnnoyedAnim" Offset="0x97F0"/>
<Animation Name="gMidoHaltToCuriousAnim" Offset="0x9B1C"/>
<Animation Name="gMidoHaltAnim" Offset="0x9E68"/>
<Animation Name="gMidoWalkingAnim" Offset="0xA138"/>
<Animation Name="gMidoWalkAnim" Offset="0xA138"/>
</File>
</Root>