Skip to content

Document Contest script commands#982

Open
CharlesFolz4 wants to merge 5 commits intopret:mainfrom
CharlesFolz4:ContestScript
Open

Document Contest script commands#982
CharlesFolz4 wants to merge 5 commits intopret:mainfrom
CharlesFolz4:ContestScript

Conversation

@CharlesFolz4
Copy link
Contributor

@CharlesFolz4 CharlesFolz4 commented Mar 1, 2026

Document Contest script commands

Renamed scripts_contest_registration to scripts_contests
Label prefixes in scripts_contests are split into ContestRegistration_, OngoingContest_, etc, depending on context.
ObjectEventIDs referenced in this script are prefixed with their map, either CONTEST_HALL_LOBBY_, or CONTEST_HALL_STAGE_ONGOING_CONTEST_, instead of LOCALID_, because this script file is not local to any one specific map.

Major struct identified UnkStruct_02095C48 as Contest

This also includes a lot of scattered miscellaneous contest documentation that isn't specific to the scripts, but was helpful in building up context for identifying things in general, and also serves as some initial contest documentation.

Copy link
Collaborator

@lhearachel lhearachel left a comment

Choose a reason for hiding this comment

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

Some preliminary feedback, mostly for the script commands and some structure.

.endm

.macro ScrCmd_0FA arg0, arg1, arg2, arg3
.macro ContestNew contestRank, contestType, competitionType, partySlot
Copy link
Collaborator

Choose a reason for hiding this comment

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

suggestion: Script commands should start with a verb. Maybe StartContest? NewContest?

.endm

.macro ScrCmd_0FC arg0, arg1
.macro ScrCmd_BufferJudgeName judgeID, idx
Copy link
Collaborator

Choose a reason for hiding this comment

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

issue: Remove the ScrCmd_ prefix from this command.

.macro ScrCmd_114
.macro HBlankSystem_Start
.short 276
.endm
Copy link
Collaborator

Choose a reason for hiding this comment

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

suggestion: StopHBlank / StartHBlank.

.endm

.macro ScrCmd_115 arg0
.macro ScrCmd_GetShouldSkipAwardCeremony destSkipAwardCeremony
Copy link
Collaborator

Choose a reason for hiding this comment

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

issue: Ditto here for the ScrCmd_ prefix.

Comment on lines +8 to +10
int ActingCompetitionInit(ApplicationManager *appMan, int *param1);
int ActingCompetitionMain(ApplicationManager *appMan, int *param1);
int ActingCompetitionExit(ApplicationManager *appMan, int *param1);
Copy link
Collaborator

Choose a reason for hiding this comment

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

polish: Add an underscore before Init/Main/Exit. Applies to other occurrences in the PR.

Copy link
Collaborator

Choose a reason for hiding this comment

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

question: This is likely out-of-scope for this PR, but do we have a plan for merging the relevant struct-files together and getting them out of this folder?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now, I think it makes sense to merge just the Contest struct into unk_020933F8.h. Not sure about the rest though.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants