From 18840c97ec3dbad662194d037884a826e0e28ae9 Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Sun, 1 May 2011 23:29:36 -0500 Subject: [PATCH] update lua docs --- Docs/Luadoc/Lua.xml | 18 +- Docs/Luadoc/LuaDocumentation.xml | 375 ++++++++++++++++++++++++++----- 2 files changed, 341 insertions(+), 52 deletions(-) diff --git a/Docs/Luadoc/Lua.xml b/Docs/Luadoc/Lua.xml index 334204ea30..30d7084c15 100644 --- a/Docs/Luadoc/Lua.xml +++ b/Docs/Luadoc/Lua.xml @@ -126,6 +126,7 @@ + @@ -519,6 +520,7 @@ + @@ -595,6 +597,7 @@ + @@ -961,6 +964,7 @@ + @@ -998,6 +1002,7 @@ + @@ -1188,6 +1193,7 @@ + @@ -1221,6 +1227,7 @@ + @@ -1258,6 +1265,7 @@ + @@ -1395,6 +1403,7 @@ + @@ -1412,6 +1421,8 @@ + + @@ -1432,6 +1443,8 @@ + + @@ -2025,6 +2038,7 @@ + @@ -2065,6 +2079,6 @@ - sm-ssc v1.2.3 - 2011-03-20 + sm-ssc v1.2.5 + 2011-05-01 diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml index cf44a947be..e991e0a589 100644 --- a/Docs/Luadoc/LuaDocumentation.xml +++ b/Docs/Luadoc/LuaDocumentation.xml @@ -41,6 +41,9 @@ [03 HSV.lua] + + [03 ProductivityHelpers.lua] Returns true if Center 1P is being used. + [03 Gameplay.lua] @@ -54,9 +57,7 @@ A generic interface to Lua's garbage collector. Performs different functions based on the value of opt. - Returns a color from a string. color can be in - hex ("#FFFFFFFF") or 0..1 values ("1.0,1.0,1.0,1.0"), - in RGBA order. + Returns a color from a string. color can be in hex ("#FFFFFFFF") or 0..1 values ("1.0,1.0,1.0,1.0"), in RGBA order. [03 Gameplay.lua] Determines what TapNoteScore allows for continuing the combo. @@ -110,11 +111,20 @@ Returns the current Life Difficulty. - Returns a string representing the name of the operating system being used. (e.g. "Xbox", "Windows", "Linux", "Mac, "Unknown") + Returns a string representing the name of the operating system being used. (e.g. "Windows", "Linux", "Mac, "Unknown") [03 ThemePrefs.lua] Returns true if player pn is using ProTiming. + + [02 Utilities.lua] Returns a path to a random song background. + + + Returns the name of the currently connected server. + + + [02 Utilities.lua] Returns a path to the current songs background. + Returns the theme's aspect ratio. @@ -155,8 +165,10 @@ Returns true if connected to StepMania Online. - Returns true if Player pn is logged on to - a SMOnline server. + Returns true if Player pn is logged on to a SMOnline server. + + + [02 Branches.lua] Returns true if Routine mode is being played. [04 WidescreenHelpers.lua] Returns true if the aspect ratio is 16:10 (1.6) or higher. @@ -188,6 +200,9 @@ [02 Sprite.lua] Returns a Sprite with the current song's background. + + Returns the length of the multi-byte character string sString. + Returns the current Minute. @@ -203,12 +218,27 @@ [03 ProductivityHelpers.lua] Converts a PlayerNumber into a short string (e.g. "P1", "P2"). + + [03 ProductivityHelpers.lua] Returns either p1val or p2val depending on pn. + [00 init.lua] + + [03 ThemePrefs.lua] Prints a table's contents to the log. + + + Returns the product ID. + + + Returns the product version. + [02 ActorDef.lua] + + [04 FileUtils.lua] Reads the file at path and returns its contents. + [03 UserPreferences2.lua] (internal) Reads the specified user preference from its config file. @@ -221,9 +251,24 @@ Returns the current second. + + Converts fSecs to Minutes:Seconds:Milliseconds format using two digits for each section. + + + Converts fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Minutes (uses 1). + + + Converts fSecs to Minutes:Seconds format. + Converts fSecs to Minutes:Seconds.Milliseconds format. + + Converts fSecs to Minutes:Seconds.Milliseconds format using two digits for each section. + + + Converts fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Milliseconds (uses 3). + [02 Branches.lua] Determines the correct music/course selection screen to use and returns it. @@ -239,6 +284,9 @@ [02 ActorDef.lua] Returns true if a decoration should be shown on the current screen or not. + + [03 CustomSpeedMods.lua] Returns a Lua option row with the custom speed mods defined in SpeedMods.txt. + [02 Utilities.lua] Splits a string at every occurence of delimiter, returning a table of the results. @@ -266,6 +314,9 @@ [00 init.lua] Alias for . + + Returns a string with characters escaped for URLs. (e.g. a space becomes '%20') + [01 base.lua] Alias for lua.GetThreadVariable. @@ -278,48 +329,17 @@ [02 ActorDef.lua] Wraps the children in an ActorFrame. + + [04 FileUtils.lua] Writes buf to the file at path. + [03 UserPreferences2.lua] (internal) Writes user preference prefName to its config file with value being tostring'd. Returns the current year. - - Returns the length of the multi-byte character string sString. - - - Returns the name of the currently connected server. - - - Converts fSecs to Minutes:Seconds:Milliseconds format using two digits for each section. - - - Converts fSecs to Minutes:Seconds.Milliseconds format using two digits for each section. - - - Converts fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Milliseconds (uses 3). - - - Converts fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Minutes (uses 1). - - - Converts fSecs to Minutes:Seconds format. - - - Returns a string with characters escaped for URLs. (e.g. a space becomes '%20') - - - - [03 CustomSpeedMods.lua] Returns a Lua option row with the custom speed mods defined in SpeedMods.txt. - - - - [04 FileUtils.lua] Reads the file at path and returns its contents. - - - [04 FileUtils.lua] Writes buf to the file at path. - + [03 ThemePrefs.lua] Returns a Lua option row for ProTiming. @@ -1235,12 +1255,15 @@ - + 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. Sets the BPMDisplay from the GameState. + + Sets the BPMDisplay from the specified Song. + @@ -1341,6 +1364,9 @@ Returns the Course's . (Returns PlayMode in sm-ssc; integer in SM4) + + Returns the name of the person who scripted the Course. + Returns the total length of the Course in seconds. @@ -1863,10 +1889,10 @@ Returns the Grade of this high score. - + Return the number of HoldNoteScores that match hns. - + Returns the modifiers used for this HighScore. @@ -1875,7 +1901,7 @@ Returns the percentage of dance points associated with the high score. - + Returns the RadarValues for this HighScore. @@ -1884,9 +1910,12 @@ Returns the number of seconds survived associated with the high score. - + Return the number of TapNoteScores that match tns. + + Returns true if this high score's name uses a fill-in marker. + @@ -1928,7 +1957,7 @@ Returns the number of lives remaining. - + Returns the number of total lives. @@ -2098,9 +2127,228 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the current NoteSkin set in the PlayerOptions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Changes the player's noteskin to noteskin. + + + Returns true if the player is using reverse. (equivalent to GetReverse() == 1) + @@ -2218,6 +2466,9 @@ + + Returns the current PlayerOptions for this PlayerState. + Returns the HealthState for this PlayerState. @@ -2406,7 +2657,7 @@ Returns true if player pn's profile is persistent. - + Returns true if Song s has never been played before (according to the machine profile). @@ -2580,10 +2831,10 @@ Sets the next Screen to be loaded. - + Returns true if the game is paused. - + Pauses or unpauses the game, depending on the value of bPause. @@ -2695,6 +2946,9 @@ Returns the MusicWheel used on this screen. + + Opens the OptionsList for Player pn + [02 StageMods.lua] Sets up modifiers for course modes. @@ -2779,6 +3033,9 @@ Returns a Step object if the StepType and Difficulty exist. + + Gets the Song's origin. + Returns the song's directory. @@ -2886,6 +3143,9 @@ Returns the course color of Course c. + + Returns a table containing all of the course group names. + Returns the extra stage info (Song, Steps) for the specified Style s. (If bExtra2 is true, it will use the second Extra Stage data instead of the first. Again, Lua.xsd sucks) @@ -3250,6 +3510,9 @@ Returns true if the TimingData contains stops. + + Returns true if the TimingData contains warps. + @@ -3296,6 +3559,12 @@ Sets the UnlockEntry's course to sCourseName.
Example: course,"Driven" + + Returns the code for this unlock. + + + Returns the Course for this unlock. + Returns the unlock description. @@ -3349,6 +3618,12 @@ Returns the number of all unlock items, regardless of status. + + Returns the number of points for the machine profile based on the specified UnlockRequirement. + + + Returns the number of points for the specified profile based on the specified UnlockRequirement. + Returns the number of points until the next unlock.