From f7936671913a19a43e9fd136c5665404ce2d288f Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Sat, 8 Jan 2011 00:54:28 -0600 Subject: [PATCH] update luadocs --- Docs/Luadoc/Lua.xml | 74 ++++++++++++++++++++------ Docs/Luadoc/LuaDocumentation.xml | 90 ++++++++++++++++++++++++++++++-- 2 files changed, 143 insertions(+), 21 deletions(-) diff --git a/Docs/Luadoc/Lua.xml b/Docs/Luadoc/Lua.xml index 4c5b58b1fd..43ca47ae66 100644 --- a/Docs/Luadoc/Lua.xml +++ b/Docs/Luadoc/Lua.xml @@ -38,11 +38,21 @@ + + + + + + + + + + @@ -55,6 +65,7 @@ + @@ -72,6 +83,7 @@ + @@ -79,6 +91,7 @@ + @@ -110,13 +123,17 @@ + + + + @@ -131,6 +148,8 @@ + + @@ -149,11 +168,13 @@ + + @@ -163,6 +184,7 @@ + @@ -170,6 +192,7 @@ + @@ -180,6 +203,7 @@ + @@ -286,6 +310,7 @@ + @@ -493,6 +518,8 @@ + + @@ -500,8 +527,10 @@ + + @@ -600,6 +629,7 @@ + @@ -608,18 +638,20 @@ - - - + + + + + @@ -638,6 +670,7 @@ + @@ -710,6 +743,7 @@ + @@ -776,10 +810,8 @@ - - @@ -792,9 +824,6 @@ - - - @@ -869,6 +898,7 @@ + @@ -896,6 +926,7 @@ + @@ -923,6 +954,7 @@ + @@ -939,8 +971,6 @@ - - @@ -990,11 +1020,15 @@ + + + + @@ -1132,6 +1166,7 @@ + @@ -1150,6 +1185,7 @@ + @@ -1210,9 +1246,11 @@ + + @@ -1251,14 +1289,12 @@ - - + - @@ -1426,6 +1462,12 @@ + + + + + + @@ -1896,9 +1938,9 @@ - + - sm-ssc v1.0 - 2010-09-10 + sm-ssc v1.2 + 2011-01-08 diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml index 4bc3a19a5f..df229e3532 100644 --- a/Docs/Luadoc/LuaDocumentation.xml +++ b/Docs/Luadoc/LuaDocumentation.xml @@ -510,12 +510,18 @@ Sets the Actor's base Z rotation to rot. + + Sets the Actor's base zoom to zoom. + Sets the Actor's base X zoom to zoom. Sets the Actor's base Y zoom to zoom. + + Sets the Actor's base Z zoom to zoom. + Sets the Actor to use the specified blend mode. @@ -657,7 +663,7 @@ Returns the Actor's current effect delta. - + Returns the Actor's current effect magnitude as three floats (not one; I hate Lua.xsd). @@ -711,6 +717,9 @@ Set the fractional horizontal alignment of the Actor according to fAlign 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 for the common case. + + Hides the Actor for the specified amount of time. + [Deprecated] Compatibility alias for the hidden command, which was removed in sm-ssc. Use instead. @@ -732,6 +741,12 @@ Sets the Actor's name to sName. + + Stops the Actor's movement. (Usually used for Sprites or Models.) + + + Starts the Actor's movement. (Usually used for Sprites or Models.) + Plays a command named sCommandName. @@ -862,6 +877,9 @@ Zooms the Actor to zoom scale on the Z axis. + + [02 Actor.lua] + [03 ProductivityHelpers.lua] Centers an Actor on the X axis. (equivalent to x,SCREEN_CENTER_X) @@ -1101,6 +1119,12 @@ + + Returns true if the Banner is currently scrolling. + + + + Loads the background from an UnlockEntry. @@ -1122,6 +1146,9 @@ Loads a Banner from a specified Song Group. + + Loads a Banner from a specified SortOrder. + Loads an icon from the specified Character. @@ -1131,6 +1158,9 @@ See . + + + @@ -1413,6 +1443,12 @@ + + Returns any Character associated with this item (or nil if there isn't one). + + + Returns any Course that may have been set. + Returns the index of this item. @@ -1425,18 +1461,27 @@ Returns any Profile ID that may have been set. + + Returns any screen that may have been set as a string. + Returns any Song that may have been set. Returns the name of any song group that may have been set. + + Returns any Steps that may have been set. + Returns any Style that may have been set. Returns the display text. + + Returns any Trail that may have been set. + Returns any Url that may have been set. @@ -1479,6 +1524,9 @@ Returns the environment table. See . + + Returns the current for the specified . + Returns the current . @@ -1710,6 +1758,9 @@ Saves the bookkeeping and machine profile data. + + Sets the current for the specified . + Sets the current Course to course. @@ -1860,6 +1911,9 @@ Returns the number of lives remaining. + + + @@ -2109,6 +2163,9 @@ Returns true if the player was disqualified from ranking. + + Sets the Player's score to iScore. + @@ -2250,6 +2307,9 @@ Returns true if the specified code sUnlockEntryID is unlocked. + + Sets the current for the Profile. + Sets the goal to iCals calories. @@ -2414,6 +2474,9 @@ + + Loads the metrics for this RollingNumbers from sGroupName. + Sets the target number to f. @@ -2432,6 +2495,11 @@ Posts a message with the text sScreenMsg to the Screen. + + + Returns the current . + + Returns the current StageStats. @@ -2737,7 +2805,7 @@ Returns an array of all the installed songs. - Returns the course color of course c. + Returns the course color of Course c. 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) @@ -2773,7 +2841,7 @@ Returns a random song. - Returns the song color of song s. + Returns the song color of Song s. Returns a Song given a set of Steps st. @@ -2785,6 +2853,9 @@ Returns a table containing all of the song group names. + + Returns the rank (popularity) of Song s. + Returns a table containing all of the songs in group sGroupName. @@ -2872,6 +2943,9 @@ [01 alias.lua] Alias for CropTo. + + Sets all the state delays to fRate. Useful for Sprites that need to change by BPM (e.g. Tran from DDR 5th Mix, the cube from DS EuroMix 2). + @@ -2983,6 +3057,9 @@ + + Returns the number of total tracks this Style contains (e.g. 4 for dance-versus, but 8 for dance-double). + Returns the name of the Style. @@ -2992,6 +3069,9 @@ Returns the StyleType for this Style. + + Returns true if the Style needs to be zoomed out with two players. + @@ -3093,7 +3173,7 @@ Returns the Trail's difficulty. - + Returns a table of TrailEntry items. @@ -3120,7 +3200,7 @@ Returns the Steps used in this TrailEntry. - (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 ?)