From 21dc7f019b003c1bc38d90dcada46b1a36d4779a Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Thu, 29 Dec 2011 11:59:38 -0600 Subject: [PATCH] luadoc update --- Docs/Luadoc/LuaDocumentation.xml | 71 +++++++++++++++++++++++++++++++- 1 file changed, 70 insertions(+), 1 deletion(-) diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml index 52532631bb..174d2274fe 100644 --- a/Docs/Luadoc/LuaDocumentation.xml +++ b/Docs/Luadoc/LuaDocumentation.xml @@ -18,6 +18,11 @@ -> Basename() To add a link to an Enum: -> CoinMode + +save yourself some time, copy this for undocumented things: + + + --> @@ -55,6 +60,9 @@ CLAMP is an all-female Japanese mangaka group that formed in the mid 1980s. Erm, I mean... Clamps fValue between fLow and fHigh. + + [04 KeymapGuard.lua] + Closes any connection to an online server. @@ -97,6 +105,15 @@ Tries to connect to the server at sAddress. + + [02 Colors.lua] + + + [02 Colors.lua] + + + [02 Colors.lua] + Returns the current day of the month. @@ -109,6 +126,12 @@ [01 base.lua] "Override Lua's dofile to use our loadfile." + + [03 Gameplay.lua] + + + [03 Gameplay.lua] + [02 Utilities.lua] @@ -124,12 +147,16 @@ Returns the number passed to the function followed by its suffix ("th", "nd", and so on). + Returns fPercentDancePoints formatted as a percentage. [03 Gameplay.lua] Returns a list of valid styles for the current gametype. + + [03 Gameplay.lua] + Returns the corresponding CustomDifficulty string for a StepsType/Difficulty (/optional CourseType) combination. @@ -190,6 +217,12 @@ Returns the current Timing difficulty. + + [01 alias.lua] + + + [01 alias.lua] + [04 Scoring.lua] "Retrieve the amount of taps/holds/rolls involved." Used in some scoring formulas. @@ -249,6 +282,9 @@ [02 Utilities.lua] Returns true if Arcade and the coin mode is CoinMode_Free. + + [03 Gameplay.lua] Returns true if the current game is sGame. + [02 Utilities.lua] Returns true if the coin mode is set to CoinMode_Home. @@ -261,6 +297,9 @@ Returns true if Player pn is logged on to a SMOnline server. + + [04 Scoring.lua] Returns true if W1 is allowed (and tns == 'TapNoteScore_W2') + [02 Branches.lua] Returns true if Routine mode is being played. @@ -273,6 +312,12 @@ [02 Utilities.lua] Joins a table, splitting each item with delimiter, returning a string of the results. + + [02 Colors.lua] + + + [02 Colors.lua] + Returns an Actor definition for the actor at sPath. If sPath points to a Lua file, any additional arguments will be passed to that script. @@ -329,6 +374,12 @@ so that the construction for k,v in pairs(t) do body end will iterate over all key–value pairs of table t." + + [02 Colors.lua] + + + [02 Colors.lua] + [02 Utilities.lua] Converts a PlayerNumber into a short string (e.g. "P1", "P2"). @@ -341,8 +392,11 @@ [03 ThemePrefs.lua] Prints a table's contents to the log. + + Returns the product family. (e.g. "StepMania") + - Returns the product ID. + Returns the product ID. (e.g. "StepMania 5") Returns the product version. @@ -375,6 +429,12 @@ [02 Utilities.lua] Round a number. + + [03 Gameplay.lua] Returns the routine noteskin for player . + + + [03 Gameplay.lua] Returns the routine noteskin for player 2. + [02 Colors.lua] Modifies the saturation of the specified color @@ -428,6 +488,9 @@ [03 UserPreferences2.lua] Themer-facing function for setting a user preference. + + [03 Gameplay.lua] + [02 ActorDef.lua] Returns true if a decoration should be shown on the current screen or not. @@ -437,6 +500,12 @@ [02 Utilities.lua] Splits a string at every occurence of delimiter, returning a table of the results. + + [02 Colors.lua] + + + [02 Colors.lua] + [02 ActorDef.lua]