OutFox has actors and actors can have commands. Makes sense that there would be a lot of commands pre-defined by the game, so this is a list of what commands the game has, how and when they're used and what parameters they give.
InitCommand
OnCommand
OffCommand
BeginCommand
EndCommand
SetAttackCommandCalled on the noteskin actor before drawing an Attack-type TapNote
Parameters:
Modifiers (string, The attack associated with the tap note.)
UnsetAttackCommandCalled on the noteskin actor after drawing an Attack-type TapNote
ScreenGainFocusCommandCalled when processing the SM_GainFocus Screen Message.
Only used in ScreenOptionsManageProfiles, ScreenOptionsManageEditSteps and ScreenOptionsManageCourses.
ScreenLoseFocusCommandCalled when processing the SM_LoseFocus Screen Message.
Only used in ScreenOptionsManageProfiles, ScreenOptionsManageEditSteps and ScreenOptionsManageCourses.
LoseLifeCommandCalled when losing a battery.
Prefixed in metrics with "NumLivesP1" and "NumLivesP2".
GainLifeCommandCalled when gaining a battery.
Prefixed in metrics with "NumLivesP1" and "NumLivesP2".
AfterSetCommandCalled on the TextBanner after having set the title, subtitle and artist fields. (Runs after calling SetFromSong or SetFromString)
LoseFocusCommandCalled on BGAs when fading away, on ScreenDebugOverlay's pages when switching away, on OptionRows when switching away from a row, and other places
GainFocusCommandCalled on BGAs when fading in, on ScreenDebugOverlay's pages when switching to them, on OptionRows when switching to a row, and other places
FadeCommandCalled when setting the brightness overlay to the actual brightness (based on cover & BGBrightness)
Prefixed in metrics with "BrightnessOverlay".
NextPageCommandCalled when switching to the next page in ScreenRanking.
SwitchedPageCommandCalled when handling the SM_HidePage Screen Message in ScreenRanking.
ReverseOnCommandCalled on a column's Receptor when the column goes beyond 50% reverse
ReverseOffCommandCalled on a column's Receptor when the column goes below 50% reverse
LiftCommandCalled on a column's Receptor when the column stops being pressed.
PressCommandCalled on a column's Receptor when the column gets pressed.
ProW1/ProW2/ProW3/ProW4/ProW5/W1/W2/W3/W4/W5/MissCommandCalled on a column's Receptor and noteflash when a column gets the relevant judgment.
ShowNoteUpcomingCommandCalled on a column's Receptor when the column has notes approaching
HideNoteUpcomingCommandCalled on a column's Receptor when the column has no notes approaching
EditCommandCalled on ScreenEdit's overlay & underlay when entering the Edit state.
RecordCommandCalled on ScreenEdit's overlay & underlay when entering the Record state.
RecordPausedCommandCalled on ScreenEdit's overlay & underlay when entering the RecordPaused state.
PlayingCommandCalled on ScreenEdit's overlay & underlay when entering the Playing state.
AnimationFinishedCommandCalled on a Sprite when looping an animation.
HoldingOffCommandCalled on a noteflash when ending a hold.
RollOffCommandCalled on a noteflash when ending a roll.
HoldingOnCommandCalled on a noteflash when starting a hold.
RollOnCommandCalled on a noteflash when starting a roll.
ColumnJudgmentCommandCalled on a noteflash when a judgment happens. Also seen as a MessageCommand.
Parameters:
TapNoteScore (TapNoteScore enum, The related judgment. nil for hold notes)HoldNoteScore (HoldNoteScore enum, The related judgment. nil for tap notes)Column (integer, The column the judgment happened on.)Color (string, The last color seen on the noteskin. ScreenNetSelectBase appears to modify this)JudgmentCommand(Not to be confused with the Judgment MessageCommand!)
Called on a noteflash when a judgment happens.
BrightCommandCalled on a noteflash when the combo is higher than the bright threshold.
DimCommandCalled on a noteflash when the combo is lower than the bright threshold.
ToggledCommandCalled on the button text of ScreenDebugOverlay when the button is pressed.
Prefixed in metrics with "ButtonText"
DeSelCommandCalled when pressing menuup or menudown on ScreenNetEvaluation.
Prefixed in metrics with "User"
SelCommandCalled when pressing menuup or menudown on ScreenNetEvaluation.
Prefixed in metrics with "User"
Tier02OrBetterCommandCalled in ScreenNetEvaluation when a player got a grade of tier 2 or better.
Prefixed in metrics with "User"
ShowCommandCalled in ScreenGameplayLesson when showing a page, in OptionsList when something is selected, in DifficultyList, and on the ScreenSyncOverlay when showing help.
HideCommandCalled in ScreenGameplayLesson when hiding a page, in OptionsList when something is deselected, in DifficultyList, and on the ScreenSyncOverlay when hiding help.
StartTransitioningCommandCalled when starting a screen transition.
GoToOptionsCommandCalled when going into the Song Options menu.
AskFroGoToOptionsCommandCalled when asking if the player wants to go into the Song Options menu.
DisabledCommandCalled when showing that an OptionRow or ScreenSelectMaster choice is disabled.
RefreshCommandCalled on OptionRow when setting the ModIcon.
Parameters:
GameCommand (GameCommand object, The related commands.)Text (string, The text that goes with the commands.)LevelCommandCalled when setting the content of a PaneDisplay.
ConnectedCommandCalled in ControllerStateDisplay.
UnpluggedCommandCalled in ControllerStateDisplay.
NeedsMultitapCommandCalled in ControllerStateDisplay.
NoInputHandlerCommandCalled in ControllerStateDisplay.
SetTwoRowsCommandCalled when setting an OptionsList underline to work with items in two rows.
Prefixed in metrics with "Underline".
SetOneRowCommandCalled when setting an OptionsList underline to work with items in one row.
Prefixed in metrics with "Underline".
PositionTwoRowsCommandCalled when setting an OptionsList cursor to work with items in two rows.
Prefixed in metrics with "Cursor".
PositionOneRowCommandCalled when setting an OptionsList cursor to work with items in one row.
Prefixed in metrics with "Cursor".
TweenOffCommandCalled when loading or closing an OptionRow, tweening off the debug text in ScreenGameplay, and in ScreenMapControllers.
TransformCommandCalled on the Player's Judgment & Combo during `Player::Init``
Prefixed in metrics with "Judgment" and "Combo"
Parameters:
Player (PlayerNumber enum, The PlayerNumber for the combo & judgment.)MultiPlayer (MultiPlayer enum, The MultiPlayer for the combo & judgment.)iEnabledPlayerIndex (integer, The enabled player index)iNumEnabledPlayers (integer, The number of total enabled players)bPlayerUsingBothSides (boolean, If the current style has one player on both "sides", like Doubles)bReverse (boolean, Is the player on Reverse?)bCentered (boolean, Is the player on Centered?)ResetCommandCalled when resetting an OptionRow or Player Judgment.
TweenOffCommandCalled when opening an OptionRow, displaying the debug text in ScreenGameplay, and in ScreenMapControllers.
TweenOutForwardCommandCalled when tweening out of an OptionsList.
Prefixed in metrics with "OptionsList"
TweenOutBackwardCommandCalled when tweening out of an OptionsList.
Prefixed in metrics with "OptionsList"
TweenInForwardCommandCalled when tweening into an OptionsList.
Prefixed in metrics with "OptionsList"
TweenInBackwardCommandCalled when tweening into an OptionsList.
Prefixed in metrics with "OptionsList"
EnabledCommandCalled when showing that a ScreenSelectMaster choice is enabled.
SwitchToPage1Command / SwitchToPage2CommandCalled when switching to a different page in ScreenSelectMaster.
Prefixed in metrics with "IconChoice1/2/3/4", "ExplanationPage1/2", "MorePage1/2"
LostSelectedLoseFocusCommandCalled when canceling a selection in ScreenSelectMaster.
LostSelectedGainFocusCommandCalled when canceling a selection in ScreenSelectMaster.
ChangeCommandCalled when changing a selection in ScreenSelectMaster, when updating a StepsDisplayList/DifficultyList or when updating ScreenOptions.
Prefixed in metrics with "CursorP1" and "CursorP2"in the case of ScreenSelectMaster.
MadeChoiceP1Command / MadeChoiceP2CommandCalled when making a selection in ScreenSelectMaster.
ChooseCommandCalled on the cursor when making a selection in ScreenSelectMaster.
InitialSelectionCommandCalled when making a selection in ScreenSelectMaster during a two-step selection.
OffFocusedCommandCalled when tweening off ScreenSelectMaster.
OffUnfocusedCommandCalled when tweening off ScreenSelectMaster.
BackCommandCalled when turning on a BG in ScreenPackages? Also when setting up the backside of the CDTitle.
Prefixed in metrics with "PackagesBG", "WebBG" and "CDTitle"
AwayCommandCalled when turning off a BG in ScreenPackages?
Prefixed in metrics with "PackagesBG" and "WebBG"
HeldCommandCalled on a HoldJudgment when a hold or roll is completed.
Prefixed in metrics with "HoldJudgment"
LetGoCommandCalled on a HoldJudgment when a hold or roll is dropped.
Prefixed in metrics with "HoldJudgment"
MissedHoldCommandCalled on a HoldJudgment when a hold or roll is missed.
Prefixed in metrics with "HoldJudgment"
TwentyFiveMilestoneCommandCalled on Player when displaying a 25 combo milestone.
FiftyMilestoneCommandCalled on Player when displaying a 50 combo milestone.
HundredMilestoneCommandCalled on Player when displaying a 100 combo milestone.
TwoHundredFiftyMilestoneCommandCalled on Player when displaying a 250 combo milestone.
ThousandMilestoneCommandCalled on Player when displaying a 1000 combo milestone.
ComboCommandCalled on the Player when updating the combo amount.
Parameters:
Combo (integer, The current combo.)Misses (integer, The current number of misses.)FullComboW1 (boolean, The player currently has a full combo and the lowest TNS is W1.)FullComboW2 (boolean, The player currently has a full combo and the lowest TNS is W2.)FullComboW3 (boolean, The player currently has a full combo and the lowest TNS is W3.)FullComboW4 (boolean, The player currently has a full combo and the lowest TNS is W4.)SortOnCommandCalled when tweening on the sorting screen in Music Wheels.
Prefixed in metrics with "MusicWheel", "MusicWheelItem" and "Highlight"
SortOffCommandCalled when tweening off the sorting screen in Music Wheels.
Prefixed in metrics with "MusicWheel", "MusicWheelItem" and "Highlight"
DieCommandCalled when a Player dies in Oni mode
Prefixed in metrics with "OniGameOverP1" and "OniGameOverP2"
SetCommand (ScreenGameplay)Called when setting a Player's StepsDisplay?
Prefixed in c++ with "SetDummy%i", "SetP1" and "SetP2"
SetReverseCommandCalled on LyricsDisplay and StepsDisplay when Reverse is on.
Prefixed in metrics with "LyricDisplay", "StepsDisplayP1" and "StepsDisplayP2"
SetNoReverseCommandCalled on LyricsDisplay and StepsDisplay when Reverse is off.
Prefixed in metrics with "LyricDisplay", "StepsDisplayP1" and "StepsDisplayP2"
SetOneReverseCommandCalled on LyricsDisplay when Reverse is on at least one Player, but not all.
Prefixed in metrics with "LyricDisplay"
PauseCommandCalled on ScreenGameplay when pausing the game.
UnpauseCommandCalled on ScreenGameplay when unpausing the game.
StartOnCommandCalled on ScreenGameplay's debug text when start is held
Prefixed in metrics with "Debug"
BackOnCommandCalled on ScreenGameplay's debug text when the back button is held
Prefixed in metrics with "Debug"
StartCommandCalled on ScreenGameplay's next course song item when starting to load the next song.
FinishCommandCalled on ScreenGameplay's next course song item when switching to the next song.
FadeFromCachedCommandCalled on FadingBanner when loading from a cached image to the actual image.
Prefixed in metrics with "Banner"
FadeOffCommandCalled on FadingBanner when loading from nothing to the actual image.
Prefixed in metrics with "Banner"
ResetFadeCommandCalled on FadingBanner after performing the fade.
Prefixed in metrics with "Banner"
RouletteCommandCalled on FadingBanner when fading to the roulette banner.
Prefixed in metrics with "Banner"
RandomCommandCalled on FadingBanner when fading to the random banner.
Prefixed in metrics with "Banner"
<custom>CommandCalled on FadingBanner when fading to a custom banner.
Prefixed in metrics with "Banner"
SpecialKeyCalled on ScreenTextEntry's cursor when on a special key.
RegularKeyCalled on ScreenTextEntry's cursor when on a regular key.
NeverShowCalled on ScreenMapControllers' warning actor if it exists.
MappedInputCommandCalled in ScreenMapControllers after having mapped a key.
Prefixed in metrics with "MappedTo"?
LoseMarkCommandCalled in ScreenMapControllers when removing an element from the set list.
Prefixed in metrics with "MappedTo"?
GainMarkCommandCalled in ScreenMapControllers when adding an element to the set list.
Prefixed in metrics with "MappedTo"?
WaitingCommandCalled in ScreenMapControllers when waiting for the player to set a key after hitting enter.
Prefixed in metrics with "MappedTo"?
SetTextCommandCalled when sanity checking the input from ScreenMapControllers.
Parameters:
Text (string, The reasons a sanity check failed.)FirstUpdateCommandCalled when ScreenWithMenuElements begins the screen.
SetHelptextCommandCalled when ScreenWithMenuElements updates the HelpText.
Parameters:
Text (string, The help text.)CancelCommandCalled when canceling out of a ScreenWithMenuElements menu.
Prefixed in metrics with "Out", "Cancel"
ChangeCommandCalled when ScreenWithMenuElements begins the screen.
FrontCommandCalled when setting up the frontside of the CDTitle.
Prefixed in metrics with "CDTitle"
ModsCommandCalled during ScreenSelectMusic's BeginScreen.
ShowEnteringOptionsCommandCalled when entering the PlayerOptions menu after selecting a song.
HidePressStartForOptionsCommandCalled when hiding the prompt to enter the Player Options menu.
SortChangeCommandCalled when changing the sort order of ScreenSelectMusic
ShowPressStartForOptionsCommandCalled when showing the prompt to enter the Player Options menu.
ChangeToExitCommandCalled when moving the highlight line to the exit button.
Prefixed in metrics with "LineHighlight", "LineHighlightP1" and "LineHighlightP2"
SelectedCommandCalled when changing a value in ScreenOptions?
UnselectedCommandCalled when changing a value in ScreenOptions?
Called when changing the group & song banner in ScreenEdit as well as when updating the LyricDisplay.
Prefixed in metrics for LyricDisplay with "LyricFront" and "LyricBack"
PlayerStateSetCommandCalled when running NoteField::Init(), can be seen in 5.0.12's default theme with NoteField board.
Parameters:
PlayerNumber (PlayerNumber enum, The player number for the notefield's PlayerState.)LoadCommand (StepsDisplay)Called when running StepsDisplay::Load.
Prefixed in metrics with "Frame" and maybe others?
Parameters:
PlayerState (PlayerState object, The PlayerState for the given StepsDisplay.)SetCommand (StepsDisplay)Called when running StepsDisplay::SetInternal.
Prefixed in metrics with "Frame", "Ticks", "Meter", "Description", "Credit", "Autogen" and "StepsType"
Parameters:
CustomDifficulty (string, Representation of the difficulty.)DisplayDescription (string, The chart's related description.)Steps (Steps object, The steps of the chart. nil if not available.)Trail (Trail object, The trail for the course. nil if not available.)Meter (integer, The chart meter value.)StepsType (StepsType enum, The type of chart being shown.)AnalogInputCommandCalled on TopScreen from InputHandler when doing analog input. As seen in ScreenTestLuaAnalog
Parameters:
Device (integer, The device ID(?) recorded from the input.)Button (string, The button recorded from the input.)PostSwitchPageCommandCalled on ScreenSelectMaster after switching the page? Also has a MessageCommand variant?
Parameters:
NewPageIndex (integer, The page to switch to.)PreSwitchPageCommandCalled on ScreenSelectMaster before switching the page? Also has a MessageCommand variant?
Parameters:
OldPageIndex (integer, The page to switch from.)NewPageIndex (integer, The page to switch to.)SetCommand (MusicWheelItem)Called on MusicWheelItem when loading from WheelItemData or when handling a change message.
Parameters:
Song (Song object, The song for the wheel item.)Course (Course object, The course for the wheel item.)Index (integer, The index of the wheel item. nil if done through a change message)HasFocus (boolean, Is the wheel item focused? nil if done through a change message)Text (string, The text of the wheel item?)DrawIndex (integer, The draw index of the wheel item. nil if done through a change message)Type (string, The MusicWheelItemType.)Color (RageColor?, The color associated with the wheel item.)Label (string, The label for the wheel item.)SetGradeCommandCalled on MusicWheelItem when refreshing grades.
Parameters:
PlayerNumber (PlayerNumber enum, The player who has the grade)Grade (Grade enum, The highest grade gotten. nil if there's no HighScoreList.)NumTimesPlayed (integer, How many times the song or course was played. nil if there's no HighScoreList.)MenuTimerExpiredCalled on ScreenNameEntryTraditional when the menu timer hits zero. Also seen as a MessageCommand.
PlayerFinishedCommandCalled on ScreenNameEntryTraditional when a player finishes entering their name. Also seen as a MessageCommand.
Parameters:
PlayerNumber (PlayerNumber enum, The player that finished.)EntryChangedCommandCalled on ScreenNameEntryTraditional when a player updates their selection text.
Parameters:
PlayerNumber (PlayerNumber enum, The player that updated their selection text.)Text (string, The current text. Has a _ at the end if more characters can be entered.)SelectKeyCommandCalled on ScreenNameEntryTraditional when a player changes which key is being selected.
Parameters:
PlayerNumber (PlayerNumber enum, The player that changed the key.)Key (string, The currently selected key)SetSongCommandCalled on CourseContentsList when setting the item from GameState.
Parameters:
PlayerNumber (PlayerNumber enum, The player who selected the course)Song (Song object, The song for this part of the course)Steps (Steps object, The Steps of the song.)Difficulty (Difficulty enum, The Difficulty of the course)Meter (integer, The difficulty meter)Number (integer, The position in the course)Modifiers (string, The modifiers to apply for the song)Secret (boolean, Is the song considered a secret?)HurryTimerCommandCalled on ScreenContinue when hurrying up the timer.
Parameters:
PlayerNumber (PlayerNumber enum, The player hurrying up the timer.)LoadCommand (ScoreDisplayNormal)Called when running ScoreDisplayNormal::Init
Parameters:
PlayerState (PlayerState object, The associated PlayerState.)PlayerStageStats (PlayerStageStats object, The associated PlayerStageStats.)SetStatusCommandCalled when updating ScreenSyncOverlay.
Parameters:
Text (string, The status text.)SetAdjustmentsCommandCalled when updating ScreenSyncOverlay.
Parameters:
Text (string, The adjustment text.)SetCommand (ScreenHighScores)Called when configuring the ScoreScroller.
Parameters:
Song (Song object, The song with the high score. nil if it's a course high score.)Course (Course object, The course with the high score. nil if it's a song high score.)Entries (lua table, Steps data. Iterate with pairs and not ipairs.)ScrolledCommandCalled when scrolling ScreenHighScores.
Parameters:
Direction (integer, the direction.)RouletteStoppedMessageCommandCalled when the music wheel is slowing down during roulette.
StartRouletteMessageCommandCalled when the music wheel is starting the roulette
StartRandomMessageCommandCalled when the music wheel chosing a random song from the Random item.
CoinInsertedMessageCommandCalled when insering a coin and clearing credits.
Themes can use this command to update other actors about coin information (Does not send any data).
ToggleConsoleDisplayMessageCommandCalled when pressing the pause key on the keyboard. Its' use in fallback is commented out and the keybind conflicts with the mute actions keybind.
LifeChangedMessageCommandCalled when updating the LifeMeter. Different LifeMeter types give different parameters.
Parameters:
Player (PlayerNumber enum, The Player who's having life differences.)LifeMeter (LifeMeter object, The LifeMeter for that player.)LivesLeft (integer, number of batteries left. nil if not using LifeMeterBattery.)LostLife (boolean, Did the player lose a life? nil if not using LifeMeterBattery.)TapNoteScore (TapNoteScore enum LuaReference, the TapNoteScore the player got. nil if not using LifeMeterTime.)HoldNoteScore (HoldNoteScore enum LuaReference, the HoldNoteScore the player got. nil if not using LifeMeterTime.)OldLife (float, the previous amount of time nil if not using LifeMeterTime.)Difference (float, the difference between the old amount of life and current amount. nil if not using LifeMeterTime.)ShowDangerAllMessageCommandCalled in Background when all players are in danger of failing.
HideDangerAllMessageCommandCalled in background when all players are not in danger of failing (or if they're all dead).
ScreenChangedMessageCommandCalled when running ScreenManager::LoadDelayedScreen
Prefixed in metrics with "CreditsP1" and "CreditsP2" when dealing with the credits text.
SystemMessageMessageCommandCalled when creating a SystemMessage
Parameters:
Message (string, The message itself.)NoAnimate (boolean, Do we do an animated SystemMessage?)HideSystemMessageMessageCommandCalled when hiding the SystemMessage. Seemingly unused?
RefreshCreditTextMessageCommandCalled when refreshing the credits text.
Prefixed in metrics with "CreditsP1" and "CreditsP2".
AutosyncChangedMessageCommandCalled when changing the Autosync type from ScreenDebugOverlay.
ToggleScriptErrorMessageCommandCalled when toggling the error display from ScreenDebugOverlay.
ClearScriptErrorMessageCommandCalled when clearing the current lua errors from ScreenDebugOverlay.
UpdateNetEvalStatsMessageCommandCalled when updating the evaluation stats during net play.
Parameters:
ActivePlayerIndex (integer, The current active player.)Difficulty (Difficulty enum, The song's difficulty.)Score (integer, The player's score.)Grade (integer, The player's grade.)PlayerOptions (string, The player's playeroptions.)Steps (Steps object, The song's steps. nil if they don't exist.)ScoreChangedMessageCommandCalled when loading ScoreKeeperNormal and handling score.
Parameters:
PlayerNumber (PlayerNumber enum, The PlayerNumber associated with the score.)MultiPlayer (MultiPlayer enum, The MultiPlayer associated with the score.)ToastyCombo (integer, The current combo as the toasty sees it. nil if not coming from ScoreKeeperNormal::HandleTapRowScore)CurrentComboChangedP1MessageCommand / CurrentComboChangedP2MessageCommandCalled when dealing with combo in ScoreKeeperNormal.
ToastyAchievedMessageCommandCalled when a player gets the toasty.
Parameters:
PlayerNumber (PlayerNumber enum, The PlayerNumber associated with the toasty.)ToastyCombo (integer, The current combo as the toasty sees it. nil if not coming from ScoreKeeperNormal::HandleTapRowScore)Level (integer, How many times has the player gotten a toasty?)ToastyDroppedMessageCommandCalled when a player drops the toasty.
Parameters:
PlayerNumber (PlayerNumber enum, The PlayerNumber associated with the dropped toasty.)AutoJoyMappingAppliedMessageCommandCalled when automapping a joystick.
CrossedBeatMessageCommandCalled every time a beat is crossed?
Parameters:
Beat (integer, The beat that was just crossed?)LessonClearedMessageCommandCalled when clearing a lesson?
LessonFailedMessageCommandCalled when failing a lesson?
LessonTry1MessageCommand / LessonTry2MessageCommandCalled when attempting a lesson?
StorageDevicesChangedMessageCommandCalled when updating the MemoryCardManager.
CardRemovedP1MessageCommand / CardRemovedP2MessageCommandCalled when a memory card is removed?
SongModifiedMessageCommandCalled when saving sync changes while in EditMode.
OptionsListOpenedMessageCommandCalled every time an OptionsList is opened.
Parameters:
Player (PlayerNumber enum, The player that opened the OptionsList.)OptionsListClosedMessageCommandCalled every time an OptionsList is closed.
Parameters:
Player (PlayerNumber enum, The player that closed the OptionsList.)OptionsListQuickChangeMessageCommandCalled every time an OptionsList selection changes. Used when Start is used as down, and the button is left or right.
Parameters:
Player (PlayerNumber enum, The player that changed the OptionsList.)Direction (integer, The direction to move.)Selection (integer, The item being selected.)OptionsListLeftMessageCommand / OptionsListRightMessageCommandCalled every time an player moves on the OptionsList.
Parameters:
Player (PlayerNumber enum, The player that moved through the OptionsList.)Selection (integer, The item being selected.)OptionsMenuChangedMessageCommandCalled when switching to a different row.
Parameters:
Player (PlayerNumber enum, The player that changed to the row.)Menu (string, The menu being switched to?)OptionsListPopMessageCommandCalled when popping off an OptionsList.
Parameters:
Player (PlayerNumber enum, The player that popped off the list.)OptionsListResetMessageCommandCalled when resetting an OptionsList.
Parameters:
Player (PlayerNumber enum, The player that reset the list.)OptionsListPushMessageCommandCalled when pushing an OptionsList.
Parameters:
Player (PlayerNumber enum, The player that pushed the list.)OptionsListStartMessageCommandCalled when pushing the start button in an OptionsList.
Parameters:
Player (PlayerNumber enum, The player that pushed the start button.)Selection (integer, The item being selected.)DownloadFinishedMessageCommandCalled when a download finishes in ScreenInstallOverlay.
MenuLeftP1MessageCommand / MenuLeftP2MessageCommand / MenuDownP1MessageCommand / MenuDownP2MessageCommand / MenuUpP1MessageCommand / MenuUpP2MessageCommand / MenuRightP1MessageCommand / MenuRightP2MessageCommandCalled when moving around ScreenSelectMaster, ScreenOptions or ScreenSelectProfile.
MenuSelectionChangedMessageCommandCalled when updating a menu selection on ScreenSelectMaster or ScreenOptions.
MenuStartP1MessageCommand / MenuStartP2MessageCommandCalled when pushing the start button ScreenSelectMaster or ScreenOptions.
Parameters:
ScreenEmpty (boolean, Is the screen empty?) (Is this the screen we're about to go to?)CurrentCourseChangedMessageCommandCalled when changing the course, shuffling the Workout or shuffling the course.
ComboChangedMessageCommandCalled when updating the player's Combo.
Parameters:
Player (PlayerNumber enum, The player whose combo is getting updated.)OldCombo (integer, the old combo)OldMissCombo (integer, the old miss combo)PlayerState (PlayerState object LuaReference, the Player's PlayerState. nil if it doesn't exist.)PlayerStageStats (PlayerStageStats object LuaReference, the Player's PlayerStageStats. nil if it doesn't exist.)ScoreNoneMessageCommandCalled when processing a TapNoteScore_None in Player.
StepMessageCommandCalled when any player steps.
Parameters:
PlayerNumber (PlayerNumber enum, the player that did the step.)MultiPlayer (MultiPlayer enum, The MultiPlayer that did the step.)Column (integer, the column getting stepped. 0-indexed?)StepP1MessageCommand / StepP2MessageCommandCalled when any player steps. For backwards compatbility with older content.
JudgmentMessageCommand(Not to be confused with JudgmentCommand!)
Called when any player gets a judgment.
Parameters:
Player (PlayerNumber enum, the player that did the step.)MultiPlayer (MultiPlayer enum, The MultiPlayer that did the step.)FirstTrack (integer, The first column to hit the note.)NumTracks (integer, Number of columns with a hold? Only seen with Hold judgments.)TapNoteScore (TapNoteScore enum, the tap note score that was gotten.)HoldNoteScore (HoldNoteScore enum, the hold note score that was gotten.)Early (boolean, Was the hit early? Only seen with non-Hold judgments.)TapNoteOffset (float, How far away was the hit in seconds?)Holds (lua table, indexable by column number for everything that has a hold running. Only seen with non-Hold judgments.)Notes (lua table of TapNotes, indexable by column number for everything that has a note hit at once. Only seen with non-Hold judgments.)TapNote (TapNote object?, The TapNote for the hold. Only seen with Hold Judgments.)JudgmentMessageCommand (Mines)(Not to be confused with JudgmentCommand!)
Called when any player gets a judgment relating to a mine.
Parameters:
Player (PlayerNumber enum, the player that did the step.)TapNoteScore (TapNoteScore enum, the tap note score that was gotten.)FirstTrack (integer, The first column to hit the mine.)JudgmentWindowMessageCommandCalled when making use of luajudgments.
Parameters:
Type (string, The thing being judged.)Window (float, How far away the note was when it was hit.)score (TapNoteScore enum, Set from lua, determines the score a player should get.)timing (float, Set from lua, determines the timing window a player should use.)<DeviceInput>PressedMessageCommand / <DeviceInput>ReleasedMessageCommandCalled from ScreenTestInput when recieving input. <DeviceInput> is replaced with a ToString'd input name.
UpdateScreenheaderMessageCommandCalled when updating a NetRoom's room title.
Parameters:
Header (string, The header text.)Subheader (string, The subheader text.)DoneLoadingNextSongMessageCommandCalled when ScreenGameplay finishes loading the next song in a course. Seems unused?
HealthStateMessageCommandCalled when a player's HealthState changes.
Parameters:
PlayerNumber (PlayerNumber enum, the player that's having their health state change.)HealthState (HealthState enum, The current health state.)OldHealthState (HealthState enum, The previous health state.)PlayerFailedMessageCommandCalled when a player fails.
Parameters:
PlayerNumber (PlayerNumber enum, the player that failed.)BeatCrossedMessageCommandCalled every time a beat is crossed in ScreenGameplay. Seems unused?
NoteCrossedMessageCommand / NoteWillCrossMessageCommandCalled when a player's note will cross or has crossed.
Parameters:
PlayerNumber (PlayerNumber enum, the player whose note is gonna cross. nil if both players have the same style.)ButtonName (string, The column's button.)NumTracks (integer, The number of tracks with a tap or hold head.)IsMine (boolean, Is the note a mine?)NumMessagesFromCrossed (integer, How many messages is the note away from crossing? 0 = crossed.)NoteWillCrossIn400Ms / NoteWillCrossIn800Ms / NoteWillCrossIn1200MsCalled when a note is going to cross. Refer to message names for distance?
NoteCrossedJumpMessageCommandCalled when a jump crosses.
BeforeLoadingNextCourseSongMessageCommandCalled before playing the next song transition in a course.
ChangeCourseSongInMessageCommandCalled after playing the next song transition in a course.
ChangeCourseSongOutMessageCommandCalled when loading the next song in a course.
<PreferenceName>ChangedMessageCommandCalled when a preference changes. <PreferenceName> is replaced with the actual preference name.
PlayerJoinedMessageCommandCalled when a player joins.
Parameters:
Player (PlayerNumber enum, the player that joined.)PlayerUnjoinedMessageCommandCalled when a player leaves.
Parameters:
Player (PlayerNumber enum, the player that left.)GoalCompleteP1MessageCommand / GoalCompleteP2MessageCommandCalled when a player completes a workout goal?
WorkoutGoalCompleteMessageCommandCalled when a player completes a workout goal during a course.
ScriptErrorMessageCommandCalled when a lua script errors or reports an error.
Parameters:
message (string, The error message.)DisplayLanguageChangedMessageCommandCalled when switching between transliterated and native language on the music wheel (Press F9).
StepsUnchosenMessageCommandCalled when a player unselects steps.
Parameters:
Player (PlayerNumber enum, The player that backed out.)SelectMenuInputMessageCommandCalled in ScreenSelectMusic. Not sure when.
Parameters:
Player (PlayerNumber enum, The player that caused this.)Button (string, The button that was pressed)PreviousSongMessageCommandCalled when moving to the previous song in ScreenSelectMusic.
NextSongMessageCommandCalled when moving to the next song in ScreenSelectMusic.
PreviousGroupMessageCommandCalled when moving to the previous group in ScreenSelectMusic.
NextGroupMessageCommandCalled when moving to the next group in ScreenSelectMusic.
TwoPartConfirmCanceledMessageCommandCalled when canceling out of a Two-Part confirm.
SongUnchosenMessageCommandCalled when a player unselects a song.
Parameters:
Player (PlayerNumber enum, The player that backed out.)PlayerOptionsChangedMessageCommandCalled when a player changes their PlayerOptions through CodeDetector (ScreenSelectMusic).
Parameters:
PlayerNumber (PlayerNumber enum, The player that performed the code.)SongOptionsChangedMessageCommandCalled when a player changes the SongOptions through CodeDetector (ScreenSelectMusic).
SelectMenuOpenedMessageCommand / SelectMenuClosedMessageCommandCalled when updating the select button status on ScreenSelectMusic.
Parameters:
Player (PlayerNumber enum, The player that pushed select.)ChangeStepsMessageCommandCalled when changing the current steps.
Parameters:
Player (PlayerNumber enum, The player that changed the steps.)Direction (integer, The direction the player went.)SongChosenMessageCommandCalled when choosing the steps like in pump pro.
StepsChosenMessageCommandCalled when choosing the steps.
Parameters:
Player (PlayerNumber enum, The player that chose the steps.)StartSelectingSongMessageCommand / StartSelectingStepsMessageCommand / StartFinalizedMessageCommandCalled at some point in ScreenSelectMusic?
SelectMultipleMessageCommandCalled when changing the rows in ScreenOptions.
Parameters:
PlayerNumber (PlayerNumber enum, The player that is changing things.)RowIndex (integer, The current row.)ChoiceInRow (integer, The current selection in the row.)Selected (boolean, Is the current item selected?)ChangeValueMessageCommandCalled when changing the value in ScreenOptions.
Parameters:
PlayerNumber (PlayerNumber enum, The player that is changing things.)RowIndex (integer, The current row.)ChangeRowMessageCommandCalled when changing the rows in ScreenOptions in an absolute amount.
Parameters:
PlayerNumber (PlayerNumber enum, The player that is changing things.)RowIndex (integer, The current row.)ChangedToExit (boolean, Is the current row an exit?)LifeMeterChangedP1MessageCommand / LifeMeterChangedP2MessageCommandCalled when setting the life meter state for a given point of time.
Parameters:
Life (float, The current amount of life.)StepsSecond (float, The point of time in the song/course)FriendsUpdateMessageCommandCalled when updating the friends list?
UsersUpdateMessageCommandCalled when updating the users list?
CurrentGameChangedMessageCommandCalled when the current game changes? Seems unused?
PlayModeChangedMessageCommandCalled when the play mode changes? Seems unused?
CoinsChangedMessageCommandCalled when the amount of coins changes? Seems unused?
PreferredSongGroupChangedMessageCommandCalled when the preferred song group changes? Seems unused?
PreferredCourseGroupChangedMessageCommandCalled when the preferred course group changes? Seems unused?
PreferredStepsTypeChangedMessageCommandCalled when the preferred steps type changes? Seems unused?
PreferredDifficultyP1ChangedMessageCommand / PreferredDifficultyP2ChangedMessageCommandCalled when the preferred difficulty changes? Seems unused?
PreferredCourseDifficultyP1ChangedMessageCommand / PreferredCourseDifficultyP2ChangedMessageCommandCalled when the preferred course difficulty changes? Seems unused?
SortOrderChangedMessageCommandCalled when the sort order changes?
CurrentSongChangedMessageCommandCalled when the current song changes?
CurrentStepsP1ChangedMessageCommand / CurrentStepsP2ChangedMessageCommandCalled when the current steps change?
CurrentCourseChangedMessageCommandCalled when the current course changes?
CurrentTrailP1ChangedMessageCommand / CurrentTrailP2ChangedMessageCommandCalled when the current trail changes?
GameplayLeadInChangedMessageCommandCalled when changing the Gameplay lead-in?
EditStepsTypeChangedMessageCommandCalled when the edit steps type changes? Seems unused?
EditCourseDifficultyChangedMessageCommandCalled when the edit course difficulty changes? Seems unused?
EditSourceStepsChangedMessageCommandCalled when the edit source steps changes? Seems unused?
EditSourceStepsTypeChangedMessageCommandCalled when the edit source steps type changes? Seems unused?
EditCourseEntryIndexChangedMessageCommandCalled when the edit course entry index changes? Seems unused?
EditLocalProfileIDChangedMessageCommandCalled when the edit local profile ID changes? Seems unused?
CurrentStyleChangedMessageCommandCalled when the current style changes? Seems unused?