update luadocs
This commit is contained in:
+58
-16
@@ -38,11 +38,21 @@
|
||||
<Function name='FormatNumberAndSuffix'/>
|
||||
<Function name='FormatPercentScore'/>
|
||||
<Function name='GameCompatibleModes'/>
|
||||
<Function name='GamePrefAdjustSpeed'/>
|
||||
<Function name='GamePrefAutoSetStyle'/>
|
||||
<Function name='GamePrefComboOnRolls'/>
|
||||
<Function name='GamePrefComboUnderField'/>
|
||||
<Function name='GamePrefNotePosition'/>
|
||||
<Function name='GetCoursesToShowRanking'/>
|
||||
<Function name='GetCustomDifficulty'/>
|
||||
<Function name='GetDefaultArrowSpacing'/>
|
||||
<Function name='GetDefaultOptionLines'/>
|
||||
<Function name='GetEditModeSubScreens'/>
|
||||
<Function name='GetExtraColorThreshold'/>
|
||||
<Function name='GetGamePref'/>
|
||||
<Function name='GetGamePrefB'/>
|
||||
<Function name='GetGamePrefC'/>
|
||||
<Function name='GetGamePrefN'/>
|
||||
<Function name='GetGradeFromPercent'/>
|
||||
<Function name='GetLifeDifficulty'/>
|
||||
<Function name='GetOSName'/>
|
||||
@@ -55,6 +65,7 @@
|
||||
<Function name='GetSongBackground'/>
|
||||
<Function name='GetTapPosition'/>
|
||||
<Function name='GetThemeAspectRatio'/>
|
||||
<Function name='GetThemePref'/>
|
||||
<Function name='GetTimingDifficulty'/>
|
||||
<Function name='GetUnlockEntryIndexToCelebrate'/>
|
||||
<Function name='GetUserPref'/>
|
||||
@@ -72,6 +83,7 @@
|
||||
<Function name='Hour'/>
|
||||
<Function name='Hue'/>
|
||||
<Function name='ImmediateHoldLetGo'/>
|
||||
<Function name='InitGamePrefs'/>
|
||||
<Function name='InitUserPrefs'/>
|
||||
<Function name='InitialHoldLife'/>
|
||||
<Function name='IsArcade'/>
|
||||
@@ -79,6 +91,7 @@
|
||||
<Function name='IsHome'/>
|
||||
<Function name='IsNetConnected'/>
|
||||
<Function name='IsNetSMOnline'/>
|
||||
<Function name='IsRoutine'/>
|
||||
<Function name='IsSMOnlineLoggedIn'/>
|
||||
<Function name='IsUsingWideScreen'/>
|
||||
<Function name='JudgmentLineToColor'/>
|
||||
@@ -110,13 +123,17 @@
|
||||
<Function name='PlayerNumberToLocalizedString'/>
|
||||
<Function name='PlayerNumberToString'/>
|
||||
<Function name='PlayerScoreColor'/>
|
||||
<Function name='PrintTable'/>
|
||||
<Function name='ProductID'/>
|
||||
<Function name='ProductVersion'/>
|
||||
<Function name='RadarCategoryToLocalizedString'/>
|
||||
<Function name='ReadGamePrefFromFile'/>
|
||||
<Function name='ReadPrefFromFile'/>
|
||||
<Function name='ReportStyle'/>
|
||||
<Function name='ResolveRelativePath'/>
|
||||
<Function name='RollBodyIncrementsCombo'/>
|
||||
<Function name='RoutineSkinP1'/>
|
||||
<Function name='RoutineSkinP2'/>
|
||||
<Function name='SMOnlineScreen'/>
|
||||
<Function name='Saturation'/>
|
||||
<Function name='ScoreKeeperClass'/>
|
||||
@@ -131,6 +148,8 @@
|
||||
<Function name='SelectMusicOrCourse'/>
|
||||
<Function name='SelectProfileKeys'/>
|
||||
<Function name='Serialize'/>
|
||||
<Function name='SetGamePref'/>
|
||||
<Function name='SetThemePref'/>
|
||||
<Function name='SetUserPref'/>
|
||||
<Function name='ShowHoldJudgments'/>
|
||||
<Function name='ShowStandardDecoration'/>
|
||||
@@ -149,11 +168,13 @@
|
||||
<Function name='TableStringLookup'/>
|
||||
<Function name='TapNoteScoreToLocalizedString'/>
|
||||
<Function name='TextBannerAfterSet'/>
|
||||
<Function name='ThemePrefRow'/>
|
||||
<Function name='ToEnumShortString'/>
|
||||
<Function name='Trace'/>
|
||||
<Function name='TrailToCustomDifficulty'/>
|
||||
<Function name='URLEncode'/>
|
||||
<Function name='UnlockRewardTypeToLocalizedString'/>
|
||||
<Function name='UserPrefAdjustSpeed'/>
|
||||
<Function name='UserPrefAutoSetStyle'/>
|
||||
<Function name='UserPrefComboOnRolls'/>
|
||||
<Function name='UserPrefComboUnderField'/>
|
||||
@@ -163,6 +184,7 @@
|
||||
<Function name='UserPrefLongFail'/>
|
||||
<Function name='UserPrefNotePosition'/>
|
||||
<Function name='UserPrefShowLotsaOptions'/>
|
||||
<Function name='UserPrefSpecialScoringMode'/>
|
||||
<Function name='Var'/>
|
||||
<Function name='VersionDate'/>
|
||||
<Function name='VersionTime'/>
|
||||
@@ -170,6 +192,7 @@
|
||||
<Function name='Weekday'/>
|
||||
<Function name='WideScale'/>
|
||||
<Function name='WrapInActorFrame'/>
|
||||
<Function name='WriteGamePrefToFile'/>
|
||||
<Function name='WritePrefToFile'/>
|
||||
<Function name='Year'/>
|
||||
<Function name='assert'/>
|
||||
@@ -180,6 +203,7 @@
|
||||
<Function name='dofile'/>
|
||||
<Function name='error'/>
|
||||
<Function name='fapproach'/>
|
||||
<Function name='foreach_ordered'/>
|
||||
<Function name='gcinfo'/>
|
||||
<Function name='getenv'/>
|
||||
<Function name='getfenv'/>
|
||||
@@ -286,6 +310,7 @@
|
||||
<Function name='basezoomx'/>
|
||||
<Function name='basezoomy'/>
|
||||
<Function name='basezoomz'/>
|
||||
<Function name='bezier'/>
|
||||
<Function name='blend'/>
|
||||
<Function name='bob'/>
|
||||
<Function name='bounce'/>
|
||||
@@ -493,6 +518,8 @@
|
||||
<Function name='SetFromGameState'/>
|
||||
</Class>
|
||||
<Class base='Sprite' name='Banner'>
|
||||
<Function name='GetPercentScrolling'/>
|
||||
<Function name='GetScrolling'/>
|
||||
<Function name='LoadBackgroundFromUnlockEntry'/>
|
||||
<Function name='LoadBannerFromUnlockEntry'/>
|
||||
<Function name='LoadCardFromCharacter'/>
|
||||
@@ -500,8 +527,10 @@
|
||||
<Function name='LoadFromCourse'/>
|
||||
<Function name='LoadFromSong'/>
|
||||
<Function name='LoadFromSongGroup'/>
|
||||
<Function name='LoadFromSortOrder'/>
|
||||
<Function name='LoadIconFromCharacter'/>
|
||||
<Function name='ScaleToClipped'/>
|
||||
<Function name='SetScrolling'/>
|
||||
<Function name='scaletoclipped'/>
|
||||
</Class>
|
||||
<Class base='Actor' name='BitmapText'>
|
||||
@@ -600,6 +629,7 @@
|
||||
<Function name='Unset'/>
|
||||
</Class>
|
||||
<Class base='ActorFrame' name='FadingBanner'>
|
||||
<Function name='GetLatestIndex'/>
|
||||
<Function name='LoadCardFromCharacter'/>
|
||||
<Function name='LoadFromCourse'/>
|
||||
<Function name='LoadFromSong'/>
|
||||
@@ -608,18 +638,20 @@
|
||||
<Function name='ScaleToClipped'/>
|
||||
<Function name='scaletoclipped'/>
|
||||
</Class>
|
||||
<Class name='Game'>
|
||||
<Function name='GetName'/>
|
||||
</Class>
|
||||
<Class name='GameCommand'>
|
||||
<Function name='GetCharacter'/>
|
||||
<Function name='GetCourse'/>
|
||||
<Function name='GetIndex'/>
|
||||
<Function name='GetMultiPlayer'/>
|
||||
<Function name='GetName'/>
|
||||
<Function name='GetProfileID'/>
|
||||
<Function name='GetScreen'/>
|
||||
<Function name='GetSong'/>
|
||||
<Function name='GetSongGroup'/>
|
||||
<Function name='GetSteps'/>
|
||||
<Function name='GetStyle'/>
|
||||
<Function name='GetText'/>
|
||||
<Function name='GetTrail'/>
|
||||
<Function name='GetUrl'/>
|
||||
</Class>
|
||||
<Class name='GameManager'>
|
||||
@@ -638,6 +670,7 @@
|
||||
<Function name='ClearStageModifiersIllegalForCourse'/>
|
||||
<Function name='EnoughCreditsToJoin'/>
|
||||
<Function name='Env'/>
|
||||
<Function name='GetCharacter'/>
|
||||
<Function name='GetCoinMode'/>
|
||||
<Function name='GetCoins'/>
|
||||
<Function name='GetCoinsNeededToJoin'/>
|
||||
@@ -710,6 +743,7 @@
|
||||
<Function name='PlayersCanJoin'/>
|
||||
<Function name='Reset'/>
|
||||
<Function name='SaveLocalData'/>
|
||||
<Function name='SetCharacter'/>
|
||||
<Function name='SetCurrentCourse'/>
|
||||
<Function name='SetCurrentSong'/>
|
||||
<Function name='SetCurrentSteps'/>
|
||||
@@ -776,10 +810,8 @@
|
||||
<Function name='GetTotalLives'/>
|
||||
</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'/>
|
||||
@@ -792,9 +824,6 @@
|
||||
<Class name='MessageManager'>
|
||||
<Function name='Broadcast'/>
|
||||
</Class>
|
||||
<Class base='ActorFrame' name='MeterDisplay'>
|
||||
<Function name='SetStreamWidth'/>
|
||||
</Class>
|
||||
<Class base='ActorFrame' name='ModIconRow'>
|
||||
<Function name='Load'/>
|
||||
</Class>
|
||||
@@ -869,6 +898,7 @@
|
||||
<Function name='GetTapNoteScores'/>
|
||||
<Function name='IsDisqualified'/>
|
||||
<Function name='MaxCombo'/>
|
||||
<Function name='SetScore'/>
|
||||
</Class>
|
||||
<Class name='PlayerState'>
|
||||
<Function name='GetHealthState'/>
|
||||
@@ -896,6 +926,7 @@
|
||||
<Function name='GetGoalSeconds'/>
|
||||
<Function name='GetGoalType'/>
|
||||
<Function name='GetHighScoreList'/>
|
||||
<Function name='GetLastUsedHighScoreName'/>
|
||||
<Function name='GetMostPopularCourse'/>
|
||||
<Function name='GetMostPopularSong'/>
|
||||
<Function name='GetNumToasties'/>
|
||||
@@ -923,6 +954,7 @@
|
||||
<Function name='GetWeightPounds'/>
|
||||
<Function name='HasPassedAnyStepsInSong'/>
|
||||
<Function name='IsCodeUnlocked'/>
|
||||
<Function name='SetCharacter'/>
|
||||
<Function name='SetGoalCalories'/>
|
||||
<Function name='SetGoalSeconds'/>
|
||||
<Function name='SetGoalType'/>
|
||||
@@ -939,8 +971,6 @@
|
||||
<Function name='GetProfileDir'/>
|
||||
<Function name='IsPersistentProfile'/>
|
||||
<Function name='IsSongNew'/>
|
||||
<Function name='LastLoadWasFromLastGood'/>
|
||||
<Function name='LastLoadWasTamperedOrCorrupt'/>
|
||||
<Function name='SaveMachineProfile'/>
|
||||
</Class>
|
||||
<Class name='RadarValues'>
|
||||
@@ -990,11 +1020,15 @@
|
||||
<Function name='FinishRenderingTo'/>
|
||||
</Class>
|
||||
<Class base='BitmapText' name='RollingNumbers'>
|
||||
<Function name='Load'/>
|
||||
<Function name='targetnumber'/>
|
||||
</Class>
|
||||
<Class base='BitmapText' name='ScoreDisplayAliveTime'/>
|
||||
<Class base='BitmapText' name='ScoreDisplayCalories'/>
|
||||
<Class base='ScreenWithMenuElements' name='ScreenAttract'/>
|
||||
<Class base='ScreenWithMenuElements' name='ScreenEdit'>
|
||||
<Function name='GetEditState'/>
|
||||
</Class>
|
||||
<Class base='ScreenWithMenuElements' name='ScreenEvaluation'>
|
||||
<Function name='GetStageStats'/>
|
||||
</Class>
|
||||
@@ -1132,6 +1166,7 @@
|
||||
<Function name='GetSongFromSteps'/>
|
||||
<Function name='GetSongGroupColor'/>
|
||||
<Function name='GetSongGroupNames'/>
|
||||
<Function name='GetSongRank'/>
|
||||
<Function name='GetSongsInGroup'/>
|
||||
<Function name='SetPreferredCourses'/>
|
||||
<Function name='SetPreferredSongs'/>
|
||||
@@ -1150,6 +1185,7 @@
|
||||
<Function name='LoadFromCurrentSongBackground'/>
|
||||
<Function name='LoadFromSongBackground'/>
|
||||
<Function name='LoadFromSongBanner'/>
|
||||
<Function name='SetAllStateDelays'/>
|
||||
<Function name='SetCustomImageRect'/>
|
||||
<Function name='SetEffectMode'/>
|
||||
<Function name='SetTexture'/>
|
||||
@@ -1210,9 +1246,11 @@
|
||||
<Function name='setfromgamestate'/>
|
||||
</Class>
|
||||
<Class name='Style'>
|
||||
<Function name='ColumnsPerPlayer'/>
|
||||
<Function name='GetName'/>
|
||||
<Function name='GetStepsType'/>
|
||||
<Function name='GetStyleType'/>
|
||||
<Function name='NeedsZoomOutWith2Players'/>
|
||||
</Class>
|
||||
<Class base='ActorFrame' name='TextBanner'>
|
||||
<Function name='Load'/>
|
||||
@@ -1251,14 +1289,12 @@
|
||||
</Class>
|
||||
<Class name='Trail'>
|
||||
<Function name='GetArtists'/>
|
||||
<Function name='GetDescription'/>
|
||||
<Function name='GetDifficulty'/>
|
||||
<Function name='GetEntries'/>
|
||||
<Function name='GetMeter'/>
|
||||
<Function name='GetRadarValues'/>
|
||||
<Function name='GetStepsType'/>
|
||||
<Function name='GetTrailEntries'/>
|
||||
<Function name='GetTrailEntry'/>
|
||||
<Function name='IsAPlayerEdit'/>
|
||||
</Class>
|
||||
<Class name='TrailEntry'>
|
||||
<Function name='GetNormalModifiers'/>
|
||||
@@ -1426,6 +1462,12 @@
|
||||
<EnumValue name=''EditMode_Home'' value='2'/>
|
||||
<EnumValue name=''EditMode_Full'' value='3'/>
|
||||
</Enum>
|
||||
<Enum name='EditState'>
|
||||
<EnumValue name=''EditState_Edit'' value='0'/>
|
||||
<EnumValue name=''EditState_Record'' value='1'/>
|
||||
<EnumValue name=''EditState_RecordPaused'' value='2'/>
|
||||
<EnumValue name=''EditState_Playing'' value='3'/>
|
||||
</Enum>
|
||||
<Enum name='EffectMode'>
|
||||
<EnumValue name=''EffectMode_Normal'' value='0'/>
|
||||
<EnumValue name=''EffectMode_Unpremultiply'' value='1'/>
|
||||
@@ -1896,9 +1938,9 @@
|
||||
<Constant name='left' value=''HorizAlign_Left''/>
|
||||
<Constant name='middle' value=''VertAlign_Middle''/>
|
||||
<Constant name='right' value=''HorizAlign_Right''/>
|
||||
<Constant name='sGame' value=''kb7''/>
|
||||
<Constant name='sGame' value=''dance''/>
|
||||
<Constant name='top' value=''VertAlign_Top''/>
|
||||
</Constants>
|
||||
<Version>sm-ssc v1.0</Version>
|
||||
<Date>2010-09-10</Date>
|
||||
<Version>sm-ssc v1.2</Version>
|
||||
<Date>2011-01-08</Date>
|
||||
</Lua>
|
||||
|
||||
@@ -510,12 +510,18 @@
|
||||
<Function name='baserotationz' return='void' arguments='float rot'>
|
||||
Sets the Actor's base Z rotation to <code>rot</code>.
|
||||
</Function>
|
||||
<Function name='basezoom' sm-ssc='true' 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' sm-ssc='true' 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>
|
||||
@@ -657,7 +663,7 @@
|
||||
<Function name='GetEffectDelta' return='float' arguments=''>
|
||||
Returns the Actor's current effect delta.
|
||||
</Function>
|
||||
<Function name='geteffectfagnitude' return='float' arguments=''>
|
||||
<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' sm-ssc='true' return='color' arguments=''>
|
||||
@@ -711,6 +717,9 @@
|
||||
<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>
|
||||
<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>
|
||||
@@ -732,6 +741,12 @@
|
||||
<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>
|
||||
<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>
|
||||
@@ -862,6 +877,9 @@
|
||||
Zooms the Actor to <code>zoom</code> scale on the Z axis.
|
||||
</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='CenterX' theme='_fallback' return='void' arguments=''>
|
||||
[03 ProductivityHelpers.lua] Centers an Actor on the X axis. (equivalent to <code>x,SCREEN_CENTER_X</code>)
|
||||
</Function>
|
||||
@@ -1101,6 +1119,12 @@
|
||||
</Function>
|
||||
</Class>
|
||||
<Class name='Banner'>
|
||||
<Function name='GetScrolling' sm-ssc='true' return='bool' arguments=''>
|
||||
Returns <code>true</code> if the Banner is currently scrolling.
|
||||
</Function>
|
||||
<Function name='GetPercentScrolling' sm-ssc='true' return='float' arguments=''>
|
||||
<!-- todo -->
|
||||
</Function>
|
||||
<Function name='LoadBackgroundFromUnlockEntry' return='void' arguments='UnlockEntry pUE'>
|
||||
Loads the background from an UnlockEntry.
|
||||
</Function>
|
||||
@@ -1122,6 +1146,9 @@
|
||||
<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>
|
||||
@@ -1131,6 +1158,9 @@
|
||||
<Function name='ScaleToClipped' return='void' arguments='float fWidth, float fHeight'>
|
||||
See <Link class='Sprite' function='scaletoclipped' />.
|
||||
</Function>
|
||||
<Function name='SetScrolling' sm-ssc='true' return='void' arguments='bool bScroll'>
|
||||
<!-- todo -->
|
||||
</Function>
|
||||
</Class>
|
||||
<Class name='BitmapText'>
|
||||
<Function name='AddAttribute' return='void' arguments='int iPos, Attribute attr'>
|
||||
@@ -1413,6 +1443,12 @@
|
||||
</Function>
|
||||
</Class>
|
||||
<Class name='GameCommand'>
|
||||
<Function name='GetCharacter' sm-ssc='true' return='Character' arguments=''>
|
||||
Returns any Character associated with this item (or <code>nil</code> if there isn't one).
|
||||
</Function>
|
||||
<Function name='GetCourse' sm-ssc='true' return='Course' arguments=''>
|
||||
Returns any Course that may have been set.
|
||||
</Function>
|
||||
<Function name='GetIndex' return='int' arguments=''>
|
||||
Returns the index of this item.
|
||||
</Function>
|
||||
@@ -1425,18 +1461,27 @@
|
||||
<Function name='GetProfileID' return='string' arguments=''>
|
||||
Returns any Profile ID that may have been set.
|
||||
</Function>
|
||||
<Function name='GetScreen' sm-ssc='true' 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='GetSteps' sm-ssc='true' 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' sm-ssc='true' return='Trail' arguments=''>
|
||||
Returns any Trail that may have been set.
|
||||
</Function>
|
||||
<Function name='GetUrl' sm-ssc='true' return='string' arguments=''>
|
||||
Returns any Url that may have been set.
|
||||
</Function>
|
||||
@@ -1479,6 +1524,9 @@
|
||||
<Function name='Env' return='table' arguments=''>
|
||||
Returns the environment table. See <Link class='GameCommand' />.
|
||||
</Function>
|
||||
<Function name='GetCharacter' sm-ssc='true' 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>
|
||||
@@ -1710,6 +1758,9 @@
|
||||
<Function name='SaveLocalData' return='void' arguments=''>
|
||||
Saves the bookkeeping and machine profile data.
|
||||
</Function>
|
||||
<Function name='SetCharacter' sm-ssc='true' 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>
|
||||
@@ -1860,6 +1911,9 @@
|
||||
<Function name='GetLivesLeft' sm-ssc='true' return='int' arguments=''>
|
||||
Returns the number of lives remaining.
|
||||
</Function>
|
||||
<Function name='GetTotalLives' sm-ssc='true' return='int' arguments=''>
|
||||
|
||||
</Function>
|
||||
</Class>
|
||||
<Class name='MemoryCardManager'>
|
||||
<Function name='GetCardLocked' sm-ssc='true' return='bool' arguments='PlayerNumber pn'>
|
||||
@@ -2109,6 +2163,9 @@
|
||||
<Function name='IsDisqualified' return='bool' arguments=''>
|
||||
Returns <code>true</code> if the player was disqualified from ranking.
|
||||
</Function>
|
||||
<Function name='SetScore' sm-ssc='true' return='void' arguments='int iScore'>
|
||||
Sets the Player's score to <code>iScore</code>.
|
||||
</Function>
|
||||
</Class>
|
||||
<Class name='PlayerState'>
|
||||
<Function name='GetHealthState' sm-ssc='true' return='HealthState' arguments=''>
|
||||
@@ -2250,6 +2307,9 @@
|
||||
<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' sm-ssc='true' 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>
|
||||
@@ -2414,6 +2474,9 @@
|
||||
</Function>
|
||||
</Class>
|
||||
<Class name='RollingNumbers'>
|
||||
<Function name='Load' sm-ssc='true' 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>
|
||||
@@ -2432,6 +2495,11 @@
|
||||
Posts a message with the text <code>sScreenMsg</code> to the Screen.
|
||||
</Function>
|
||||
</Class>
|
||||
<Class name='ScreenEdit'>
|
||||
<Function name='GetEditState' sm-ssc='true' 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.
|
||||
@@ -2737,7 +2805,7 @@
|
||||
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>.
|
||||
Returns the course color of Course <code>c</code>.
|
||||
</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)
|
||||
@@ -2773,7 +2841,7 @@
|
||||
Returns a random song.
|
||||
</Function>
|
||||
<Function name='GetSongColor' return='color' arguments='Song s'>
|
||||
Returns the song color of song <code>s</code>.
|
||||
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>.
|
||||
@@ -2785,6 +2853,9 @@
|
||||
<Function name='GetSongGroupNames' sm-ssc='true' return='{string}' arguments=''>
|
||||
Returns a table containing all of the song group names.
|
||||
</Function>
|
||||
<Function name='GetSongRank' sm-ssc='true' return='int' arguments='Song s'>
|
||||
Returns the rank (popularity) of Song <code>s</code>.
|
||||
</Function>
|
||||
<Function name='GetSongsInGroup' sm-ssc='true' return='{Song}' arguments='string sGroupName'>
|
||||
Returns a table containing all of the songs in group <code>sGroupName</code>.
|
||||
</Function>
|
||||
@@ -2872,6 +2943,9 @@
|
||||
<Function name='cropto' theme='_fallback' return='void' arguments='float fWidth, float fHeight'>
|
||||
[01 alias.lua] Alias for CropTo.
|
||||
</Function>
|
||||
<Function name='SetAllStateDelays' sm-ssc='true' 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=''>
|
||||
@@ -2983,6 +3057,9 @@
|
||||
</Function>
|
||||
</Class>
|
||||
<Class name='Style'>
|
||||
<Function name='ColumnsPerPlayer' sm-ssc='true' return='int' arguments=''>
|
||||
Returns the number of total tracks 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>
|
||||
@@ -2992,6 +3069,9 @@
|
||||
<Function name='GetStyleType' return='StyleType' arguments=''>
|
||||
Returns the StyleType for this Style.
|
||||
</Function>
|
||||
<Function name='NeedsZoomOutWith2Players' sm-ssc='true' 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'>
|
||||
@@ -3093,7 +3173,7 @@
|
||||
<Function name='GetDifficulty' return='Difficulty' arguments=''>
|
||||
Returns the Trail's difficulty.
|
||||
</Function>
|
||||
<Function name='GetEntries' sm-ssc='true' return='{TrailEntry}' arguments=''>
|
||||
<Function name='GetTrailEntries' sm-ssc='true' return='{TrailEntry}' arguments=''>
|
||||
Returns a table of TrailEntry items.
|
||||
</Function>
|
||||
<Function name='GetMeter' return='int' arguments=''>
|
||||
@@ -3120,7 +3200,7 @@
|
||||
Returns the Steps used in this TrailEntry.
|
||||
</Function>
|
||||
<Function name='IsSecret' sm-ssc='true' return='bool' arguments=''>
|
||||
(why'd I think this was a good idea when we have CourseEntry:IsSecret?)
|
||||
(why'd I think this was a good idea when we have <Link class='CourseEntry' function='IsSecret' />?)
|
||||
</Function>
|
||||
</Class>
|
||||
<Class name='UnlockEntry'>
|
||||
|
||||
Reference in New Issue
Block a user