Document `EnGo` and `EnGo2` functions, fields, and animations #2295

Feacur · 2024-11-13T12:36:19Z

additonally:

renamed func_8002F368 as Player_GetExchangeItemId
- umm, it's oneline, but has bloated the file count
- might be better to cancel these changes (?)
marked En_Go as unused (which is also stated in the web too)
this PR will conflict a bit with Document Actor "Fidget Tables" #2287
restructured EnGo2_StopRolling with a switch
restructured EnGo2_RollingSlow with a switch
restructured EnGo2_UpdateTalking with separate ifs (couldn't do any better)
- but it was fun to mess with the tools for a while

- `callback1_80A3ED24` is `NpcGetTextIdFunc` - `callback2_80A3ED24` is `NpcUpdateTalkStateFunc`

reason: `EnGo2_EyeMouthTexState` code analogy

returns are indeed required to match

partially they already were there

and `func_80A45360` as `EnGo2_UpdateShadowAlpha`

zeldaret#2295 (comment)

zeldaret#2295 (comment) zeldaret#2295 (comment) zeldaret#2295 (comment) zeldaret#2295 (comment)

zeldaret#2295 (comment)

an "ammendment" for 57951ed somehow haven't saved the changes that time

Feacur · 2024-11-14T01:23:33Z

ok, got all current conversations fixed; thank you! also added a better actor params decription for each of the goron entities.

fig02

I plan to review go2 on its own shortly. I would rather review the actor thats actually used, and then port over any similarities to go after the fact.

For now, here is one comment about the function named in z_actor. I would kinda prefer docs for this function happen in a separate PR, personally.

src/code/z_actor.c

Feacur added 30 commits November 11, 2024 17:12

Document func_8002F368 as Player_GetExchangeItemId

d3eedf6

Document Goron's limbs

f249068

Document Goron's limbs' display lists

a71747b

Document non-limb display lists

b3b6b28

just align attributes

ba0bb10

Document animations

40203d0

remove unused EnGo callbacks

60b8664

- `callback1_80A3ED24` is `NpcGetTextIdFunc` - `callback2_80A3ED24` is `NpcUpdateTalkStateFunc`

redocument EnGo subtypes as an enum

3411f1e

Document EnGo path param

687e70e

Document EnGo opening Goron's cage

78d0d41

Document func_80A3F0E4 as EnGo_UpdateBlinking

8784c81

reason: `EnGo2_EyeMouthTexState` code analogy

streamline EnGo *_Draw function into 3 sections

46a13d5

returns are indeed required to match

Document bouncing in EnGo_IsRollingOnGround

bbf4225

Document EnGo .unk_218 as .waypoint

3be6be5

Document EnGo .unk_20E as .knockbackCooldown

87097be

Document EnGo .unk_212 as .attentionCooldown

9de2038

Document EnGo .unk_21E as .eyedropsTimer

91d1382

Document EnGo .unk_210 as .curledTimer

705ff1b

Document EnGo .unk_20C as .gaveSword

8fb7fc2

EnGo_IsCameraModified -> EnGo_IsAttentionDrawn

4a793fa

Document EnGo play speed factor

c794de2

Document EnGo funtions based on the context

d9bd40d

prepare EnGo2's *_Draw function

686f367

Document bouncing in EnGo2_IsRollingOnGround

2cc0e12

Document EnGo2 .unk_211 as .isUncurled

4ecd12d

Document EnGo2 .unk_216 as .reverseWaypoint

50d3b84

redocument EnGo2 message states

7f30ab6

move EnGo2 .goronState comments to the TU

960c8b5

partially they already were there

redocument EnGo2 .alpha as .shadowAlpha

3b0e2ce

and `func_80A45360` as `EnGo2_UpdateShadowAlpha`

EnGo2_IsCameraModified->EnGo2_IsAttentionDrawn

787b260

Feacur added 9 commits November 14, 2024 02:09

remove unnecessary block braces

a8dff36

zeldaret#2295 (comment)

CAGED_FLAG -> CAGED_SWITCH_FLAG

e2cda14

zeldaret#2295 (comment)

remove a [mis]leading zero

fff6cf4

remove unnecessary comment

2ab3f6b

zeldaret#2295 (comment)

use uniform naming between variables

e87bc05

zeldaret#2295 (comment)

tweak EnGo2_UpdateTalking code and comments

1fa1922

zeldaret#2295 (comment) zeldaret#2295 (comment) zeldaret#2295 (comment) zeldaret#2295 (comment)

link two if parts with and else

9115505

zeldaret#2295 (comment)

Document actor.params bits allocation

57951ed

Document actor.params bits allocation

4063499

an "ammendment" for 57951ed somehow haven't saved the changes that time

yeah, be less judgemental

d891107

fig02 added Needs first approval Needs second approval labels Nov 14, 2024

Feacur added 2 commits November 15, 2024 00:43

clarify "in range" of what it is

768297f

use BINANG macros instead of hex values

423748a

Feacur force-pushed the doc/actor_goron branch from 771e39d to 423748a Compare November 15, 2024 01:18

Feacur added 4 commits November 18, 2024 13:19

give a function a better name

fe53732

name animation reversing func as such

5ba85a3

follow the bugs documentation style guide

5d1bf77

give better names to rolling checks

771570a

cadmic approved these changes Nov 27, 2024

View reviewed changes

Merge branch 'main' into doc/actor_goron

bdf44ff

fig02 removed the Needs first approval label Dec 3, 2024

Feacur added 2 commits December 8, 2024 21:35

tweak animations' names

220007e

move defines into the headers

6b3eebb

Feacur mentioned this pull request Dec 9, 2024

Rename known flags documented in EnGo2 #2334

Open

Merge branch 'main' into doc/actor_goron

96c9712

fig02 reviewed Dec 13, 2024

View reviewed changes

src/code/z_actor.c Outdated Show resolved Hide resolved

Feacur added 2 commits December 13, 2024 16:57

restore func_8002F368 name

e5c5c32

Merge branch 'main' into doc/actor_goron

2efe6fe

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document `EnGo` and `EnGo2` functions, fields, and animations #2295

Document `EnGo` and `EnGo2` functions, fields, and animations #2295

Feacur commented Nov 13, 2024 •

edited

Loading

Feacur commented Nov 14, 2024 •

edited

Loading

fig02 left a comment •

edited

Loading

Document EnGo and EnGo2 functions, fields, and animations #2295

Are you sure you want to change the base?

Document EnGo and EnGo2 functions, fields, and animations #2295

Conversation

Feacur commented Nov 13, 2024 • edited Loading

Feacur commented Nov 14, 2024 • edited Loading

fig02 left a comment • edited Loading

Choose a reason for hiding this comment

Document `EnGo` and `EnGo2` functions, fields, and animations #2295

Document `EnGo` and `EnGo2` functions, fields, and animations #2295

Feacur commented Nov 13, 2024 •

edited

Loading

Feacur commented Nov 14, 2024 •

edited

Loading

fig02 left a comment •

edited

Loading