From 82aa997719cbb2fce8dc7761e60d43d48da5a9b0 Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Mon, 4 Jul 2011 22:30:17 -0500 Subject: [PATCH] more lua docs update --- Docs/Luadoc/LuaDocumentation.xml | 67 +++++++++++++++++++++++++++++--- 1 file changed, 62 insertions(+), 5 deletions(-) diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml index c2b6635ac0..d1d6f53eda 100644 --- a/Docs/Luadoc/LuaDocumentation.xml +++ b/Docs/Luadoc/LuaDocumentation.xml @@ -302,6 +302,9 @@ [03 Gameplay.lua] Returns the value to start showing the miss combo at. + + Creates a module. See the Lua manual for more details. + Returns the current month of the year. @@ -311,6 +314,20 @@ Returns Month m as a string. + + "Allows a program to traverse all fields of a table. Its first argument is a + table and its second argument is an index in this table. + next returns the next index of the table and its associated value." + See the Lua manual for more details. + + + [03 ThemePrefs.lua] Returns a Lua option row for ProTiming. + + + "Returns three values: the function, the table t, and nil, + so that the construction for k,v in pairs(t) do body end + will iterate over all key–value pairs of table t." + [03 ProductivityHelpers.lua] Converts a PlayerNumber into a short string (e.g. "P1", "P2"). @@ -329,6 +346,16 @@ Returns the product version. + + "Checks whether v1 is equal to v2, without invoking any metamethod." + + + "Gets the real value of t[index], without invoking any metamethod." + + + "Sets the real value of t[index] to value, without invoking any metamethod." + The modified t is then returned. + [02 ActorDef.lua] @@ -341,6 +368,9 @@ Sends the current style to the server. + + Loads the specified module. See the Lua manual for more information. + [02 Utilities.lua] Round a number. @@ -377,6 +407,11 @@ Converts fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Milliseconds (uses 3). + + "If index is a number, returns all arguments after argument + number index. Otherwise, index must be the string + "#", and [it] returns the total number of extra arguments it received." + [02 Branches.lua] Determines the correct music/course selection screen to use and returns it. @@ -410,6 +445,12 @@ [02 ActorDef.lua] + + [02 Utilities.lua] Returns a shuffled version of t. + + + [02 Utilities.lua] Returns a slice of the specified table of size num. + [02 Utilities.lua] Look up each value in a table, returning a table with the resulting strings. @@ -419,12 +460,27 @@ [03 ProductivityHelpers.lua] Converts a string or number to a bool. + + Tries to convert e to a number. Returns nil if + it can't convert the input to a number. (base is optional.) + + + Converts e to a string. + [02 Enum.lua] Returns a string representing an enum starting from '_'. For example, passing PlayerNumber_P1 to this function will return P1. [00 init.lua] Alias for . + + Returns the type of the object as a string. See the Lua manual for valid return values. + + + "Returns the elements from the given table. + This function is equivalent to return list[i], list[i+1], ···, list[j]" + (i and j are optional; "by default, i is 1 and j is the length of the list.") + Returns a string with characters escaped for URLs. (e.g. a space becomes '%20') @@ -443,24 +499,25 @@ [04 WidescreenHelpers.lua] Depending on the screen width, scales between ar43 (4:3; 640px) and ar169 (16:9; 854px). + + [02 Utilities.lua] + [02 ActorDef.lua] Wraps the children in an ActorFrame. [04 FileUtils.lua] Writes buf to the file at path. + + [03 GamePreferences.lua] + [03 UserPreferences2.lua] (internal) Writes user preference prefName to its config file with value being tostring'd. Returns the current year. - - - - [03 ThemePrefs.lua] Returns a Lua option row for ProTiming. - [03 ThemePrefs.lua] Returns a Lua option row for toggling AutoSetStyle.