| Name
| Arguments
| Explanation
| Returns
| Example
|
| IsPlayerEnabled
| PlayerNumber
| Checks if {PlayerNumber} is enabled (e.g. playing).
| True/False (1/0)
| IsPlayerEnabled(1)
|
| IsHumanPlayer
| PlayerNumber
| Checks if {PlayerNumber} is a human player or not.
| True/False
| IsHumanPlayer(1)
|
| IsPlayerUsingProfile
| PlayerNumber
| Checks if {PlayerNumber} is using a profile.
| True/False
| IsPlayerUsingProfile(1)
|
| IsWinner
| PlayerNumber
| Checks if {PlayerNumber} is the winner of the current match.
| True/False
| IsWinner(1)
|
| IsCourseMode
| None
| Checks if the current mode is a course mode.
| True/False
| IsCourseMode() == 1
|
| IsDemonstration
| None
| Checks if the current mode is the demonstration mode.
| True/False
| IsDemonstration() == 1
|
| StageIndex
| None
| The number of the current stage.
| Integer
| StageIndex() == 0 [Note: 0 is Stage 1, 1 is Stage 2, etc.]
|
| NumStagesLeft
| None
| Returns how many stages are left to play.
| Integer
|
|
| IsFinalStage
| None
| Checks if the current stage is the final stage.
| True/False
|
|
| IsExtraStage
| None
| Checks if the current stage is the extra stage.
| True/False
|
|
| IsExtraStage2
| None
| Checks if the current stage is the bonus/one more extra stage.
| True/False
|
|
| CourseSongIndex
| None
| The current stage within a course(?)
| Integer
|
|
| PlayModeName
| None
| Returns the current play mode name.
| String
|
|
| CurStyleName
| None
| Returns the current style (single, double, etc.)
| String
|
|
| GetNumPlayersEnabled
| None
| Gets the number of players enabled.
| Integer
|
|
| PlayerUsingBothSides
| None
| Checks if the player is using both sides of the stage (e.g. doubles).
| True/False
|
|
| GetEasiestNotesDifficulty
| None
| Gets the easiest level of the song.
| ?
|
|
| GetEnv
| String
| Returns the environmental variable passed into it.
| String
| GetEnv("Variable") == "Value"
|
| SetEnv
| String, String
| Sets an environmental variable's value.
| None
|
|
| CurSong
| None
| Returns the current song being played.
| Song()
| CurSong() == Song("MEI -for X-")
|
| CurSteps
| PlayerNumber
| Returns the current steps being played.
| Integer
| CurSteps(1) == 1 See #Enumerated Types for information.
|
| MonthOfYear
| None
| Returns current month of year.
| Integer
| MonthOfYear() == 10
|
| DayOfMonth
| None
| Returns current day of month.
| Integer
| DayOfMonth() == 10
|
| Hour
| None
| Returns current hour. Uses 24 hour time.
| Integer (0…23)
| Hour() == 22
|
| Minute
| None
| Returns current minute.
| Integer (0…60)
| Minute() == 22
|
| Second
| None
| Returns current second.
| Integer (0…60)
| Second() == 22
|
| Year
| None
| Returns current year.
| Integer
| Year() == 2007
|
| Weekday
| None
| Returns ?.
| ?
|
|
| DayOfYear
| None
| Returns current day of year.
| Integer
| DayOfYear() == 320
|
| IsNetConnected
| None
| Returns status of network connection (SMLAN).
| True/False
|
|
| IsAnyPlayerUsingMemoryCard
| None
| Checks if any player is using a memory card.
| True/False
|
|
| Song
| String
| An instance of a song.
| ?
|
|
| SongFullDisplayTitle
| Song
| Returns a song's full display title (main and subtitles).
| String
|
|
| StepsMeter
| Steps
| Returns the meter level of the steps.
| Integer
|
|
| GetStagesPlayed
| None
| Returns the number of stages played in this game.
| Integer
|
|
| GetBestGrade
| None
| Returns the best grade gotten in the current round.
| Grade()
| GetBestGrade() <= Grade("AAA")
|
| GetWorstGrade
| None
| Returns the worst grade gotten in the current round.
| Grade()
| GetBestGrade() >= Grade("B")
|
| OnePassed
| None
| Check if at least one player passed the song.
| True/False
|
|
| FullCombo
| PlayerNumber
| Check if {PlayerNumber} full combo'ed the song.
| True/False
| FullCombo(1) == true
|
| MaxCombo
| PlayerNumber
| Return the max combo {PlayerNumber} got.
| Integer
|
|
| GetGrade
| PlayerNumber
| Get the grade for {PlayerNumber}.
| Grade()
| GetGrade(1) == Grade("AAA")
|
| Grade
| String
| A grade.
| Grade()
|
|
| OneGotGrade
| Integer, Integer
| Checks whether either player has the grade specified.
| True/False
|
|
| GetFinalGrade
| PlayerNumber
| Returns final grade (summary) for {PlayerNumber}.
| Grade()
|
|
| GetBestFinalGrade
| None
| Returns the best final grade (summary) between the players.
| Grade()
|
|
| UsingModifier
| PlayerNumber, ModifierName
| Checks if the player is using the modifier specifed.
| True/False
| UsingModifier(1, "reverse")
|
