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

luadocs checkpoint

Browse Source
This commit is contained in:
AJ Kelly
2011-07-04 15:56:22 -05:00
parent 3d6828eb67
commit d5e19e42ce
2 changed files with 198 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Luadoc/Lua.xml
+6 -4
View File
@@ -153,6 +153,7 @@
<Function name='SelectMusicOrCourse'/>
<Function name='SelectProfileKeys'/>
<Function name='Serialize'/>
<Function name='SetFail'/>
<Function name='SetGamePref'/>
<Function name='SetThemePref'/>
<Function name='SetUserPref'/>
@@ -932,6 +933,7 @@
<Function name='GetMines'/>
<Function name='GetMini'/>
<Function name='GetMirror'/>
<Function name='GetNoAttacks'/>
<Function name='GetNoFakes'/>
<Function name='GetNoHands'/>
<Function name='GetNoHolds'/>
@@ -1477,8 +1479,8 @@
<Function name='GetCode'/>
<Function name='GetCourse'/>
<Function name='GetDescription'/>
<Function name='GetRequirePassHardSteps'/>
<Function name='GetRequirePassChallengeSteps'/>
<Function name='GetRequirePassHardSteps'/>
<Function name='GetRequirement'/>
<Function name='GetSong'/>
<Function name='GetUnlockRewardType'/>
@@ -2130,9 +2132,9 @@
<Constant name='left' value='&apos;HorizAlign_Left&apos;'/>
<Constant name='middle' value='&apos;VertAlign_Middle&apos;'/>
<Constant name='right' value='&apos;HorizAlign_Right&apos;'/>
<Constant name='sGame' value='&apos;pump&apos;'/>
<Constant name='sGame' value='&apos;dance&apos;'/>
<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants>
<Version>StepMania 5 v5.0 Preview 1a</Version>
<Date>2011-06-24</Date>
<Version>StepMania 5 v5.0 Preview 2</Version>
<Date>2011-07-04</Date>
</Lua>
Docs/Luadoc/LuaDocumentation.xml
+192 -21
View File
@@ -23,6 +23,9 @@
<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'>
[03 HSV.lua] Returns a <code>color</code> with the specified alpha.
</Function>
<Function name='AreStagePlayerModsForced' theme='_fallback' return='bool' arguments=''>
[02 StageMods.lua]
</Function>
@@ -36,10 +39,10 @@
Returns the base name of file path.
</Function>
<Function name='BoostColor' theme='_fallback' return='color' arguments='color c, float fBoost'>
[02 Colors.lua]
[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'>
[03 HSV.lua]
[03 HSV.lua] Modifies the brightness of the specified color.
</Function>
<Function name='Center1Player' theme='_fallback' return='bool' arguments=''>
[03 ProductivityHelpers.lua] Returns <code>true</code> if Center 1P is being used.
@@ -48,7 +51,8 @@
[03 Gameplay.lua]
</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>.
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='CloseConnection' return='void' arguments=''>
Closes any connection to an online server.
@@ -59,6 +63,21 @@
<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='' 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='' 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='' 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'>
[03 HSV.lua] Returns a hex representation for the specified color.
</Function>
<Function name='ColorToHSV' theme='_fallback' return='table' arguments='color c'>
[03 HSV.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>
@@ -68,6 +87,12 @@
<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>
@@ -77,14 +102,23 @@
<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='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='FindSelection' theme='_fallback' return='int' arguments='table list'>
[02 Utilities.lua] Return the index of a true value in <code>list</code>.
<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).
@@ -98,6 +132,12 @@
<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>
@@ -113,21 +153,45 @@
<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'>
[03 ProductivityHelpers.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=''>
[03 ProductivityHelpers.lua]
</Function>
<Function name='GetRealInverse' theme="_fallback" return='float' arguments=''>
[03 ProductivityHelpers.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='' arguments=''>
[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='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>
@@ -140,9 +204,38 @@
<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'>
[03 HSV.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'>
[03 HSV.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'>
[03 HSV.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'>
[03 HSV.lua] "Converts a set of HSV values to a color."
</Function>
<Function name='HSVToHex' theme='_fallback' return='string' arguments='table hsv'>
[03 HSV.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'>
[03 HSV.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>
@@ -206,6 +299,9 @@
<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='MonthOfYear' return='int' arguments=''>
Returns the current month of the year.
</Function>
@@ -245,6 +341,9 @@
<Function name='round' theme='_fallback' return='int' arguments='float val, int decimal'>
[02 Utilities.lua] Round a number.
</Function>
<Function name='Saturation' theme='_fallback' return='color' arguments='color c, float percent'>
[03 HSV.lua] Modifies the saturation of the specified color
</Function>
<Function name='ScoreKeeperClass' theme='_fallback' return='string' arguments=''>
[03 Gameplay.lua] Returns the primary ScoreKeeper class to use.
</Function>
@@ -275,6 +374,9 @@
<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>
@@ -367,9 +469,16 @@
<!-- 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>
@@ -414,6 +523,20 @@
</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' />.
@@ -422,9 +545,6 @@
Writes <code>sString</code> to info.txt and log.txt as
a warning. Aliased by <Link class='GLOBAL' function='Warn' />.
</Function>
<Function name='Flush' return='void' arguments='' >
Flushes log files to disk.
</Function>
</Namespace>
<Namespace name='RageFileUtil'>
<Function name='CreateRageFile' return='RageFile' arguments=''>
@@ -563,7 +683,21 @@
[02 Actor.lua]
</Function>
<Function name='Center' theme='_fallback' return='void' arguments=''>
[02 Actor.lua] Centers an Actor.
[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=''>
[03 ProductivityHelpers.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=''>
[03 ProductivityHelpers.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.
@@ -856,6 +990,9 @@
<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>
@@ -880,6 +1017,12 @@
<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>
@@ -901,19 +1044,19 @@
<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='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=''>
[03 ProductivityHelpers.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=''>
[03 ProductivityHelpers.lua] Centers an Actor on the y axis. (equivalent to <code>y,SCREEN_CENTER_Y</code>)
</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>
@@ -1166,7 +1309,7 @@
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.
@@ -1455,6 +1598,9 @@
<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>
@@ -2007,6 +2153,9 @@
</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>
@@ -2707,7 +2856,9 @@
</Function>
</Class>
<Class name='ProfileManager'>
<Function name='GetLocalProfile' return='Profile' arguments='string sProfileID' />
<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' />
@@ -2729,6 +2880,9 @@
<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>
@@ -2864,12 +3018,21 @@
<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=''>
@@ -3340,6 +3503,9 @@
<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>
@@ -3352,6 +3518,9 @@
<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>
@@ -3797,7 +3966,9 @@
<Function name='GetUnlockEntryIndexToCelebrate' return='int' arguments=''>
Returns the UnlockEntry index to celebrate.
</Function>
<Function name='PreferUnlockEntryID' return='void' arguments='string sUnlockEntryID' />
<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>