-
Notifications
You must be signed in to change notification settings - Fork 596
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.
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
En_Sw
doc
#1466
base: main
Are you sure you want to change the base?
En_Sw
doc
#1466
Conversation
- docing fields and funcs - creating enums for Skultula types - macro for getting type from params.
id'd most fields and funcs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quick review
/* 0x0490 */ char unk_490[0x48]; | ||
} EnSw; // size = 0x04D8 | ||
|
||
#define SW_GOLDTYPE(params) ((params & 0xE000) >> 0xD) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should follow the ENSW_GET_GOLDTYPE(thisx)
format instead, for example see BGICESHELTER_GET_TYPE
or ENDOOR_GET_TYPE
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
using params
as the macro's arg rather than thisx
appears to be more compatible, as there are 3 different use cases of thisx->params
thisx->params - 0x8000
and this->actor.params
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actors don't always put all their params in Actor.params
(mostly for "not everything fits there" reasons), so to abstract where the data goes we decided these macros should take a thisx
(for the this->actor.params
uses it would mean passing &this->actor
to the macro)
Admittedly ENSW_GET_GOLDTYPE((thisx->params - 0x8000))
is a weird one, didn't notice that... I would suggest keeping that one not using the macro for now, a comment could still indicate it's the type
The line below it uses its shift anyway
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be noted that the (thisx)->params
convention breaks in MM (and it's in en_sw
as well):
https://github.com/zeldaret/mm/blob/master/src/overlays/actors/ovl_En_Sw/z_en_sw.h#L10
https://github.com/zeldaret/mm/blob/master/src/overlays/actors/ovl_Obj_Tsubo/z_obj_tsubo.c#L106
There really isn't much reason for us to tie params to an actor instance, yet we do so because we are able to get away with it in most cases. I don't think this issue has ever really been discussed properly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you show in code where there is a macro being passed params instead of thisx?
I don't think this issue has ever really been discussed properly.
It has, Tharo even made #1359
better name for "gold Jumping" bool, matrix used in some rotate calculation, and ends of Skullwalltula's eyesight.
Hi |
merge fix
ran fomat.py
Bump - been sitting on these changes for over a year. |
Hi, sorry again. Been busy with other things in the codebase. I think it would be more efficient for me personally to make the changes I have in mind myself, and push to your branch, rather than to have this go through a long review process. That will have to occur when I have the time and motivation to do so for this large actor. Anyone else is free to review this though if they get to it before me. |
better document behavior of Skullwalltula and Gold Skulltula.