Available in sm-ssc only (compared to StepMania 4 alpha 5)
Defined in sm-ssc's _fallback theme
Defined in sm-ssc's default theme
diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml
index 7aced901a2..13b375728b 100644
--- a/Docs/Luadoc/LuaDocumentation.xml
+++ b/Docs/Luadoc/LuaDocumentation.xml
@@ -24,9 +24,24 @@
+
+ [02 StageMods.lua]
+
+
+ [02 StageMods.lua]
+
Returns the base name of file path.
+
+ [02 Colors.lua]
+
+
+ [03 HSV.lua]
+
+
+ [03 Gameplay.lua]
+
Returns a color from a string. color can be in
hex ("#FFFFFFFF") or 0..1 values ("1.0,1.0,1.0,1.0"),
@@ -476,6 +491,9 @@
Returns the Actor's aux value.
+
+ Returns the Actor's base X zoom value.
+
Returns true if the Actor has a command named sCmdName.
@@ -485,6 +503,9 @@
Returns the Actor's current diffusealpha.
+
+ Returns the Actor's horizontal alignment as a number in the range 0..1.
+
Returns the Actor's name.
@@ -503,6 +524,9 @@
Returns the Actor's current Z rotation.
+
+ Returns the Actor's vertical alignment as a number in the range 0..1.
+
Returns the Actor's current width.
@@ -536,12 +560,18 @@
Plays the commands that follow at a normal rate, where fRate is in seconds.
+
+ [02 Lyrics.lua] Plays the lyric command for the specified side ("Back" or "Front").
+
Sets the Actor's name to sName.
Plays a command named sCommandName.
+
+ [02 Actor.lua] Sets the visibility of the Actor based on p being a human player.
+
Makes the Actor grow and shrink. Can use to define different pulsing behavior.
@@ -572,6 +602,12 @@
Scales the Actor to fit inside a rectangle defined by the four float arguments.
+
+ Sets the size of the Actor.
+
+
+ [01 alias.lua] Alias for setsize.
+
Sets a multi-framed Actor's state to iNewState.
@@ -866,6 +902,20 @@
Stops the sound.
+
+
+ Returns true if Announcer sAnnouncer exists.
+
+
+ Returns a table of installed announcers.
+
+
+ Returns the current announcer's name.
+
+
+ Sets the announcer to sNewAnnouncer.
+
+
Loads the background from an UnlockEntry.
@@ -1574,6 +1624,11 @@
Returns a table of the high scores.
+
+
+ Loads the HoldJudgment for the specified MultiPlayer.
+
+
Returns the amount of life left in the LifeMeter as a float in the range 0..1.
@@ -1588,15 +1643,29 @@
Returns true if in danger.
+
+
+ Returns the number of lives remaining.
+
+
+
+ Returns true if player pn's card is locked.
+
Return the state for player pn.
Returns the name of the storage device.
+
+ Returns true if player pn's name is available.
+
+
+ Returns the current MenuTimer's value.
+
Pauses the MenuTimer, stopping it from counting down.
@@ -1621,6 +1690,11 @@
set to nil.
+
+
+
+
+
Controls if the model should loop or not.
@@ -1703,9 +1777,13 @@
+ (PlayerInfo is a part of ScreenGameplay.)
Returns the of player pn.
+
+
+
@@ -1777,6 +1855,12 @@
Returns a table of possible steps.
+
+ Returns a RadarValues object representing the player's actual performance.
+
+
+ Returns a RadarValues object representing the total values for the song.
+
Returns the score.
@@ -1985,6 +2069,12 @@
Returns true if Song s has never been played before (according to the machine profile).
+
+ Returns true if the last load of player pn's profile was a LastGood copy of the profile.
+
+
+ Returns true if the last load of player pn's profile resulted in a tampered or corrupt profile.
+
Saves the machine profile.
@@ -2115,16 +2205,27 @@
Posts a message with the text sScreenMsg to the Screen.
+
+
+ Returns the current StageStats.
+
+
Returns true if a single has its NoteField centered.
+
+ Returns a dummy PlayerInfo for the specified index.
+
Returns the for the specified pn.
Returns the next in the current .
+
+ Returns the PlayerInfo for player pn.
+
Sets the next Screen to be loaded.
@@ -2224,6 +2325,17 @@
Returns player pn's current selected item as an integer.
+
+
+ Returns true if the player is going to the options screen.
+
+
+ [02 StageMods.lua] Sets up modifiers for course modes.
+
+
+ [02 StageMods.lua] Sets up modifiers for non-course modes.
+
+
Tells the screen to go to the previous screen.
@@ -2260,6 +2372,9 @@
Returns the displayed artist of the song.
+
+ Returns a table containing the display BPMs.
+
Returns the displayed full title of the song, including subtitle.
@@ -2350,6 +2465,12 @@
Returns true if the song has .
+
+ Returns true if the song's DisplayBPM is constant.
+
+
+ Returns true if the song's DisplayBPM is secret.
+
Returns true if the song is considered easy.
@@ -2388,6 +2509,9 @@
Returns the course color of course c.
+
+ Returns the extra stage info for the specified Style s. (If bExtra2 is true, it will use the second Extra Stage data instead of the first.)
+
Returns the number of courses loaded via Additional folders.
@@ -2510,7 +2634,7 @@
Crops the Sprite to fWidthxfHeight.
- Alias for CropTo.
+ [01 alias.lua] Alias for CropTo.
@@ -2634,6 +2758,9 @@
+
+ Loads the TextBanner from the specified metrics group.
+
Loads the TextBanner's child elements from a .
@@ -2710,6 +2837,9 @@
Returns true if the TimingData contains BPM changes.
+
+ Returns true if the TimingData contains any BPM changes with a negative BPM.
+
Returns true if the TimingData contains stops.