actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
9367c45d78df4cafc87f1135f4fcb120a052dcd4
itgmania212121/Docs/Luadoc/LuaDocumentation.xml
T

4831 lines
225 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?xml version="1.0" encoding="UTF-8" ?>
<!-- Before checking the documentation in, make sure that it validates by
going to http://www.corefiling.com/opensource/schemaValidate.html and using
Lua.xsd for the XML Schema and this file for the XML Instance. -->
<!-- Using Link:
If you leave out the text (i.e., <Link ... />), it tries to output what
you would want.
To add a link to a function in the current class:
<Link function='addx' /> -> Actor.addx()
To add a link to a function in another class:
<Link class='ActorFrame' function='propagate' /> -> ActorFrame.propagate()
To add a link to a class:
<Link class='ActorFrame' /> -> ActorFrame
To add a link to a global function:
<Link class='GLOBAL' function='Basename' /> -> Basename()
To add a link to an Enum:
<Link class='ENUM' function='CoinMode' /> -> CoinMode
save yourself some time, copy this for undocumented things:
<Function name='' return='' arguments=''>
</Function>
-->
<Documentation xmlns='http://www.stepmania.com' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.stepmania.com Lua.xsd'>
<!-- Global functions -->
<GlobalFunctions>
<Function name='Alpha' theme='_fallback' return='color' arguments='color c, float percent'>
[02 Colors.lua] Returns a <code>color</code> with the specified alpha.
</Function>
<Function name='AreStagePlayerModsForced' theme='_fallback' return='bool' arguments=''>
[02 StageMods.lua]
</Function>
<Function name='AreStageSongModsForced' theme='_fallback' return='bool' arguments=''>
[02 StageMods.lua]
</Function>
<Function name='assert' return='various' arguments='LuaReference v, string sAssertMessage'>
Issues an error when <code>v</code> is <code>false</code> (or <code>nil</code>). Returns all arguments otherwise. <code>sAssertMessage</code> is an optional error message (the default is "assertion failed!").
</Function>
<Function name='Basename' return='string' arguments='string path'>
Returns the base name of file path.
</Function>
<Function name='BoostColor' theme='_fallback' return='color' arguments='color c, float fBoost'>
[02 Colors.lua] Boosts the specified color by multiplying its values by <code>fBoost</code>.
</Function>
<Function name='Brightness' theme='_fallback' return='color' arguments='color c, float percent'>
[02 Colors.lua] Modifies the brightness of the specified color.
</Function>
<Function name='Center1Player' theme='_fallback' return='bool' arguments=''>
[02 Utilities.lua] Returns <code>true</code> if Center 1P is being used.
</Function>
<Function name='CheckpointsTapsSeparateJudgment' theme='_fallback' return='bool' arguments=''>
[03 Gameplay.lua] Returns <code>true</code> if checkpoint judgments and tap judgments
are considered separate, or <code>false</code> otherwise.
</Function>
<Function name='clamp' return='float' arguments='float fValue, float fLow, float fHigh'>
CLAMP is an all-female Japanese mangaka group that formed in the mid 1980s.
Erm, I mean... Clamps <code>fValue</code> between <code>fLow</code> and <code>fHigh</code>.
</Function>
<Function name='ClearEnterMappedKeys' theme='_fallback' return='void' arguments=''>
[04 KeymapGuard.lua]
</Function>
<Function name='CloseConnection' return='void' arguments=''>
Closes any connection to an online server.
</Function>
<Function name='collectgarbage' return='void' arguments='string opt, float arg'>
A generic interface to Lua's garbage collector. Performs different functions based on the value of <code>opt</code>.
</Function>
<Function name='color' return='color' arguments='string color'>
Returns a color from a string. <code>color</code> can be in hex (<code>"#FFFFFFFF"</code>) or 0..1 values (<code>"1.0,1.0,1.0,1.0"</code>), in RGBA order.
</Function>
<Function name='ColorDarkTone' theme='_fallback' return='color' arguments='color c'>
[02 Colors.lua] Returns a darker tone of the color. (Specifically <code>c[1]/2, c[2]/2, c[3]/2, c[4]</code>)
</Function>
<Function name='ColorLightTone' theme='_fallback' return='color' arguments='color c'>
[02 Colors.lua] Returns a lighter tone of the color. (Specifically <code>c[1]+(c[1]/2), c[2]+(c[2]/2), c[3]+(c[3]/2), c[4]</code>)
</Function>
<Function name='ColorMidTone' theme='_fallback' return='color' arguments='color c'>
[02 Colors.lua] Returns a midtone of the color. (Specifically <code>c[1]/1.5, c[2]/1.5, c[3]/1.5, c[4]</code>)
</Function>
<Function name='ColorToHex' theme='_fallback' return='string' arguments='color c'>
[02 Colors.lua] Returns a hex representation for the specified color.
</Function>
<Function name='ColorToHSV' theme='_fallback' return='table' arguments='color c'>
[02 Colors.lua] Takes in a color and returns a table with the HSV values.
</Function>
<Function name='ComboContinue' theme='_fallback' return='TapNoteScore' arguments=''>
[03 Gameplay.lua] Determines what TapNoteScore allows for continuing the combo.
</Function>
<Function name='ComboMaintain' theme='_fallback' return='TapNoteScore' arguments=''>
[03 Gameplay.lua] Determines what TapNoteScore allows for maintaining the combo.
</Function>
<Function name='ComboPerRow' theme='_fallback' return='bool' arguments=''>
[03 Gameplay.lua] Determines if combo should be per row (Jump = 1) or per column (Jump = 2).
</Function>
<Function name='ComboTransformCommand' theme='_fallback' return='void' arguments='Actor self, params p'>
[02 Other.lua] The combo trasform command.
</Function>
<Function name='ComboUnderField' theme='_fallback' return='bool' arguments=''>
[03 Gameplay.lua] Returns the <code>UserPrefComboUnderField</code> user preference value.
</Function>
<Function name='ConnectToServer' return='bool' arguments='string sAddress'>
Tries to connect to the server at <code>sAddress</code>.
</Function>
<Function name='CustomDifficultyToColor' theme='_fallback' return='color' arguments='string cd'>
[02 Colors.lua]
</Function>
<Function name='CustomDifficultyToDarkColor' theme='_fallback' return='color' arguments='string cd'>
[02 Colors.lua]
</Function>
<Function name='CustomDifficultyToLightColor' theme='_fallback' return='color' arguments='string cd'>
[02 Colors.lua]
</Function>
<Function name='DayOfMonth' return='int' arguments=''>
Returns the current day of the month.
</Function>
<Function name='DayOfYear' return='int' arguments=''>
Returns the current day of the year.
</Function>
<Function name='DeepCopy' theme='_fallback' return='table' arguments='table from, table to, table already_copied'>
[02 Serialize] Recursively deep-copy a table.
</Function>
<Function name='dofile' theme='_fallback' return='chunk' arguments='string sFilePath'>
[01 base.lua] "Override Lua's dofile to use our <Link function="loadfile">loadfile</Link>."
</Function>
<Function name='EvalUsesCheckpointsWithJudgments' theme='_fallback' return='bool' arguments=''>
[03 Gameplay.lua]
</Function>
<Function name='FailCombo' theme='_fallback' return='int' arguments=''>
[03 Gameplay.lua]
</Function>
<Function name='fapproach' theme='_fallback' return='float' arguments='float val, float other_val, float to_move'>
[02 Utilities.lua]
</Function>
<Function name='FindSelection' theme='_fallback' return='int' arguments='table list'>
[02 Utilities.lua] Return the index of a true value in <code>list</code>.
</Function>
<Function name='FindValue' theme='_fallback' return='string' arguments='table tab, various value'>
[02 Utilities.lua] Find a key in <code>tab</code> with the given <code>value</code>.
</Function>
<Function name='foreach_ordered' theme='_fallback' return='void' arguments='table t, function f'>
<code>func</code> takes a key and a value.
</Function>
<Function name='FormatNumberAndSuffix' return='string' arguments='int num'>
Returns the number passed to the function followed by its suffix (&quot;th&quot;, &quot;nd&quot;, and so on).
</Function>
<!-- FormatNumSongsPlayed -->
<Function name='FormatPercentScore' return='string' arguments='float fPercentDancePoints'>
Returns <code>fPercentDancePoints</code> formatted as a percentage.
</Function>
<Function name='GameCompatibleModes' theme='_fallback' return='string' arguments=''>
[03 Gameplay.lua] Returns a list of valid styles for the current gametype.
</Function>
<Function name='GetCodeForGame' theme='_fallback' return='string' arguments=''>
[03 Gameplay.lua]
</Function>
<Function name='GetCustomDifficulty' return='string' arguments='StepsType st, Difficulty d, CourseType ct'>
Returns the corresponding CustomDifficulty string for a StepsType/Difficulty (/optional CourseType) combination.
</Function>
<Function name='GetDirectRadar' theme='_fallback' return='RadarValues' arguments='PlayerNumber pn'>
[04 Scoring.lua] "Get the radar values directly. The individual steps aren't used much."
</Function>
<Function name='GetEditModeSubScreens' theme='_fallback' return='string' arguments=''>
[02 Other.lua] Returns a string with the Edit Mode SubScreens.
</Function>
<Function name='getenv' theme='_fallback' return='various' arguments='string name'>
[03 EnvUtils2.lua] Returns the value of <code>name</code> from the Env table.
</Function>
<Function name='GetExtraColorThreshold' theme='_fallback' return='int' arguments=''>
[03 Gameplay.lua] Returns the number at which the Extra color should be used.
</Function>
<Function name='GetGradeFromPercent' return='Grade' arguments='float fPercent, bool bMerciful'>
Returns a corresponding <Link class='ENUM' function='Grade' /> for the given percentage.
</Function>
<Function name='GetLifeDifficulty' return='int' arguments=''>
Returns the current Life Difficulty.
</Function>
<Function name='GetOSName' return='string' arguments=''>
Returns a string representing the name of the operating system being used. (e.g. "Windows", "Linux", "Mac, "Unknown")
</Function>
<Function name='GetPlayerOrMachineProfile' theme='_fallback' return='Profile' arguments='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."
</Function>
<Function name='GetProTiming' theme='default' return='bool' arguments='PlayerNumber pn'>
[03 ThemePrefs.lua] Returns <code>true</code> if player <code>pn</code> is using ProTiming.
</Function>
<Function name='GetRandomSongBackground' theme='_fallback' return='string' arguments=''>
[02 Utilities.lua] Returns a path to a random song background.
</Function>
<Function name='GetReal' theme="_fallback" return='float' arguments=''>
[02 Actor.lua]
</Function>
<Function name='GetRealInverse' theme="_fallback" return='float' arguments=''>
[02 Actor.lua]
</Function>
<Function name='GetScreenAspectRatio' return='float' arguments=''>
Returns the display aspect ratio.
</Function>
<Function name='GetServerName' return='string' arguments=''>
Returns the name of the currently connected server.
</Function>
<Function name='GetSongBackground' theme='_fallback' return='string' arguments=''>
[02 Utilities.lua] Returns a path to the current songs background.
</Function>
<Function name='GetTapPosition' theme='_fallback' return='float' arguments=''>
[03 Gameplay.lua]
</Function>
<Function name='GetThemeAspectRatio' return='float' arguments=''>
Returns the theme's aspect ratio.
</Function>
<Function name='GetThemePref' theme='_fallback' return='various' arguments='string pref'>
[03 ThemePrefs.lua] (Alias for <Link class='ThemePrefs' function='Get' />.)
</Function>
<Function name='GetTimingDifficulty' return='int' arguments=''>
Returns the current Timing difficulty.
</Function>
<Function name='GetTitleSafeH' theme='_fallback' return='float' arguments='float fPercent'>
[01 alias.lua]
</Function>
<Function name='GetTitleSafeV' theme='_fallback' return='float' arguments='float fPercent'>
[01 alias.lua]
</Function>
<Function name='GetTotalItems' theme='_fallback' return='float' arguments='RadarValues radars'>
[04 Scoring.lua] "Retrieve the amount of taps/holds/rolls involved." Used in some scoring formulas.
</Function>
<Function name='GetUserPref' theme='_fallback' return='string' arguments='string name'>
[03 UserPreferences2.lua] Themer-facing function for getting a user preference.
</Function>
<Function name='GetUserPrefB' theme='_fallback' return='bool' arguments='string name'>
[03 UserPreferences2.lua] Themer-facing function for getting a user preference as a boolean.
</Function>
<Function name='GetUserPrefC' theme='_fallback' return='color' arguments='string name'>
[03 UserPreferences2.lua] Themer-facing function for getting a user preference as a color.
</Function>
<Function name='GetUserPrefN' theme='_fallback' return='float' arguments='string name'>
[03 UserPreferences2.lua] Themer-facing function for getting a user preference as a number.
</Function>
<Function name='HasAlpha' theme='_fallback' return='float' arguments='color c'>
[02 Colors.lua] Returns the color's alpha if it has any, otherwise returns 1.
</Function>
<Function name='HitCombo' theme='_fallback' return='int' arguments=''>
[03 Gameplay.lua] Returns the value to start showing the combo at.
</Function>
<Function name='HoldHeadStep' theme='_fallback' return='bool' arguments=''>
[03 Gameplay.lua] Returns <code>true</code> if you need to step on hold heads to activate them.
</Function>
<Function name='HoldTiming' theme='_fallback' return='float' arguments=''>
[03 Gameplay.lua] Returns 0 in <code>pump</code> mode, <code>TimingWindowSecondsHold</code> preference value in any other game mode.
</Function>
<Function name='Hour' return='int' arguments=''>
Returns the current hour.
</Function>
<Function name='HSV' theme='_fallback' return='color' arguments='float h, float s, float v'>
[02 Colors.lua] Converts a color from HSV values to something StepMania can understand.
hue is from <code>0-360</code>, saturation and value are <code>0..1</code>
</Function>
<Function name='HSVA' theme='_fallback' return='color' arguments='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 <code>0-360</code>, saturation, value, and alpha are <code>0..1</code>
</Function>
<Function name='HSVToColor' theme='_fallback' return='color' arguments='table hsv'>
[02 Colors.lua] "Converts a set of HSV values to a color."
</Function>
<Function name='HSVToHex' theme='_fallback' return='string' arguments='table hsv'>
[02 Colors.lua] "Takes in a normal color and returns the hex representation. (Adapted from code in LuaBit)"
</Function>
<Function name='Hue' theme='_fallback' return='color' arguments='color c, int newHue'>
[02 Colors.lua] Changes the hue of the input color.
</Function>
<Function name='InitUserPrefs' theme='default' return='void' arguments=''>
[03 ThemePrefs.lua] Initializes various user preferences.
</Function>
<Function name='ipairs' theme='_fallback' return='function' arguments='table t'>
[01 base.lua] "Like ipairs(), but returns only values."
</Function>
<Function name='IsArcade' theme="_fallback" return='bool' arguments=''>
[02 Utilities.lua] Returns <code>true</code> if the coin mode is not set to <Link class='ENUM' function='CoinMode'>CoinMode_Home</Link>.
</Function>
<Function name='IsEventMode' return='bool' arguments=''>
Returns <code>true</code> if Event Mode is turned on.
</Function>
<Function name='IsFreePlay' theme="_fallback" return='bool' arguments=''>
[02 Utilities.lua] Returns <code>true</code> <Link function='IsArcade'>if Arcade</Link> and the coin mode is <Link class='ENUM' function='CoinMode'>CoinMode_Free</Link>.
</Function>
<Function name='IsGame' theme='_fallback' return='bool' arguments='string sGame'>
[03 Gameplay.lua] Returns <code>true</code> if the current game is <code>sGame</code>.
</Function>
<Function name='IsHome' theme="_fallback" return='bool' arguments=''>
[02 Utilities.lua] Returns <code>true</code> if the coin mode is set to <Link class='ENUM' function='CoinMode'>CoinMode_Home</Link>.
</Function>
<Function name='IsNetConnected' return='bool' arguments=''>
Returns <code>true</code> if connected to the Internet.
</Function>
<Function name='IsNetSMOnline' return='bool' arguments=''>
Returns <code>true</code> if connected to StepMania Online.
</Function>
<Function name='IsSMOnlineLoggedIn' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if Player <code>pn</code> is logged on to a SMOnline server.
</Function>
<Function name='IsW1Allowed' theme='_fallback' return='bool' arguments='TapNoteScore tns'>
[04 Scoring.lua] Returns <code>true</code> if W1 is allowed (and <code>tns == 'TapNoteScore_W2'</code>)
</Function>
<Function name='IsRoutine' theme='_fallback' return='bool' arguments=''>
[02 Branches.lua] Returns <code>true</code> if Routine mode is being played.
</Function>
<Function name='IsUsingWideScreen' theme='_fallback' return='bool' arguments=''>
[04 WidescreenHelpers.lua] Returns <code>true</code> if the aspect ratio is 16:10 (<code>1.6</code>) or higher.
</Function>
<Function name='ivalues' theme='_fallback' return='{various}' arguments='table t'>
[01 base.lua] "Like ipairs(), but returns only values."
</Function>
<Function name='join' theme='_fallback' return='string' arguments='string delimiter, table list'>
[02 Utilities.lua] Joins a table, splitting each item with <code>delimiter</code>, returning a string of the results.
</Function>
<Function name='JudgmentLineToColor' theme='_fallback' return='color' arguments='JudgmentLine jl'>
[02 Colors.lua]
</Function>
<Function name='JudgmentLineToStrokeColor' theme='_fallback' return='color' arguments='JudgmentLine jl'>
[02 Colors.lua]
</Function>
<Function name='LoadActor' return='ActorDef' arguments='string sPath, ...'>
Returns an Actor definition for the actor at <code>sPath</code>. If <code>sPath</code> points to a Lua file, any additional arguments will be passed to that script.
</Function>
<Function name='LoadActorFunc' theme='_fallback' return='ActorDef' arguments='string path, int level'>
[02 ActorDef.lua] Loads an actor template. This is the actual core of LoadActor.
</Function>
<Function name='LoadActorWithParams' theme='_fallback' return='void' arguments='string path, table params, ...'>
[02 ActorDef.lua] Loads an actor with params.
</Function>
<Function name='loadfile' theme='_fallback' return='chunk' arguments='string sFilePath'>
[01 base.lua] "Override Lua's loadfile to use <Link class="lua" function="ReadFile">lua.ReadFile</Link>."
</Function>
<Function name='LoadFallbackB' theme='_fallback' return='ActorDef' arguments=''>
[02 ActorDef.lua] Load the fallback BGA for the element that is currently being loaded.
</Function>
<Function name='LoadFont' theme='_fallback' return='ActorDef' arguments='string a, string b'>
[02 ActorDef.lua] Loads a font.
</Function>
<Function name='LoadSongBackground' theme='_fallback' return='Sprite' arguments=''>
[02 Sprite.lua] Returns a Sprite with the current song's background.
</Function>
<Function name='mbstrlen' return='int' arguments='string sString'>
Returns the length of the multi-byte character string <code>sString</code>.
</Function>
<Function name='Minute' return='int' arguments=''>
Returns the current Minute.
</Function>
<Function name='MissCombo' theme='_fallback' return='int' arguments=''>
[03 Gameplay.lua] Returns the value to start showing the miss combo at.
</Function>
<Function name='module' return='void' arguments='string name, ...'>
Creates a module. See the Lua manual for more details.
</Function>
<Function name='MonthOfYear' return='int' arguments=''>
Returns the current month of the year (<code>0</code>-<code>11</code>).
</Function>
<Function name='MonthToLocalizedString' return='string' arguments='Month m'>
Returns Month <code>m</code> as a localized string.
</Function>
<Function name='MonthToString' return='string' arguments='Month m'>
Returns Month <code>m</code> as a string.
</Function>
<Function name='next' return='void' arguments='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.
<code>next</code> returns the next index of the table and its associated value."
See the Lua manual for more details.
</Function>
<Function name='OptionRowProTiming' theme='default' return='LuaOptionRow' arguments=''>
[03 ThemePrefs.lua] Returns a Lua option row for ProTiming.
</Function>
<Function name='pairs' return='function' arguments='table t'>
"Returns three values: the <Link class='GLOBAL' function='next' /> function, the table <code>t</code>, and <code>nil</code>,
so that the construction <code>for k,v in pairs(t) do body end</code>
will iterate over all key–value pairs of table <code>t</code>."
</Function>
<Function name='PlayerColor' theme='_fallback' return='color' arguments='PlayerNumber pn'>
[02 Colors.lua]
</Function>
<Function name='PlayerScoreColor' theme='_fallback' return='color' arguments='PlayerNumber pn'>
[02 Colors.lua]
</Function>
<Function name='pname' theme='_fallback' return='string' arguments='PlayerNumber pn'>
[02 Utilities.lua] Converts a PlayerNumber into a short string (e.g. "P1", "P2").
</Function>
<Function name='PositionPerPlayer' theme='_fallback' return='float' arguments='PlayerNumber pn, float p1val, float p2val'>
[02 Actor.lua] Returns either <code>p1val</code> or <code>p2val</code> depending on <code>pn</code>.
</Function>
<Function name='PrettyPercent' return='string' arguments='float num, float den'>
Returns a formatted percent with the specified <code>num</code>erator and <code>den</code>ominator.
</Function>
<Function name='print' theme='_fallback' return='void' arguments='string s'>
[00 init.lua]
</Function>
<Function name='PrintTable' theme='_fallback' return='void' arguments='table t'>
[03 ThemePrefs.lua] Prints a table's contents to the log.
</Function>
<Function name='ProductFamily' return='string' arguments=''>
Returns the product family. (e.g. "StepMania")
</Function>
<Function name='ProductID' return='string' arguments=''>
Returns the product ID. (e.g. "StepMania 5")
</Function>
<Function name='ProductVersion' return='string' arguments=''>
Returns the product version.
</Function>
<Function name='rawequal' return='bool' arguments='various v1, varoius v2'>
"Checks whether <code>v1</code> is equal to <code>v2</code>, without invoking any metamethod."
</Function>
<Function name='rawget' return='various' arguments='table t, various index'>
"Gets the real value of <code>t[index]</code>, without invoking any metamethod."
</Function>
<Function name='rawset' return='table' arguments='table t, int index, various value'>
"Sets the real value of <code>t[index]</code> to <code>value</code>, without invoking any metamethod."
The modified <code>t</code> is then returned.
</Function>
<Function name='ResolveRelativePath' theme='_fallback' return='string' arguments='string path, int level'>
[02 ActorDef.lua]
</Function>
<Function name='ReadFile' theme='_fallback' return='string' arguments='string path'>
[04 FileUtils.lua] Reads the file at <code>path</code> and returns its contents.
</Function>
<Function name='ReadPrefFromFile' theme='_fallback' return='string' arguments='string prefName'>
[03 UserPreferences2.lua] (internal) Reads the specified user preference from its config file.
</Function>
<Function name='ReportStyle' return='void' arguments=''>
Sends the current style to the server.
</Function>
<Function name='require' return='void' arguments='string modname'>
Loads the specified module. See the Lua manual for more information.
</Function>
<Function name='round' theme='_fallback' return='int' arguments='float val, int decimal'>
[02 Utilities.lua] Round a number.
</Function>
<Function name='RoutineSkinP1' theme='_fallback' return='string' arguments=''>
[03 Gameplay.lua] Returns the routine noteskin for player .
</Function>
<Function name='RoutineSkinP2' theme='_fallback' return='string' arguments=''>
[03 Gameplay.lua] Returns the routine noteskin for player 2.
</Function>
<Function name='Saturation' theme='_fallback' return='color' arguments='color c, float percent'>
[02 Colors.lua] Modifies the saturation of the specified color
</Function>
<Function name='scale' return='float' arguments='float x, float low1, float high1, float low2, float high2'>
Scales <code>x</code>, originally within <code>low1</code> and <code>high1</code>, to fall between <code>low2</code> and <code>high2</code>.
</Function>
<Function name='ScoreKeeperClass' theme='_fallback' return='string' arguments=''>
[03 Gameplay.lua] Returns the primary ScoreKeeper class to use.
</Function>
<Function name='ScreenMetric' theme='_fallback' return='string' arguments='string s'>
[00 alias.lua, 02 Other.lua] alias for <Link class='Screen' function='Metric' />.
</Function>
<Function name='ScreenString' theme='_fallback' return='string' arguments='string s'>
[00 alias.lua, 02 Other.lua] alias for <Link class='Screen' function='String' />.
</Function>
<Function name='Second' return='int' arguments=''>
Returns the current second.
</Function>
<Function name='SecondsToHHMMSS' return='string' arguments='float fSecs'>
Converts <code>fSecs</code> to Minutes:Seconds:Milliseconds format using two digits for each section.
</Function>
<Function name='SecondsToMSS' return='string' arguments='float fSecs'>
Converts <code>fSecs</code> to Minutes:Seconds.Milliseconds format using two digits for each section except Minutes (uses 1).
</Function>
<Function name='SecondsToMMSS' return='string' arguments='float fSecs'>
Converts <code>fSecs</code> to Minutes:Seconds format.
</Function>
<Function name='SecondsToMSSMsMs' return='string' arguments='float fSecs'>
Converts <code>fSecs</code> to Minutes:Seconds.Milliseconds format.
</Function>
<Function name='SecondsToMMSSMsMs' return='string' arguments='float fSecs'>
Converts <code>fSecs</code> to Minutes:Seconds.Milliseconds format using two digits for each section.
</Function>
<Function name='SecondsToMMSSMsMsMs' return='string' arguments='float fSecs'>
Converts <code>fSecs</code> to Minutes:Seconds.Milliseconds format using two digits for each section except Milliseconds (uses 3).
</Function>
<Function name='select' return='various' arguments='various index, ...'>
"If <code>index</code> is a number, returns all arguments after argument
number <code>index</code>. Otherwise, <code>index</code> must be the string
<code>"#"</code>, and [it] returns the total number of extra arguments it received."
</Function>
<Function name='SelectMusicOrCourse' theme='_fallback' return='string' arguments=''>
[02 Branches.lua] Determines the correct music/course selection screen to use and returns it.
</Function>
<Function name='SelectProfileKeys' theme='_fallback' return='string' arguments=''>
[03 Gameplay.lua] (soon to be deprecated) Returns a list of codes to use on ScreenSelectProfile.
</Function>
<Function name='Serialize' return='string' arguments='table t'>
[02 Serialize.lua] Serialize the table <code>t</code>.
</Function>
<Function name='setenv' theme='_fallback' return='various' arguments='string name, various value'>
[03 EnvUtils2.lua] Sets the value of <code>name</code> to <code>value</code> in the Env table.
</Function>
<Function name='SetUserPref' theme='_fallback' return='bool' arguments='string name, string value'>
[03 UserPreferences2.lua] Themer-facing function for setting a user preference.
</Function>
<Function name='ShowHoldJudgments' theme='_fallback' return='bool' arguments=''>
[03 Gameplay.lua]
</Function>
<Function name='ShowStandardDecoration' theme='_fallback' return='bool' arguments='string sMetricsName'>
[02 ActorDef.lua] Returns <code>true</code> if a decoration should be shown on the current screen or not.
</Function>
<Function name='SpeedMods' theme='_fallback' return='LuaOptionRow' arguments=''>
[03 CustomSpeedMods.lua] Returns a Lua option row with the custom speed mods defined in SpeedMods.txt.
</Function>
<Function name='split' theme='_fallback' return='table' arguments='string delimiter, string text'>
[02 Utilities.lua] Splits a string at every occurence of <code>delimiter</code>, returning a table of the results.
</Function>
<Function name='StageToColor' theme='_fallback' return='color' arguments='Stage s'>
[02 Colors.lua]
</Function>
<Function name='StageToStrokeColor' theme='_fallback' return='color' arguments='Stage s'>
[02 Colors.lua]
</Function>
<Function name='StandardDecorationFromTable' theme='_fallback' return='Actor' arguments='string sMetricsName, table t'>
[02 ActorDef.lua]
</Function>
<Function name='StandardDecorationFromFile' theme='_fallback' return='Actor' arguments='string sMetricsName, string sFileName'>
[02 ActorDef.lua]
</Function>
<Function name='StandardDecorationFromFileOptional' theme='_fallback' return='Actor' arguments='string sMetricsName, string sFileName'>
[02 ActorDef.lua]
</Function>
<Function name='tableshuffle' theme='_fallback' return='table' arguments='table t'>
[02 Utilities.lua] Returns a shuffled version of <code>t</code>.
</Function>
<Function name='tableslice' theme='_fallback' return='table' arguments='table t, int num'>
[02 Utilities.lua] Returns a slice of the specified table of size <code>num</code>.
</Function>
<Function name='TableStringLookup' theme='_fallback' return='table' arguments='table t, string group'>
[02 Utilities.lua] Look up each value in a table, returning a table with the resulting strings.
</Function>
<Function name='TextBannerAfterSet' theme='default' return='void' arguments=''>
[02 TextBanner.lua] This function defines how the TextBanner is laid out.
</Function>
<Function name='tobool' theme='_fallback' return='bool' arguments='various v'>
[02 Utilities.lua] Converts a string or number to a bool.
</Function>
<Function name='tonumber' return='float' arguments='various e, int base'>
Tries to convert <code>e</code> to a number. Returns <code>nil</code> if
it can't convert the input to a number. (<code>base</code> is optional.)
</Function>
<Function name='tostring' return='string' arguments='various e'>
Converts <code>e</code> to a string.
</Function>
<Function name='ToEnumShortString' theme='_fallback' return='string' arguments='enum e'>
[02 Enum.lua] Returns a string representing an enum starting from '_'. For example, passing <Link class='ENUM' function='PlayerNumber'>PlayerNumber_P1</Link> to this function will return <code>P1</code>.
</Function>
<Function name='Trace' theme='_fallback' return='void' arguments='string sString'>
[00 init.lua] Alias for <Link class='lua' function='Trace' />.
</Function>
<Function name='type' return='string' arguments='various v'>
Returns the type of the object as a string. See the Lua manual for valid return values.
</Function>
<Function name='unpack' return='various' arguments='table list, int i, int j'>
"Returns the elements from the given table.
This function is equivalent to <code>return list[i], list[i+1], ···, list[j]</code>"
(<code>i</code> and <code>j</code> are optional; "by default, i is 1 and j is the length of the list.")
</Function>
<Function name='URLEncode' return='string' arguments='string sInput'>
Returns a string with characters escaped for URLs. (e.g. a space becomes '%20')
</Function>
<Function name='Var' theme='_fallback' return='ThreadVariable' arguments=''>
[01 base.lua] Alias for <Link class="lua" function="GetThreadVariable">lua.GetThreadVariable</Link>.
</Function>
<Function name='VersionDate' return='string' arguments=''>
Returns the current version's build date.
</Function>
<Function name='VersionTime' return='string' arguments=''>
Returns the current version's build time.
</Function>
<Function name='Warn' theme='_fallback' return='void' arguments='string sString'>
[00 init.lua] Alias for <Link class='lua' function='Warn' />.
</Function>
<Function name='WideScale' theme='_fallback' return='float' arguments='float ar43, float ar169'>
[04 WidescreenHelpers.lua] Depending on the screen width, scales between <code>ar43</code> (4:3; 640px) and <code>ar169</code> (16:9; 854px).
</Function>
<Function name='wrap' theme='_fallback' return='float' arguments='float val, float n'>
[02 Utilities.lua]
</Function>
<Function name='WrapInActorFrame' theme='_fallback' return='ActorFrame' arguments='table children'>
[02 ActorDef.lua] Wraps the children in an ActorFrame.
</Function>
<Function name='WriteFile' theme='_fallback' return='bool' arguments='string path, string buf'>
[04 FileUtils.lua] Writes <code>buf</code> to the file at <code>path</code>.
</Function>
<Function name='WriteGamePrefToFile' theme='_fallback' return='bool' arguments='string name'>
[03 GamePreferences.lua]
</Function>
<Function name='WritePrefToFile' theme='_fallback' return='bool' arguments='string prefName, various value'>
[03 UserPreferences2.lua] (internal) Writes user preference <code>prefName</code> to its config file with <code>value</code> being <code>tostring</code>'d.
</Function>
<Function name='Year' return='int' arguments=''>
Returns the current year.
</Function>
<Function name='UserPrefAutoSetStyle' theme='default' return='LuaOptionRow' arguments=''>
[03 ThemePrefs.lua] Returns a Lua option row for toggling AutoSetStyle.
</Function>
<Function name='UserPrefGameplayShowScore' theme='default' return='LuaOptionRow' arguments=''>
[03 ThemePrefs.lua] Returns a Lua option row for displaying the score on ScreenGameplay.
</Function>
<Function name='UserPrefGameplayShowStepsDisplay' theme='default' return='LuaOptionRow' arguments=''>
[03 ThemePrefs.lua] Returns a Lua option row for displaying the StepsDisplay on ScreenGameplay.
</Function>
<Function name='UserPrefGameplayLongFail' theme='default' return='LuaOptionRow' arguments=''>
[03 ThemePrefs.lua] Returns a Lua option row for determining the fail length.
</Function>
<Function name='UserPrefNotePosition' theme='default' return='LuaOptionRow' arguments=''>
[03 ThemePrefs.lua] Returns a Lua option row for determining the receptor arrow position.
</Function>
<Function name='UserPrefShowLotsaOptions' theme='default' return='LuaOptionRow' arguments=''>
[03 ThemePrefs.lua] Returns a Lua option row determining how deep the player options menu should go.
</Function>
</GlobalFunctions>
<!-- Namespaces -->
<Namespaces>
<Namespace name='ActorUtil'>
<Function name='GetFileType' return='FileType' arguments='string sPath'>
Returns the <Link class='ENUM' function='FileType' /> for the file at <code>sPath</code>.
</Function>
<Function name='IsRegisteredClass' return='bool' arguments='string sClassName'>
Returns <code>true</code> if <code>sClassName</code> is a registered Class.
</Function>
<Function name='LoadAllCommandsAndSetXY' return='void' arguments='Actor a'>
Loads all commands and sets X and Y for the specified Actor.
</Function>
<Function name='ResolvePath' return='string' arguments='string sPath, int iLevel' />
</Namespace>
<Namespace name='Enum'>
<Description>
Enumerated types are lookup tables associating a string to each numerical
value for each <Link class='Enums'>Enum</Link>. For example,
<code><Link class='ENUM' function='PlayerNumber' />[1]</code> would be the
string <code>'PlayerNumber_P1'</code>.<br />
The functions defined in the <code>Enum</code> namespace are valid member
functions of every <Link class='Enums'>Enum</Link> where the first argument is
omitted and the name of the <Link class='Enums'>Enum</Link> is used in place
of <code>Enum</code>. Instead of
<code><Link function='GetName'>Enum.GetName</Link>(
<Link class='ENUM' function='PlayerNumber' /> )</code> or
<code><Link function='Reverse'>Enum.Reverse</Link>(
<Link class='ENUM' function='PlayerNumber' /> )</code>, one can use
<code><Link class='ENUM' function='PlayerNumber' />:<!--
--><Link function='GetName'>GetName</Link>()</code> or
<code><Link class='ENUM' function='PlayerNumber' />:<!--
--><Link function='Reverse'>Reverse</Link>()</code>, respectively.
</Description>
<Function name='Compare' return='int' arguments='Enum e, string x, string y'>
Both <code>x</code> and <code>y</code> need to be elements of the enumerated
type <code>e</code>. Returns a value less than/greater than/equal to
<code>0</code> corresponding to the numerical value of <code>x</code> being
less than/greater than/equal to the numerical value of <code>y</code> as
determined by
<code><Link function='Reverse'>Enum.Reverse</Link>( e )</code>.
</Function>
<Function name='GetName' return='string' arguments='Enum e'>
Returns the type of <code>e</code>. For example,
<code>Enum.GetName( <Link class='ENUM' function='PlayerNumber' /> )</code>
will return the string <code>'PlayerNumber'</code>.
</Function>
<Function name='Reverse' return='{int}' arguments='Enum e'>
Returns a reverse lookup table for the enumerated type <code>e</code>. For
example: <br /><code>local r =
Enum.Reverse( <Link class='ENUM' function='PlayerNumber'/> );<br />
local n = r['PlayerNumber_P2'];</code><br />
The value of <code>n</code> in this case would be <code>1</code> corresponding
to the 0-based indexing using in C++ and not <code>2</code> as might be
expected for the 1-based indexing used in Lua.
</Function>
</Namespace>
<Namespace name='lua'>
<Function name='CheckType' return='bool' arguments='string sType, various v'>
Returns <code>true</code> if the type of <code>v</code> is <code>sType</code>.
</Function>
<Function name='Flush' return='void' arguments='' >
Flushes log files to disk.
</Function>
<Function name='GetThreadVariable' return='LuaThreadVariable' arguments='string s' />
<Function name='ReadFile' return='string' arguments='string sPath'>
Tries to read the file at <code>sPath</code>. If successful, it returns the file's contents.
If unsuccessful, it returns two values: <code>nil</code> and <code>"error"</code>.
</Function>
<Function name='RunWithThreadVariables' return='int' arguments='function func, table t, ...'>
Calls <code>func(...)</code> with two LuaThreadVariables set, and returns the return values of <code>func()</code>.
</Function>
<Function name='Trace' return='void' arguments='string sString'>
Writes <code>sString</code> to log.txt. Aliased by
<Link class='GLOBAL' function='Trace' />.
</Function>
<Function name='Warn' return='void' arguments='string sString'>
Writes <code>sString</code> to info.txt and log.txt as
a warning. Aliased by <Link class='GLOBAL' function='Warn' />.
</Function>
</Namespace>
<Namespace name='MersenneTwister'>
<Function name='Random' return='float' arguments='...'>
Returns a random number. Without arguments, the number is in the range <code>0..1</code>. With a single argument (<code>n</code>), the number is in the range of <code>1..n</code>. With two arguments (<code>lower</code>, <code>upper</code>), the number is in the range of <code>l..u</code>.
</Function>
<Function name='Seed' return='void' arguments='int seed'>
Sets the seed of the random number generator to <code>seed</code>.
</Function>
</Namespace>
<Namespace name='RageFileUtil'>
<Function name='CreateRageFile' return='RageFile' arguments=''>
Creates a RageFile handle with which one can use the commands in <Link class='RageFile' />.
</Function>
</Namespace>
<Namespace name='ScreenSystemLayerHelpers'>
<Function name='GetCreditsMessage' return='string' arguments='PlayerNumber pn'>
Gets the credits message for Player <code>pn</code>.
</Function>
</Namespace>
<Namespace name='SongUtil'>
<Function name='GetPlayableSteps' return='Steps' arguments='Song so'>
Gets the playable Steps for the present Song based on the present Game.
</Function>
<Function name='IsStepsPlayable' return='bool' arguments='Song so, Steps st'>
Returns true if the song's steps (<code>st</code>) are playable.
</Function>
<Function name='IsStepsTypePlayable' return='bool' arguments='Song so, StepsType st'>
Returns true if the song's StepsType (<code>st</code>) are playable.
</Function>
</Namespace>
<Namespace name='TrailUtil'>
<Function name='GetNumSongs' return ='float' arguments='Trail pTrail'>
Returns the number of songs in a Trail.
</Function>
<Function name='GetTotalSeconds' return ='int' arguments='Trail pTrail'>
Returns the Trail's total length in seconds.
</Function>
</Namespace>
</Namespaces>
<!-- Classes -->
<Classes>
<Class name='Actor'>
<Function name='GetParent' return='Actor' arguments=''>
Returns the Actor's parent, or <code>nil</code> if it doesn't have one.
</Function>
<Function name='GetVisible' return='bool' arguments=''>
Returns the Actor's visibility.
</Function>
<Function name='GetX' return='float' arguments=''>
Returns the Actor's x position.
</Function>
<Function name='GetY' return='float' arguments=''>
Returns the Actor's y position.
</Function>
<Function name='GetZ' return='float' arguments=''>
Returns the Actor's z position.
</Function>
<Function name='GetZoom' return='float' arguments=''>
Returns the Actor's zoom.
</Function>
<Function name='GetZoomX' return='float' arguments=''>
Returns the Actor's X zoom.
</Function>
<Function name='GetZoomY' return='float' arguments=''>
Returns the Actor's Y zoom.
</Function>
<Function name='GetZoomZ' return='float' arguments=''>
Returns the Actor's Z zoom.
</Function>
<Function name='SetTextureFiltering' return='void' arguments='bool b'>
Sets Texture Filtering for an Actor to <code>b</code>.
</Function>
<Function name='accelerate' return='void' arguments='float fRate'>
Plays the commands that follow at an accelerated rate (<code>fRate</code> * <code>fRate</code>), where <code>fRate</code> is in seconds.
</Function>
<Function name='addcommand' return='void' arguments='string sName, ActorCommand cmd'>
Adds a command to the Actor.
</Function>
<Function name='addrotationx' return='void' arguments='float rot'>
Adds <code>rot</code> to the Actor's current x rotation.
</Function>
<Function name='addrotationy' return='void' arguments='float rot'>
Adds <code>rot</code> to the Actor's current y rotation.
</Function>
<Function name='addrotationz' return='void' arguments='float rot'>
Adds <code>rot</code> to the Actor's current z rotation.
</Function>
<Function name='addx' return='void' arguments='float xPos'>
Adds <code>xPos</code> to the Actor's current x position.
</Function>
<Function name='addy' return='void' arguments='float yPos'>
Adds <code>yPos</code> to the Actor's current y position.
</Function>
<Function name='addz' return='void' arguments='float zPos'>
Adds <code>zPos</code> to the Actor's current z position.
</Function>
<Function name='align' theme='_fallback' return='void' arguments='float h, float v'>
[02 Actor.lua] Sets the alignment of an Actor, where <code>h</code> and <code>v</code> are in the range 0..1.
</Function>
<Function name='animate' return='void' arguments='bool b'>
Sets whether or not the Actor should animate.
</Function>
<Function name='aux' return='void' arguments='float fAux'>
Sets the Actor's aux value. (This can be a solution for coupling data with an Actor.)
</Function>
<Function name='backfacecull' return='void' arguments='bool b'>
If <code>true</code>, cull the Actor's back faces. See also: <Link class='Actor' function='cullmode' />.
</Function>
<Function name='basealpha' return='void' arguments='float fAlpha'>
Sets the Actor's base alpha to <code>fAlpha</code>, where <code>fAlpha</code> is in the range 0..1.
</Function>
<Function name='baserotationx' return='void' arguments='float rot'>
Sets the Actor's base X rotation to <code>rot</code>.
</Function>
<Function name='baserotationy' return='void' arguments='float rot'>
Sets the Actor's base Y rotation to <code>rot</code>.
</Function>
<Function name='baserotationz' return='void' arguments='float rot'>
Sets the Actor's base Z rotation to <code>rot</code>.
</Function>
<Function name='basezoom' return='void' arguments='float zoom'>
Sets the Actor's base zoom to <code>zoom</code>.
</Function>
<Function name='basezoomx' return='void' arguments='float zoom'>
Sets the Actor's base X zoom to <code>zoom</code>.
</Function>
<Function name='basezoomy' return='void' arguments='float zoom'>
Sets the Actor's base Y zoom to <code>zoom</code>.
</Function>
<Function name='basezoomz' return='void' arguments='float zoom'>
Sets the Actor's base Z zoom to <code>zoom</code>.
</Function>
<Function name='blend' return='void' arguments='BlendMode mode'>
Sets the Actor to use the specified blend mode.
</Function>
<Function name='bob' return='void' arguments=''>
Makes the Actor bob up and down. Can use <Link function='effectmagnitude' /> to define different bobbing behavior.
</Function>
<Function name='bounce' return='void' arguments=''>
Makes the Actor bounce, similar to bob but with one point acting as the ground. Can use <Link function='effectmagnitude' /> to define different bouncing behavior (with effectmagnitude values relating to x, y, and z movement).
</Function>
<Function name='bouncebegin' theme='_fallback' return='void' arguments='float time'>
[02 Actor.lua]
</Function>
<Function name='bounceend' theme='_fallback' return='void' arguments='float time'>
[02 Actor.lua]
</Function>
<Function name='Center' theme='_fallback' return='void' arguments=''>
[02 Actor.lua] Centers an Actor on the screen. (equivalent to <code>x,SCREEN_CENTER_X;y,SCREEN_CENTER_Y</code>)
</Function>
<Function name='CenterX' theme='_fallback' return='void' arguments=''>
[02 Actor.lua] Centers an Actor on the X axis. (equivalent to <code>x,SCREEN_CENTER_X</code>)
</Function>
<Function name='CenterY' theme='_fallback' return='void' arguments=''>
[02 Actor.lua] Centers an Actor on the y axis. (equivalent to <code>y,SCREEN_CENTER_Y</code>)
</Function>
<Function name='clearzbuffer' return='void' arguments='bool bClear'>
Determines if the z-buffer should be cleared or not.
</Function>
<Function name='compound' theme='_fallback' return='void' arguments='float length, string tweens'>
[02 Actor.lua] Combines multiple interpolators for complex tweens. <code>tweens</code>
can either be a string like <code>"linear,0.25,accelerate,0.75"</code> or
a table with tween information <code>{ {Type="linear", Percent=0.25, Bezier=nil}, {Type="accelerate", Percent=0.75, Bezier=nil} }</code>
</Function>
<Function name='cropbottom' return='void' arguments='float percent'>
Crops <code>percent</code> of the Actor from the bottom, where <code>percent</code> is in the range 0..1.
</Function>
<Function name='cropleft' return='void' arguments='float percent'>
Crops <code>percent</code> of the Actor from the left, where <code>percent</code> is in the range 0..1.
</Function>
<Function name='cropright' return='void' arguments='float percent'>
Crops <code>percent</code> of the Actor from the right, where <code>percent</code> is in the range 0..1.
</Function>
<Function name='croptop' return='void' arguments='float percent'>
Crops <code>percent</code> of the Actor from the top, where <code>percent</code> is in the range 0..1.
</Function>
<Function name='cullmode' return='void' arguments='CullMode mode'>
Sets the Actor's cull mode to <code>mode</code>.
</Function>
<Function name='decelerate' return='void' arguments='float fRate'>
Plays the commands that follow at an decelerated rate (1 - (1-<code>fRate</code>) * (1-<code>fRate</code>)), where <code>fRate</code> is in seconds.
</Function>
<Function name='diffuse' return='void' arguments='color c'>
Set the Actor's diffuse color to <code>c</code>.
</Function>
<Function name='diffusealpha' return='void' arguments='float fAlpha'>
Sets the Actor's alpha level to <code>fAlpha</code>, where <code>fAlpha</code> is in the range 0..1.
</Function>
<Function name='diffuseblink' return='void' arguments=''>
Makes the Actor switch between two colors immediately.
</Function>
<Function name='diffusebottomedge' return='void' arguments=''>
Sets the Actor's bottom edge color to <code>c</code>.
</Function>
<Function name='diffusecolor' return='void' arguments='color c'>
Set the Actor's diffuse color to <code>c</code>, ignoring any alpha value in <code>c</code>.
</Function>
<Function name='diffuseleftedge' return='void' arguments='color c'>
Sets the Actor's left edge color to <code>c</code>.
</Function>
<Function name='diffuselowerleft' return='void' arguments='color c'>
Sets the Actor's lower left corner color to <code>c</code>.
</Function>
<Function name='diffuselowerright' return='void' arguments='color c'>
Sets the Actor's lower right corner color to <code>c</code>.
</Function>
<Function name='diffuseramp' return='void' arguments=''>
Makes the Actor switch between two colors, jumping back to the first after reaching the second.
</Function>
<Function name='diffuserightedge' return='void' arguments='color c'>
Sets the Actor's right edge color to <code>c</code>.
</Function>
<Function name='diffuseshift' return='void' arguments=''>
Makes the Actor shift between two colors smoothly.
</Function>
<Function name='diffusetopedge' return='void' arguments='color c'>
Sets the Actor's top edge color to <code>c</code>.
</Function>
<Function name='diffuseupperleft' return='void' arguments='color c'>
Sets the Actor's upper left corner color to <code>c</code>.
</Function>
<Function name='diffuseupperright' return='void' arguments='color c'>
Sets the Actor's upper right corner color to <code>c</code>.
</Function>
<Function name='Draw' return='void' arguments=''>
Tells the Actor to draw itself.
</Function>
<Function name='draworder' return='void' arguments='int iOrder'>
Sets the Actor's draworder to <code>iOrder</code>, where larger values display first.
</Function>
<Function name='drop' theme='_fallback' return='void' arguments='float time'>
[02 Actor.lua] (Added in sm-ssc)
</Function>
<Function name='ease' theme='_fallback' return='void' arguments='float time, float fEase'>
[02 Actor.lua]
</Function>
<Function name='effectclock' return='void' arguments='string s'>
Set the Actor's effect clock to <code>s</code>.
</Function>
<Function name='effectcolor1' return='void' arguments='color c'>
Sets the first effect color to <code>c</code>.
</Function>
<Function name='effectcolor2' return='void' arguments='color c'>
Sets the second effect color to <code>c</code>.
</Function>
<Function name='effectmagnitude' return='void' arguments='float fX, float fY, float fZ'>
Set the Actor's effect magnitude in each direction to the given values.
</Function>
<Function name='effectoffset' return='void' arguments='float fTime'>
Set the Actor's effect offset to <code>fTime</code>.
</Function>
<Function name='effectperiod' return='void' arguments='float fTime'>
Set the Actor's effect period to <code>fTime</code>.
</Function>
<Function name='effecttiming' return='void' arguments='float fRampUp, float fAtHalf, float fRampDown, float fAtZero'>
Set the Actor's effect timing.
</Function>
<Function name='fadebottom' return='void' arguments='float percent'>
Fades <code>percent</code> of the Actor from the bottom where <code>percent</code> is in the range 0..1.
</Function>
<Function name='fadeleft' return='void' arguments='float percent'>
Fades <code>percent</code> of the Actor from the left where <code>percent</code> is in the range 0..1.
</Function>
<Function name='faderight' return='void' arguments='float percent'>
Fades <code>percent</code> of the Actor from the right where <code>percent</code> is in the range 0..1.
</Function>
<Function name='fadetop' return='void' arguments='float percent'>
Fades <code>percent</code> of the Actor from the top where <code>percent</code> is in the range 0..1.
</Function>
<Function name='finishtweening' return='void' arguments=''>
Finishes up an Actor's tween immediately.
</Function>
<Function name='FullScreen' theme='_fallback' return='void' arguments=''>
[02 Actor.lua] Stretches an Actor to fill the entire screen.
</Function>
<Function name='getaux' return='float' arguments=''>
Returns the Actor's aux value.
</Function>
<Function name='GetBaseZoomX' return='float' arguments=''>
Returns the Actor's base X zoom value.
</Function>
<Function name='GetBaseZoomY' return='float' arguments=''>
Returns the Actor's base Y zoom value.
</Function>
<Function name='GetBaseZoomZ' return='float' arguments=''>
Returns the Actor's base Z zoom value.
</Function>
<Function name='GetCommand' return='bool' arguments='string sCmdName'>
Returns <code>true</code> if the Actor has a command named <code>sCmdName</code>.
</Function>
<Function name='GetDiffuse' return='color' arguments=''>
Returns the Actor's current diffuse color.
</Function>
<Function name='GetDiffuseAlpha' return='float' arguments=''>
Returns the Actor's current diffusealpha.
</Function>
<Function name='GetEffectDelta' return='float' arguments=''>
Returns the Actor's current effect delta.
</Function>
<Function name='geteffectmagnitude' return='float' arguments=''>
Returns the Actor's current effect magnitude as three floats (not one; I hate Lua.xsd).
</Function>
<Function name='GetGlow' return='color' arguments=''>
Returns the Actor's current glow color.
</Function>
<Function name='GetHAlign' return='float' arguments=''>
Returns the Actor's horizontal alignment as a number in the range 0..1.
</Function>
<Function name='GetName' return='string' arguments=''>
Returns the Actor's name.
</Function>
<Function name='GetNumStates' return='int' arguments=''>
Returns the number of states the Actor has.
</Function>
<Function name='GetHeight' return='float' arguments=''>
Returns the Actor's current height.
</Function>
<!-- todo: GetRotation() returns three numbers, the x, y, and z -->
<Function name='GetRotationX' return='float' arguments=''>
Returns the Actor's current X rotation.
</Function>
<Function name='GetRotationY' return='float' arguments=''>
Returns the Actor's current Y rotation.
</Function>
<Function name='GetRotationZ' return='float' arguments=''>
Returns the Actor's current Z rotation.
</Function>
<Function name='GetSecsIntoEffect' return='float' arguments=''>
Returns the number of seconds into the currently running effect (e.g. diffuseshift, bob).
</Function>
<Function name='GetTweenTimeLeft' return='float' arguments=''>
Returns how much time is remaining for the current tween.
</Function>
<Function name='GetVAlign' return='float' arguments=''>
Returns the Actor's vertical alignment as a number in the range 0..1.
</Function>
<Function name='GetWidth' return='float' arguments=''>
Returns the Actor's current width.
</Function>
<Function name='GetZoomedHeight' return='float' arguments=''>
Returns the zoomed height of an Actor.
</Function>
<Function name='GetZoomedWidth' return='float' arguments=''>
Returns the zoomed width of an Actor.
</Function>
<Function name='glow' return='void' arguments='color c'>
Sets the Actor's glow color.
</Function>
<Function name='glowblink' return='void' arguments=''>
Makes the Actor glow between two colors immediately.
</Function>
<Function name='glowramp' return='void' arguments=''>
Makes the Actor glow between two colors smoothly, jumping back to the first at the end.
</Function>
<Function name='glowshift' return='void' arguments=''>
Makes the Actor glow between two colors smoothly.
</Function>
<Function name='halign' return='void' arguments='float fAlign'>
Set the fractional horizontal alignment of the Actor according to <code>fAlign</code> which should be a float in the range 0..1. An alignment of 0 is left aligned while an alignment of 1 is right aligned. See <Link function='horizalign' /> for the common case.
</Function>
<!-- heading -->
<Function name='hibernate' return='void' arguments='float fTime'>
Hides the Actor for the specified amount of time.
</Function>
<Function name='hidden' return='void' theme='_fallback' arguments='bool b'>
[Deprecated] Compatibility alias for the hidden command, which was removed in sm-ssc. Use <Link function='visible' /> instead.
</Function>
<Function name='hide_if' theme='_fallback' return='void' arguments='bool b'>
[02 Actor.lua] "Hide if <code>b</code> is <code>true</code>, but don't unhide if <code>b</code> is <code>false</code>."
</Function>
<Function name='horizalign' return='void' arguments='HorizAlign align'>
Set the horizontal alignment of the Actor according to <code>align</code>. See <Link function='halign' /> for fractional alignment.
</Function>
<Function name='hurrytweening' return='void' arguments='float factor'>
Hurries up an Actor's tweening by <code>factor</code>.
</Function>
<Function name='linear' return='void' arguments='float fRate'>
Plays the commands that follow at a normal rate, where <code>fRate</code> is in seconds.
</Function>
<Function name='LyricCommand' theme='_fallback' return='void' arguments='string side'>
[02 Lyrics.lua] Plays the lyric command for the specified <code>side</code> (<code>"Back"</code> or <code>"Front"</code>).
</Function>
<Function name='name' return='void' arguments='string sName'>
Sets the Actor's name to <code>sName</code>.
</Function>
<Function name='pause' return='void' arguments=''>
Stops the Actor's movement. (Usually used for Sprites or Models.)
</Function>
<!-- pitch -->
<Function name='play' return='void' arguments=''>
Starts the Actor's movement. (Usually used for Sprites or Models.)
</Function>
<Function name='playcommand' return='void' arguments='string sCommandName'>
Plays a command named <code>sCommandName</code>.
</Function>
<Function name='player' theme='_fallback' return='void' arguments='PlayerNumber p'>
[02 Actor.lua] Sets the visibility of the Actor based on <code>p</code> being a human player.
</Function>
<Function name='pulse' return='void' arguments=''>
Makes the Actor grow and shrink. Can use <Link function='effectmagnitude' /> to define different pulsing behavior.
</Function>
<Function name='queuecommand' return='void' arguments='string sCommandName'>
Queues a command named <code>sCommandName</code> to be played.
</Function>
<Function name='queuemessage' return='void' arguments='string sMessageName'>
Basically creates a command named <code>!sMessageName</code> (Note the ! at the beginning. The source code says this: "Hack: use "!" as a marker to broadcast a command, instead of playing a command, so we don't have to add yet another element to every tween state for this rarely-used command.")
</Function>
<Function name='rainbow' return='void' arguments=''>
Makes the Actor change colors continually using colors of the rainbow.
</Function>
<!-- roll -->
<Function name='rotationx' return='void' arguments='float fRotation'>
Set the Actor's rotation on the X axis to <code>fAlign</code>.
</Function>
<Function name='rotationy' return='void' arguments='float fRotation'>
Set the Actor's rotation on the Y axis to <code>fAlign</code>.
</Function>
<Function name='rotationz' return='void' arguments='float fRotation'>
Set the Actor's rotation on the Z axis to <code>fAlign</code>.
</Function>
<!-- RunCommandsRecursively -->
<Function name='scale_or_crop_alternative' theme="_fallback" return='void' arguments=''>
[02 Actor.lua] An alternative version of <Link function='scale_or_crop_background' />.
</Function>
<Function name='scale_or_crop_background' theme="_fallback" return='void' arguments=''>
[02 Actor.lua]
</Function>
<Function name='scaletocover' return='void' arguments='float fLeft, float fTop, float fRight, float fBottom'>
Scales the Actor to cover a rectangle defined by the four float arguments.
</Function>
<Function name='scaletofit' return='void' arguments='float fLeft, float fTop, float fRight, float fBottom'>
Scales the Actor to fit inside a rectangle defined by the four float arguments.
</Function>
<Function name='SetHeight' return='void' arguments='float height'>
Sets the height of the Actor.
</Function>
<Function name='setsize' return='void' arguments='float width, float height'>
Sets the size of the Actor.
</Function>
<Function name='SetSize' theme='_fallback' return='void' arguments='float width, float height'>
[01 alias.lua] Alias for setsize.
</Function>
<Function name='setstate' return='void' arguments='int iNewState'>
Sets a multi-framed Actor's state to <code>iNewState</code>.
</Function>
<Function name='SetWidth' return='void' arguments='float width'>
Sets the width of the Actor.
</Function>
<Function name='shadowcolor' return='void' arguments='color c'>
Sets the shadow's color to <code>c</code>.
</Function>
<Function name='shadowlength' return='void' arguments='float fLength'>
Sets the Actor's shadow length to <code>fLength</code>.
</Function>
<Function name='shadowlengthx' return='void' arguments='float fLength'>
Sets the Actor's horizontal shadow length to <code>fLength</code>.
</Function>
<Function name='shadowlengthy' return='void' arguments='float fLength'>
Sets the Actor's vertical shadow length to <code>fLength</code>.
</Function>
<Function name='skewx' return='void' arguments='float fAmount'>
Skews the Actor on the x axis by <code>fAmount</code>.
</Function>
<Function name='skewy' return='void' arguments='float fAmount'>
Skews the Actor on the y axis by <code>fAmount</code>.
</Function>
<Function name='sleep' return='void' arguments='float fSeconds'>
Waits <code>fSeconds</code> before executing the next command.
</Function>
<Function name='smooth' theme='_fallback' return='void' arguments='float time'>
[02 Actor.lua]
</Function>
<Function name='spin' return='void' arguments=''>
Tells the Actor to spin. Can use <Link function='effectmagnitude' /> to define different spinning behavior.
</Function>
<!-- spring -->
<Function name='stopeffect' return='void' arguments=''>
Stops any effect the Actor has.
</Function>
<Function name='stoptweening' return='void' arguments=''>
Stops any tweening.
</Function>
<Function name='stretchto' return='void' arguments='float x1, float y1, float x2, float y2'>
Stretches the Actor to a rectangle of a specific size.
</Function>
<Function name='texturewrapping' return='void' arguments='bool bWrap'>
Determines if the Actor should use texture wrapping or not.
</Function>
<!-- tween -->
<Function name='valign' return='void' arguments='float fAlign'>
Set the fractional vertical alignment of the Actor according to <code>fAlign</code> which should be a float in the range 0..1. An alignment of 0 is top aligned while an alignment of 1 is bottom aligned. See <Link function="vertalign" /> for the common case.
</Function>
<Function name='vertalign' return='void' arguments='VertAlign align'>
Set the vertical alignment of the Actor according to <code>align</code>. See <Link function="valign" /> for fractional alignment.
</Function>
<Function name='vibrate' return='void' arguments=''>
Makes the Actor vibrate violently. Can use <Link function='effectmagnitude' /> to define different vibration behavior.
</Function>
<Function name='visible' return='void' arguments='bool b'>
Sets an Actor's visibility to b.
</Function>
<Function name='wag' return='void' arguments=''>
Makes the Actor wag. Use <Link function='effectmagnitude' /> to define different wag behavior.
</Function>
<Function name='x' return='void' arguments='float xPos'>
Set the x position of the Actor to <code>xPos</code>.
</Function>
<Function name='y' return='void' arguments='float yPos'>
Set the y position of the Actor to <code>yPos</code>.
</Function>
<Function name='z' return='void' arguments='float zPos'>
Set the z position of the Actor to <code>zPos</code>.
</Function>
<Function name='zbias' return='void' arguments='float fBias'>
Sets the z bias to <code>fBias</code>.
</Function>
<Function name='zbuffer' return='void' arguments='bool bUse'>
Enables/disables z-buffer depending on <code>bUse</code>.
</Function>
<Function name='zoom' return='void' arguments='float zoom'>
Zooms the Actor to <code>zoom</code> scale.
</Function>
<Function name='zoomto' return='void' arguments='float zoomX, float zoomY'>
Zooms the Actor on both the X and Y axis using <code>zoomX</code> and <code>zoomY</code>.
</Function>
<Function name='zoomtoheight' return='void' arguments='float zoom'>
Zooms the Actor to <code>zoom</code> height. See also: <Link function='zoomy' />.
</Function>
<Function name='zoomtowidth' return='void' arguments='float zoom'>
Zooms the Actor to <code>zoom</code> width. See also: <Link function='zoomx' />.
</Function>
<Function name='zoomx' return='void' arguments='float zoom'>
Zooms the Actor to <code>zoom</code> scale on the X axis.
</Function>
<Function name='zoomy' return='void' arguments='float zoom'>
Zooms the Actor to <code>zoom</code> scale on the Y axis.
</Function>
<Function name='zoomz' return='void' arguments='float zoom'>
Zooms the Actor to <code>zoom</code> scale on the Z axis.
</Function>
<Function name='ztest' return='void' arguments='bool bTest'>
Sets the z testing mode to write on pass if <code>true</code>, turns it off if <code>false</code>
</Function>
<Function name='ztestmode' return='void' arguments='ZTestMode testMode'>
Sets the z testing mode to <code>testMode</code>.
</Function>
<Function name='zwrite' return='void' arguments='bool bWrite'>
Sets z writing to <code>true</code> or <code>false</code> based on <code>bWrite</code>.
</Function>
<!-- addons from scripts that come with sm-ssc (non-compat) -->
<Function name='bezier' theme='_fallback' return='void' arguments=''>
[02 Actor.lua]
</Function>
<Function name='FullScreen' theme='_fallback' return='void' arguments=''>
[02 Actor.lua] Stretches an Actor to cover the screen. (equivalent to <code>stretchto,0,0,SCREEN_WIDTH,SCREEN_HEIGHT</code>)
</Function>
<Function name='heartbeat' theme='_fallback' return='void' arguments='float fEffectPeriod'>
[02 Actor.lua] A customized version of pulse that is more appealing for on-beat effects.
</Function>
<Function name='MaskDest' theme='_fallback' return='void' arguments=''>
[02 Actor.lua] Sets and Actor as a mask destination.
</Function>
<Function name='MaskSource' theme='_fallback' return='void' arguments=''>
[02 Actor.lua] Sets an Actor as a mask source. (Also clears zbuffer; other mask sources need to not clear the zbuffer)
</Function>
<Function name='Real' theme='_fallback' return='void' arguments='float f'>
[02 Actor.lua] Make graphics their true size at any resolution.
</Function>
<Function name='RealInverse' theme='_fallback' return='void' arguments='float f'>
[02 Actor.lua] Scale things back up after they have already been scaled down.
</Function>
<Function name='thump' theme='_fallback' return='void' arguments='float fEffectPeriod'>
[02 Actor.lua] A customized version of pulse that is more appealing for on-beat effects.
</Function>
<Function name='xy' theme='_fallback' return='void' arguments='float actorX, float actorY'>
Sets the x and y location of the Actor in one command.
</Function>
</Class>
<Class name='ActorFrame'>
<Function name='AddChildFromPath' return='bool' arguments='string sPath'>
Adds a child to the ActorFrame from the specified path.
</Function>
<Function name='fov' return='void' arguments='float fFOV'>
Sets the field of view for the ActorFrame.
</Function>
<Function name='GetChild' return='Actor' arguments='string sName'>
Returns the child with a name of <code>sName</code>.
</Function>
<Function name='GetChildren' return='{Actor}' arguments=''>
Returns a table of all the children in the ActorFrame.
</Function>
<Function name='GetDrawFunction' return='LuaReference' arguments=''>
Gets the ActorFrame's Draw function.
</Function>
<Function name='GetNumChildren' return='int' arguments=''>
Returns the number of children in the ActorFrame.
</Function>
<Function name='playcommandonchildren' return='void' arguments='string sCommandName'>
Plays the <code>sCommandName</code> command on the ActorFrame's children.
</Function>
<Function name='playcommandonleaves' return='void' arguments='string sCommandName'>
Plays the <code>sCommandName</code> command on the ActorFrame's leaves.
</Function>
<Function name='propagate' return='void' arguments='bool bPropagate'>
Sets if the Actorframe should propagate commands to its children.
</Function>
<Function name='propagatecommand' theme='_fallback' return='void' arguments='LuaReference cmd'>
[02 Actor.lua] Propagates a command to the ActorFrame's children.
</Function>
<Function name='RemoveAllChildren' return='void' arguments=''>
Removes all the children from the ActorFrame.
</Function>
<Function name='RemoveChild' return='void' arguments='string sChild'>
Removes the specified child from the ActorFrame.
</Function>
<Function name='RunCommandsOnChildren' return='void' arguments='LuaReference cmds'>
Runs the commands in <code>cmds</code> on the ActorFrame's children.
</Function>
<Function name='runcommandsonleaves' return='void' arguments='LuaReference cmds'>
Runs the commands in <code>cmds</code> on the ActorFrame's leaves.
</Function>
<Function name='SetAmbientLightColor' return='void' arguments='Color c'>
Sets the ActorFrame's ambient light color to <code>c</code>.
</Function>
<Function name='SetDiffuseLightColor' return='void' arguments='Color c'>
Sets the ActorFrame's diffuse light color to <code>c</code>.
</Function>
<Function name='SetDrawByZPosition' return='void' arguments='bool b'>
Sets if the ActorFrame should draw by Z position.
</Function>
<Function name='SetDrawFunction' return='void' arguments='LuaReference DrawFunction'>
Sets the ActorFrame's Draw function to the specified Lua function.
</Function>
<Function name='SetFOV' return='void' arguments='float fFOV'>
Sets the field of view for the ActorFrame.
</Function>
<Function name='SetLightDirection' return='void' arguments='float x, float y, float z'>
Currently unimplemented since it does not handle errors correctly. Arguments must be passed in as a table.
</Function>
<Function name='SetSpecularLightColor' return='void' arguments='Color c'>
Sets the ActorFrame's specular light color to <code>c</code>.
</Function>
<Function name='SetUpdateFunction' return='void' arguments='LuaReference UpdateFunction'>
Sets the ActorFrame's update function to the specified Lua function.
</Function>
<Function name='SetUpdateRate' return='void' arguments='float fRate'>
Sets the update function's rate to <code>fRate</code>.
</Function>
<Function name='SortByDrawOrder' return='void' arguments=''>
Tells the ActorFrame to sort by draw order.
</Function>
<Function name='vanishpoint' return='void' arguments='float fX, float fY'>
Sets the vanishing point for the ActorFrame.
</Function>
</Class>
<Class name='ActorFrameTexture'>
<Function name='Create' return='void' arguments=''>
Creates the ActorFrameTexture.
</Function>
<Function name='EnableAlphaBuffer' return='void' arguments='bool bEnable'>
Enables/disables the Alpha Buffer.
</Function>
<Function name='EnableDepthBuffer' return='void' arguments='bool bEnable'>
Enables/disables the Depth Buffer.
</Function>
<Function name='EnableFloat' return='void' arguments='bool bEnable'>
Enables/disables
</Function>
<Function name='EnablePreserveTexture' return='void' arguments='bool bEnable'>
Enables/disables the Preserve Texture option.
</Function>
<Function name='GetTexture' return='RageTexture' arguments=''>
Returns the texture.
</Function>
<Function name='SetTextureName' return='void' arguments='string sName'>
Sets the Texture's name to <code>sName</code>.
</Function>
</Class>
<Class name='ActorMultiTexture'>
<Function name='AddTexture' return='int' arguments='RageTexture tex'>
Adds a texture to the ActorMultiTexture. Returns the number of texture units.
</Function>
<Function name='ClearTextures' return='void' arguments=''>
Clears all the textures from the ActorMultiTexture.
</Function>
<Function name='SetEffectMode' return='void' arguments='EffectMode em'>
Sets the EffectMode on the ActorMultiTexture.
</Function>
<Function name='SetSizeFromTexture' return='void' arguments='RageTexture tex'>
Sets the size of the ActorMultiTexture from the specified texture.
</Function>
<Function name='SetTextureCoords' return='void' arguments='float x1, float y1, float x2, float y2'>
Sets the coordinates of the ActorMultiTexture.
</Function>
<Function name='SetTextureMode' return='void' arguments='int iIndex, TextureMode tm'>
Sets a TextureMode on the specified index.
</Function>
</Class>
<Class name='ActorProxy'>
<Function name='GetTarget' return='Actor' arguments=''>
Returns the target of the ActorProxy.
</Function>
<Function name='SetTarget' return='void' arguments='Actor a'>
Sets the ActorProxy target to <code>a</code>.
</Function>
</Class>
<Class name='ActorScroller'>
<Function name='GetCurrentItem' return='float' arguments=''>
Returns the scroller's current item.
</Function>
<Function name='GetDestinationItem' return='float' arguments=''>
Returns the item the scroller's going to.
</Function>
<Function name='GetFullScrollLengthSeconds' return='float' arguments=''>
Returns how long it will take for the scroller to completely scroll through all its items.
</Function>
<Function name='GetNumItems' return='int' arguments=''>
Returns the number of items in the ActorScroller.
</Function>
<Function name='GetSecondsToDestination' renamed='true' return='float' arguments=''>
Returns the number of seconds until the scroller reaches its destination.
</Function>
<Function name='getsecondtodestination' theme='_fallback' return='float' arguments=''>
Compatibility alias for <Link function='GetSecondsToDestination' />.
</Function>
<Function name='PositionItems' return='void' arguments=''>
Positions the scroller items.
</Function>
<Function name='ScrollThroughAllItems' renamed='true' return='void' arguments=''>
Scrolls through all the items in the scroller.
</Function>
<Function name='scrollthroughallitems' theme='_fallback' return='void' arguments=''>
Compatibility alias for <Link function='ScrollThroughAllItems' />.
</Function>
<Function name='ScrollWithPadding' renamed='true' return='void' arguments='float fItemPaddingStart, float fItemPaddingEnd'>
Scrolls through all the items in the scroller with padding at the beginning and end.
</Function>
<Function name='scrollwithpadding' theme='_fallback' return='void' arguments='float fItemPaddingStart, float fItemPaddingEnd'>
Compatibility alias for <Link function='ScrollWithPadding' />.
</Function>
<Function name='SetCurrentAndDestinationItem' return='void' arguments='float fItemIndex'>
Sets the item the scroller should scroll to next and makes it the current item.
</Function>
<Function name='SetDestinationItem' return='void' arguments='float fItemIndex'>
Sets the item the scroller should scroll to next.
</Function>
<Function name='SetFastCatchup' renamed='true' return='void' arguments='bool bOn'>
Sets if the scroller should catch up fast.
</Function>
<Function name='setfastcatchup' theme='_fallback' return='void' arguments='bool bOn'>
Compatibility alias for <Link function='SetFastCatchup' />.
</Function>
<Function name='SetLoop' return='void' arguments='bool bLoop'>
Specifies if the scroller should loop or not.
</Function>
<Function name='SetMask' return='void' arguments='float fWidth, float fHeight'>
Sets the scroller's mask to a Quad that is <code>fWidth</code> by <code>fHeight</code> pixels.
</Function>
<Function name='SetNumItemsToDraw' return='void' arguments='float fNumItems'>
Sets the scroller to draw <code>fNumItems</code> items.
</Function>
<Function name='SetNumSubdivisions' renamed='true' return='void' arguments='int iNumSubdivisions'>
Sets the number of subdivisions in the scroller.
</Function>
<Function name='setnumsubdivisions' theme='_fallback' return='void' arguments='int iNumSubdivisions'>
Compatibility alias for <Link function='SetNumSubdivisions' />.
</Function>
<Function name='SetPauseCountdownSeconds' return='void' arguments='float fSecs'>
Sets the scroller's pause countdown to <code>fSecs</code>.
</Function>
<Function name='SetSecondsPauseBetweenItems' return='void' arguments='float fSeconds'>
Sets the scroller's pause between items to <code>fSeconds</code>.
</Function>
<Function name='SetSecondsPerItem' renamed='true' return='void' arguments='float fSeconds'>
Sets how many seconds the scroller should spend on each item.<br />
A value of <code>0</code> means the scroller will not scroll.
</Function>
<Function name='setsecondsperitem' theme='_fallback' return='void' arguments='float fSeconds'>
Compatibility alias for <Link function='SetSecondsPerItem' />.
</Function>
<Function name='SetTransformFromFunction' return='void' arguments='LuaReference ScrollerFunction'>
Sets the scroller's transform function to the specified Lua function.
</Function>
<Function name='SetTransformFromHeight' return='void' arguments='float fItemHeight'>
Sets the scroller's transform function from <code>fItemHeight</code>.
</Function>
<Function name='SetTransformFromWidth' return='void' arguments='float fItemWidth'>
Sets the scroller's transform function from <code>fItemWidth</code>.
</Function>
</Class>
<Class name='ActorSound'>
<Description>
This Actor represents a playable sound. There are two attributes that can be set on load.<br />
* <code>SupportPan</code> - Let the sound pan from side to side.<br />
* <code>SupportRateChanging</code> - Let the sound change rate and pitch.
</Description>
<Function name='get' return='RageSound' arguments=''>
Returns the <Link class='RageSound' /> that can be played by this Actor.
</Function>
<Function name='load' return='void' arguments='string sPath'>
Loads the sound at <code>sPath</code>.
</Function>
<Function name='pause' return='void' arguments='bool bPause'>
Pauses or unpauses the sound based on <code>bPause</code>.
</Function>
<Function name='play' return='void' arguments=''>
Plays the sound.
</Function>
<Function name='playforplayer' theme='_fallback' return='void' arguments='PlayerNumber pn'>
[02 Sound.lua] Plays the sound on the given player's side. You must set <code>SupportPan = true</code> on load.
</Function>
<Function name='stop' return='void' arguments=''>
Stops the sound.
</Function>
</Class>
<Class name='AnnouncerManager'>
<Function name='DoesAnnouncerExist' return='bool' arguments='string sAnnonucer'>
Returns true if Announcer <code>sAnnouncer</code> exists.
</Function>
<Function name='GetAnnouncerNames' return='{string}' arguments=''>
Returns a table of installed announcers.
</Function>
<Function name='GetCurrentAnnouncer' return='string' arguments=''>
Returns the current announcer's name.
</Function>
<Function name='SetCurrentAnnouncer' return='void' arguments='string sNewAnnouncer'>
Sets the announcer to <code>sNewAnnouncer</code>.
</Function>
</Class>
<Class name='ArchHooks'>
<Function name='AppHasFocus' return='bool' arguments=''>
Returns <code>true</code> if the application presently has focus.
</Function>
<Function name='GetArchName' return='{string}' arguments=''>
Returns the name of the architecture in use.
</Function>
</Class>
<Class name='Banner'>
<Function name='GetScrolling' return='bool' arguments=''>
Returns <code>true</code> if the Banner is currently scrolling.
</Function>
<Function name='GetPercentScrolling' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='LoadBackgroundFromUnlockEntry' return='void' arguments='UnlockEntry pUE'>
Loads the background from an UnlockEntry.
</Function>
<Function name='LoadBannerFromUnlockEntry' return='void' arguments='UnlockEntry pUE'>
Loads the banner from an UnlockEntry.
</Function>
<Function name='LoadCardFromCharacter' return='void' arguments='Character pCharacter'>
Loads the card image from the specified Character.
</Function>
<Function name='LoadFromCachedBanner' return='void' arguments='string sPath'>
Loads the banner from the cache based on <code>sPath</code> (typically <Link class='Song' function='GetBannerPath' /> or <Link class='Course' function='GetBannerPath' />).
</Function>
<Function name='LoadFromCourse' return='void' arguments='Course c'>
Loads a Banner from a specified Course.
</Function>
<Function name='LoadFromSong' return='void' arguments='Song s'>
Loads a Banner from a specified Song.
</Function>
<Function name='LoadFromSongGroup' return='void' arguments='string s'>
Loads a Banner from a specified Song Group.
</Function>
<Function name='LoadFromSortOrder' return='void' arguments='SortOrder so'>
Loads a Banner from a specified SortOrder.
</Function>
<Function name='LoadIconFromCharacter' return='void' arguments='Character pCharacter'>
Loads an icon from the specified Character.
</Function>
<Function name='scaletoclipped' return='void' arguments='float fWidth, float fHeight'>
See <Link class='Sprite' function='scaletoclipped' />.
</Function>
<Function name='ScaleToClipped' return='void' arguments='float fWidth, float fHeight'>
See <Link class='Sprite' function='scaletoclipped' />.
</Function>
<Function name='SetScrolling' return='void' arguments='bool bScroll'>
<!-- todo -->
</Function>
</Class>
<Class name='BitmapText'>
<Function name='AddAttribute' return='void' arguments='int iPos, Attribute attr'>
Add the attribute <code>attr</code> to the string at position
<code>iPos</code>.<br />
The attribute is a table that must contain <code>Length</code>
which specifies how many (multi-byte) characters the attribute
is to apply. If <code>Length=-1</code>, then the attribute applies
until another attribute overrides it.<br />
If the table contains <code>Diffuse</code>, then the color value
is applied to the range of text.<br />
If the table contains <code>Diffuses</code>, then it should be
an array of 4 colors which specify the diffuse color for the
top left, top right, bottom left, and bottom right.<br />
If the table contains <code>Glow</code>, then the color value
is applied as a glow to the range of text.<br />
Example:<br />
<code>attr = { Length = 10; Diffuse = color("#AABBCC"); }</code>
</Function>
<Function name='ClearAttributes' return='void' arguments=''>
Clear all attributes associated with the BitmapText.
</Function>
<Function name='DiffuseAndStroke' theme='_fallback' return='void' arguments='color diffuseColor, color strokeColor'>
[02 Actor.lua] Sets the diffuse and stroke color of text in one command.
</Function>
<Function name='GetText' return='string' arguments=''>
Returns the text that is currently set.
</Function>
<Function name='jitter' return='void' arguments='bool bJitter'>
If <code>bJitter</code> is <code>true</code>, move each character of the string around by a small random amount.
</Function>
<Function name='maxheight' return='void' arguments='float fHeight'>
Set the maximum height of the unzoomed text to <code>fHeight</code>. If <code>fHeight</code> is <code>0</code>, then there is no maximum height.
</Function>
<Function name='maxwidth' return='void' arguments='float hWidth'>
Set the maximum width of the unzoomed text to <code>fWidth</code>. If <code>fWidth</code> is <code>0</code>, then there is no maximum width.
</Function>
<Function name='NoStroke' theme='_fallback' return='void' arguments=''>
[02 Actor.lua] Remove any stroke color.
</Function>
<Function name='PixelFont' theme='_fallback' return='void' arguments=''>
[02 Actor.lua] Alias for setting <Link class='Actor' function='SetTextureFiltering' /> to <code>false</code>.
</Function>
<Function name='rainbowscroll' return='void' arguments='bool bRainbowScroll'>
If <code>true</code>, set each character of the text in turn to the rainbow colors in the metrics <code>BitmapText::RainbowColor#</code>.
</Function>
<Function name='settext' return='void' arguments='string sText'>
Set the text to <code>sText</code>. This clears all attributes.
</Function>
<Function name='settextf' theme='_fallback' return='void' arguments='string sFormat, ...'>
[02 Actor.lua] Sets text using <code>string.format(sFormat, ...)</code>.
</Function>
<Function name='Stroke' theme='_fallback' return='void' arguments='color c'>
[02 Actor.lua] Alias for <Link function='strokecolor' />.
</Function>
<Function name='strokecolor' return='void' arguments='color c'>
Sets the stroke color to <code>c</code>.
</Function>
<Function name='textglowmode' return='void' arguments='TextGlowMode tgm'>
If the text is glowing, specify if just the stroke layer, just the inner layer, or both are affected by the glow.
</Function>
<Function name='uppercase' return='void' arguments='bool b'>
If <code>true</code>, make all text uppercase.
</Function>
<Function name='vertspacing' return='void' arguments='int iSpacing'>
Add <code>iSpacing</code> pixels of padding between lines of text.
</Function>
<Function name='wrapwidthpixels' return='void' arguments='int iWidth'>
Wrap the unzoomed text at <code>iWidth</code> pixels. If you <Link class='Actor' function='zoom' /> or <Link class='Actor' function='zoomx' /> by <code>x</code> and you want the text wrapped at <code>width</code>, then you should use <code>wrapwidthpixels(width/x)</code>.
</Function>
</Class>
<Class name='BPMDisplay'>
<Function name='GetText' return='string' arguments=''>
Returns the text that is currently set at the exact moment you call it. This is likely only going to be useful in an Update command.
</Function>
<Function name='SetFromCourse' return='void' arguments='Course c'>
Sets the BPMDisplay from the specified Course.
</Function>
<Function name='SetFromGameState' return='void' arguments=''>
Sets the BPMDisplay from the GameState.
</Function>
<Function name='SetFromSong' return='void' arguments='Song s'>
Sets the BPMDisplay from the specified Song.
</Function>
<Function name='SetFromSteps' return='void' arguments='Steps s'>
Sets the BPMDisplay from the specified Steps.
</Function>
</Class>
<Class name='Character'>
<Function name='GetCardPath' return='string' arguments=''>
Returns the path to the character's card graphic.
</Function>
<Function name='GetCharacterDir' return='string' arguments=''>
Returns this character's directory.
</Function>
<Function name='GetCharacterID' return='string' arguments=''>
Returns this character's ID.
</Function>
<Function name='GetDanceAnimationPath' return='string' arguments=''>
Returns the path of the dancing animation of this character.
</Function>
<Function name='GetDisplayName' return='string' arguments=''>
Returns the character's display name.
</Function>
<Function name='GetIconPath' return='string' arguments=''>
Returns the path to the character's icon.
</Function>
<Function name='GetModelPath' return='string' arguments=''>
Returns the path of the model of this character.
</Function>
<Function name='GetRestAnimationPath' return='string' arguments=''>
Returns the path of the rest animation of this character.
</Function>
<Function name='GetSongSelectIconPath' return='string' arguments=''>
Returns the path to the character's ScreenSelectMode icon.
</Function>
<Function name='GetStageIconPath' return='string' arguments=''>
Returns the path to the character's ScreenStage icon.
</Function>
<Function name='GetWarmUpAnimationPath' return='string' arguments=''>
Returns the path of the warm-up animation of this character.
</Function>
</Class>
<Class name='CharacterManager'>
<Function name='GetAllCharacters' return='{Character}' arguments=''>
Returns a table of all characters installed.
</Function>
<Function name='GetCharacter' return='Character' arguments='string sID'>
Return the <Link class='Character' /> corresponding to <code>sID</code>.
</Function>
<Function name='GetRandomCharacter' return='Character' arguments=''>
Returns a random character.
</Function>
<Function name='GetCharacterCount' return='int' arguments=''>
Returns the number of characters available.
</Function>
</Class>
<Class name='ComboGraph'>
<Function name='Load' return='void' arguments='string sMetricsGroup'>
Loads the ComboGraph commands from the Metrics in group <code>sMetricsGroup</code>.
</Function>
<Function name='Set' return='void' arguments='StageStats s, PlayerStageStats pss'>
Sets the values of the ComboGraph using the specified StageStats and PlayerStageStats.
</Function>
</Class>
<Class name='ControllerStateDisplay'>
<Function name='LoadGameController' return='void' arguments='string sType, GameController gc'>
Loads the ControllerStateDisplay from the specified GameController.
</Function>
<Function name='LoadMultiPlayer' return='void' arguments='string sType, MultiPlayer mp'>
Loads the ControllerStateDisplay from the specified MultiPlayer.
</Function>
</Class>
<Class name='Course'>
<Function name='AllSongsAreFixed' return='bool' arguments=''>
Returns <code>true</code> if all of the songs in the course have been defined (as opposed to random songs).
</Function>
<Function name='GetAllTrails' return='{Trail}' arguments=''>
Returns a table of all the Trails in the Course.
</Function>
<Function name='GetBackgroundPath' return='string' arguments=''>
Returns the path to the Course's background.
</Function>
<Function name='GetBannerPath' return='string' arguments=''>
Returns the path to the Course's banner.
</Function>
<Function name='GetCourseDir' return='string' arguments=''>
Returns the Course's directory.
</Function>
<Function name='GetCourseEntries' return='{CourseEntry}' arguments=''>
Returns a table of CourseEntry items.
</Function>
<Function name='GetCourseEntry' return='CourseEntry' arguments='int iIndex'>
Gets the CourseEntry at <code>iIndex</code> from the Course.
</Function>
<Function name='GetCourseType' renamed='true' return='CourseType' arguments=''>
Returns the Course's <Link class='ENUM' function='CourseType' />. (Returns CourseType in SM5; integer in SM4)
</Function>
<Function name='GetDescription' return='string' arguments=''>
Returns the description for this Course.
</Function>
<Function name='GetDisplayFullTitle' return='string' arguments=''>
Returns the full display title of the Course.
</Function>
<Function name='GetEstimatedNumStages' return='int' arguments=''>
Returns the estimated number of stages for the Course.
</Function>
<Function name='GetGoalSeconds' return='float' arguments=''>
Returns the goal seconds for the Course.
</Function>
<Function name='GetGroupName' return='string' arguments=''>
Returns the Course's group name.
</Function>
<Function name='GetPlayMode' renamed='true' return='PlayMode' arguments=''>
Returns the Course's <Link class='ENUM' function='PlayMode' />. (Returns PlayMode in SM5; integer in SM4)
</Function>
<Function name='GetScripter' return='string' arguments=''>
Returns the name of the person who scripted the Course.
</Function>
<Function name='GetTotalSeconds' return='float' arguments='StepsType st'>
Returns the total length of the Course in seconds.
</Function>
<Function name='GetTranslitFullTitle' return='string' arguments=''>
Returns the full transliterated title of the Course.
</Function>
<Function name='HasBackground' return='bool' arguments=''>
Returns <code>true</code> if the Course has a background.
</Function>
<Function name='HasBanner' return='bool' arguments=''>
Returns <code>true</code> if the Course has a banner.
</Function>
<Function name='HasMods' return='bool' arguments=''>
Returns <code>true</code> if the Course has modifiers.
</Function>
<Function name='HasTimedMods' return='bool' arguments=''>
Returns <code>true</code> if the Course has timed modifiers.
</Function>
<Function name='IsAnEdit' return='bool' arguments=''>
Returns <code>true</code> if the Course is an edit.
</Function>
<Function name='IsAutogen' return='bool' arguments=''>
Returns <code>true</code> if the Course was automatically generated.
</Function>
<Function name='IsEndless' return='bool' arguments=''>
Returns <code>true</code> if the Course is Endless.
</Function>
<Function name='IsNonstop' return='bool' arguments=''>
Returns <code>true</code> if the Course is Nonstop.
</Function>
<Function name='IsOni' return='bool' arguments=''>
Returns <code>true</code> if the Course is Oni.
</Function>
<Function name='IsPlayableIn' return='bool' arguments='StepsType st'>
Returns <code>true</code> if the Course is playable in StepsType <code>st</code>.
</Function>
<Function name='IsRanking' return='bool' arguments=''>
Returns <code>true</code> if the Course is a ranking course.
</Function>
</Class>
<Class name='CourseContentsList'>
<Function name='SetFromGameState' return='void' arguments=''>
Sets the CourseContentsList from the GameState.
</Function>
</Class>
<Class name='CourseEntry'>
<Function name='GetSong' return='Song' arguments=''>
Returns the Song that this CourseEntry corresponds to.
</Function>
<!-- sm-ssc additions -->
<Function name='GetGainLives' return='int' arguments=''>
Returns the number of lives gained after completing the song.
</Function>
<Function name='GetGainSeconds' return='float' arguments=''>
Returns the number of seconds gained after completing the song.
</Function>
<Function name='GetNormalModifiers' return='string' arguments=''>
Returns any stage (non-timed) modifiers.
</Function>
<Function name='GetNumModChanges' return='int' arguments=''>
Returns the number of modifier changes in this CourseEntry.
</Function>
<Function name='GetTextDescription' return='string' arguments=''>
Returns a comma-delimited string representing various facts about the CourseEntry.
</Function>
<Function name='IsFixedSong' return='bool' arguments=''>
Returns <code>true</code> if this CourseEntry is a fixed song.
</Function>
<Function name='IsSecret' return='bool' arguments=''>
Returns <code>true</code> if this CourseEntry is secret.
</Function>
</Class>
<Class name='CryptManager'>
<Function name='GenerateRandomUUID' return='string' arguments=''>
Generates a random UUID (version 4).
</Function>
<Function name='MD5File' return='string' arguments='string sPath'>
Returns the MD5 hash for the file at <code>sPath</code>.
</Function>
<Function name='MD5String' return='string' arguments='string s'>
Returns the MD5 hash for <code>s</code>.
</Function>
<Function name='SHA1File' return='string' arguments='string sPath'>
Returns the SHA-1 hash for the file at <code>sPath</code>.
</Function>
<Function name='SHA1String' return='string' arguments='string s'>
Returns the SHA-1 hash for <code>s</code>.
</Function>
</Class>
<Class name='DifficultyIcon'>
<Function name='SetFromDifficulty' return='void' arguments='Difficulty dc'>
Sets the DifficultyIcon's state from the difficulty passed in.
</Function>
<Function name='SetFromSteps' return='void' arguments='Steps pSteps'>
Sets the DifficultyIcon's Player to <code>pn</code>,
then sets the DifficultyIcon's state from the difficulty of Steps <code>pSteps</code>
</Function>
<Function name='SetFromTrail' return='void' arguments='PlayerNumber pn, Trail pTrail'>
Sets the DifficultyIcon's Player to <code>pn</code>,
then sets the DifficultyIcon's state from the difficulty of Trail <code>pTrail</code>
</Function>
<Function name='SetPlayer' return='void' arguments='PlayerNumber pn'>
Sets the DifficultyIcon's Player to <code>pn</code>.
</Function>
<Function name='Unset' return='void' arguments=''>
Blanks the DifficultyIcon.
</Function>
</Class>
<Class name='FadingBanner'>
<Function name='GetLatestIndex' return='int' arguments=''>
Returns the index of the last banner loaded.
</Function>
<Function name='LoadCourseFallback' return='void' arguments=''>
Loads the fallback course banner.
</Function>
<Function name='LoadFallback' return='void' arguments=''>
Loads the fallback banner.
</Function>
<Function name='LoadCardFromCharacter' return='void' arguments='Character pCharacter'>
Loads the card image from the specified Character.
</Function>
<Function name='LoadFromCourse' return='void' arguments='Course c'>
Loads a Banner from a specified Course.
</Function>
<Function name='LoadFromSong' return='void' arguments='Song s'>
Loads a Banner from a specified Song.
</Function>
<Function name='LoadFromSongGroup' return='void' arguments='string s'>
Loads a Banner from a specified Song Group.
</Function>
<Function name='LoadFromSortOrder' return='void' arguments='SortOrder so'>
Loads a Banner from a specified SortOrder.
</Function>
<Function name='LoadIconFromCharacter' return='void' arguments='Character pCharacter'>
Loads an icon from the specified Character.
</Function>
<Function name='LoadRandom' return='void' arguments=''>
Loads the Random banner.
</Function>
<Function name='LoadRoulette' return='void' arguments=''>
Loads the Roulette banner.
</Function>
<Function name='scaletoclipped' return='void' arguments='float fWidth, float fHeight'>
See <Link class='Sprite' function='scaletoclipped' />.
</Function>
<Function name='ScaleToClipped' return='void' arguments='float fWidth, float fHeight'>
See <Link class='Sprite' function='scaletoclipped' />.
</Function>
</Class>
<Class name='StepsDisplayList'>
<Function name='setfromgamestate' return='void' arguments=''>
Sets the StepsDisplayList from the GameState.
</Function>
</Class>
<Class name='Game'>
<Function name='CountNotesSeparately' return='bool' arguments=''>
Returns <code>true</code> if notes are counted separately in this game.
</Function>
<Function name='GetMapJudgmentTo' return='TapNoteScore' arguments='TapNoteScore tns'>
Returns the mapped judgment for <code>tns</code>.
</Function>
<Function name='GetName' return='string' arguments=''>
Returns the name of the game such as &quot;dance&quot; or &quot;pump&quot;.
</Function>
</Class>
<Class name='GameCommand'>
<Function name='GetAnnouncer' return='string' arguments=''>
Returns any announcer that may have been set.
</Function>
<Function name='GetCharacter' return='Character' arguments=''>
Returns any Character associated with this item (or <code>nil</code> if there isn't one).
</Function>
<Function name='GetCourse' return='Course' arguments=''>
Returns any Course that may have been set.
</Function>
<Function name='GetCourseDifficulty' return='Difficulty' arguments=''>
Returns a course difficulty, if one is set in the GameCommand.
</Function>
<Function name='GetDifficulty' return='Difficulty' arguments=''>
Returns a difficulty, if one is set in the GameCommand.
</Function>
<Function name='GetIndex' return='int' arguments=''>
Returns the index of this item.
</Function>
<Function name='GetMultiPlayer' return='MultiPlayer' arguments=''>
Returns any MultiPlayer that may have been set.
</Function>
<Function name='GetName' return='string' arguments=''>
Returns the choice name.
</Function>
<Function name='GetPlayMode' return='PlayMode' arguments=''>
Returns the PlayMode associated with this GameCommand.
</Function>
<Function name='GetPreferredModifiers' return='string' arguments=''>
Returns any preferred modifiers that may have been set.
</Function>
<Function name='GetProfileID' return='string' arguments=''>
Returns any Profile ID that may have been set.
</Function>
<Function name='GetScreen' return='string' arguments=''>
Returns any screen that may have been set as a string.
</Function>
<Function name='GetSong' return='Song' arguments=''>
Returns any Song that may have been set.
</Function>
<Function name='GetSongGroup' return='string' arguments=''>
Returns the name of any song group that may have been set.
</Function>
<Function name='GetSortOrder' return='SortOrder' arguments=''>
Returns the sort order, if the GameCommand has set one.
</Function>
<Function name='GetStageModifiers' return='string' arguments=''>
Returns any stage modifiers that may have been set.
</Function>
<Function name='GetSteps' return='Steps' arguments=''>
Returns any Steps that may have been set.
</Function>
<Function name='GetStyle' return='Style' arguments=''>
Returns any Style that may have been set.
</Function>
<Function name='GetText' return='string' arguments=''>
Returns the display text.
</Function>
<Function name='GetTrail' return='Trail' arguments=''>
Returns any Trail that may have been set.
</Function>
<Function name='GetUrl' return='string' arguments=''>
Returns any Url that may have been set.
</Function>
</Class>
<Class name='GameManager'>
<Function name='GetFirstStepsTypeForGame' return='StepsType' arguments='Game game'>
Return the first <Link class='StepsType' /> for the specified <code>game</code>.
</Function>
<Function name='IsGameEnabled' return='bool' arguments='string s'>
Returns <code>true</code> if any noteskins exist for the specified Game <code>s</code>.
</Function>
<Function name='StepsTypeToLocalizedString' return='string' arguments='StepsType st'>
Return the localized string representation of <code>st</code>.
</Function>
</Class>
<Class name='GameSoundManager'>
<Function name='DimMusic' return='void' arguments='float fVolume, float fDuration'>
Set the music volume to <code>fVolume</code> for <code>fDuration</code> seconds.
</Function>
<Function name='GetPlayerBalance' return='float' arguments='PlayerNumber pn'>
<!-- XXX: Presumably, 0 is all the way to the left, and 1 is all the way
to the right. -->
Return the sound balance for <code>pn</code>.
</Function>
<Function name='PlayAnnouncer' return='void' arguments='string sPath'>
Plays a sound from the current announcer.
</Function>
<Function name='PlayMusicPart' return='void' arguments='string musicPath, float musicStart, float musicLength, float fadeIn, float fadeOut'>
Play the sound at <code>musicPath</code> starting from <code>musicStart</code> for
<code>musicLength</code> seconds one time. Both <code>fadeIn</code> and
<code>fadeOut</code> can be customized as required.
</Function>
<Function name='PlayOnce' return='void' arguments='string sPath'>
Play the sound at <code>sPath</code> one time.
</Function>
</Class>
<Class name='GameState'>
<Function name='AddStageToPlayer' return='void' arguments='PlayerNumber pn'>
Adds another stage to the specifed player.
</Function>
<Function name='ApplyPreferredModifiers' return='void' arguments='PlayerNumber pn, string mods'>
Applies the specified modifiers for the specified player's preferred modifier set.
</Function>
<Function name='ApplyStageModifiers' return='void' arguments='PlayerNumber pn, string mods'>
Applies the specified modifiers for the specified player for the current stage.
</Function>
<Function name='AnyPlayerHasRankingFeats' return='bool' arguments=''>
Returns <code>true</code> if any player has performed a feat worthy of ranking.
</Function>
<Function name='ApplyGameCommand' return='void' arguments='string sCommand, PlayerNumber pn'>
The second argument is optional. Apply the GameCommand represented by <code>sCommand</code>
for <code>pn</code>, if given. See <Link class='GameCommand' />.
</Function>
<Function name='ClearStageModifiersIllegalForCourse' return='void' arguments=''>
Removes any stage modifiers that are illegal for course play.
</Function>
<Function name='CurrentOptionsDisqualifyPlayer' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if <code>pn</code>'s options will disqualify them for ranking.
</Function>
<Function name='EnoughCreditsToJoin' return='bool' arguments=''>
Returns <code>true</code> if enough credits have been inserted to join.
</Function>
<Function name='Dopefish' return='bool' arguments=''>
fishpolk.mid; See also: Rise of the Triad
</Function>
<Function name='Env' return='table' arguments=''>
Returns the environment table. See <Link class='GameCommand' />.
</Function>
<Function name='GetCharacter' return='Character' arguments='PlayerNumber pn'>
Returns the current <Link class='Character' /> for the specified <Link class='ENUM' function='PlayerNumber' />.
</Function>
<Function name='GetCoinMode' return='CoinMode'>
Returns the current <Link class='ENUM' function='CoinMode' />.
</Function>
<Function name='GetCoins' return='int' arguments=''>
Return the number of inserted but unused coins. This number is
decremented when players join.
</Function>
<Function name='GetCoinsNeededToJoin' return='int' arguments=''>
Return the number of coins needed to join based on the current coin and premium modes
as well as the number of people joined, if that matters for the premium mode. See
<Link function='GetCoinMode' /> and <Link function='GetPremium' />.
</Function>
<Function name='GetCourseSongIndex' return='int' arguments=''>
The <Link class='Song' />s in a <Link class='Course' /> are numbered sequentially
starting from 0. Return the number of the current <Link class='Song' />.
</Function>
<Function name='GetCurMusicSeconds' return='float' arguments=''>
Return the current number of seconds that have passed in the current song. This value can be negative.
</Function>
<Function name='GetCurrentCourse' return='Course' arguments=''>
Return the current <Link class='Course' />.
</Function>
<Function name='GetCurrentGame' return='Game' arguments=''>
Return the current <Link class='Game' />.
</Function>
<Function name='GetCurrentSong' return='Song' arguments=''>
Return the current <Link class='Song' />.
</Function>
<Function name='GetCurrentStage' return='Stage' arguments=''>
Return the current <Link class='Stage' />.
</Function>
<Function name='GetCurrentStageIndex' return='int' arguments=''>
Returns the current stage index (starts at 0).
</Function>
<Function name='GetCurrentSteps' return='Steps' arguments='PlayerNumber pn'>
Return the current <Link class='Steps' /> for the specified Player.
</Function>
<Function name='GetCurrentStepsCredits' return='multiple' arguments=''>
Return a variable number of arguments based on the <Link class='Steps' /> being
played by all players. For each distinct <Link class='Steps' /> being played by
the players, in increasing <Link class='ENUM' function='PlayerNumber' /> order,
the difficulty and description of the <Link class='Steps' /> is returned as strings.
<br />For example,<br />
<code>local credits = {GAMESTATE:GetCurrentStepsCredits()};</code><br />
will make a table of the difficulties and descriptions.
</Function>
<Function name='GetCurrentStyle' return='Style' arguments=''>
Return the current <Link class='Style' />.
</Function>
<Function name='GetCurrentTrail' return='Trail' arguments='PlayerNumber pn'>
Return the current <Link class='Trail' /> for the specified player.
</Function>
<Function name='GetDefaultSongOptions' return='string' arguments=''>
Return a string representation of the default song options.
</Function>
<Function name='GetEarnedExtraStage' return='EarnedExtraStage' arguments=''>
Returns the <Link class='ENUM' function='EarnedExtraStage' /> value.
</Function>
<Function name='GetEasiestStepsDifficulty' return='Difficulty' arguments=''>
Return the easiest <Link class='ENUM' function='Difficulty' /> of the
currently selected steps by all players. For example, if player 1 has
selected Hard steps and player 2 has selected Medium steps, Medium will
be returned.
</Function>
<Function name='GetEditCourseEntryIndex' return='int' arguments=''>
<!-- XXX: What is the edit course entry index? -->
</Function>
<Function name='GetEditLocalProfile' return='Profile' arguments=''>
Return the Edit Local <Link class='Profile' /> (during Profile editing)
or <code>nil</code> if it does not exist.
</Function>
<Function name='GetEditLocalProfileID' return='string' arguments=''>
Returns the ID of the Edit Local <Link class='Profile' /> (during Profile editing).
</Function>
<Function name='GetEditSourceSteps' return='Steps' arguments=''>
Return the source <Link class='Steps' /> for the editor or <code>nil</code>
if it does not exist.
</Function>
<Function name='GetEnabledPlayers' return='{PlayerNumber}' arguments=''>
Returns a table of enabled players.
</Function>
<Function name='GetExpandedSectionName' return='string' arguments=''>
Returns the name of the currently expanded section.
</Function>
<Function name='GetGameSeed' return='int' arguments=''>
Return the random seed for the game.
</Function>
<Function name='GetGameplayLeadIn' return='bool' arguments=''>
Return <code>true</code> if the gameplay lead in is enabled. If
<code>false</code>, gameplay begins immediately. <!-- XXX: I think. -->
</Function>
<Function name='GetHardestStepsDifficulty' return='Difficulty' arguments=''>
Return the hardest <Link class='ENUM' function='Difficulty' /> of the
currently selected steps by all players. For example, if player 1 has
selected Hard steps and player 2 has selected Medium steps, Hard will
be returned.
</Function>
<Function name='GetHumanPlayers' return='{PlayerNumber}' arguments=''>
Returns an array of <Link class='PlayerNumber' />s corresponding to Human players.
</Function>
<Function name='GetLoadingCourseSongIndex' return='int' arguments=''>
Returns the index of the next song in the course.
</Function>
<Function name='GetMasterPlayerNumber' return='PlayerNumber' arguments=''>
Returns the master player number.
</Function>
<Function name='GetMultiplayer' return='bool' arguments=''>
Returns <code>true</code> if the game is Multiplayer.
</Function>
<Function name='GetMultiPlayerState' return='PlayerState' arguments='MultiPlayer mp'>
Returns the PlayerState for the specified MultiPlayer.
</Function>
<Function name='GetNumMultiplayerNoteFields' return='int' arguments=''>
Returns the number of active multiplayer NoteFields.
</Function>
<Function name='GetNumPlayersEnabled' return='int' arguments=''>
Returns the number of players enabled.
</Function>
<Function name='GetNumSidesJoined' return='int' arguments=''>
Returns the number of sides joined.
</Function>
<Function name='GetNumStagesForCurrentSongAndStepsOrCourse' return='int' arguments=''>
Returns the number of stages for the current Song and its Steps or the current Course.
</Function>
<Function name='GetNumStagesLeft' return='int' arguments='PlayerNumber pn'>
Returns the number of stages left for player <code>pn</code>.
</Function>
<Function name='GetPlayerDisplayName' return='string' arguments='PlayerNumber pn'>
Returns the display name for player <code>pn</code>.
</Function>
<Function name='GetPlayerState' return='PlayerState' arguments='PlayerNumber pn'>
Returns the PlayerState for player <code>pn</code>.
</Function>
<Function name='GetPlayMode' return='PlayMode' arguments=''>
Returns the current PlayMode.
</Function>
<Function name='GetPreferredDifficulty' return='Difficulty' arguments=''>
Returns the preferred difficulty.
</Function>
<Function name='GetPreferredSong' return='Song' arguments=''>
Returns the preferred song.
</Function>
<Function name='GetPreferredSongGroup' return='string' arguments=''>
Returns the preferred song group.
</Function>
<Function name='GetPremium' return='Premium' arguments=''>
Returns the current Premium.
</Function>
<Function name='GetSmallestNumStagesLeftForAnyHumanPlayer' return='int' arguments=''>
<!-- Kind of does what it says on the tin. -->
Returns the smallest number of stages left for any human player.
</Function>
<Function name='GetSongBeat' theme='_fallback' return='float' arguments=''>
[01 alias.lua] Returns the current beat of the song.
</Function>
<Function name='GetSongBeatNoOffset' theme='_fallback' return='float' arguments=''>
[01 alias.lua] Returns the current beat of the song without an offset.
</Function>
<Function name='GetSongBeatVisible' return='float' arguments=''>
Returns the current visible beat of the song.
</Function>
<Function name='GetSongBPS' theme='_fallback' return='float' arguments=''>
[01 alias.lua] Returns the song's current beats per second.
</Function>
<Function name='GetSongDelay' theme='_fallback' return='bool' arguments=''>
[01 alias.lua] Returns <code>true</code> if a delay is active in the song.
</Function>
<Function name='GetSongFreeze' theme='_fallback' return='bool' arguments=''>
[01 alias.lua] Returns <code>true</code> if the song is currently in a freeze.
</Function>
<Function name='GetSongOptions' return='string' arguments='ModsLevel ml'>
Returns the song options for the specified ModsLevel as a string.
</Function>
<Function name='GetSongOptionsString' return='string' arguments=''>
Returns the song options as a string.
</Function>
<Function name='GetSongPercent' return='float' arguments='float fBeat'>
Returns how much of the song is through at beat <code>fBeat</code>.
</Function>
<Function name='GetSongPosition' return='SongPosition' arguments=''>
Returns the current SongPosition.
</Function>
<Function name='GetSortOrder' return='SortOrder' arguments=''>
Returns the current SortOrder.
</Function>
<Function name='GetStageResult' return='StageResult' arguments='PlayerNumber pn'>
Returns the StageResult for player <code>pn</code>.
</Function>
<Function name='GetStageIndex' return='int' arguments=''>
Returns the current stage index.
</Function>
<Function name='GetStageSeed' return='int' arguments=''>
Return the random seed for the current stage.
</Function>
<Function name='GetWorkoutGoalComplete' return='bool' arguments=''>
Returns <code>true</code> if the workout goal is complete.
</Function>
<Function name='HasEarnedExtraStage' return='bool' arguments=''>
Returns <code>true</code> if an extra stage was earned.
</Function>
<Function name='InStepEditor' return='bool' arguments=''>
Returns <code>true</code> if we are specifically in the Step Editor's
editing portion. If in recording or playing mode, this will return
<code>false</code>.
</Function>
<Function name='IsAnExtraStage' return='bool' arguments=''>
Returns <code>true</code> if this is an extra stage.
</Function>
<Function name='IsAnyHumanPlayerUsingMemoryCard' return='bool' arguments=''>
Returns <code>true</code> if any human player is using a memory card.
</Function>
<Function name='IsBattleMode' return='bool' arguments=''>
Returns <code>true</code> if playing in Battle mode.
</Function>
<Function name='IsCourseMode' return='bool' arguments=''>
Returns <code>true</code> if playing in a Course mode.
</Function>
<Function name='IsDemonstration' return='bool' arguments=''>
Returns <code>true</code> if in Demonstration mode.
</Function>
<Function name='IsDraw' return='bool' arguments=''>
Returns <code>true</code> if the match was a draw.
</Function>
<Function name='IsEventMode' return='bool' arguments=''>
Returns <code>true</code> if Event Mode is on, <Link class='GameState' function='SetTemporaryEventMode'>temporary</Link> or otherwise.
</Function>
<Function name='IsExtraStage' return='bool' arguments=''>
Returns <code>true</code> if this is the first extra stage.
</Function>
<Function name='IsExtraStage2' return='bool' arguments=''>
Returns <code>true</code> if this is the second extra stage.
</Function>
<Function name='IsGoalComplete' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if player <code>pn</code> has completed the current Goal.
</Function>
<Function name='IsHumanPlayer' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if player <code>pn</code> is human.
</Function>
<Function name='IsPlayerEnabled' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if player <code>pn</code> is enabled.
</Function>
<Function name='IsSideJoined' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if player <code>pn</code> has joined the game.
</Function>
<Function name='IsWinner' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if player <code>pn</code> is the winner.
</Function>
<Function name='JoinPlayer' return='void' arguments='PlayerNumber pn'>
Joins player <code>pn</code>.
</Function>
<Function name='PlayerIsUsingModifier' return='bool' arguments='PlayerNumber pn, string sModifier'>
Returns <code>true</code> if player <code>pn</code> is using modifier <code>sModifier</code>.
</Function>
<Function name='PlayersCanJoin' return='bool' arguments=''>
Returns <code>true</code> if players can join the game.
</Function>
<Function name='RefreshNoteSkinData' return='void' arguments=''>
Refreshes the NoteSkin data for the current game.
</Function>
<Function name='Reset' return='void' arguments=''>
Resets the GameState.
</Function>
<Function name='ResetPlayerOptions' return='void' arguments='PlayerNumber pn'>
Resets the specific Player's mods to the default settings.
</Function>
<Function name='SaveLocalData' return='void' arguments=''>
Saves the bookkeeping and machine profile data.
</Function>
<Function name='SetCharacter' return='void' arguments='PlayerNumber pn, string sCharID'>
Sets the current <Link class='Character' /> for the specified <Link class='ENUM' function='PlayerNumber' />.
</Function>
<Function name='SetCurrentCourse' return='void' arguments='Course course'>
Sets the current Course to <code>course</code>.
</Function>
<Function name='SetCurrentSong' return='void' arguments='Song song'>
Sets the current Song to <code>song</code>.
</Function>
<Function name='SetCurrentSteps' return='void' arguments='PlayerNumber pn, Steps steps'>
Sets Player <code>pn</code>'s current Steps to <code>steps</code>.
</Function>
<Function name='SetCurrentTrail' return='void' arguments='Trail trail'>
Sets the current Trail to <code>trail</code>.
</Function>
<Function name='SetJukeboxUsesModifiers' return='void' arguments='bool bUseMods'>
Sets if the Jukebox should use modifiers.
</Function>
<Function name='SetMultiplayer' return='void' arguments='bool b'>
</Function>
<Function name='SetNumMultiplayerNoteFields' return='void' arguments='int iFields'>
Sets the number of multiplayer notefields to <code>iFields</code>
</Function>
<Function name='SetPreferredDifficulty' return='void' arguments='PlayerNumber pn, Difficulty dc'>
Sets the preferred difficulty of Player <code>pn</code> to Difficulty <code>dc</code>.
</Function>
<Function name='SetPreferredSong' return='void' arguments='Song song'>
Sets the preferred Song to <code>song</code>.
</Function>
<Function name='SetPreferredSongGroup' return='void' arguments='String sGroup'>
Sets the preferred song group to <code>sGroup</code>.
</Function>
<Function name='SetSongOptions' return='void' arguments='ModsLevel m, string so'>
Sets the Song Options from <code>so</code> using ModsLevel <code>m</code>.
</Function>
<Function name='SetTemporaryEventMode' return='void' arguments='bool bOn'>
Turns temporary Event Mode on or off, depending on <code>bOn</code>.
</Function>
<Function name='ShowW1' return='void' arguments='bool bOn'>
Determines if Judgment W1 should be shown based on <code>bOn</code>.
</Function>
<Function name='UnjoinPlayer' return='void' arguments='PlayerNumber pn'>
Unjoins player <code>pn</code>.
</Function>
</Class>
<Class name='GradeDisplay'>
<Function name='Load' return='void' arguments='string sMetricsGroup'>
Loads the GradeDisplay commands from the Metrics in group <code>sMetricsGroup</code>.
</Function>
<Function name='SetGrade' return='void' arguments='Grade g'>
Sets the GradeDisplay to show Grade <code>g</code>.
</Function>
</Class>
<Class name='GraphDisplay'>
<Function name='Load' return='void' arguments='string sMetricsGroup'>
Loads the GraphDisplay commands from the Metrics in group <code>sMetricsGroup</code>.
</Function>
<Function name='Set' return='void' arguments='StageStats s, PlayerStageStats pss'>
Sets the values of the GraphDisplay using the specified StageStats and PlayerStageStats.
</Function>
</Class>
<Class name='GrooveRadar'>
<Function name='SetEmpty' return='void' arguments='PlayerNumber pn'>
Sets the GrooveRadar values for Player <code>pn</code> to empty.
</Function>
<Function name='SetFromRadarValues' return='void' arguments='PlayerNumber pn, RadarValues rv'>
Sets the GrooveRadar values for Player <code>pn</code> from RadarValues <code>rv</code>
</Function>
<Function name='SetFromValues' return='void' arguments='PlayerNumber pn, {float vals}'>
Sets the GrooveRadar values for Player <code>pn</code> to the specified values in the table.
</Function>
</Class>
<Class name='HelpDisplay'>
<Function name='gettips' return='{string}' arguments=''>
Returns two tables representing the tips and alternate tips in the HelpDisplay.
</Function>
<Function name='setfromsongorcourse' theme='_fallback' return='void' arguments=''>
[02 HelpDisplay.lua] Sets the tips from a Song or Course.
</Function>
<Function name='SetSecsBetweenSwitches' return='void' arguments='float fSeconds'>
Sets the seconds between switches of tips to <code>fSeconds</code>.
</Function>
<Function name='settips' return='void' arguments='string tips, string altTips'>
Sets the HelpDisplay's tips using <code>tips</code> (and optionally <code>altTips</code>).
</Function>
<Function name='SetTipsColonSeparated' return='void' arguments='string sTips'>
Sets the HelpDisplay's text from <code>sTips</code> using colons to separate new sections.
</Function>
</Class>
<Class name='HighScore'>
<Function name='GetDate' return='DateTime' arguments=''>
Returns the date and time the high score was achieved.
</Function>
<Function name='GetGrade' return='Grade' arguments=''>
Returns the Grade of this high score.
</Function>
<Function name='GetHoldNoteScore' return='int' arguments='HoldNoteScore hns'>
Return the number of HoldNoteScores that match <code>hns</code>.
</Function>
<Function name='GetMaxCombo' return='int' arguments=''>
Returns the Max Combo of this high score.
</Function>
<Function name='GetModifiers' return='string' arguments=''>
Returns the modifiers used for this HighScore.
</Function>
<Function name='GetName' return='string' arguments=''>
Returns the name associated with the high score.
</Function>
<Function name='GetPeakComboAward' return='PeakComboAward' arguments=''>
Returns the Peak Combo Award for this high score.
</Function>
<Function name='GetPercentDP' return='float' arguments=''>
Returns the percentage of dance points associated with the high score.
</Function>
<Function name='GetRadarValues' return='RadarValues' arguments=''>
Returns the RadarValues for this HighScore.
</Function>
<Function name='GetScore' return='int' arguments=''>
Returns the score associated with the high score.
</Function>
<Function name='GetStageAward' return='StageAward' arguments=''>
Retrns the Stage Award for this high score.
</Function>
<Function name='GetSurvivalSeconds' return='float' arguments=''>
Returns the number of seconds survived associated with the high score.
</Function>
<Function name='GetTapNoteScore' return='int' arguments='TapNoteScore tns'>
Return the number of TapNoteScores that match <code>tns</code>.
</Function>
<Function name="IsFillInMarker" return='bool' arguments=''>
Returns <code>true</code> if this high score's name uses a fill-in marker.
</Function>
</Class>
<Class name='HighScoreList'>
<Description>
You can get a HighScoreList using <Link class='Profile' function='GetHighScoreList' />.
</Description>
<Function name='GetHighScores' return='{HighScore}' arguments=''>
Returns a table of the high scores.
</Function>
</Class>
<Class name='HoldJudgment'>
<Function name='LoadFromMultiPlayer' return='void' arguments='MultiPlayer mp'>
Loads the HoldJudgment for the specified MultiPlayer.
</Function>
</Class>
<Class name='InputFilter'>
<Function name='GetMouseWheel' return='float' arguments=''>
Returns the mouse wheel value.
</Function>
<Function name='GetMouseX' return='float' arguments=''>
Returns the X position of the mouse.
</Function>
<Function name='GetMouseY' return='float' arguments=''>
Returns the Y position of the mouse.
</Function>
</Class>
<Class name='LifeMeter'>
<Function name='GetLife' return='float' arguments=''>
Returns the amount of life left in the LifeMeter as a float in the range 0..1.
</Function>
<Function name='IsFailing' return='bool' arguments=''>
Returns <code>true</code> if failing.
</Function>
<Function name='IsHot' return='bool' arguments=''>
Returns <code>true</code> if the LifeMeter is "hot".
</Function>
<Function name='IsInDanger' return='bool' arguments=''>
Returns <code>true</code> if in danger.
</Function>
</Class>
<Class name='LifeMeterBattery'>
<Function name='ChangeLives' return='void' arguments='int iNumLives'>
Changes the player's life by <code>iNumLives</code>. (Negative values subtract lives.)
</Function>
<Function name='GetLivesLeft' return='int' arguments=''>
Returns the number of lives remaining.
</Function>
<Function name='GetTotalLives' return='int' arguments=''>
Returns the number of total lives.
</Function>
</Class>
<Class name='MemoryCardManager'>
<Function name='GetCardLocked' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if player <code>pn</code>'s card is locked.
</Function>
<Function name='GetCardState' return='MemoryCardState' arguments='PlayerNumber pn'>
Return the state for player <code>pn</code>.
</Function>
<Function name='GetName' return='string' arguments='PlayerNumber pn'>
Returns the name of the storage device.
</Function>
<Function name='IsNameAvailable' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if player <code>pn</code>'s name is available.
</Function>
</Class>
<Class name='MenuTimer'>
<Function name='disable' return='void' arguments=''>
Stops the MenuTimer by setting it to 99.99 and pausing.
</Function>
<Function name='GetSeconds' return='float' arguments=''>
Returns the current MenuTimer's value.
</Function>
<Function name='pause' return='void' arguments=''>
Pauses the MenuTimer, stopping it from counting down.
</Function>
<Function name='setseconds' return='void' arguments='float fSeconds'>
Compatibility alias for SetSeconds.
</Function>
<Function name='SetSeconds' return='void' arguments='float fSeconds'>
Sets the MenuTimer's value to <code>fSeconds</code>.
</Function>
<Function name='silent' return='void' arguments='bool bSilent'>
Sets the MenuTimer's silent setting to <code>bSilent</code>.
</Function>
<Function name='start' return='void' arguments=''>
Starts up the timer.
</Function>
<Function name='stealth' return='void' arguments='bool bStealth'>
Sets the MenuTimer's stealth setting to <code>bStealth</code>. If
<code>true</code>, the timer will be invisible and silent.
</Function>
<Function name='stop' return='void'>
Stops the MenuTimer by setting it to 0 and pausing.
</Function>
</Class>
<Class name='MessageManager'>
<Function name='Broadcast' return='void' arguments='string sMessage, table paramTable'>
Broadcast the message to all listeners subscribed to <code>sMessage</code>. The
second argument is an optional table of parameters. It may be omitted or explicitly
set to <code>nil</code>.
</Function>
</Class>
<Class name='MeterDisplay'>
<Function name='SetStreamWidth' return='void' arguments='float fWidth'>
Sets the width of the MeterDisplay to <code>fWidth</code>.
</Function>
</Class>
<Class name='Model'>
<Function name='GetDefaultAnimation' return='string' arguments=''>
Returns the model's default animation.
</Function>
<Function name='loop' return='void' arguments='bool bLoop'>
Controls if the model should loop or not.
</Function>
<Function name='playanimation' return='void' arguments='string sAniName, float fPlayRate'>
Plays animation <code>sAniName</code> at <code>fPlayRate</code> speed (default 1.0).
</Function>
<Function name='position' return='void' arguments='float fSeconds'>
Sets how far into the animation the model is.
</Function>
<Function name='rate' return='void' arguments='float fRate'>
Sets the current animation's playback rate to <code>fRate</code>.
</Function>
<Function name='SetDefaultAnimation' return='void' arguments='string sAnimation, float fPlayRate'>
Sets the model's default animation to <code>sAnimation</code> at <code>fPlayRate</code> speed (default 1.0).
</Function>
<!-- sm-ssc additions -->
<Function name='GetNumStates' return='int' arguments=''>
Returns the number of states the Model has.
</Function>
</Class>
<Class name='ModIconRow'>
<Function name='Load' return='void' arguments='string sMetricsGroup, PlayerNumber pn'>
Loads the ModIconRow of Player <code>pn</code> from the Metrics in group <code>sMetricsGroup</code>.
</Function>
</Class>
<Class name='NoteSkinManager'>
<Function name='GetMetricA' return='ActorCommand' arguments='string sElement, string sValue'>
Returns a command from the specified element and value.
</Function>
<Function name='GetMetricAForNoteSkin' return='ActorCommand' arguments='string sElement, string sValue, string sNoteSkin'>
Returns a command from the specified element and value using NoteSkin <code>sNoteSkin</code>.
</Function>
<Function name='GetMetricB' return='bool' arguments='string sElement, string sValue'>
Returns a bool from the specified element and value.
</Function>
<Function name='GetMetricBForNoteSkin' return='bool' arguments='string sElement, string sValue, string sNoteSkin'>
Returns a bool from the specified element and value using NoteSkin <code>sNoteSkin</code>.
</Function>
<Function name='GetMetricF' return='float' arguments='string sElement, string sValue'>
Returns a float from the specified element and value.
</Function>
<Function name='GetMetricFForNoteSkin' return='float' arguments='string sElement, string sValue, string sNoteSkin'>
Returns a float from the specified element and value using NoteSkin <code>sNoteSkin</code>.
</Function>
<Function name='GetMetricI' return='int' arguments='string sElement, string sValue'>
Returns a integer from the specified element and value.
</Function>
<Function name='GetMetricIForNoteSkin' return='int' arguments='string sElement, string sValue, string sNoteSkin'>
Returns a integer from the specified element and value using NoteSkin <code>sNoteSkin</code>.
</Function>
<Function name='GetPath' return='string' arguments='string sButton, string sElement'>
Returns the path for the specified <code>sButton sElement</code>.
</Function>
<Function name='GetPathForNoteSkin' return='string' arguments='string sButton, string sElement, string sNoteSkin'>
Returns the path for the specified <code>sButton sElement</code> using NoteSkin <code>sNoteSkin</code>.
</Function>
<Function name='LoadActor' return='Actor' arguments='string sButton, string sElement'>
Returns the actor for the specified <code>sButton sElement</code>.
</Function>
<Function name='LoadActorForNoteSkin' return='Actor' arguments='string sButton, string sElement, string sNoteSkin'>
Returns the actor for the specified <code>sButton sElement</code> using NoteSkin <code>sNoteSkin</code>.
</Function>
<!-- sm-ssc additions -->
<Function name='DoesNoteSkinExist' return='bool' arguments='string strName'>
Returns <code>true</code> if the <code>strName</code> noteskin exists in the current gametype.
</Function>
<Function name='GetNoteSkinNames' return='{string}' arguments=''>
Returns a table of noteskin names for the current gametype.
</Function>
</Class>
<Class name='OptionRow'>
<Function name='FirstItemGoesDown' return='bool' arguments=''>
Returns <code>true</code> if the first item in the row goes down.
</Function>
<Function name='GetChoiceInRowWithFocus' return='int' arguments='PlayerNumber pn'>
Returns an index of the choice in the row that player <code>pn</code> is on.
</Function>
<Function name='GetLayoutType' return='LayoutType' arguments=''>
Returns the OptionRow's layout type.
</Function>
<Function name='GetName' return='string' arguments=''>
Returns the name of the OptionRow.
</Function>
<Function name='GetNumChoices' return='int' arguments=''>
Returns the number of choices in this OptionRow.
</Function>
<Function name='GetRowTitle' return='string' arguments=''>
Returns the row title string.
</Function>
<Function name='GetSelectType' return='SelectType' arguments=''>
Returns the OptionRow's select type.
</Function>
<Function name='HasFocus' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if this row is focused by player <code>pn</code>.
</Function>
<Function name='OneChoiceForAllPlayers' return='bool' arguments=''>
Returns <code>true</code> if this row forces one choice on all players.
</Function>
</Class>
<Class name='PaneDisplay'>
<Function name='SetFromGameState' return='void' arguments=''>
Sets the PaneDisplay from the GameState.
</Function>
</Class>
<Class name='PercentageDisplay'>
<Function name='LoadFromStats' return='void' arguments='PlayerState pPlayerState, PlayerStageStats pPlayerStageStats'>
Sets the PercentageDisplay from the specified PlayerState and PlayerStageStats.
</Function>
</Class>
<Class name='Player'>
<Function name='GetPlayerTimingData' return='TimingData' arguments=''>
Returns the current TimingData for this player.
</Function>
<Function name='SetActorWithComboPosition' return='void' arguments='Actor a'>
Sets Actor with Combo position.
</Function>
<Function name='SetActorWithJudgmentPosition' return='void' arguments='Actor a'>
Sets Actor with Judgment position.
</Function>
</Class>
<Class name='PlayerInfo'>
<Description>(PlayerInfo is a part of ScreenGameplay.)</Description>
<Function name='GetLifeMeter' return='LifeMeter' arguments='PlayerNumber pn'>
Returns the <Link class='LifeMeter' /> of player <code>pn</code>.
</Function>
<Function name='GetStepsQueueWrapped' return='Steps' arguments='int index'>
Returns the Steps located at <code>index</code> in the current steps queue.
</Function>
</Class>
<Class name='PlayerOptions'>
<Function name='GetAlternate' return='float' arguments=''>
Returns the value of the Alternate modifier.
</Function>
<Function name='SetAlternate' return='void' arguments='float fAlternate'>
Sets the value of the Alternate modifier.
</Function>
<Function name='GetAttackMines' return='bool' arguments=''>
Returns the status of the Attack Mines modifier.
</Function>
<Function name='SetAttackMines' return='void' arguments='bool bAttackMines'>
Sets the Attack Mines modifier.
</Function>
<Function name='GetBackwards' return='bool' arguments=''>
Returns <code>true</code> if the Backwards modifier is applied.
</Function>
<Function name='SetBackwards' return='void' arguments='bool bBackwards'>
Sets the Backwards modifier.
</Function>
<Function name='GetBeat' return='float' arguments=''>
Returns the value of the Beat modifier.
</Function>
<Function name='SetBeat' return='void' arguments='float fBeat'>
Sets the value for the Beat modifier.
</Function>
<Function name='GetBig' return='bool' arguments=''>
Returns the status of the Big modifier.
</Function>
<Function name='SetBig' return='void' arguments='bool bBig'>
Sets the Big modifier.
</Function>
<Function name='GetBlind' return='float' arguments=''>
Returns the value of the Blind modifier.
</Function>
<Function name='SetBlind' return='void' arguments='float fBlind'>
Sets the value for the Blind modifier.
</Function>
<Function name='GetBlink' return='float' arguments=''>
Returns the value of the Blink modifier.
</Function>
<Function name='SetBlink' return='void' arguments='float fBlink'>
Sets the value for the Blink modifier.
</Function>
<Function name='GetBMRize' return='bool' arguments=''>
Returns the status of the BMRize modifier.
</Function>
<Function name='SetBMRize' return='void' arguments='bool bBMRize'>
Sets the BMRize modifier.
</Function>
<Function name='GetBoomerang' return='float' arguments=''>
Returns the value of the Boomerang modifier.
</Function>
<Function name='SetBoomerang' return='void' arguments='float fBoomerang'>
Sets the value for the Boomerang modifier.
</Function>
<Function name='GetBoost' return='float' arguments=''>
Returns the value of the Boost modifier.
</Function>
<Function name='SetBoost' return='void' arguments='float fBoost'>
Sets the value for the Boost modifier.
</Function>
<Function name='GetBrake' return='float' arguments=''>
Returns the value of the Brake modifier.
</Function>
<Function name='SetBrake' return='void' arguments='float fBrake'>
Sets the value for the Brake modifier.
</Function>
<Function name='GetBumpy' return='float' arguments=''>
Returns the value of the Bumpy modifier.
</Function>
<Function name='SetBumpy' return='void' arguments='float fBumpy'>
Sets the value for the Bumpy modifier.
</Function>
<Function name='GetCentered' return='float' arguments=''>
Returns the value of the Centered modifier.
</Function>
<Function name='SetCentered' return='void' arguments='float fCentered'>
Sets the value for the Centered modifier.
</Function>
<Function name='GetCMod' return='float' arguments=''>
Returns the player's C-mod.
</Function>
<Function name='SetCMod' return='void' arguments='float fCmod'>
Sets the player's C-mod to <code>fCmod</code>.
</Function>
<Function name='GetConfusion' return='float' arguments=''>
Returns the value of the Confusion modifier.
</Function>
<Function name='SetConfusion' return='void' arguments='float fConfusion'>
Sets the value for the Confusion modifier.
</Function>
<Function name='GetCover' return='float' arguments=''>
Returns the value of the Cover modifier.
</Function>
<Function name='SetCover' return='void' arguments='float fCover'>
Sets the value for the Cover modifier.
</Function>
<Function name='GetCross' return='float' arguments=''>
Returns the value of the Cross modifier.
</Function>
<Function name='SetCross' return='void' arguments='float fCross'>
Sets the value for the Cross modifier.
</Function>
<Function name='GetDark' return='float' arguments=''>
Returns the value of the Dark modifier.
</Function>
<Function name='SetDark' return='void' arguments='float fDark'>
Sets the value for the Dark modifier.
</Function>
<Function name='GetDizzy' return='float' arguments=''>
Returns the value of the Dizzy modifier.
</Function>
<Function name='SetDizzy' return='void' arguments='float fDizzy'>
Sets the value for the Dizzy modifier.
</Function>
<Function name='GetDrunk' return='float' arguments=''>
Returns the value of the Drunk modifier.
</Function>
<Function name='SetDrunk' return='void' arguments='float fDrunk'>
Sets the value for the Drunk modifier.
</Function>
<Function name='GetEcho' return='bool' arguments=''>
Returns the status of the Echo modifier.
</Function>
<Function name='SetEcho' return='void' arguments='bool bEcho'>
Sets the Echo modifier.
</Function>
<Function name='GetExpand' return='float' arguments=''>
Returns the value of the Expand modifier.
</Function>
<Function name='SetExpand' return='void' arguments='float fExpand'>
Sets the value for the Expand modifier.
</Function>
<Function name='GetFlip' return='float' arguments=''>
Returns the value of the Flip modifier.
</Function>
<Function name='SetFlip' return='void' arguments='float fFlip'>
Sets the value for the Flip modifier.
</Function>
<Function name='GetFloored' return='bool' arguments=''>
Returns the status of the Floored modifier.
</Function>
<Function name='SetFloored' return='void' arguments='bool bFloored'>
Sets the Floored modifier.
</Function>
<Function name='GetHidden' return='float' arguments=''>
Returns the value of the Hidden modifier.
</Function>
<Function name='SetHidden' return='void' arguments='float fHidden'>
Sets the value for the Hidden modifier.
</Function>
<Function name='GetHiddenOffset' return='float' arguments=''>
Returns the value of the Hidden Offset modifier.
</Function>
<Function name='SetHiddenOffset' return='void' arguments='float fHiddenOffset'>
Sets the value for the Hidden Offset modifier.
</Function>
<Function name='GetHoldRolls' return='bool' arguments=''>
Returns <code>true</code> if Holds will be converted to Rolls.
</Function>
<Function name='SetHoldRolls' return='void' arguments='bool bHoldsRolls'>
If <code>true</code>, Holds will be converted to Rolls.
</Function>
<Function name='GetInvert' return='float' arguments=''>
Returns the value of the Invert modifier.
</Function>
<Function name='SetInvert' return='void' arguments='float fInvert'>
Sets the value for the Invert modifier.
</Function>
<Function name='GetLeft' return='bool' arguments=''>
Returns the status of the Left modifier.
</Function>
<Function name='SetLeft' return='void' arguments='bool bLeft'>
Sets the Left modifier.
</Function>
<Function name='GetLittle' return='bool' arguments=''>
Returns the status of the Little modifier.
</Function>
<Function name='SetLittle' return='void' arguments='bool bLittle'>
Sets the Little modifier.
</Function>
<Function name='GetMines' return='bool' arguments=''>
Returns the status of the Mines modifier.
</Function>
<Function name='SetMines' return='void' arguments='bool bMines'>
Sets the Mines modifier.
</Function>
<Function name='GetMini' return='float' arguments=''>
Returns the value of the Mini modifier.
</Function>
<Function name='SetMini' return='void' arguments='float fMini'>
Sets the value for the Mini modifier.
</Function>
<Function name='GetMirror' return='bool' arguments=''>
Returns <code>true</code> if the Mirror modifier is applied.
</Function>
<Function name='SetMirror' return='void' arguments='bool bMirror'>
Sets the Mirror modifier.
</Function>
<Function name='GetMMod' return='float' arguments=''>
Returns the player's M-mod.
</Function>
<Function name='SetMMod' return='void' arguments='float fMmod'>
Sets the player's M-mod to <code>fMmod</code>.
</Function>
<Function name='GetMuteOnError' return='bool' arguments=''>
Returns <code>true</code> if the game mutes an instrument track on errors.
</Function>
<Function name='SetMuteOnError' return='void' arguments='bool bMuteOnError'>
Sets the Mute on Error modifier.
</Function>
<Function name='GetNoAttacks' return='float' arguments=''>
Returns the value of the No Attacks modifier.
</Function>
<Function name='GetNoFakes' return='bool' arguments=''>
Returns the status of the No Fakes modifier.
</Function>
<Function name='SetNoFakes' return='void' arguments='bool bNoFakes'>
Sets the No Fakes modifier, removing all Fakes.
</Function>
<Function name='GetNoHands' return='bool' arguments=''>
Returns the status of the No Hands modifier.
</Function>
<Function name='SetNoHands' return='void' arguments='bool bNoHands'>
Sets the No Hands modifier, removing all Hands.
</Function>
<Function name='GetNoHolds' return='bool' arguments=''>
Returns the status of the No Holds modifier.
</Function>
<Function name='SetNoHolds' return='void' arguments='bool bNoHolds'>
Sets the No Holds modifier, removing all Holds.
</Function>
<Function name='GetNoJumps' return='bool' arguments=''>
Returns the status of the No Jumps modifier.
</Function>
<Function name='SetNoJumps' return='void' arguments='bool bNoJumps'>
Sets the No Jumps modifier, removing all Jumps.
</Function>
<Function name='GetNoLifts' return='bool' arguments=''>
Returns the status of the No Lifts modifier.
</Function>
<Function name='SetNoLifts' return='void' arguments='bool bNoLifts'>
Sets the No Lifts modifier, removing all Lifts.
</Function>
<Function name='GetNoMines' return='bool' arguments=''>
Returns the status of the No Mines modifier.
</Function>
<Function name='SetNoMines' return='void' arguments='bool bNoMines'>
Sets the No Mines modifier, removing all Mines.
</Function>
<Function name='GetNoQuads' return='bool' arguments=''>
Returns the status of the No Quads modifier.
</Function>
<Function name='SetNoQuads' return='void' arguments='bool bNoQuads'>
Sets the No Quads modifier, removing all Quads.
</Function>
<Function name='GetNoRolls' return='bool' arguments=''>
Returns the status of the No Rolls modifier.
</Function>
<Function name='SetNoRolls' return='void' arguments='bool bNoRolls'>
Sets the No Rolls modifier, removing all Rolls.
</Function>
<Function name='GetNoStretch' return='bool' arguments=''>
Returns the status of the No Stretch modifier.
</Function>
<Function name='SetNoStretch' return='void' arguments='bool bNoStretch'>
Sets the No Stretch modifier, removing all step combinations that require a large stretch.
</Function>
<Function name='GetNoteSkin' return='string' arguments=''>
Returns the current NoteSkin set in the PlayerOptions.
</Function>
<Function name='SetNoteSkin' return='void' arguments='string noteskin'>
Changes the player's noteskin to <code>noteskin</code>.
</Function>
<Function name='GetPassmark' return='float' arguments=''>
Returns the value of the Passmark.
</Function>
<Function name='SetPassmark' return='void' arguments='float fPassmark'>
Sets the value for the Passmark.
</Function>
<Function name='GetPlanted' return='bool' arguments=''>
Returns the status of the Planted modifier.
</Function>
<Function name='SetPlanted' return='void' arguments='bool bPlanted'>
Sets the Planted modifier.
</Function>
<Function name='GetQuick' return='bool' arguments=''>
Returns the status of the Quick modifier.
</Function>
<Function name='SetQuick' return='void' arguments='bool bQuick'>
Sets the Quick modifier.
</Function>
<Function name='GetRandomAttacks' return='float' arguments=''>
Returns the value of the Random Attacks modifier.
</Function>
<Function name='SetRandomAttacks' return='void' arguments='float fRandomAttacks'>
Sets the value for the Random Attacks modifier.
</Function>
<Function name='GetRandomSpeed' return='float' arguments=''>
Returns the value of the Random Speed modifier.
</Function>
<Function name='SetRandomSpeed' return='void' arguments='float fRandomSpeed'>
Sets the value for the Random Speed modifier.
</Function>
<Function name='GetRandomVanish' return='float' arguments=''>
Returns the value of the Random Vanish modifier.
</Function>
<Function name='SetRandomVanish' return='void' arguments='float fRandomVanish'>
Sets the value for the Random Vanish modifier.
</Function>
<Function name='GetReverse' return='float' arguments=''>
Returns the value of the Reverse modifier.
</Function>
<Function name='SetReverse' return='void' arguments='float fReverse'>
Sets the value for the Reverse modifier.
</Function>
<Function name='GetReversePercentForColumn' return='float' arguments='int col'>
Returns the amount of reverse applied to the specified column.
</Function>
<Function name='GetRight' return='bool' arguments=''>
Returns the status of the Right modifier.
</Function>
<Function name='SetRight' return='void' arguments='bool bRght'>
Sets the Right modifier.
</Function>
<Function name='GetRoll' return='float' arguments=''>
Returns the value of the Roll modifier.
</Function>
<Function name='SetRoll' return='void' arguments='float fRoll'>
Sets the value for the Roll modifier.
</Function>
<Function name='GetShuffle' return='bool' arguments=''>
Returns the status of the Shuffle modifier.
</Function>
<Function name='SetShuffle' return='void' arguments='bool bShuffle'>
Sets the Shuffle modifier.
</Function>
<Function name='GetSkew' return='float' arguments=''>
Returns the value of the NoteField skew.
</Function>
<Function name='SetSkew' return='void' arguments='float fSkew'>
Sets the NoteField skew. This is used to replicate the various
views. (Distant, Hallway, etc.)
</Function>
<Function name='GetSkippy' return='bool' arguments=''>
Returns the status of the Skippy modifier.
</Function>
<Function name='SetSkippy' return='void' arguments='bool bSkippy'>
Sets the Skippy modifier.
</Function>
<Function name='GetSoftShuffle' return='bool' arguments=''>
Returns the status of the Soft Shuffle modifier.
</Function>
<Function name='SetSoftShuffle' return='void' arguments='bool bSoftShuffle'>
Sets the Soft Shuffle modifier.
</Function>
<Function name='GetSongAttacks' return='float' arguments=''>
This function is deprecated. Please use GetStepAttacks() instead.
</Function>
<Function name='GetStepAttacks' return='float' arguments=''>
</Function>
<Function name='GetSplit' return='float' arguments=''>
Returns the value of the Split modifier.
</Function>
<Function name='SetSplit' return='void' arguments='float fSplit'>
Sets the value for the Split modifier.
</Function>
<Function name='GetStealth' return='float' arguments=''>
Returns the value of the Stealth modifier.
</Function>
<Function name='SetStealth' return='void' arguments='float fStealth'>
Sets the value for the Stealth modifier.
</Function>
<Function name='GetStomp' return='bool' arguments=''>
Returns the status of the Stomp modifier.
</Function>
<Function name='SetStomp' return='void' arguments='bool bStomp'>
Sets the Stomp modifier.
</Function>
<Function name='GetSudden' return='float' arguments=''>
Returns the value of the Sudden modifier.
</Function>
<Function name='SetSudden' return='void' arguments='float fSudden'>
Sets the value for the Sudden modifier.
</Function>
<Function name='GetSuddenOffset' return='float' arguments=''>
Returns the value of the Sudden Offset modifier.
</Function>
<Function name='SetSuddenOffset' return='void' arguments='float fSuddenOffset'>
Sets the value for the Sudden Offset modifier.
</Function>
<Function name='GetSuperShuffle' return='bool' arguments=''>
Returns the status of the Super Shuffle modifier.
</Function>
<Function name='SetSuperShuffle' return='void' arguments='bool bSuperShuffle'>
Sets the Super Shuffle modifier.
</Function>
<Function name='GetTiny' return='float' arguments=''>
Returns the value of the Tiny modifier.
</Function>
<Function name='SetTiny' return='void' arguments='float fTiny'>
Sets the value for the Tiny modifier.
</Function>
<Function name='GetTipsy' return='float' arguments=''>
Returns the value of the Tipsy modifier.
</Function>
<Function name='SetTipsy' return='void' arguments='float fTipsy'>
Sets the value for the Tipsy modifier.
</Function>
<Function name='GetTornado' return='float' arguments=''>
Returns the value of the Tornado modifier.
</Function>
<Function name='SetTornado' return='void' arguments='float fTornado'>
Sets the value for the Tornado modifier.
</Function>
<Function name='GetTwirl' return='float' arguments=''>
Returns the value of the Twirl modifier.
</Function>
<Function name='SetTwirl' return='void' arguments='float fTwirl'>
Sets the value for the Twirl modifier.
</Function>
<Function name='GetTwister' return='bool' arguments=''>
Returns the status of the Twister modifier.
</Function>
<Function name='SetTwister' return='void' arguments='bool bTwister'>
Sets the Twister modifier.
</Function>
<Function name='GetWave' return='float' arguments=''>
Returns the value of the Wave modifier.
</Function>
<Function name='SetWave' return='void' arguments='float fWave'>
Sets the value for the Wave modifier.
</Function>
<Function name='GetWide' return='bool' arguments=''>
Returns the status of the Wide modifier.
</Function>
<Function name='SetWide' return='void' arguments='bool bWide'>
Sets the Wide modifier.
</Function>
<Function name='GetXMod' return='float' arguments=''>
Returns the player's X-mod.
</Function>
<Function name='SetXMod' return='void' arguments='float fXmod'>
Sets the player's X-mod to <code>fXmod</code>.
</Function>
<Function name='GetXMode' return='float' arguments=''>
Returns the value of X Mode.
</Function>
<Function name='IsEasierForCourseAndTrail' return='bool' arguments='Course c, Trail t'>
Returns <code>true</code> if the current PlayerOptions makes the current Course/Trail easier.
</Function>
<Function name='IsEasierForSongAndSteps' return='bool' arguments='Song so, Steps st'>
Returns <code>true</code> if the current PlayerOptions makes the current Song/Steps easier.
</Function>
<Function name='SetXMode' return='void' arguments='float fXModeVal'>
Sets the X Mode percentage to <code>fXModeVal</code>.
</Function>
<Function name='UsingReverse' return='bool' arguments=''>
Returns <code>true</code> if the player is using reverse. (equivalent to <code>GetReverse() == 1.0</code>)
</Function>
</Class>
<Class name='PlayerStageStats'>
<Function name='FailPlayer' return='bool' arguments=''>
Fails the player.
</Function>
<Function name='FullCombo' return='bool' arguments=''>
Returns <code>true</code> if a full combo (TNS_W3 and up) was obtained.
</Function>
<Function name='FullComboOfScore' return='bool' arguments='TapNoteScore tns'>
Returns <code>true</code> if a full combo (<code>tns</code> and up) was obtained.
</Function>
<Function name='GetActualDancePoints' return='int' arguments=''>
Returns the number of Dance Points obtained by the player.
</Function>
<Function name='GetAliveSeconds' return='float' arguments=''>
Returns how long the player has been alive.
</Function>
<Function name='GetBestFullComboTapNoteScore' return='TapNoteScore' arguments=''>
Returns the best tap note score for a full combo.
</Function>
<Function name='GetCaloriesBurned' return='float' arguments=''>
Returns the number of calories burned.
</Function>
<Function name='GetCurMaxScore' return='int' arguments=''>
Returns the current possible maximum score.
</Function>
<Function name='GetCurrentCombo' return='int' arguments=''>
Returns the player's current combo.
</Function>
<Function name='GetCurrentLife' return='float' arguments=''>
Returns the player's current life from 0..1.
</Function>
<Function name='GetCurrentMissCombo' return='int' arguments=''>
Returns the player's current miss combo.
</Function>
<Function name='GetCurrentPossibleDancePoints' return='int' arguments=''>
Returns the number of Dance Points possible to be obtained by the player.
</Function>
<Function name='GetCurrentScoreMultiplier' return='int' arguments=''>
Returns the player's current score multiplier.
</Function>
<Function name='GetFailed' return='bool' arguments=''>
Returns <code>true</code> if the player failed.
</Function>
<Function name='GetGrade' return='Grade' arguments=''>
Returns the player's grade.
</Function>
<Function name='GetHoldNoteScores' return='int' arguments='HoldNoteScore hns'>
Returns the number of judgments for a specified HoldNoteScore.
</Function>
<Function name='GetLessonScoreActual' return='int' arguments=''>
Returns the player's actual score on the lesson.
</Function>
<Function name='GetLessonScoreNeeded' return='int' arguments=''>
Returns the score needed to pass the lesson.
</Function>
<Function name='GetLifeRemainingSeconds' return='float' arguments=''>
Returns the player's life remaining seconds.
</Function>
<Function name='GetMachineHighScoreIndex' return='int' arguments=''>
Returns the machine high score index for this performance.
</Function>
<Function name='GetNumControllerSteps' return='int' arguments=''>
Returns the number of controller steps.
</Function>
<Function name='GetPeakComboAward' return='PeakComboAward' arguments=''>
Returns the peak combo award for this performance.
</Function>
<Function name='GetPersonalHighScoreIndex' return='int' arguments=''>
Returns the personal high score index for this performance.
</Function>
<Function name='GetPlayedSteps' return='{Steps}' arguments=''>
Returns a table of played steps.
</Function>
<Function name='GetPercentageOfTaps' return='float' arguments='TapNoteScore tns'>
Gets the percentage of taps that were scored as <code>tns</code>.
</Function>
<Function name='GetPercentDancePoints' return='float' arguments=''>
Returns the player's Dance Point percentage.
</Function>
<Function name='GetPossibleDancePoints' return='int' arguments=''>
Returns the number of possible Dance Points.
</Function>
<Function name='GetPossibleSteps' return='{Steps}' arguments=''>
Returns a table of possible steps.
</Function>
<Function name='GetRadarActual' return='RadarValues' arguments=''>
Returns a RadarValues object representing the player's actual performance.
</Function>
<Function name='GetRadarPossible' return='RadarValues' arguments=''>
Returns a RadarValues object representing the total values for the song.
</Function>
<Function name='GetScore' return='int' arguments=''>
Returns the score.
</Function>
<Function name='GetStageAward' return='StageAward' arguments=''>
Returns the stage award for this performance.
</Function>
<Function name='GetSurvivalSeconds' return='float' arguments=''>
Returns how long the player survived in seconds.
</Function>
<Function name='GetTapNoteScores' return='int' arguments='TapNoteScore tns'>
Returns the number of judgments for a specified TapNoteScore.
</Function>
<Function name='MaxCombo' return='int' arguments=''>
Returns the max combo for this performance.
</Function>
<Function name='IsDisqualified' return='bool' arguments=''>
Returns <code>true</code> if the player was disqualified from ranking.
</Function>
<Function name='SetCurMaxScore' return='int' arguments=''>
Sets the current possible maximum score.
</Function>
<Function name='SetScore' return='void' arguments='int iScore'>
Sets the Player's score to <code>iScore</code>.
</Function>
</Class>
<Class name='PlayerState'>
<Function name='GetCurrentPlayerOptions' return='PlayerOptions' arguments='' >
Returns the current PlayerOptions for this PlayerState.
</Function>
<Function name='GetHealthState' return='HealthState' arguments=''>
Returns the HealthState for this PlayerState.
</Function>
<Function name='GetMultiPlayerNumber' return='MultiPlayer' arguments=''>
Returns the multiplayer number for this PlayerState.
</Function>
<Function name='GetPlayerController' return='PlayerController' arguments=''>
Returns the PlayerController for this PlayerState.
</Function>
<Function name='GetPlayerNumber' return='PlayerNumber' arguments=''>
Returns the player number for this PlayerState.
</Function>
<Function name='GetPlayerOptions' renamed='true' return='PlayerOptions' arguments='ModsLevel ml'>
Returns a PlayerOptions object for the specified ModsLevel.
</Function>
<Function name='GetPlayerOptionsString' return='string' arguments='ModsLevel ml'>
Returns a string of player options for the specified ModsLevel. (was <code>GetPlayerOptions</code> before sm-ssc v1.2.3)
</Function>
<Function name='GetPlayerOptionsArray' return='{string}' arguments='ModsLevel ml'>
Returns a table of strings, containing the player options for the specified ModsLevel.
</Function>
<Function name='GetSongPosition' return='SongPosition' arguments=''>
Returns the SongPosition for this PlayerState.
</Function>
<Function name='GetSuperMeterLevel' return='float' arguments=''>
Returns the current Super Meter level for this PlayerState.
</Function>
<Function name='SetPlayerOptions' return='string' arguments='ModsLevel ml, string sPlayerOptions'>
Sets the player options to <code>sPlayerOptions</code> for the specified ModsLevel.
</Function>
</Class>
<Class name='PrefsManager'>
<Function name='GetPreference' return='various' arguments='string sPreference'>
Return the value of the preference <code>sPreference</code>.
</Function>
<Function name='PreferenceExists' return='bool' arguments='string sPreference'>
Return true if preference <code>sPreference</code> exists.
</Function>
<Function name='SetPreference' return='void' arguments='string sPreference, various value'>
Set the value of the preference <code>sPreference</code> to <code>value</code>.
</Function>
<Function name='SetPreferenceToDefault' return='void' arguments='string sPreference'>
Reset preference <code>sPreference</code> to the default value.
</Function>
</Class>
<Class name='Profile'>
<Function name='GetCaloriesBurnedToday' return='float' arguments=''>
Returns the number of calories burned during the current day.
</Function>
<Function name='GetCharacter' return='Character' arguments=''>
Returns the Character being used by this profile.
</Function>
<Function name='GetCoursesActual' return='float' arguments='StepsType st, Difficulty d'>
Returns a composite of your high scores over courses with the specified StepsType and Difficulty.
</Function>
<Function name='GetCoursesPercentComplete' return='float' arguments='StepsType st, Difficulty d'>
Returns the percentage of courses that you've completed with the specified StepsType and Difficulty.
</Function>
<Function name='GetCoursesPossible' return='float' arguments='StepsType st, Difficulty d'>
Returns the possible score of courses with the specified StepsType and Difficulty.
</Function>
<Function name='GetDisplayName' return='string' arguments=''>
Returns the profile's display name.
</Function>
<Function name='GetDisplayTotalCaloriesBurned' return='string' arguments=''>
Return the number of calories burned as a string.
</Function>
<Function name='GetGoalCalories' return='int' arguments=''>
Returns the number of calories needed to reach the goal.
</Function>
<Function name='GetGoalSeconds' return='int' arguments=''>
Returns the number of seconds needed to reach the goal.
</Function>
<Function name='GetGoalType' return='GoalType' arguments=''>
Returns the current goal type.
</Function>
<Function name='GetHighScoreList' return='HighScoreList' arguments='Song s, Steps st'>
Gets the profile's HighScoreList for a specified Song and Steps. (Alternate arguments for Courses: <code>Course c, Trail t</code>)
</Function>
<Function name='GetLastPlayedCourse' return='Course' arguments=''>
Returns the last played Course for this profile.
</Function>
<Function name='GetLastPlayedSong' return='Song' arguments=''>
Returns the last played Song for this profile.
</Function>
<Function name='GetLastUsedHighScoreName' return='string' arguments=''>
Returns the last used high score name.
</Function>
<Function name='GetNumToasties' return='int' arguments=''>
Returns the number of Toasties gotten using the specified profile.
</Function>
<Function name='GetMostPopularCourse' return='Course' arguments=''>
Returns the profile's most popular course.
</Function>
<Function name='GetMostPopularSong' return='Song' arguments=''>
Returns the profile's most popular song.
</Function>
<Function name='GetNumTotalSongsPlayed' return='int' arguments=''>
Returns the total number of songs played with the profile.
</Function>
<Function name='GetSongNumTimesPlayed' return='int' arguments='Song s'>
Returns the number of times song <code>s</code> has been played with the profile.
</Function>
<Function name='GetSongsActual' return='float' arguments='StepsType st, Difficulty d'>
Returns a composite of your high scores over songs with the specified StepsType and Difficulty.
</Function>
<Function name='GetSongsAndCoursesPercentCompleteAllDifficulties' return='float' arguments='StepsType st'>
Returns the percent complete for all songs and courses for the specified StepsType <code>st</code>.
</Function>
<Function name='GetSongsPercentComplete' return='float' arguments='StepsType st, Difficulty d'>
Returns the percentage of songs that you've completed with the specified StepsType and Difficulty.
</Function>
<Function name='GetSongsPossible' return='float' arguments='StepsType st, Difficulty d'>
Returns the possible score of songs with the specified StepsType and Difficulty.
</Function>
<Function name='GetTotalCaloriesBurned' return='float' arguments=''>
Return the total number of calories burned.
</Function>
<Function name='GetTotalHands' return='int' arguments=''>
Returns the number of Hands stepped on.
</Function>
<Function name='GetTotalHolds' return='int' arguments=''>
Returns the number of successful Holds.
</Function>
<Function name='GetTotalJumps' return='int' arguments=''>
Returns the number of Jumps stepped on.
</Function>
<Function name='GetTotalLifts' return='int' arguments=''>
Returns the number of successful Lifts.
</Function>
<Function name='GetTotalMines' return='int' arguments=''>
Returns the number of Mines stepped on.
</Function>
<Function name='GetTotalNumSongsPlayed' return='int' arguments=''>
Returns the total number of songs played with the profile.
</Function>
<Function name='GetTotalRolls' return='int' arguments=''>
Returns the number of successful Rolls.
</Function>
<Function name='GetTotalStepsWithTopGrade' return='int' arguments='StepsType st, Difficulty d, Grade g'>
Returns the number of steps with the specified StepsType and Difficulty that you've scored a certain Grade <code>g</code> on.
</Function>
<Function name='GetTotalTapsAndHolds' return='int' arguments=''>
Returns the number of Taps and successful Holds.
</Function>
<Function name='GetTotalTrailsWithTopGrade' return='int' arguments='StepsType st, Difficulty d, Grade g'>
Returns the number of trails with the specified StepsType and Difficulty that you've scored a certain Grade <code>g</code> on.
</Function>
<Function name='GetUserTable' return='table' arguments=''>
Returns the user table for this Profile.
</Function>
<Function name='GetWeightPounds' return='int' arguments=''>
Returns how much the player weighs.
</Function>
<Function name='HasPassedAnyStepsInSong' return='bool' arguments='Song s'>
Returns <code>true</code> if the player has passed any steps in the specified Song <code>s</code>.
</Function>
<Function name='IsCodeUnlocked' return='bool' arguments='string sUnlockEntryID'>
Returns <code>true</code> if the specified code <code>sUnlockEntryID</code> is unlocked.
</Function>
<Function name='SetCharacter' return='void' arguments='string sCharID'>
Sets the current <Link class='Character' /> for the Profile.
</Function>
<Function name='SetGoalCalories' return='void' arguments='int iCals'>
Sets the goal to <code>iCals</code> calories.
</Function>
<Function name='SetGoalSeconds' return='void' arguments='int iSecs'>
Sets the goal to <code>iSecs</code> seconds.
</Function>
<Function name='SetGoalType' return='void' arguments='GoalType gt'>
Sets the current goal type to <code>gt</code>.
</Function>
<Function name='SetWeightPounds' return='void' arguments='int weightPounds'>
Sets how much the player weighs (in pounds) to <code>weightPounds</code>.
</Function>
<!-- sm-ssc additions -->
<Function name='GetTotalGameplaySeconds' return='int' arguments=''>
Returns the amount of time this profile has spent in gameplay (in seconds).
</Function>
<Function name='GetTotalSessions' return='int' arguments=''>
Returns the number of sessions this profile has had.
</Function>
<Function name='GetTotalSessionSeconds' return='int' arguments=''>
Returns the total session length (in seconds) of this profile.
</Function>
</Class>
<Class name='ProfileManager'>
<Function name='GetLocalProfile' return='Profile' arguments='string sProfileID'>
Returns the Profile for the specified profile ID.
</Function>
<Function name='GetLocalProfileFromIndex' return='Profile' arguments='int iIndex' />
<Function name='GetLocalProfileIDFromIndex' return='string' arguments='int iIndex' />
<Function name='GetLocalProfileIndexFromID' return='int' arguments='string sProfileID' />
<Function name='GetMachineProfile' return='Profile' arguments=''>
Retuns the machine profile.
</Function>
<Function name='GetNumLocalProfiles' return='int' arguments=''>
Retuns the amount of local profiles.
</Function>
<Function name='GetProfile' return='Profile' arguments='PlayerNumber pn'>
Returns the profile for player <code>pn</code>.
</Function>
<Function name='GetProfileDir' return='string' arguments='ProfileSlot slot'>
Returns the profile directory of the specified <code>ProfileSlot</code>.
</Function>
<Function name='IsPersistentProfile' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if player <code>pn</code>'s profile is persistent.
</Function>
<Function name='IsSongNew' return='bool' arguments='Song s'>
Returns <code>true</code> if Song <code>s</code> has never been played before (according to the machine profile).
</Function>
<Function name='ProfileWasLoadedFromMemoryCard' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if <code>pn</code>'s Profile was loaded from a memory card.
</Function>
<Function name='LastLoadWasFromLastGood' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if the last load of player <code>pn</code>'s profile was a LastGood copy of the profile.
</Function>
<Function name='LastLoadWasTamperedOrCorrupt' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if the last load of player <code>pn</code>'s profile resulted in a tampered or corrupt profile.
</Function>
<Function name='SaveMachineProfile' return='void' arguments=''>
Saves the machine profile.
</Function>
</Class>
<Class name='RadarValues'>
<Function name='GetValue' return='int' arguments='RadarCategory rc'>
Returns the value of <code>rc</code> from <Link class='Steps' function='GetRadarValues' />.
</Function>
</Class>
<Class name='RageDisplay'>
<Function name='GetDisplayHeight' return='int' arguments=''>
Return the height of the display.
</Function>
<Function name='GetDisplayWidth' return='int' arguments=''>
Return the width of the display.
</Function>
<Function name='GetFPS' return='int' arguments=''>
Return the FPS.
</Function>
<Function name='GetVPF' return='int' arguments=''>
Return the VPF.
</Function>
<Function name='GetCumFPS' return='int' arguments=''>
Return the cumulative FPS.
</Function>
</Class>
<Class name='RageFile'>
<Description>
These commands require a RageFile handle. You can create one using
<Link class='RageFileUtil' />.
</Description>
<Function name='AtEOF' return='bool' arguments=''>
Returns <code>true</code> if the current position within the file is the end. (EOF = End of File)
</Function>
<Function name='ClearError' return='void' arguments=''>
Clears the last error message.
</Function>
<Function name='Close' return='void' arguments=''>
Closes the file and releases it from memory.
</Function>
<Function name='destroy' return='void' arguments=''>
Safely deletes the file handle.
</Function>
<Function name='GetError' return='string' arguments=''>
Gets the last error message and returns it.
</Function>
<Function name='GetLine' return='string' arguments=''>
Gets a line and returns it.
</Function>
<Function name='Open' return='bool' arguments='string sPath, int iAccessType'>
Opens a file at <code>sPath</code> (relative to the StepMania root directory).<br />
<code>iAccessType</code> can be set to read (<code>1</code>), write (<code>2</code>), stream (<code>4</code>) or flush to disk on close (<code>8</code>).<br />
These can also be combined with addition. For example, to set up read and write, set <code>iAccessType</code> to <code>3</code> (1+2).
</Function>
<Function name='PutLine' return='int' arguments='string s'>
Puts a new line in the file.
</Function>
<Function name='Read' return='string' arguments=''>
Returns a string containing the entire contents of the file.
</Function>
<Function name='ReadBytes' return='string' arguments='int length'>
Returns <code>length</code> bytes from the RageFile's current position.
</Function>
<Function name='Seek' return='int' arguments=''>
Seeks to a position in the file and returns the new position.
</Function>
<Function name='Tell' return='int' arguments=''>
Returns the current position in the file.
</Function>
<Function name='Write' return='int' arguments='string str'>
Writes a file with the contents of <code>str</code>.
</Function>
</Class>
<Class name='RageFileManager'>
<Function name='DoesFileExist' return='bool' arguments='string sPath'>
Returns <code>true</code> if a file exists at <code>sPath</code>.
</Function>
<Function name='GetDirListing' return='{string}' arguments='string sPath, bool bOnlyDirs, bool bReturnPathToo'>
Returns a listing of files from <code>sPath</code>. The last two arguments are optional (and default to false).
</Function>
<Function name='GetFileSizeBytes' return='int' arguments='string sPath'>
Returns a file's size in bytes.
</Function>
<Function name='GetHashForFile' return='int' arguments='string sPath'>
Returns the hash of the file at <code>sPath</code>.
</Function>
</Class>
<Class name='RageInput'>
<Function name='GetDescriptions' return='{string}' arguments=''>
Return an array of connected input device descriptions.
</Function>
</Class>
<Class name='RageSound'>
<Description>
See <Link class='ActorSound' /> for loading a sound.
</Description>
<Function name='SetParam' return='void' arguments='string sProperty, float fVal'>
Actually sets the value of <code>sProperty</code> to <code>fVal</code>. The supported properties depend on how the associated <Link class='ActorSound' /> was loaded.
</Function>
<Function name='SetProperty' return='void' arguments='string sProperty, float fVal'>
Attempts (and typically fails) to set the value of <code>sProperty</code> to <code>fVal</code>. The supported properties depend on how the associated <Link class='ActorSound' /> was loaded.
</Function>
<Function name='pitch' return='void' arguments='float fPitch'>
Sets the pitch to <code>fPitch</code>. The associated <Link class='ActorSound' /> have <code>SupportsRateChanging = true</code> on load.
</Function>
<Function name='speed' return='void' arguments='float fSpeed'>
Sets the speed (that is, the rate at which the sound plays) to <code>fSpeed</code>. The associated <Link class='ActorSound' /> must have <code>SupportsRateChanging = true</code> on load.
</Function>
<Function name='volume' return='void' arguments='float fVolume'>
Sets the volume to <code>fVolume</code>, which is between 0..1.
</Function>
</Class>
<Class name='RageTexture'>
<Function name='GetTextureCoordRect' return='{float}' arguments=''>
Return the texture coordinate rectangle as <code>{left, top, right, bottom}</code>.
</Function>
<Function name='loop' return='void' arguments='bool bLoop'>
Sets the animation or movie looping to <code>bLoop</code>.
</Function>
<Function name='position' return='void' arguments='float fPos'>
Sets the animation or movie position to <code>fPos</code>.
</Function>
<Function name='rate' return='void' arguments='float fRate'>
Sets the animation or movie playback rate to <code>fRate</code>.
</Function>
</Class>
<Class name='RollingNumbers'>
<Function name='Load' return='void' arguments='string sGroupName'>
Loads the metrics for this RollingNumbers from <code>sGroupName</code>.
</Function>
<Function name='targetnumber' return='void' arguments='float f'>
Sets the target number to <code>f</code>.
</Function>
</Class>
<Class name='Screen'>
<Function name='GetNextScreenName' return='string' arguments=''>
Returns the name of the next Screen.
</Function>
<Function name='GetPrevScreenName' return='string' arguments=''>
Returns the name of the previous Screen.
</Function>
<Function name='GetScreenType' return='ScreenType' arguments=''>
Returns the ScreenType for this Screen.
</Function>
<Function name='lockinput' return='void' arguments='float f'>
Locks input for <code>f</code> seconds.
</Function>
<Function name='Metric' theme='_fallback' return='string' arguments='string sName'>
[02 Other.lua] Gets a metric from the current Screen.
</Function>
<Function name='PostScreenMessage' return='void' arguments='string sScreenMsg'>
Posts a message with the text <code>sScreenMsg</code> to the Screen.
</Function>
<Function name='String' theme='_fallback' return='string' arguments='string sName'>
[02 Other.lua] Gets a string from the current Screen in the current language.
</Function>
</Class>
<Class name='ScreenEdit'>
<Function name='GetEditState' return='EditState' arguments=''>
Returns the current <Link class='ENUM' function='EditState' />.
</Function>
</Class>
<Class name='ScreenEvaluation'>
<Function name='GetStageStats' return='StageStats' arguments=''>
Returns the current StageStats.
</Function>
</Class>
<Class name='ScreenGameplay'>
<Function name='Center1Player' return='bool' arguments=''>
Returns <code>true</code> if a single <Link class='Player' /> has its NoteField centered.
</Function>
<Function name='GetDummyPlayerInfo' return='PlayerInfo' arguments='int index'>
Returns a dummy PlayerInfo for the specified index.
</Function>
<Function name='GetLifeMeter' return='LifeMeter' arguments='PlayerNumber pn'>
Returns the <Link class='LifeMeter' /> for the specified <Link class='ENUM' function='PlayerNumber' /> <code>pn</code>.
</Function>
<Function name='GetNextCourseSong' return='Song' arguments=''>
Returns the next <Link class='Song' /> in the current <Link class='Course' />.
</Function>
<Function name='GetPlayerInfo' return='PlayerInfo' arguments='PlayerNumber pn'>
Returns the PlayerInfo for player <code>pn</code>.
</Function>
<Function name='SetNewScreen' return='void' arguments='string s'>
Sets the next Screen to be loaded.
</Function>
<Function name='IsPaused' return='bool' arguments=''>
Returns <code>true</code> if the game is paused.
</Function>
<Function name='PauseGame' return='void' arguments='bool bPause'>
Pauses or unpauses the game, depending on the value of <code>bPause</code>.
</Function>
</Class>
<Class name='ScreenHowToPlay'>
<Function name='GetLifeMeter' return='LifeMeter' arguments=''>
Returns the LifeMeter.
</Function>
</Class>
<Class name='ScreenManager'>
<Function name='AddNewScreenToTop' return='void' arguments='string sScreenName, string sMessage'>
Adds a screen at the top of the screen stack. (<code>sMessage</code> is an optional ScreenMessage posted once the new screen is finished.)
</Function>
<Function name='GetTopScreen' return='Screen' arguments=''>
Gets the screen at the top of the screen stack.
</Function>
<Function name='ReloadOverlayScreens' return='void' arguments=''>
Reloads any loaded overlay screens.
</Function>
<Function name='ScreenClassExists' return='bool' arguments='string s'>
Returns <code>true</code> if screen class <code>s</code> exists.
</Function>
<Function name='ScreenIsPrepped' return='bool' arguments='string s'>
Returns <code>true</code> if screen <code>s</code> is prepared.
</Function>
<Function name='SetNewScreen' return='void' arguments='string s'>
Sets the next screen to <code>s</code>.
</Function>
<Function name='SystemMessage' return='void' arguments='string s'>
Broadcasts a system message.
</Function>
</Class>
<Class name='ScreenNameEntryTraditional'>
<Function name='Backspace' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if Player <code>pn</code> backspaced successfully.
</Function>
<Function name='EnterKey' return='bool' arguments='PlayerNumber pn, string sKey'>
Returns <code>true</code> if Player <code>pn</code> was able to add <code>sKey</code> to their name.
</Function>
<Function name='Finish' return='bool' arguments='PlayerNumber pn'>
Attempts to finish Player <code>pn</code> and returns <code>true</code>
if successful.
</Function>
<Function name='GetAnyEntering' return='bool' arguments=''>
Returns <code>true</code> if anyone is entering their name.
</Function>
<Function name='GetAnyStillEntering' return='bool' arguments=''>
Returns <code>true</code> if anyone is still entering their name.<br />
(As opposed to those who are Finalized; see <Link function="GetFinalized" />)
</Function>
<Function name='GetEnteringName' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if Player <code>pn</code> is entering their name.
</Function>
<Function name='GetFinalized' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if Player <code>pn</code> is finished entering their name.
</Function>
<Function name='GetSelection' return='string' arguments='PlayerNumber pn'>
Gets the currently selected letter of Player <code>pn</code>.
</Function>
</Class>
<Class name='ScreenNetEvaluation'>
<Function name='GetNumActivePlayers' return='int' arguments=''>
Returns the number of active players.
</Function>
</Class>
<Class name='ScreenOptions'>
<Function name='AllAreOnLastRow' return='bool' arguments=''>
Returns <code>true</code> if all active players are on the last options row.
</Function>
<Function name='FocusedItemEndsScreen' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if the specified player is on an items that ends the screen.
</Function>
<Function name='GetCurrentRowIndex' renamed='true' return='int' arguments='PlayerNumber pn'>
Returns the current row that player <code>pn</code> is on. (Was previously <code>GetCurrentRow</code>.)
</Function>
<Function name='GetOptionRow' return='OptionRow' arguments='int iRow'>
Returns the specified OptionRow.
</Function>
</Class>
<Class name='ScreenPlayerOptions'>
<Function name='GetGoToOptions' return='bool' arguments=''>
Returns <code>true</code> if we are going to PlayerOptions.
</Function>
</Class>
<Class name='ScreenProfileLoad'>
<Function name='Continue' return='void' arguments=''>
Continues to the next screen.
</Function>
<Function name='HaveProfileToLoad' return='bool' arguments=''>
Returns <code>true</code> if there is a profile that can be loaded.
</Function>
</Class>
<Class name='ScreenProfileSave'>
<Function name='Continue' return='void' arguments=''>
Continues to the next screen.
</Function>
<Function name='HaveProfileToSave' return='bool' arguments=''>
Returns <code>true</code> if there is a profile that can be saved.
</Function>
</Class>
<Class name='ScreenSelectMaster'>
<Function name='GetSelectionIndex' return='int' arguments='PlayerNumber pn'>
Returns player <code>pn</code>'s current selected item as an integer.
</Function>
</Class>
<Class name='ScreenSelectMusic'>
<Function name='GetGoToOptions' return='bool' arguments=''>
Returns <code>true</code> if the player is going to the options screen.
</Function>
<Function name='GetMusicWheel' return='MusicWheel' arguments=''>
Returns the MusicWheel used on this screen.
</Function>
<Function name='OpenOptionsList' return='void' arguments='PlayerNumber pn'>
Opens the OptionsList for Player <code>pn</code>
</Function>
<Function name='setupcoursestagemods' theme='_fallback' return='void' arguments=''>
[02 StageMods.lua] Sets up modifiers for course modes.
</Function>
<Function name='setupmusicstagemods' theme='_fallback' return='void' arguments=''>
[02 StageMods.lua] Sets up modifiers for non-course modes.
</Function>
</Class>
<Class name='ScreenSelectProfile'>
<Function name='Cancel' return='void' arguments=''>
Tells the screen to go to the previous screen.
</Function>
<Function name='Finish' return='bool' arguments=''>
Attempts to finish the screen and returns <code>true</code>
if successful.
</Function>
<Function name='GetProfileIndex' return='int' arguments='PlayerNumber pn'>
Returns the profile index of the specified Player.
</Function>
<Function name='SetProfileIndex' return='bool' arguments='PlayerNumber pn, int iProfileIndex'>
Sets the profile index of Player <code>pn</code> to <code>iProfileIndex</code>.
</Function>
</Class>
<Class name='ScreenTextEntry'>
<Description>
TextEntrySettings is implemented similar to the Attributes in BitmapText. Formatting issues prevent the sample from being properly shown here; please see Changelog_sm-ssc.txt for the TextEntrySettings format.
</Description>
<Function name='Load' return='void' arguments='TextEntrySettings args'>
Sets up a ScreenTextEntry's values.
</Function>
</Class>
<Class name='ScreenWithMenuElements'>
<Function name='Cancel' return='void' arguments=''>
Tells the screen to go to the previous screen.
</Function>
</Class>
<Class name='Song'>
<Function name='GetAllSteps' return='{Steps}' arguments=''>
Returns an array of all the available <Link class='Steps' /> objects for a <Link class='Song' />.
</Function>
<Function name='GetBackgroundPath' return='string' arguments=''>
Returns the path to the song's background image.
</Function>
<Function name='GetBannerPath' return='string' arguments=''>
Returns the path to the song's banner.
</Function>
<Function name='GetCDImagePath' return='string' arguments=''>
Returns the path to the song's CD image.
</Function>
<Function name='GetCDTitlePath' return='string' arguments=''>
Gets the path to the CDTitle.
</Function>
<Function name='GetDiscPath' return='string' arguments=''>
Returns the path to the song's disc image (different from CD, think Pump).
</Function>
<Function name='GetDisplayArtist' return='string' arguments=''>
Returns the displayed artist of the song.
</Function>
<Function name='GetDisplayBpms' return='{float}' arguments=''>
Returns a table of 2 floats containing the display BPMs.
</Function>
<Function name='GetDisplayFullTitle' return='string' arguments=''>
Returns the displayed full title of the song, including subtitle.
</Function>
<Function name='GetDisplayMainTitle' return='string' arguments=''>
Returns the displayed main title of the song.
</Function>
<Function name='GetDisplaySubTitle' return='string' arguments=''>
Returns the displayed subtitle of the song.
</Function>
<Function name='GetFirstBeat' return='float' arguments=''>
Returns the first beat of the song.
</Function>
<Function name='GetFirstSecond' return='float' arguments=''>
Returns the first second of the song.
</Function>
<Function name='GetGenre' return='string' arguments=''>
Returns the genre of the song.
</Function>
<Function name='GetGroupName' return='string' arguments=''>
Returns the group name that the song is in.
</Function>
<Function name='GetJacketPath' return='string' arguments=''>
Returns the path to the song's jacket image.
</Function>
<Function name='GetLastBeat' return='float' arguments=''>
Returns the last beat of the song.
</Function>
<Function name='GetLastSecond' return='float' arguments=''>
Returns the last second of the song.
</Function>
<Function name='GetLyricsPath' return='string' arguments=''>
Gets the path to the lyrics.
</Function>
<Function name='GetMusicPath' return='string' arguments=''>
Gets the path to the music file.
</Function>
<Function name='GetOneSteps' return='Steps' arguments='StepsType st, Difficulty d'>
Returns a Step object if the StepType and Difficulty exist.
</Function>
<Function name='GetOrigin' return='string' arguments=''>
Gets the Song's origin.
</Function>
<Function name='GetPreviewVidPath' return='string' arguments=''>
Returns the path to the Song's preview video, if it exists. (Returns <code>nil</code> otherwise.)
</Function>
<Function name='GetSampleLength' return='float' arguments=''>
Gets the length of a song's sample time in seconds.
</Function>
<Function name='GetSampleStart' return='float' arguments=''>
Gets the starting position of a song sample in seconds.
</Function>
<Function name='GetSongDir' return='string' arguments=''>
Returns the song's directory.
</Function>
<Function name='GetSongFilePath' return='string' arguments=''>
Returns the songfile path.
</Function>
<Function name='GetStepsByStepsType' return='{Steps}' arguments='StepsType st'>
Returns a table of Steps that have StepsType <code>st</code>.
</Function>
<Function name='GetStepsSeconds' return='float' arguments=''>
Returns how long the longest stepchart is in seconds.
</Function>
<Function name='GetTimingData' return='TimingData' arguments=''>
Returns the song's TimingData.
</Function>
<Function name='GetTranslitArtist' return='string' arguments=''>
Returns the transliterated artist of the song.
</Function>
<Function name='GetTranslitFullTitle' return='string' arguments=''>
Returns the transliterated full title of the song, including subtitle.
</Function>
<Function name='GetTranslitMainTitle' return='string' arguments=''>
Returns the transliterated main title of the song.
</Function>
<Function name='GetTranslitSubTitle' return='string' arguments=''>
Returns the transliterated subtitle of the song.
</Function>
<Function name='HasStepsTypeAndDifficulty' return='bool' arguments='StepsType st, Difficulty d'>
Returns <code>true</code> if the song has steps for the specified difficulty in <code>st</code>.
</Function>
<Function name='HasAttacks' return='bool' arguments=''>
Returns <code>true</code> if the song has attacks.
</Function>
<Function name='HasBackground' return='bool' arguments=''>
Returns <code>true</code> if the song has a background.
</Function>
<Function name='HasBanner' return='bool' arguments=''>
Returns <code>true</code> if the song has a banner.
</Function>
<Function name='HasBGChanges' return='bool' arguments=''>
Returns <code>true</code> if the song has BGChanges.
</Function>
<Function name='HasCDImage' return='bool' arguments=''>
Returns <code>true</code> if the song has a CD image.
</Function>
<Function name='HasCDTitle' return='bool' arguments=''>
Returns <code>true</code> if the song has a CDTitle.
</Function>
<Function name='HasDisc' return='bool' arguments=''>
Returns <code>true</code> if the song has a Disc graphic.
</Function>
<Function name='HasEdits' return='bool' arguments='StepsType st'>
Returns <code>true</code> if the song has edits.
</Function>
<Function name='HasJacket' return='bool' arguments=''>
Returns <code>true</code> if the song has a jacket graphic.
</Function>
<Function name='HasLyrics' return='bool' arguments=''>
Returns <code>true</code> if the song has lyrics.
</Function>
<Function name='HasMusic' return='bool' arguments=''>
Returns <code>true</code> if the song has music.
</Function>
<Function name='HasPreviewVid' return='bool' arguments=''>
Returns <code>true</code> if the song has a preview video.
</Function>
<Function name='HasSignificantBPMChangesOrStops' return='bool' arguments=''>
Returns <code>true</code> if the song has significant BPM changes or stops.
</Function>
<Function name='HasStepsType' return='bool' arguments='StepsType st'>
Returns <code>true</code> if the song has the specified StepsType.
</Function>
<Function name='IsDisplayBpmConstant' return='bool' arguments=''>
Returns <code>true</code> if the song's DisplayBPM is constant.
</Function>
<Function name='IsDisplayBpmRandom' return='bool' arguments=''>
Returns <code>true</code> if the song's DisplayBPM is random.
</Function>
<Function name='IsDisplayBpmSecret' return='bool' arguments=''>
Returns <code>true</code> if the song's DisplayBPM is secret.
</Function>
<Function name='IsEasy' return='bool' arguments=''>
Returns <code>true</code> if the song is considered easy.
</Function>
<Function name='IsEnabled' return='bool' arguments=''>
Returns <code>true</code> if the song is enabled.
</Function>
<Function name='IsLong' return='bool' arguments=''>
Returns <code>true</code> if the song meets the criteria for a &quot;Long Version&quot;.
</Function>
<Function name='IsMarathon' return='bool' arguments=''>
Returns <code>true</code> if the song meets the criteria for &quot;Marathon&quot; length.
</Function>
<Function name='IsStepsUsingDifferentTiming' return='bool' arguments='Steps s'>
Returns <code>true</code> if the song and the specified steps have different timing.
</Function>
<Function name='IsTutorial' return='bool' arguments=''>
Returns <code>true</code> if the song only has Beginner steps.
</Function>
<Function name='MusicLengthSeconds' return='float' arguments=''>
Returns the length of the song in seconds.
</Function>
<Function name='NormallyDisplayed' return='bool' arguments=''>
Returns <code>true</code> if the song is normally displayed.
</Function>
<Function name='ShowInDemonstrationAndRanking' return='bool' arguments=''>
Returns <code>true</code> if the song is shown in Demonstration and Ranking.
</Function>
</Class>
<Class name='SongManager'>
<Function name='DoesCourseGroupExist' return='bool' arguments='string sGroup'>
Returns <code>true</code> if the specified course group exists.
</Function>
<Function name='DoesSongGroupExist' return='bool' arguments='string sGroup'>
Returns <code>true</code> if the specified song group exists.
</Function>
<Function name='FindCourse' return='Course' arguments='string sCourse'>
Returns a Course if one matching <code>sCourse</code> is found.
</Function>
<Function name='FindSong' return='Song' arguments='string sSong'>
Returns a Song if one matching <code>sSong</code> is found.
</Function>
<Function name='GetAllCourses' return='{Course}' arguments='bool bIncludeAutogen'>
Returns an array of all the installed courses.
</Function>
<Function name='GetAllSongs' return='{Song}' arguments=''>
Returns an array of all the installed songs.
</Function>
<Function name='GetCourseColor' return='color' arguments='Course c'>
Returns the course color of Course <code>c</code>.
</Function>
<Function name='GetCourseGroupBannerPath' return='string' arguments='string sGroup'>
Returns the path to the specified course group's banner.
</Function>
<Function name='GetCourseGroupNames' return='{string}' arguments=''>
Returns a table containing all of the course group names.
</Function>
<Function name='GetCoursesInGroup' return='{Course}' arguments='string sGroup'>
Returns a table with all of the courses in the specified group.
</Function>
<Function name='GetExtraStageInfo' return='various' arguments='bool bExtra2, Style s'>
Returns the extra stage info (Song, Steps) for the specified Style <code>s</code>. (If <code>bExtra2</code> is true, it will use the second Extra Stage data instead of the first. Again, Lua.xsd sucks)
</Function>
<Function name='GetNumAdditionalCourses' return='int' arguments=''>
Returns the number of courses loaded via Additional folders.
</Function>
<Function name='GetNumAdditionalSongs' return='int' arguments=''>
Returns the number of songs loaded via Additional folders.
</Function>
<Function name='GetNumCourseGroups' return='int' arguments=''>
Returns the number of course groups.
</Function>
<Function name='GetNumCourses' return='int' arguments=''>
Returns the number of courses.
</Function>
<Function name='GetNumSelectableAndUnlockedSongs' return='int' arguments=''>
Returns the number of selectable and unlocked songs.
</Function>
<Function name='GetNumSongGroups' return='int' arguments=''>
Returns the number of song groups.
</Function>
<Function name='GetNumSongs' return='int' arguments=''>
Returns the number of songs.
</Function>
<Function name='GetNumLockedSongs' return='int' arguments=''>
Returns the number of locked songs, regardless of reason for locking.
</Function>
<Function name='GetNumUnlockedSongs' return='int' arguments=''>
Returns the number of unlocked songs.
</Function>
<Function name='GetPopularCourses' return='{Course}' arguments='CourseType ct'>
Returns a table of popular courses for the specified CourseType.
</Function>
<Function name='GetPopularSongs' return='{Song}' arguments=''>
Returns a table of popular songs.
</Function>
<Function name='GetPreferredSortCourses' return='{Course}' arguments='CourseType ct, bool bIncludeAutogen'>
Returns a table of courses as they'd appear in preferred sort.
</Function>
<Function name='GetPreferredSortSongs' return='{Song}' arguments=''>
Returns a table of songs as they'd appear in preferred sort.
</Function>
<Function name='GetRandomCourse' return='Course' arguments=''>
Returns a random course.
</Function>
<Function name='GetRandomSong' return='Song' arguments=''>
Returns a random song.
</Function>
<Function name='GetSongColor' return='color' arguments='Song s'>
Returns the song color of Song <code>s</code>.
</Function>
<Function name='GetSongFromSteps' return='Song' arguments='Steps st'>
Returns a Song given a set of Steps <code>st</code>.
</Function>
<Function name='GetSongGroupBannerPath' return='string' arguments='string sGroup'>
Returns the path to the specified song group's banner.
</Function>
<Function name='GetSongGroupColor' return='color' arguments='string sGroupName'>
Returns the song group color of <code>sGroupName</code>.
</Function>
<Function name='GetSongGroupNames' return='{string}' arguments=''>
Returns a table containing all of the song group names.
</Function>
<Function name='GetSongRank' return='int' arguments='Song s'>
Returns the rank (popularity) of Song <code>s</code>.
</Function>
<Function name='GetSongsInGroup' return='{Song}' arguments='string sGroupName'>
Returns a table containing all of the songs in group <code>sGroupName</code>.
</Function>
<Function name='ShortenGroupName' return='string' arguments='string sGroupName'>
Returns the shortened group name (based on entries in Translations.xml).
</Function>
<Function name='SetPreferredCourses' return='void' arguments='string sListName'>
Loads preferred courses from <code>{theme}/Other/SongManager sListName.txt</code>.
</Function>
<Function name='SetPreferredSongs' return='void' arguments='string sListName'>
Loads preferred songs from <code>{theme}/Other/SongManager sListName.txt</code>.
</Function>
<Function name='SongToPreferredSortSectionName' return='string' arguments='Song s'>
Returns the preferred sort section name for the specified Song.
</Function>
<Function name='WasLoadedFromAdditionalCourses' return='bool' arguments='Course c'>
Returns <code>true</code> if the specified course was loaded from AdditionalCourses.
</Function>
<Function name='WasLoadedFromAdditionalSongs' return='bool' arguments='Song s'>
Returns <code>true</code> if the specified song was loaded from AdditionalSongs.
</Function>
</Class>
<Class name='SongPosition'>
<Function name='GetCurBPS' return='float' arguments=''>
Returns the current beats per second.
</Function>
<Function name='GetDelay' return='bool' arguments=''>
Returns <code>true</code> if a Delay is active.
</Function>
<Function name='GetFreeze' return='bool' arguments=''>
Returns <code>true</code> if a Freeze is active.
</Function>
<Function name='GetMusicSeconds' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='GetMusicSecondsVisible' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='GetSongBeat' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='GetSongBeatNoOffset' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='GetSongBeatVisible' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='GetWarpBeginRow' return='int' arguments=''>
Returns the row where a warp appears.
</Function>
<Function name='GetWarpDestination' return='float' arguments=''>
Returns the warp destination length.
</Function>
</Class>
<Class name='Sprite'>
<Function name='GetAnimationLengthSeconds' return='float' arguments=''>
Returns the length of the animation in seconds.
</Function>
<Function name='GetNumStates' return='int' arguments=''>
Return the number of states this Sprite has.
</Function>
<Function name='GetState' return='int' arguments=''>
Returns the Sprite's current state (frame number in a multi-frame sprite).
</Function>
<Function name='GetTexture' return='RageTexture' arguments=''>
Returns the Sprite's texture.
</Function>
<Function name='LinearFrames' theme='_fallback' return='table' arguments='int iNumFrames, float fSeconds'>
[02 Sprite.lua] Returns a <code>Frames</code> table consisting of <code>iNumFrames</code> frames lasting for a total of <code>fSeconds</code> seconds. This function is not a member function and should be used as <code>Frames = Sprite.LinearFrames( 5, 2.6 )</code>.
</Function>
<Function name='Load' return='void' arguments='string sPath'>
If <code>sPath</code> is <code>nil</code>, then unload the texture. Otherwise, load the texture at path <code>sPath</code>.
</Function>
<Function name='LoadBackground' return='void' arguments='string sPath'>
Load the song background texture at <code>sPath</code>.
</Function>
<Function name='LoadBanner' return='void' arguments='string sPath'>
Load the song banner texture at <code>sPath</code>.
</Function>
<Function name='LoadFromCurrentSongBackground' theme='_fallback' return='void' arguments=''>
[02 Sprite.lua] Loads the background from the current Song or the first Trail entry.
</Function>
<Function name='LoadFromSongBackground' theme='_fallback' return='void' arguments='Song song'>
[02 Sprite.lua] Load the texture for <code>song</code>'s background.
</Function>
<Function name='LoadFromSongBanner' theme='_fallback' return='void' arguments='Song song'>
[02 Sprite.lua] Load the texture for <code>song</code>'s banner.
</Function>
<Function name='SetCustomImageRect' return='void' arguments='float fLeft, float fTop, float fRight, float fBottom'>
Sets the custom image rectangle. (Works in image pixel space.)
</Function>
<Function name='SetEffectMode' return='void' arguments='EffectMode mode'>
Set the <Link class='ENUM' function='EffectMode' /> to <code>mode</code>.
</Function>
<Function name='SetSecondsIntoAnimation' return='void' arguments='float fSeconds'>
Sets the number of seconds into the animation to <code>fSeconds</code>.
</Function>
<Function name='SetTexture' return='void' arguments='RageTexture texture'>
Set the texture to <code>texture</code>.
</Function>
<Function name='addimagecoords' return='void' arguments='float fX, float fY'>
<!-- XXX: how does this work? -->
</Function>
<Function name='customtexturerect' return='void' arguments='float fLeft, float fTop, float fRight, float fBottom'>
Allows the themer to set a custom texture rectangle that effects the way the texture is drawn.
</Function>
<Function name='loop' theme='_fallback' return='void' arguments='bool bLoop'>
[02 Sprite.lua] Call <Link class='RageTexture' function='loop'><code>RageTexture:loop</code></Link><code>( bLoop )</code> on the texture.
</Function>
<Function name='position' theme='_fallback' return='void' arguments='float fPos'>
[02 Sprite.lua] Call <Link class='RageTexture' function='position'><code>RageTexture:position</code></Link><code>( fPos )</code> on the texture.
</Function>
<Function name='rate' theme='_fallback' return='void' arguments='float fRate'>
[02 Sprite.lua] Call <Link class='RageTexture' function='rate'><code>RageTexture:rate</code></Link><code>( fRate )</code> on the texture.
</Function>
<Function name='scaletoclipped' return='void' arguments='float fWidth, float fHeight'>
Scale the Sprite to width <code>fWidth</code> and height <code>fHeight</code> clipping if the dimensions do not match.
</Function>
<Function name='setstate' return='void' arguments='int iNewState'>
Set the Sprite's state to <code>iNewState</code>.
</Function>
<Function name='stretchtexcoords' return='void' arguments='float fX, float fY'>
<!-- XXX: What does this do? -->
</Function>
<Function name='texcoordvelocity' return='void' arguments='float fVelX, float fVelY'>
Set the texture coordinate velocity which controls how the Sprite changes as it animates. <!-- XXX: Can we be more specific? -->
</Function>
<!-- sm-ssc addons -->
<Function name='CropTo' return='void' arguments='float fWidth, float fHeight'>
Crops the Sprite to <code>fWidth</code>x<code>fHeight</code>.
</Function>
<Function name='cropto' theme='_fallback' return='void' arguments='float fWidth, float fHeight'>
[01 alias.lua] Alias for CropTo.
</Function>
<Function name='SetAllStateDelays' return='void' arguments='float fRate'>
Sets all the state delays to <code>fRate</code>. Useful for Sprites that need to change by BPM (e.g. Tran from DDR 5th Mix, the cube from DS EuroMix 2).
</Function>
</Class>
<Class name='StageStats'>
<Function name='AllFailed' return='bool' arguments=''>
Returns <code>true</code> if everyone failed.
</Function>
<Function name='GetEarnedExtraStage' return='EarnedExtraStage' arguments=''>
Returns the <Link class="ENUM" function="EarnedExtraStage">EarnedExtraStage</Link> value.
</Function>
<Function name='GetGameplaySeconds' return='float' arguments=''>
Returns the number of seconds played.
</Function>
<Function name='GetMultiPlayerStageStats' return='PlayerStageStats' arguments='MultiPlayer mp'>
Returns the PlayerStageStats of multiplayer <code>mp</code>.
</Function>
<Function name='GetPlayedSongs' return='{Song}' arguments='' />
<Function name='GetPlayerStageStats' return='PlayerStageStats' arguments='PlayerNumber pn'>
Returns the PlayerStageStats of player <code>pn</code>.
</Function>
<Function name='GetPossibleSongs' return='{Song}' arguments='' />
<Function name='GetStage' return='Stage' arguments=''>
Returns the <Link class="ENUM" function="Stage">Stage</Link> value.
</Function>
<Function name='GetStageIndex' return='int' arguments=''>
Returns the stage index.
</Function>
<Function name='OnePassed' return='bool' arguments=''>
Returns <code>true</code> if at least one person passed.
</Function>
<Function name='PlayerHasHighScore' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if player <code>pn</code> has a high score.
</Function>
</Class>
<Class name='StatsManager'>
<Function name='GetAccumPlayedStageStats' return='StageStats' arguments=''>
Returns the accumulated played StageStats.
</Function>
<Function name='GetBestFinalGrade' return='Grade' arguments=''>
Returns the best final grade.
</Function>
<Function name='GetBestGrade' return='Grade' arguments=''>
Returns the best grade.
</Function>
<Function name='GetCurStageStats' return='StageStats' arguments=''>
Returns the current StageStats.
</Function>
<Function name='GetFinalGrade' return='Grade' arguments='PlayerNumber pn'>
Returns player <code>pn</code>'s final grade.
</Function>
<Function name='GetPlayedStageStats' return='StageStats' arguments='int iAgo'>
Get the StageStats from <code>iAgo</code> rounds ago.
</Function>
<Function name='GetStagesPlayed' return='int' arguments=''>
Returns the number of stages played.
</Function>
<Function name='GetWorstGrade' return='Grade' arguments=''>
Returns the worst grade.
</Function>
<Function name='Reset' return='void' arguments=''>
Resets the stats.
</Function>
</Class>
<Class name='Steps'>
<Function name='GetAuthorCredit' return='string' arguments=''>
Returns the author that made that particular Steps pattern.
</Function>
<Function name='GetChartName' return='string' arguments=''>
Returns the Steps chart name.
</Function>
<Function name='GetChartStyle' return='string' arguments=''>
Returns the Chart Style for this Steps.
</Function>
<Function name='GetDescription' return='string' arguments=''>
Returns the Steps description.
</Function>
<Function name='GetDifficulty' return='Difficulty' arguments=''>
Returns the Steps difficulty.
</Function>
<Function name='GetDisplayBpms' return='{float}' arguments=''>
Returns a table with the minimum and maximum values from the DisplayBPM.
</Function>
<Function name='GetDisplayBPMType' return='DisplayBPM' arguments=''>
Returns the DisplayBPM type.
</Function>
<Function name='GetFilename' return='string' arguments=''>
Returns the Steps filename from the Cache.
</Function>
<Function name='GetHash' return='unsigned' arguments=''>
Returns a hash of the Steps.
</Function>
<Function name='GetMeter' return='int' arguments=''>
Returns the numerical difficulty of the Steps.
</Function>
<Function name='HasAttacks' return='bool' arguments=''>
Returns <code>true</code> if the Steps has any attacks.
</Function>
<Function name='HasSignificantTimingChanges' return='bool' arguments=''>
Returns <code>true</code> if the Steps pattern has significant timing changes.
</Function>
<Function name='GetRadarValues' return='RadarValues' arguments='PlayerNumber pn'>
Returns the complete list of RadarValues for player <code>pn</code>. Use <Link class='RadarValues' function='GetValue' /> to grab a specific value.
</Function>
<Function name='GetStepsType' return='StepsType' arguments=''>
Returns the Steps type.
</Function>
<Function name='GetTimingData' return='TimingData' arguments=''>
Returns the TimingData for the Steps.
</Function>
<Function name='IsAnEdit' return='bool' arguments=''>
Returns <code>true</code> if the Steps are an edit.
</Function>
<Function name='IsAPlayerEdit' return='bool' arguments=''>
Returns <code>true</code> if the Steps are a player edit (loaded from a profile).
</Function>
<Function name='IsAutogen' return='bool' arguments=''>
Returns <code>true</code> if the steps were automatically generated.
</Function>
<Function name='IsDisplayBpmConstant' return='bool' arguments=''>
Returns <code>true</code> if the DisplayBPM is constant.
</Function>
<Function name='IsDisplayBpmRandom' return='bool' arguments=''>
Returns <code>true</code> if the DisplayBPM is random.
</Function>
<Function name='IsDisplayBpmSecret' return='bool' arguments=''>
Returns <code>true</code> if the DisplayBPM is secret.
</Function>
<Function name='PredictMeter' return='float' arguments=''>
Returns the predicted meter for this Step.
</Function>
<Function name='UsesSplitTiming' return='bool' arguments=''>
Returns <code>true</code> if the Steps use different <code>TimingData</code> from the Song.
</Function>
</Class>
<Class name='StepsDisplay'>
<Function name='Load' return='void' arguments='string sMetricsGroup'>
Loads the StepsDisplay commands from the Metrics in group <code>sMetricsGroup</code>.
</Function>
<Function name='SetFromGameState' return='void' arguments='PlayerNumber pn'>
Sets the StepsDisplay from the GameState using Player <code>pn</code>.
</Function>
<Function name='SetFromSteps' return='void' arguments='PlayerNumber pn, Steps pSteps'>
Sets the StepsDisplay based on Steps <code>pSteps</code>.
</Function>
<Function name='SetFromStepsTypeAndMeterAndDifficulty' return='void' arguments='StepsType st, int iMeter, Difficulty dc'>
Sets the StepsDisplay based on the passed in StepsType, <code>iMeter</code>, and Difficulty.
</Function>
<Function name='SetFromTrail' return='void' arguments='Trail pTrail'>
Sets the StepsDisplay based on Trail <code>pTrail</code>.
</Function>
</Class>
<Class name='Style'>
<Function name='ColumnsPerPlayer' return='int' arguments=''>
Returns the number of total tracks per player this Style contains (e.g. 4 for dance-versus, but 8 for dance-double).
</Function>
<Function name='GetName' return='string' arguments=''>
Returns the name of the Style.
</Function>
<Function name='GetStepsType' return='StepsType' arguments=''>
Returns the StepsType for this Style.
</Function>
<Function name='GetStyleType' return='StyleType' arguments=''>
Returns the StyleType for this Style.
</Function>
<Function name='LockedDifficulty' return='bool' arguments=''>
Returns <code>true</code> if this style locks the difficulty for both players.
</Function>
<Function name='NeedsZoomOutWith2Players' return='bool' arguments=''>
Returns <code>true</code> if the Style needs to be zoomed out with two players.
</Function>
</Class>
<Class name='TextBanner'>
<Function name='Load' return='void' arguments='string sMetricsGroup'>
Loads the TextBanner from the specified metrics group.
</Function>
<Function name='SetFromSong' return='void' arguments='Song s'>
Loads the TextBanner's child elements from a <Link class='Song' />.
</Function>
<Function name='SetFromString' return='void' arguments='string sDisplayTitle, string sTranslitTitle, string sDisplaySubTitle, string sTranslitSubTitle, string sDisplayArtist, string sTranslitArtist'>
Loads the TextBanner's child elements from strings.
</Function>
</Class>
<Class name='ThemeManager'>
<Function name='DoesLanguageExist' return='bool' arguments='string langName'>
Returns <code>true</code> if the specified language exists in the current theme.
</Function>
<Function name='DoesThemeExist' return='bool' arguments='string themeName'>
Returns <code>true</code> if the specified theme exists.
</Function>
<Function name='GetAbsolutePath' theme='_fallback' return='string' arguments='string sPath'>
[02 Utilities.lua] Returns the absolute path of a file in the theme.
</Function>
<Function name='GetCurLanguage' return='string' arguments=''>
Returns the current language.
</Function>
<Function name='GetCurrentThemeDirectory' return='string' arguments=''>
Returns the theme's current directory.
</Function>
<Function name='GetCurThemeName' return='string' arguments=''>
Returns the name of the current theme.
</Function>
<Function name='GetMetric' return='string' arguments='string ClassName, string Element'>
Returns the value of <code>Element</code> in <code>Class</code> from metrics.ini.
</Function>
<Function name='GetNumSelectableThemes' return='int' arguments=''>
Returns the number of selectable themes.
</Function>
<Function name='GetPathB' return='string' arguments='string ClassName, string Element'>
Returns the path of <code>ClassName Element</code> in the BGAnimations folder.
</Function>
<Function name='GetPathF' return='string' arguments='string ClassName, string Element'>
Returns the path of an element in the Fonts folder.
</Function>
<Function name='GetPathG' return='string' arguments='string ClassName, string Element'>
Returns the path of an element in the Graphics folder.
</Function>
<Function name='GetPathInfoB' return='string' arguments='string ClassName, string Element'>
returns three strings: BGAnimation ResolvedPath, MatchingMetricsGroup, MatchingElement. Used in <Link class='GLOBAL' function='LoadFallbackB'>LoadFallbackB</Link> in themes/_fallback/02 Other.lua. (Lua.xsd sucks)
</Function>
<Function name='GetPathO' return='string' arguments='string ClassName, string Element'>
Returns the path of an element in the Other folder.
</Function>
<Function name='GetPathS' return='string' arguments='string ClassName, string Element'>
Returns the path of an element in the Sounds folder.
</Function>
<Function name='GetSelectableThemeNames' return='{string}' arguments=''>
Returns a table of selectable theme directories.
</Function>
<Function name='GetString' return='string' arguments='string ClassName, string Element'>
Returns the value of <code>Element</code> in <code>Class</code> for the currently loaded language.
</Function>
<Function name='GetThemeAuthor' return='string' arguments=''>
Returns the author of the current theme or "[unknown author]".
</Function>
<Function name='GetThemeDisplayName' return='string' arguments=''>
Returns the display name of the current theme.
</Function>
<Function name='HasMetric' return='bool' arguments='string section, string value'>
Returns <code>true</code> if the theme has the specified metric.
</Function>
<Function name='HasString' return='bool' arguments='string section, string value'>
Returns <code>true</code> if the theme has the specified string.
</Function>
<Function name='IsThemeSelectable' return='bool' arguments='string theme'>
Returns <code>true</code> if the specified theme is selectable.
</Function>
<Function name='ReloadMetrics' return='void' arguments=''>
Reloads the current theme's metrics.
</Function>
<Function name='RunLuaScripts' return='void' arguments='string sMask'>
</Function>
</Class>
<Class name='TimingData'>
<Function name='GetActualBPM' return='{float}' arguments=''>
Returns the minimum and maximum BPM of the song in a table (in that order).
</Function>
<Function name='GetBeatFromElapsedTime' return='float' arguments='float fElapsedTime'>
Returns the beat from <code>fElapsedTime</code>.
</Function>
<Function name='GetBPMAtBeat' return='float' arguments='float fBeat'>
Returns the BPM at <code>fBeat</code>.
</Function>
<Function name='GetBPMs' return='{string}' arguments=''>
Returns a table of the BPMs as strings.
</Function>
<Function name='GetBPMsAndTimes' return='{string}' arguments=''>
Returns a table of the BPMs and the times they happen as strings with the format "<code>beat=BPM</code>".
</Function>
<Function name='GetElapsedTimeFromBeat' return='float' arguments='float fBeat'>
Returns the elapsed time from <code>fBeat</code>.
</Function>
<Function name='GetStops' return='{string}' arguments=''>
Returns a table of the Stops and the times they happen as strings with the format "<code>beat=stop seconds</code>".
</Function>
<Function name='GetDelays' return='{string}' arguments=''>
Returns a table of the Delays and the times they happen as strings with the format "<code>beat=stop seconds</code>".
</Function>
<Function name='GetLabels' return='{string}' arguments=''>
Returns a table of the Labels and the times they happen as strings with the format "<code>beat=label name</code>."
</Function>
<Function name='GetWarps' return='{string}' arguments=''>
Returns a table of the Warps and the times they happen as strings with the format "<code>beat=number of beats warped over</code>."
</Function>
<Function name='GetCombos' return='{string}' arguments=''>
Returns a table of the Combos and the times they happen as strings with the format "<code>beat=combo value</code>."
</Function>
<Function name='GetTimeSignatures' return='{string}' arguments=''>
Returns a table of the Time Signatures and the times they happen as strings with the format "<code>beat=beats per measure (numerator)=denominator</code>."
</Function>
<Function name='GetTickcounts' return='{string}' arguments=''>
Returns a table of the Tickcountss and the times they happen as strings with the format "<code>beat=number of ticks per beat</code>."
</Function>
<Function name='GetFakes' return='{string}' arguments=''>
Returns a table of the Fakes and the times they happen as strings with the format "<code>beat=number of beats to not judge</code>."
</Function>
<Function name='GetScrolls' return='{string}' arguments=''>
Returns a table of the Scrolls and the times they happen as strings with the format "<code>beat=scroll rate ratio</code>."
</Function>
<Function name='GetSpeeds' return='{string}' arguments=''>
Returns a table of the Speeds and the times they happen as strings with the format "<code>beat=scroll rate ratio=length of time to fully activate=unit of activation (0 for beats, 1 for seconds)</code>."
</Function>
<Function name='HasBPMChanges' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains BPM changes.
</Function>
<Function name='HasDelays' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains delays.
</Function>
<Function name='HasNegativeBPMs' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains any BPM changes with a negative BPM.
</Function>
<Function name='HasStops' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains stops.
</Function>
<Function name='HasWarps' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains warps.
</Function>
<Function name='HasFakes' return='bool' arguments=''>
returns <code>true</code> if the TimingData contains fake segments.
</Function>
<Function name='HasSpeedChanges' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains speed scrolling changes.
</Function>
<Function name='HasScrollChanges' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains general scrolling changes.
</Function>
</Class>
<Class name='Trail'>
<Function name='ContainsSong' return='bool' arguments='Song s'>
Returns <code>true</code> if song <code>s</code> is in the Trail.
</Function>
<Function name='GetArtists' return='{string}' arguments=''>
Returns an array with all the artists in the Trail.
</Function>
<Function name='GetDifficulty' return='Difficulty' arguments=''>
Returns the Trail's difficulty.
</Function>
<Function name='GetLengthSeconds' return='float' arguments=''>
Returns the length of this Trail in seconds.
</Function>
<Function name='GetTrailEntries' return='{TrailEntry}' arguments=''>
Returns a table of TrailEntry items.
</Function>
<Function name='GetMeter' return='int' arguments=''>
Returns the Trail's difficulty rating.
</Function>
<Function name='GetRadarValues' return='RadarValues' arguments=''>
Returns the Trail's RadarValues.
</Function>
<Function name='GetStepsType' return='StepsType' arguments=''>
Returns the Trail's StepsType.
</Function>
<Function name='GetTotalMeter' return='int' arguments=''>
Returns the Trail's total meter
</Function>
<Function name='GetTrailEntry' return='TrailEntry' arguments='int iEntry'>
Returns the TrailEntry at index <code>iEntry</code>.
</Function>
<Function name='IsSecret' return='bool' arguments=''>
Returns <code>true</code> if any of the Trail entries are secret.
</Function>
</Class>
<Class name='TrailEntry'>
<Function name='GetNormalModifiers' return='string' arguments=''>
Returns a string of modifiers used in this TrailEntry.
</Function>
<Function name='GetSong' return='Song' arguments=''>
Returns the Song used in this TrailEntry.
</Function>
<Function name='GetSteps' return='Steps' arguments=''>
Returns the Steps used in this TrailEntry.
</Function>
<Function name='IsSecret' return='bool' arguments=''>
(why'd I think this was a good idea when we have <Link class='CourseEntry' function='IsSecret' />?)
</Function>
</Class>
<Class name='UnlockEntry'>
<Function name='code' return='void' arguments='string m_sEntryID'>
Sets the UnlockEntry's ID to <code>m_sEntryID</code>.
</Function>
<Function name='course' return='void' arguments='string sCourseName'>
Sets the UnlockEntry's course to <code>sCourseName</code>.<br />
Example: <code>course,"Driven"</code>
</Function>
<Function name='GetCode' return='string' arguments=''>
Returns the code for this unlock.
</Function>
<Function name='GetCourse' return='Course' arguments=''>
Returns the Course for this unlock.
</Function>
<Function name='GetDescription' return='string' arguments=''>
Returns the unlock description.
</Function>
<Function name='GetRequirement' return='UnlockRequirement' arguments=''>
Returns the UnlockRequirement.
</Function>
<Function name='GetRequirePassHardSteps' return='bool' arguments=''>
Returns <code>true</code> if the UnlockEntry requires you to pass Hard steps.
</Function>
<Function name='GetRequirePassChallengeSteps' return='bool' arguments=''>
Returns <code>true</code> if the UnlockEntry requires you to pass Challenge steps.
</Function>
<Function name='GetSong' return='Song' arguments=''>
Returns the Song related to the UnlockEntry.
</Function>
<Function name='GetStepByStepsType' return='Steps' arguments=''>
Get all of the steps locked based on StepsType.
</Function>
<Function name='GetStepOfAllTypes' return='{Steps}' arguments=''>
Get all of the steps locked based on difficulty.
</Function>
<Function name='GetUnlockRewardType' return='UnlockRewardType' arguments=''>
Returns the UnlockRewardType for this entry.
</Function>
<Function name='IsLocked' return='bool' arguments=''>
Returns <code>true</code> if the UnlockEntry is locked.
</Function>
<Function name='mod' return='void' arguments='string sModifier'>
Sets the UnlockEntry's modifier to <code>sModifier</code>.
</Function>
<Function name='require' return='void' arguments='UnlockRequirement ut, float m_fRequirement'>
Sets the requirement for this unlock to <code>m_fRequirement</code>.
</Function>
<Function name='requirepasshardsteps' return='void' arguments=''>
Makes the UnlockEntry require passing Hard steps.
</Function>
<Function name='requirepasschallengesteps' return='void' arguments=''>
Makes the UnlockEntry require passing Challenge steps.
</Function>
<Function name='roulette' return='void' arguments=''>
Makes the UnlockEntry hide in Roulette.
</Function>
<Function name='song' return='void' arguments='string sSongName'>
Sets the UnlockEntry's song to <code>sSongName</code>. <code>sSongName</code> also requires the group.<br />
Example: <code>song,"In The Groove/Pandemonium"</code>
</Function>
<Function name='steps' return='void' arguments='string sSong, string sSteps'>
Sets the UnlockEntry to unlock a specified song's steps.<br />
Example: <code>steps,"In The Groove/Pandemonium","expert"</code>
</Function>
<Function name='steps_type' return='void' arguments='string sSong, string sSteps, string sStepsType'>
Sets the UnlockEntry to unlock a specified song's stepstype.
</Function>
</Class>
<Class name='UnlockManager'>
<Function name='AnyUnlocksToCelebrate' return='bool' arguments=''>
Returns <code>true</code> if there are any unlocks to celebrate.
</Function>
<Function name='FindEntryID' return='string' arguments='string sName'>
Returns the associated EntryID.
</Function>
<Function name='GetNumUnlocked' return='int' arguments=''>
Returns the number of unlocked items.
</Function>
<Function name='GetNumUnlocks' return='int' arguments=''>
Returns the number of all unlock items, regardless of status.
</Function>
<Function name='GetPoints' return='float' arguments='UnlockRequirement ur' >
Returns the number of points for the machine profile based on the specified UnlockRequirement.
</Function>
<Function name='GetPointsForProfile' return='float' arguments='Profile p, UnlockRequirement ur' >
Returns the number of points for the specified profile based on the specified UnlockRequirement.
</Function>
<Function name='GetPointsUntilNextUnlock' return='float' arguments='UnlockRequirement ut'>
Returns the number of points until the next unlock.
</Function>
<Function name='GetSongsUnlockedByEntryID' return='{Song}' arguments='string sEntryID'>
Returns a table of songs unlocked by UnlockEntry <code>sEntryID</code>.
</Function>
<Function name='GetStepsUnlockedByEntryID' return='{Steps}' arguments='string sEntryID'>
Returns a table of steps unlocked by UnlockEntry <code>sEntryID</code>.
</Function>
<Function name='GetUnlockEntry' return='UnlockEntry' arguments='int iIndex'>
Returns the UnlockEntry at <code>iIndex</code>.
</Function>
<Function name='GetUnlockEntryIndexToCelebrate' return='int' arguments=''>
Returns the UnlockEntry index to celebrate.
</Function>
<Function name='PreferUnlockEntryID' return='void' arguments='string sUnlockEntryID'>
Sets the preferred Song/Course to the specified <code>sUnlockEntryID</code>
</Function>
<Function name='UnlockEntryID' return='void' arguments='string sUnlockEntryID'>
Unlocks an entry by ID.
</Function>
<Function name='UnlockEntryIndex' return='void' arguments='int iUnlockEntryID'>
Unlocks an entry by index.
</Function>
<Function name='IsSongLocked' return='int' arguments='Song pSong'>
Determines if a song is locked by any means. The number returned determines
how the song is locked.
</Function>
</Class>
<Class name='WheelBase'>
<Function name='GetCurrentIndex' return='int' arguments=''>
Returns the wheel's current index.
</Function>
<Function name='GetNumItems' return='int' arguments=''>
Returns the total number of items in the wheel.
</Function>
<Function name='GetSelectedType' return='WheelItemDataType' arguments=''>
Returns the WheelItemDataType of the selected item.
</Function>
<Function name='GetWheelItem' return='WheelItemBase' arguments='int iIndex'>
Returns the WheelItem at index <code>iIndex</code>.
</Function>
<Function name='IsLocked' return='bool' arguments=''>
Returns <code>true</code> if the wheel is locked.
</Function>
<Function name='IsSettled' return='bool' arguments=''>
Returns <code>true</code> if the wheel is settled/stopped moving.
</Function>
<Function name='Move' return='void' arguments='int n'>
Moves the wheel by <code>n</code>.
</Function>
<Function name='SetOpenSection' return='void' arguments='string sSection'>
Attempts to set the open section to <code>sSection</code>.
</Function>
</Class>
<Class name='WheelItemBase'>
<Function name='GetColor' return='color' arguments=''>
Returns the color of this wheel item.
</Function>
<Function name='GetText' return='string' arguments=''>
Returns the text of this wheel item.
</Function>
<Function name='GetType' return='WheelItemDataType' arguments=''>
Returns the type of this wheel item.
</Function>
</Class>
<Class name='WorkoutGraph'>
<Function name='SetFromCurrentWorkout' return='void' arguments=''>
Sets the WorkoutGraph from the current Workout.
</Function>
<Function name='SetFromGameStateAndHighlightSong' return='void' arguments='int iSongIndex'>
Sets the WorkoutGraph from GameState and song index <code>iSongIndex</code>.
</Function>
</Class>
</Classes>
<!-- Enums -->
<Enums>
<Enum name='BlendMode'>
<Description>
Blending modes. See <Link class='Actor' function='blend' />.
</Description>
</Enum>
<Enum name='HorizAlign'>
<Description>
Horizontal alignment. See <Link class='Actor' function='horizalign' />.
</Description>
</Enum>
<Enum name='VertAlign'>
<Description>
Vertical alignment. See <Link class='Actor' function='vertalign' />.
</Description>
</Enum>
</Enums>
</Documentation>
Reference in New Issue View Git Blame Copy Permalink