- 
                Notifications
    You must be signed in to change notification settings 
- Fork 138
Document Gym scripts #793
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
base: main
Are you sure you want to change the base?
Document Gym scripts #793
Conversation
        
          
                asm/macros/scrcmd.inc
              
                Outdated
          
        
      | .endm | ||
|  | ||
| .macro ScrCmd_176 arg0 | ||
| .macro SunnyshoreGymButton arg0 | 
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.
polish: PressSunyshoreGymButton (note that it's Sunyshore, not Sunnyshore).
        
          
                asm/macros/scrcmd.inc
              
                Outdated
          
        
      | .endm | ||
|  | ||
| .macro ScrCmd_2CA | ||
| .macro EternaGymAdvanceClockState | 
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.
suggestion: AdvanceEternaGymClock
| "movement_type": "MOVEMENT_TYPE_LOOK_NORTH", | ||
| "trainer_type": "TRAINER_TYPE_NONE", | ||
| "flag": "FLAG_UNK_0x01B2", | ||
| "flag": "FLAG_CANALAVE_RIVAL", | 
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.
thought: Should flags have some verbiage attached to them? e.g., does this flag designate that you've spoken to your rival? Fought your rival? etc.
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.
I wasn't entirely sure how to document the "flag" fields, because "flag" seems to be an active-low indicator for the object's presence.  To me, that means that this field would make more sense to rename as "hidden", rather than append _HIDDEN to every one of these flag variables.  I'm not sure if that would have any further reaching implications though.
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.
Yes, the flag being set to non-0 means that the object should be hidden. What if we just use a verbiage of FLAG_HIDE_X?
| "_comment": "this is right above the kid at the bottom of the stairs", | ||
| "script": 3, | 
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.
suggestion: I don't think that this comment adds much value long-term; the goal is for events to be edited in some kind of GUI, anyways.
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.
Whoops, that was supposed to be a debug/note thing, forgot to delete it before committing.
|  | ||
| AcuityCavern_CheckShouldUxieBeRemoved: | ||
| GoToIfSet FLAG_UNK_0x008E, AcuityCavern_RemoveUxie | ||
| GoToIfSet FLAG_MAP_LOCAL, AcuityCavern_RemoveUxie | 
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.
question: Is this really local...? If so, what does "local" mean?
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.
As far as I can tell, this is being used in the same way as the VAR_MAP_LOCAL_ variables are, except it's a boolean value written to and read from like a flag, instead of being an integer like the VAR_MAP_LOCAL_ variables, so that terminology was copied.
Document Gym scripts
Add macro for GoToIfBadgeAcquired