actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update Lua documentation

Browse Source
This commit is contained in:
AJ Kelly
2010-05-18 20:00:55 -05:00
parent 2c15ad7921
commit 2b365bb3cf
3 changed files with 191 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Luadoc/Lua.xml
+59 -32
View File
@@ -42,6 +42,7 @@
<Function name='GetEditModeSubScreens'/>
<Function name='GetGradeFromPercent'/>
<Function name='GetLifeDifficulty'/>
<Function name='GetOSName'/>
<Function name='GetProTiming'/>
<Function name='GetRandomSongBackground'/>
<Function name='GetScreenAspectRatio'/>
@@ -120,6 +121,7 @@
<Function name='SecondsToMSS'/>
<Function name='SecondsToMSSMsMs'/>
<Function name='SelectMusicOrCourse'/>
<Function name='SelectProfileKeys'/>
<Function name='Serialize'/>
<Function name='SetUserPref'/>
<Function name='ShowStandardDecoration'/>
@@ -215,6 +217,7 @@
<Function name='GetDiffuse'/>
<Function name='GetDiffuseAlpha'/>
<Function name='GetEffectDelta'/>
<Function name='GetHAlign'/>
<Function name='GetHeight'/>
<Function name='GetName'/>
<Function name='GetNumStates'/>
@@ -224,6 +227,7 @@
<Function name='GetRotationZ'/>
<Function name='GetSecsIntoEffect'/>
<Function name='GetTweenTimeLeft'/>
<Function name='GetVAlign'/>
<Function name='GetVisible'/>
<Function name='GetWidth'/>
<Function name='GetX'/>
@@ -240,6 +244,7 @@
<Function name='MaskSource'/>
<Function name='RunCommandsRecursively'/>
<Function name='SetHeight'/>
<Function name='SetSize'/>
<Function name='SetTextureFiltering'/>
<Function name='SetWidth'/>
<Function name='accelerate'/>
@@ -453,6 +458,12 @@
<Function name='playforplayer'/>
<Function name='stop'/>
</Class>
<Class name='AnnouncerManager'>
<Function name='DoesAnnouncerExist'/>
<Function name='GetAnnouncerNames'/>
<Function name='GetCurrentAnnouncer'/>
<Function name='SetCurrentAnnouncer'/>
</Class>
<Class base='BitmapText' name='BPMDisplay'>
<Function name='GetText'/>
<Function name='SetFromGameState'/>
@@ -728,11 +739,17 @@
<Function name='IsHot'/>
<Function name='IsInDanger'/>
</Class>
<Class base='LifeMeter' name='LifeMeterBattery'>
<Function name='GetLivesLeft'/>
</Class>
<Class name='MemoryCardManager'>
<Function name='GetCardLocked'/>
<Function name='GetCardState'/>
<Function name='GetName'/>
<Function name='IsNameAvailable'/>
</Class>
<Class base='ActorFrame' name='MenuTimer'>
<Function name='GetSeconds'/>
<Function name='pause'/>
<Function name='setseconds'/>
<Function name='silent'/>
@@ -810,6 +827,8 @@
<Function name='GetPlayedSteps'/>
<Function name='GetPossibleDancePoints'/>
<Function name='GetPossibleSteps'/>
<Function name='GetRadarActual'/>
<Function name='GetRadarPossible'/>
<Function name='GetScore'/>
<Function name='GetStageAward'/>
<Function name='GetSurvivalSeconds'/>
@@ -887,6 +906,8 @@
<Function name='GetProfileDir'/>
<Function name='IsPersistentProfile'/>
<Function name='IsSongNew'/>
<Function name='LastLoadWasFromLastGood'/>
<Function name='LastLoadWasTamperedOrCorrupt'/>
<Function name='SaveMachineProfile'/>
</Class>
<Class name='RadarValues'>
@@ -1015,6 +1036,7 @@
<Function name='GetBannerPath'/>
<Function name='GetCDTitlePath'/>
<Function name='GetDisplayArtist'/>
<Function name='GetDisplayBpms'/>
<Function name='GetDisplayFullTitle'/>
<Function name='GetDisplayMainTitle'/>
<Function name='GetDisplaySubTitle'/>
@@ -1045,6 +1067,8 @@
<Function name='HasSignificantBPMChangesOrStops'/>
<Function name='HasStepsType'/>
<Function name='HasStepsTypeAndDifficulty'/>
<Function name='IsDisplayBpmConstant'/>
<Function name='IsDisplayBpmSecret'/>
<Function name='IsEasy'/>
<Function name='IsEnabled'/>
<Function name='IsLong'/>
@@ -1183,6 +1207,7 @@
<Function name='GetElapsedTimeFromBeat'/>
<Function name='GetStops'/>
<Function name='HasBPMChanges'/>
<Function name='HasNegativeBPMs'/>
<Function name='HasStops'/>
</Class>
<Class name='Trail'>
@@ -1269,6 +1294,7 @@
</Namespace>
</Namespaces>
<Singletons>
<Singleton class='AnnouncerManager' name='ANNOUNCER'/>
<Singleton class='RageFileManager' name='FILEMAN'/>
<Singleton class='GameManager' name='GAMEMAN'/>
<Singleton class='GameState' name='GAMESTATE'/>
@@ -1706,34 +1732,35 @@
<EnumValue name='&apos;StepsType_Dance_Double&apos;' value='1'/>
<EnumValue name='&apos;StepsType_Dance_Couple&apos;' value='2'/>
<EnumValue name='&apos;StepsType_Dance_Solo&apos;' value='3'/>
<EnumValue name='&apos;StepsType_Dance_Routine&apos;' value='4'/>
<EnumValue name='&apos;StepsType_Pump_Single&apos;' value='5'/>
<EnumValue name='&apos;StepsType_Pump_Halfdouble&apos;' value='6'/>
<EnumValue name='&apos;StepsType_Pump_Double&apos;' value='7'/>
<EnumValue name='&apos;StepsType_Pump_Couple&apos;' value='8'/>
<EnumValue name='&apos;StepsType_Pump_Routine&apos;' value='9'/>
<EnumValue name='&apos;StepsType_Kb7_Single&apos;' value='10'/>
<EnumValue name='&apos;StepsType_Ez2_Single&apos;' value='11'/>
<EnumValue name='&apos;StepsType_Ez2_Double&apos;' value='12'/>
<EnumValue name='&apos;StepsType_Ez2_Real&apos;' value='13'/>
<EnumValue name='&apos;StepsType_Para_Single&apos;' value='14'/>
<EnumValue name='&apos;StepsType_Ds3ddx_Single&apos;' value='15'/>
<EnumValue name='&apos;StepsType_Bm_Single5&apos;' value='16'/>
<EnumValue name='&apos;StepsType_Bm_Double5&apos;' value='17'/>
<EnumValue name='&apos;StepsType_Bm_Single7&apos;' value='18'/>
<EnumValue name='&apos;StepsType_Bm_Double7&apos;' value='19'/>
<EnumValue name='&apos;StepsType_Maniax_Single&apos;' value='20'/>
<EnumValue name='&apos;StepsType_Maniax_Double&apos;' value='21'/>
<EnumValue name='&apos;StepsType_Techno_Single4&apos;' value='22'/>
<EnumValue name='&apos;StepsType_Techno_Single5&apos;' value='23'/>
<EnumValue name='&apos;StepsType_Techno_Single8&apos;' value='24'/>
<EnumValue name='&apos;StepsType_Techno_Double4&apos;' value='25'/>
<EnumValue name='&apos;StepsType_Techno_Double5&apos;' value='26'/>
<EnumValue name='&apos;StepsType_Pnm_Five&apos;' value='27'/>
<EnumValue name='&apos;StepsType_Pnm_Nine&apos;' value='28'/>
<EnumValue name='&apos;StepsType_Guitar_Five&apos;' value='29'/>
<EnumValue name='&apos;StepsType_Karaoke&apos;' value='30'/>
<EnumValue name='&apos;StepsType_Lights_Cabinet&apos;' value='31'/>
<EnumValue name='&apos;StepsType_Dance_Threepanel&apos;' value='4'/>
<EnumValue name='&apos;StepsType_Dance_Routine&apos;' value='5'/>
<EnumValue name='&apos;StepsType_Pump_Single&apos;' value='6'/>
<EnumValue name='&apos;StepsType_Pump_Halfdouble&apos;' value='7'/>
<EnumValue name='&apos;StepsType_Pump_Double&apos;' value='8'/>
<EnumValue name='&apos;StepsType_Pump_Couple&apos;' value='9'/>
<EnumValue name='&apos;StepsType_Pump_Routine&apos;' value='10'/>
<EnumValue name='&apos;StepsType_Kb7_Single&apos;' value='11'/>
<EnumValue name='&apos;StepsType_Ez2_Single&apos;' value='12'/>
<EnumValue name='&apos;StepsType_Ez2_Double&apos;' value='13'/>
<EnumValue name='&apos;StepsType_Ez2_Real&apos;' value='14'/>
<EnumValue name='&apos;StepsType_Para_Single&apos;' value='15'/>
<EnumValue name='&apos;StepsType_Ds3ddx_Single&apos;' value='16'/>
<EnumValue name='&apos;StepsType_Bm_Single5&apos;' value='17'/>
<EnumValue name='&apos;StepsType_Bm_Double5&apos;' value='18'/>
<EnumValue name='&apos;StepsType_Bm_Single7&apos;' value='19'/>
<EnumValue name='&apos;StepsType_Bm_Double7&apos;' value='20'/>
<EnumValue name='&apos;StepsType_Maniax_Single&apos;' value='21'/>
<EnumValue name='&apos;StepsType_Maniax_Double&apos;' value='22'/>
<EnumValue name='&apos;StepsType_Techno_Single4&apos;' value='23'/>
<EnumValue name='&apos;StepsType_Techno_Single5&apos;' value='24'/>
<EnumValue name='&apos;StepsType_Techno_Single8&apos;' value='25'/>
<EnumValue name='&apos;StepsType_Techno_Double4&apos;' value='26'/>
<EnumValue name='&apos;StepsType_Techno_Double5&apos;' value='27'/>
<EnumValue name='&apos;StepsType_Pnm_Five&apos;' value='28'/>
<EnumValue name='&apos;StepsType_Pnm_Nine&apos;' value='29'/>
<EnumValue name='&apos;StepsType_Guitar_Five&apos;' value='30'/>
<EnumValue name='&apos;StepsType_Karaoke&apos;' value='31'/>
<EnumValue name='&apos;StepsType_Lights_Cabinet&apos;' value='32'/>
</Enum>
<Enum name='StyleType'>
<EnumValue name='&apos;StyleType_OnePlayerOneSide&apos;' value='0'/>
@@ -1805,13 +1832,13 @@
<Constant name='ASPECT_SCALE_FACTOR' value='1'/>
<Constant name='NUM_PLAYERS' value='2'/>
<Constant name='SCREEN_BOTTOM' value='480'/>
<Constant name='SCREEN_CENTER_X' value='384'/>
<Constant name='SCREEN_CENTER_X' value='427'/>
<Constant name='SCREEN_CENTER_Y' value='240'/>
<Constant name='SCREEN_HEIGHT' value='480'/>
<Constant name='SCREEN_LEFT' value='0'/>
<Constant name='SCREEN_RIGHT' value='768'/>
<Constant name='SCREEN_RIGHT' value='854'/>
<Constant name='SCREEN_TOP' value='0'/>
<Constant name='SCREEN_WIDTH' value='768'/>
<Constant name='SCREEN_WIDTH' value='854'/>
<Constant name='PLAYER_1' value='&apos;PlayerNumber_P1&apos;'/>
<Constant name='PLAYER_2' value='&apos;PlayerNumber_P2&apos;'/>
<Constant name='_VERSION' value='&apos;Lua 5.1&apos;'/>
@@ -1824,5 +1851,5 @@
<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants>
<Version>sm-ssc v1.0 beta 3</Version>
<Date>2010-04-30</Date>
<Date>2010-05-18</Date>
</Lua>
Docs/Luadoc/Lua.xsl
+1 -1
View File
@@ -244,7 +244,7 @@
<legend>Function Colors</legend>
<div class="descriptionCell">Available in SM4 baseline and sm-ssc</div>
<div class="renamed">Renamed or otherwise modified in sm-ssc</div>
<div class="sm-ssc">Available in sm-ssc only (for the time being)</div>
<div class="sm-ssc">Available in sm-ssc only (compared to StepMania 4 alpha 5)</div>
<div class="_fallbackTheme">Defined in sm-ssc's _fallback theme</div>
<div class="defaultTheme">Defined in sm-ssc's default theme</div>
</fieldset>
Docs/Luadoc/LuaDocumentation.xml
+131 -1
View File
@@ -24,9 +24,24 @@
<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='AreStagePlayerModsForced' theme='_fallback' return='bool' arguments=''>
[02 StageMods.lua]
</Function>
<Function name='AreStageSongModsForced' theme='_fallback' return='bool' arguments=''>
[02 StageMods.lua]
</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]
</Function>
<Function name='Brightness' theme='_fallback' return='color' arguments='color c, float percent'>
[03 HSV.lua]
</Function>
<Function name='CheckpointsTapsSeparateJudgment' theme='_fallback' return='bool' arguments=''>
[03 Gameplay.lua]
</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>),
@@ -476,6 +491,9 @@
<!-- XXX: What is aux? -->
Returns the Actor's aux value.
</Function>
<Function name='GetBaseZoomX' return='float' arguments=''>
Returns the Actor's base X 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>
@@ -485,6 +503,9 @@
<Function name='GetDiffuseAlpha' return='float' arguments=''>
Returns the Actor's current diffusealpha.
</Function>
<Function name='GetHAlign' sm-ssc='true' 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>
@@ -503,6 +524,9 @@
<Function name='GetRotationZ' sm-ssc='true' return='float' arguments=''>
Returns the Actor's current Z rotation.
</Function>
<Function name='GetVAlign' sm-ssc='true' 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>
@@ -536,12 +560,18 @@
<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='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>
@@ -572,6 +602,12 @@
<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='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>
@@ -866,6 +902,20 @@
Stops the sound.
</Function>
</Class>
<Class name='AnnouncerManager'>
<Function name='DoesAnnouncerExist' sm-ssc='true' return='bool' arguments='string sAnnonucer'>
Returns true if Announcer <code>sAnnouncer</code> exists.
</Function>
<Function name='GetAnnouncerNames' sm-ssc='true' return='{string}' arguments=''>
Returns a table of installed announcers.
</Function>
<Function name='GetCurrentAnnouncer' sm-ssc='true' return='string' arguments=''>
Returns the current announcer's name.
</Function>
<Function name='SetCurrentAnnouncer' sm-ssc='true' return='void' arguments='string sNewAnnouncer'>
Sets the announcer to <code>sNewAnnouncer</code>.
</Function>
</Class>
<Class name='Banner'>
<Function name='LoadBackgroundFromUnlockEntry' return='void' arguments='UnlockEntry pUE'>
Loads the background from an UnlockEntry.
@@ -1574,6 +1624,11 @@
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='LifeMeter'>
<Function name='GetLife' return='float' arguments=''>
Returns the amount of life left in the LifeMeter as a float in the range 0..1.
@@ -1588,15 +1643,29 @@
Returns <code>true</code> if in danger.
</Function>
</Class>
<Class name='LifeMeterBattery'>
<Function name='GetLivesLeft' sm-ssc='true' return='int' arguments=''>
Returns the number of lives remaining.
</Function>
</Class>
<Class name='MemoryCardManager'>
<Function name='GetCardLocked' sm-ssc='true' 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' sm-ssc='true' return='string' arguments='PlayerNumber pn'>
Returns the name of the storage device.
</Function>
<Function name='IsNameAvailable' sm-ssc='true' 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='GetSeconds' sm-ssc='true' 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>
@@ -1621,6 +1690,11 @@
set to <code>nil</code>.
</Function>
</Class>
<Class name='MeterDisplay'>
<Function name='SetStreamWidth' return='void' arguments='float fWidth'>
</Function>
</Class>
<Class name='Model'>
<Function name='loop' return='void' arguments='bool bLoop'>
Controls if the model should loop or not.
@@ -1703,9 +1777,13 @@
</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'>
</Function>
</Class>
<Class name='PlayerStageStats'>
<Function name='FullCombo' return='bool' arguments=''>
@@ -1777,6 +1855,12 @@
<Function name='GetPossibleSteps' return='{Steps}' arguments=''>
Returns a table of possible steps.
</Function>
<Function name='GetRadarActual' sm-ssc='true' return='RadarValues' arguments=''>
Returns a RadarValues object representing the player's actual performance.
</Function>
<Function name='GetRadarPossible' sm-ssc='true' 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>
@@ -1985,6 +2069,12 @@
<Function name='IsSongNew' sm-ssc="true" 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='LastLoadWasFromLastGood' sm-ssc='true' 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' sm-ssc='true' 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>
@@ -2115,16 +2205,27 @@
Posts a message with the text <code>sScreenMsg</code> to the Screen.
</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>
@@ -2224,6 +2325,17 @@
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='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.
@@ -2260,6 +2372,9 @@
<Function name='GetDisplayArtist' return='string' arguments=''>
Returns the displayed artist of the song.
</Function>
<Function name='GetDisplayBpms' sm-ssc='true' return='{float,float}' arguments=''>
Returns a table containing the display BPMs.
</Function>
<Function name='GetDisplayFullTitle' return='string' arguments=''>
Returns the displayed full title of the song, including subtitle.
</Function>
@@ -2350,6 +2465,12 @@
<Function name='HasStepsType' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the song has .
</Function>
<Function name='IsDisplayBpmConstant' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the song's DisplayBPM is constant.
</Function>
<Function name='IsDisplayBpmSecret' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the song's DisplayBPM is secret.
</Function>
<Function name='IsEasy' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the song is considered easy.
</Function>
@@ -2388,6 +2509,9 @@
<Function name='GetCourseColor' return='color' arguments='Course c'>
Returns the course color of course <code>c</code>.
</Function>
<Function name='GetExtraStageInfo' return='Song, Steps' arguments='bool bExtra2, Style s'>
Returns the extra stage info 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.)
</Function>
<Function name='GetNumAdditionalCourses' return='int' arguments=''>
Returns the number of courses loaded via Additional folders.
</Function>
@@ -2510,7 +2634,7 @@
Crops the Sprite to <code>fWidth</code>x<code>fHeight</code>.
</Function>
<Function name='cropto' theme='_fallback' return='void' arguments='float fWidth, float fHeight'>
Alias for CropTo.
[01 alias.lua] Alias for CropTo.
</Function>
</Class>
<Class name='StageStats'>
@@ -2634,6 +2758,9 @@
</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>
@@ -2710,6 +2837,9 @@
<Function name='HasBPMChanges' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains BPM changes.
</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>