Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
wants to merge 66 commits into
base: main
Choose a base branch
from
Open

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

wants to merge 66 commits into from
+894 −775

Conversation

Feacur
Copy link
Contributor

@Feacur Feacur commented Nov 13, 2024 •
edited
Loading

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

@Feacur
Document func_8002F368 as Player_GetExchangeItemId
d3eedf6
@Feacur
Document Goron's limbs
f249068
@Feacur
Document Goron's limbs' display lists
a71747b
@Feacur
Document non-limb display lists
b3b6b28
@Feacur
just align attributes
ba0bb10
@Feacur
Document animations
40203d0
@Feacur
remove unused EnGo callbacks
60b8664 
- `callback1_80A3ED24` is `NpcGetTextIdFunc`
- `callback2_80A3ED24` is `NpcUpdateTalkStateFunc`
@Feacur
redocument EnGo subtypes as an enum
3411f1e
@Feacur
Document EnGo path param
687e70e
@Feacur
Document EnGo opening Goron's cage
78d0d41
@Feacur
Document func_80A3F0E4 as EnGo_UpdateBlinking
8784c81 
reason: `EnGo2_EyeMouthTexState` code analogy
@Feacur
streamline EnGo *_Draw function into 3 sections
46a13d5 
returns are indeed required to match
@Feacur
Document bouncing in EnGo_IsRollingOnGround
bbf4225
@Feacur
Document EnGo .unk_218 as .waypoint
3be6be5
@Feacur
Document EnGo .unk_20E as .knockbackCooldown
87097be
@Feacur
Document EnGo .unk_212 as .attentionCooldown
9de2038
@Feacur
Document EnGo .unk_21E as .eyedropsTimer
91d1382
@Feacur
Document EnGo .unk_210 as .curledTimer
705ff1b
@Feacur
Document EnGo .unk_20C as .gaveSword
8fb7fc2
@Feacur
EnGo_IsCameraModified -> EnGo_IsAttentionDrawn
4a793fa
@Feacur
Document EnGo play speed factor
c794de2
@Feacur
Document EnGo funtions based on the context
d9bd40d
@Feacur
prepare EnGo2's *_Draw function
686f367
@Feacur
Document bouncing in EnGo2_IsRollingOnGround
2cc0e12
@Feacur
Document EnGo2 .unk_211 as .isUncurled
4ecd12d
@Feacur
Document EnGo2 .unk_216 as .reverseWaypoint
50d3b84
@Feacur
redocument EnGo2 message states
7f30ab6
@Feacur
move EnGo2 .goronState comments to the TU
960c8b5 
partially they already were there
@Feacur
redocument EnGo2 .alpha as .shadowAlpha
3b0e2ce 
and `func_80A45360` as `EnGo2_UpdateShadowAlpha`
@Feacur
EnGo2_IsCameraModified->EnGo2_IsAttentionDrawn
787b260
mzxrules
mzxrules reviewed Nov 13, 2024
View reviewed changes
Copy link
Contributor

@mzxrules mzxrules left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personal note: gor2 line 993 old.

src/overlays/actors/ovl_En_Go/z_en_go.c Outdated Show resolved Hide resolved
src/overlays/actors/ovl_En_Go/z_en_go.c Outdated Show resolved Hide resolved
src/overlays/actors/ovl_En_Go/z_en_go.c Outdated Show resolved Hide resolved
src/overlays/actors/ovl_En_Go/z_en_go.c Outdated Show resolved Hide resolved
src/overlays/actors/ovl_En_Go/z_en_go.c Outdated Show resolved Hide resolved
src/overlays/actors/ovl_En_Go2/z_en_go2.c Outdated Show resolved Hide resolved
src/overlays/actors/ovl_En_Go2/z_en_go2.c Outdated Show resolved Hide resolved
src/overlays/actors/ovl_En_Go2/z_en_go2.c Outdated Show resolved Hide resolved
src/overlays/actors/ovl_En_Go2/z_en_go2.c Outdated Show resolved Hide resolved
src/overlays/actors/ovl_En_Go2/z_en_go2.c Outdated Show resolved Hide resolved
@Feacur
name Hot Rodder consistently
46648b4 
zeldaret#2295 (comment)
@Feacur
make the unused comment a header
9fae0fa 
zeldaret#2295 (comment)
@Feacur
document the nature of type values
57c4c76 
zeldaret#2295 (comment)
@Feacur
remove unnecessary block braces
a8dff36 
zeldaret#2295 (comment)
@Feacur
CAGED_FLAG -> CAGED_SWITCH_FLAG
e2cda14 
zeldaret#2295 (comment)
@Feacur
remove a [mis]leading zero
fff6cf4
@Feacur
remove unnecessary comment
2ab3f6b 
zeldaret#2295 (comment)
@Feacur
use uniform naming between variables
e87bc05 
zeldaret#2295 (comment)
@Feacur
tweak EnGo2_UpdateTalking code and comments
1fa1922 
zeldaret#2295 (comment)
zeldaret#2295 (comment)
zeldaret#2295 (comment)
zeldaret#2295 (comment)
@Feacur
link two if parts with and else
9115505 
zeldaret#2295 (comment)
@Feacur
Document actor.params bits allocation
57951ed
@Feacur
Document actor.params bits allocation
4063499 
an "ammendment" for 57951ed

somehow haven't saved the changes that time
@Feacur
Copy link
Contributor Author

Feacur commented Nov 14, 2024 •
edited
Loading

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fig02 fig02 fig02 left review comments

@mzxrules mzxrules mzxrules left review comments

@cadmic cadmic cadmic approved these changes

Assignees
No one assigned
Labels
Needs first approval Needs second approval
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Feacur @mzxrules @fig02 @cadmic