Sections | |||||
---|---|---|---|---|---|
Singletons | Classes | Namespaces | Global Functions | Enums | Constants |
Functions | |
---|---|
AllowOptionsMenu | |
color | Alpha( color c, float percent )
[02 Colors.lua] Returns a |
bool | AreStagePlayerModsForced( ) [02 StageMods.lua] |
bool | AreStageSongModsForced( ) [02 StageMods.lua] |
ArgsIfPlayerJoinedOrNil | |
string | Basename( string path ) Returns the base name of file path. |
color | BoostColor( color c, float fBoost )
[02 Colors.lua] Boosts the specified color by multiplying its values by |
color | Brightness( color c, float percent ) [02 Colors.lua] Modifies the brightness of the specified color. |
bool | Center1Player( )
[02 Utilities.lua] Returns |
void | CloseConnection( ) Closes any connection to an online server. |
color | ColorDarkTone( color c )
[02 Colors.lua] Returns a darker tone of the color. (Specifically |
color | ColorLightTone( color c )
[02 Colors.lua] Returns a lighter tone of the color. (Specifically |
color | ColorMidTone( color c )
[02 Colors.lua] Returns a midtone of the color. (Specifically |
table | ColorToHSV( color c ) [02 Colors.lua] Takes in a color and returns a table with the HSV values. |
string | ColorToHex( color c ) [02 Colors.lua] Returns a hex representation for the specified color. |
TapNoteScore | ComboContinue( ) [03 Gameplay.lua] Determines what TapNoteScore allows for continuing the combo. |
TapNoteScore | ComboMaintain( ) [03 Gameplay.lua] Determines what TapNoteScore allows for maintaining the combo. |
bool | ComboPerRow( ) [03 Gameplay.lua] Determines if combo should be per row (Jump = 1) or per column (Jump = 2). |
void | ComboTransformCommand( Actor self, params p ) [02 Other.lua] The combo trasform command. |
bool | ComboUnderField( )
[03 Gameplay.lua] Returns the |
bool | ConnectToServer( string sAddress )
Tries to connect to the server at |
CourseDifficultyToLocalizedString | |
CourseTypeToLocalizedString | |
color | CustomDifficultyToColor( string cd ) [02 Colors.lua] |
color | CustomDifficultyToDarkColor( string cd ) [02 Colors.lua] |
color | CustomDifficultyToLightColor( string cd ) [02 Colors.lua] |
CustomDifficultyToLocalizedString | |
int | DayOfMonth( ) Returns the current day of the month. |
int | DayOfYear( ) Returns the current day of the year. |
table | DeepCopy( table from, table to, table already_copied ) [02 Serialize] Recursively deep-copy a table. |
bool | EvalUsesCheckpointsWithJudgments( ) [03 Gameplay.lua] |
int | FailCombo( ) [03 Gameplay.lua] |
int | FindSelection( table list )
[02 Utilities.lua] Return the index of a true value in |
string | FindValue( table tab, various value )
[02 Utilities.lua] Find a key in |
FormatNumSongsPlayed | |
string | FormatNumberAndSuffix( int num ) Returns the number passed to the function followed by its suffix ("th", "nd", and so on). |
string | FormatPercentScore( float fPercentDancePoints )
Returns |
string | GameCompatibleModes( ) [03 Gameplay.lua] Returns a list of valid styles for the current gametype. |
GamePrefDefaultFail | |
string | GetCodeForGame( ) [03 Gameplay.lua] |
GetCoursesToShowRanking | |
string | GetCustomDifficulty( StepsType st, Difficulty d, CourseType ct ) Returns the corresponding CustomDifficulty string for a StepsType/Difficulty (/optional CourseType) combination. |
GetDefaultOptionLines | |
string | GetEditModeSubScreens( ) [02 Other.lua] Returns a string with the Edit Mode SubScreens. |
int | GetExtraColorThreshold( ) [03 Gameplay.lua] Returns the number at which the Extra color should be used. |
GetGamePref | |
GetGamePrefB | |
GetGamePrefC | |
GetGamePrefN | |
Grade | GetGradeFromPercent( float fPercent, bool bMerciful ) Returns a corresponding Grade for the given percentage. |
int | GetLifeDifficulty( ) Returns the current Life Difficulty. |
Profile | GetPlayerOrMachineProfile( PlayerNumber pn ) [02 Utilities.lua] "This returns a profile, preferably a player one. If there isn't one, [it falls] back on the machine profile." |
bool | GetProTiming( PlayerNumber pn )
[03 ThemePrefs.lua] Returns |
string | GetRandomSongBackground( ) [02 Utilities.lua] Returns a path to a random song background. |
float | GetReal( ) [02 Actor.lua] |
float | GetRealInverse( ) [02 Actor.lua] |
float | GetScreenAspectRatio( ) Returns the display aspect ratio. |
string | GetServerName( ) Returns the name of the currently connected server. |
string | GetSongBackground( ) [02 Utilities.lua] Returns a path to the current songs background. |
float | GetTapPosition( ) [03 Gameplay.lua] |
float | GetThemeAspectRatio( ) Returns the theme's aspect ratio. |
various | GetThemePref( string pref ) [03 ThemePrefs.lua] (Alias for ThemePrefs.Get().) |
int | GetTimingDifficulty( ) Returns the current Timing difficulty. |
float | GetTitleSafeH( float fPercent ) [01 alias.lua] |
float | GetTitleSafeV( float fPercent ) [01 alias.lua] |
GetUnlockEntryIndexToCelebrate | |
string | GetUserPref( string name ) [03 UserPreferences2.lua] Themer-facing function for getting a user preference. |
bool | GetUserPrefB( string name ) [03 UserPreferences2.lua] Themer-facing function for getting a user preference as a boolean. |
color | GetUserPrefC( string name ) [03 UserPreferences2.lua] Themer-facing function for getting a user preference as a color. |
float | GetUserPrefN( string name ) [03 UserPreferences2.lua] Themer-facing function for getting a user preference as a number. |
color | HSV( float h, float s, float v )
[02 Colors.lua] Converts a color from HSV values to something StepMania can understand.
hue is from |
color | HSVA( float h, float s, float v, float a )
[02 Colors.lua] Converts a color from HSV values with alpha to something StepMania can understand.
hue is from |
color | HSVToColor( table hsv ) [02 Colors.lua] "Converts a set of HSV values to a color." |
string | HSVToHex( table hsv ) [02 Colors.lua] "Takes in a normal color and returns the hex representation. (Adapted from code in LuaBit)" |
float | HasAlpha( color c ) [02 Colors.lua] Returns the color's alpha if it has any, otherwise returns 1. |
int | HitCombo( ) [03 Gameplay.lua] Returns the value to start showing the combo at. |
float | HoldTiming( )
[03 Gameplay.lua] Returns 0 in |
int | Hour( ) Returns the current hour. |
color | Hue( color c, int newHue ) [02 Colors.lua] Changes the hue of the input color. |
InitGamePrefs | |
void | InitUserPrefs( ) [03 ThemePrefs.lua] Initializes various user preferences. |
bool | IsArcade( )
[02 Utilities.lua] Returns |
bool | IsFreePlay( )
[02 Utilities.lua] Returns |
bool | IsGame( string sGame )
[03 Gameplay.lua] Returns |
bool | IsHome( )
[02 Utilities.lua] Returns |
bool | IsNetConnected( )
Returns |
bool | IsNetSMOnline( )
Returns |
bool | IsRoutine( )
[02 Branches.lua] Returns |
bool | IsSMOnlineLoggedIn( PlayerNumber pn )
Returns |
bool | IsUsingWideScreen( )
[04 WidescreenHelpers.lua] Returns |
color | JudgmentLineToColor( JudgmentLine jl ) [02 Colors.lua] |
JudgmentLineToLocalizedString | |
color | JudgmentLineToStrokeColor( JudgmentLine jl ) [02 Colors.lua] |
JudgmentTransformCommand | |
JudgmentTransformSharedCommand | |
ActorDef | LoadActor( string sPath, ... )
Returns an Actor definition for the actor at |
ActorDef | LoadActorFunc( string path, int level ) [02 ActorDef.lua] Loads an actor template. This is the actual core of LoadActor. |
void | LoadActorWithParams( string path, table params, ... ) [02 ActorDef.lua] Loads an actor with params. |
ActorDef | LoadFallbackB( ) [02 ActorDef.lua] Load the fallback BGA for the element that is currently being loaded. |
ActorDef | LoadFont( string a, string b ) [02 ActorDef.lua] Loads a font. |
Sprite | LoadSongBackground( ) [02 Sprite.lua] Returns a Sprite with the current song's background. |
LocalizeOptionItem | |
int | Minute( ) Returns the current Minute. |
int | MissCombo( ) [03 Gameplay.lua] Returns the value to start showing the miss combo at. |
int | MonthOfYear( )
Returns the current month of the year ( |
string | MonthToLocalizedString( Month m )
Returns Month |
string | MonthToString( Month m )
Returns Month |
MultiPlayerToLocalizedString | |
MultiPlayerToString | |
LuaOptionRow | OptionRowProTiming( ) [03 ThemePrefs.lua] Returns a Lua option row for ProTiming. |
OptionRowScreenFilter | |
OptionsRandomJukebox | |
OptionsRowTest | |
OptionsWeight | |
PeakComboAwardToLocalizedString | |
PlayModeToLocalizedString | |
color | PlayerColor( PlayerNumber pn ) [02 Colors.lua] |
PlayerNumberToLocalizedString | |
PlayerNumberToString | |
color | PlayerScoreColor( PlayerNumber pn ) [02 Colors.lua] |
float | PositionPerPlayer( PlayerNumber pn, float p1val, float p2val )
[02 Actor.lua] Returns either |
string | PrettyPercent( float num, float den )
Returns a formatted percent with the specified |
void | PrintTable( table t ) [03 ThemePrefs.lua] Prints a table's contents to the log. |
string | ProductFamily( ) Returns the product family. (e.g. "StepMania") |
string | ProductID( ) Returns the product ID. (e.g. "StepMania 5") |
string | ProductVersion( ) Returns the product version. |
RadarCategoryToLocalizedString | |
ReadGamePrefFromFile | |
string | ReadPrefFromFile( string prefName ) [03 UserPreferences2.lua] (internal) Reads the specified user preference from its config file. |
void | ReportStyle( ) Sends the current style to the server. |
string | ResolveRelativePath( string path, int level ) [02 ActorDef.lua] |
string | RoutineSkinP1( ) [03 Gameplay.lua] Returns the routine noteskin for player . |
string | RoutineSkinP2( ) [03 Gameplay.lua] Returns the routine noteskin for player 2. |
SMOnlineScreen | |
color | Saturation( color c, float percent ) [02 Colors.lua] Modifies the saturation of the specified color |
string | ScoreKeeperClass( ) [03 Gameplay.lua] Returns the primary ScoreKeeper class to use. |
string | ScreenMetric( string s ) [00 alias.lua, 02 Other.lua] alias for Screen.Metric(). |
string | ScreenString( string s ) [00 alias.lua, 02 Other.lua] alias for Screen.String(). |
int | Second( ) Returns the current second. |
string | SecondsToHHMMSS( float fSecs )
Converts |
string | SecondsToMMSS( float fSecs )
Converts |
string | SecondsToMMSSMsMs( float fSecs )
Converts |
string | SecondsToMMSSMsMsMs( float fSecs )
Converts |
string | SecondsToMSS( float fSecs )
Converts |
string | SecondsToMSSMsMs( float fSecs )
Converts |
string | SelectMusicOrCourse( ) [02 Branches.lua] Determines the correct music/course selection screen to use and returns it. |
string | SelectProfileKeys( ) [03 Gameplay.lua] (soon to be deprecated) Returns a list of codes to use on ScreenSelectProfile. |
string | Serialize( table t )
[02 Serialize.lua] Serialize the table |
SetFail | |
SetGamePref | |
SetThemePref | |
bool | SetUserPref( string name, string value ) [03 UserPreferences2.lua] Themer-facing function for setting a user preference. |
bool | ShowHoldJudgments( ) [03 Gameplay.lua] |
bool | ShowStandardDecoration( string sMetricsName )
[02 ActorDef.lua] Returns |
SongMeterDisplayCommand | |
SongMeterDisplayX | |
SongMeterDisplayY | |
SortOrderToLocalizedString | |
LuaOptionRow | SpeedMods( ) [03 CustomSpeedMods.lua] Returns a Lua option row with the custom speed mods defined in SpeedMods.txt. |
StageAwardToLocalizedString | |
color | StageToColor( Stage s ) [02 Colors.lua] |
StageToLocalizedString | |
color | StageToStrokeColor( Stage s ) [02 Colors.lua] |
Actor | StandardDecorationFromFile( string sMetricsName, string sFileName ) [02 ActorDef.lua] |
Actor | StandardDecorationFromFileOptional( string sMetricsName, string sFileName ) [02 ActorDef.lua] |
Actor | StandardDecorationFromTable( string sMetricsName, table t ) [02 ActorDef.lua] |
StepsOrTrailToColor | |
StepsOrTrailToCustomDifficulty | |
StepsToCustomDifficulty | |
StringToBlend | |
table | TableStringLookup( table t, string group ) [02 Utilities.lua] Look up each value in a table, returning a table with the resulting strings. |
TapNoteScoreToLocalizedString | |
void | TextBannerAfterSet( ) [02 TextBanner.lua] This function defines how the TextBanner is laid out. |
ThemePrefRow | |
string | ToEnumShortString( enum e )
[02 Enum.lua] Returns a string representing an enum starting from '_'. For example, passing PlayerNumber_P1 to this function will return |
void | Trace( string sString ) [00 init.lua] Alias for lua.Trace(). |
TrailToCustomDifficulty | |
string | URLEncode( string sInput ) Returns a string with characters escaped for URLs. (e.g. a space becomes '%20') |
UndocumentedFeature | |
UnlockRewardTypeToLocalizedString | |
ThreadVariable | Var( ) [01 base.lua] Alias for lua.GetThreadVariable. |
string | VersionDate( ) Returns the current version's build date. |
string | VersionTime( ) Returns the current version's build time. |
void | Warn( string sString ) [00 init.lua] Alias for lua.Warn(). |
Weekday | |
float | WideScale( float ar43, float ar169 )
[04 WidescreenHelpers.lua] Depending on the screen width, scales between |
ActorFrame | WrapInActorFrame( table children ) [02 ActorDef.lua] Wraps the children in an ActorFrame. |
bool | WriteGamePrefToFile( string name ) [03 GamePreferences.lua] |
bool | WritePrefToFile( string prefName, various value )
[03 UserPreferences2.lua] (internal) Writes user preference |
int | Year( ) Returns the current year. |
various | assert( LuaReference v, string sAssertMessage )
Issues an error when |
float | clamp( float fValue, float fLow, float fHigh )
CLAMP is an all-female Japanese mangaka group that formed in the mid 1980s.
Erm, I mean... Clamps |
class | |
void | collectgarbage( string opt, float arg )
A generic interface to Lua's garbage collector. Performs different functions based on the value of |
color | color( string color )
Returns a color from a string. |
chunk | dofile( string sFilePath ) [01 base.lua] "Override Lua's dofile to use our loadfile." |
error | |
float | fapproach( float val, float other_val, float to_move ) [02 Utilities.lua] |
void | foreach_ordered( table t, function f )
|
gcinfo | |
various | getenv( string name )
[03 EnvUtils2.lua] Returns the value of |
getfenv | |
getmetatable | |
function | ipairs( table t ) [01 base.lua] "Like ipairs(), but returns only values." |
{various} | ivalues( table t ) [01 base.lua] "Like ipairs(), but returns only values." |
string | join( string delimiter, table list )
[02 Utilities.lua] Joins a table, splitting each item with |
load | |
chunk | loadfile( string sFilePath ) [01 base.lua] "Override Lua's loadfile to use lua.ReadFile." |
loadstring | |
int | mbstrlen( string sString )
Returns the length of the multi-byte character string |
void | module( string name, ... ) Creates a module. See the Lua manual for more details. |
newproxy | |
void | next( table t, int index )
"Allows a program to traverse all fields of a table. Its first argument is a
table and its second argument is an index in this table.
|
function | pairs( table t )
"Returns three values: the next() function, the table |
pcall | |
string | pname( PlayerNumber pn ) [02 Utilities.lua] Converts a PlayerNumber into a short string (e.g. "P1", "P2"). |
void | print( string s ) [00 init.lua] |
bool | rawequal( various v1, varoius v2 )
"Checks whether |
various | rawget( table t, various index )
"Gets the real value of |
table | rawset( table t, int index, various value )
"Sets the real value of |
void | require( string modname ) Loads the specified module. See the Lua manual for more information. |
int | round( float val, int decimal ) [02 Utilities.lua] Round a number. |
float | scale( float x, float low1, float high1, float low2, float high2 )
Scales |
various | select( various index, ... )
"If |
various | setenv( string name, various value )
[03 EnvUtils2.lua] Sets the value of |
setfenv | |
setmetatable | |
table | split( string delimiter, string text )
[02 Utilities.lua] Splits a string at every occurence of |
table | tableshuffle( table t )
[02 Utilities.lua] Returns a shuffled version of |
table | tableslice( table t, int num )
[02 Utilities.lua] Returns a slice of the specified table of size |
bool | tobool( various v ) [02 Utilities.lua] Converts a string or number to a bool. |
float | tonumber( various e, int base )
Tries to convert |
string | tostring( various e )
Converts |
string | type( various v ) Returns the type of the object as a string. See the Lua manual for valid return values. |
various | unpack( table list, int i, int j )
"Returns the elements from the given table.
This function is equivalent to |
float | wrap( float val, float n ) [02 Utilities.lua] |
xpcall |
Constant | Value |
---|---|
ASPECT_SCALE_FACTOR | 854 |
NUM_PLAYERS | 2 |
PLAYER_1 | 'PlayerNumber_P1' |
PLAYER_2 | 'PlayerNumber_P2' |
SAFE_HEIGHT | 36 |
SAFE_WIDTH | 64 |
SCREEN_BOTTOM | 480 |
SCREEN_CENTER_X | 427 |
SCREEN_CENTER_Y | 240 |
SCREEN_HEIGHT | 480 |
SCREEN_LEFT | 0 |
SCREEN_RIGHT | 854 |
SCREEN_TOP | 0 |
SCREEN_WIDTH | 854 |
_VERSION | 'Lua 5.1' |
bottom | 'VertAlign_Bottom' |
center | 'HorizAlign_Center' |
left | 'HorizAlign_Left' |
middle | 'VertAlign_Middle' |
right | 'HorizAlign_Right' |
top | 'VertAlign_Top' |