From d5e19e42ce5d391a2fd0e8ea816a82b58cf9a183 Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Mon, 4 Jul 2011 15:56:22 -0500 Subject: [PATCH] luadocs checkpoint --- Docs/Luadoc/Lua.xml | 10 +- Docs/Luadoc/LuaDocumentation.xml | 213 ++++++++++++++++++++++++++++--- 2 files changed, 198 insertions(+), 25 deletions(-) diff --git a/Docs/Luadoc/Lua.xml b/Docs/Luadoc/Lua.xml index ed192118a5..4f56b8b1a2 100644 --- a/Docs/Luadoc/Lua.xml +++ b/Docs/Luadoc/Lua.xml @@ -153,6 +153,7 @@ + @@ -932,6 +933,7 @@ + @@ -1477,8 +1479,8 @@ - + @@ -2130,9 +2132,9 @@ - + - StepMania 5 v5.0 Preview 1a - 2011-06-24 + StepMania 5 v5.0 Preview 2 + 2011-07-04 diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml index 40d229921d..edad01dcee 100644 --- a/Docs/Luadoc/LuaDocumentation.xml +++ b/Docs/Luadoc/LuaDocumentation.xml @@ -23,6 +23,9 @@ + + [03 HSV.lua] Returns a color with the specified alpha. + [02 StageMods.lua] @@ -36,10 +39,10 @@ Returns the base name of file path. - [02 Colors.lua] + [02 Colors.lua] Boosts the specified color by multiplying its values by fBoost. - [03 HSV.lua] + [03 HSV.lua] Modifies the brightness of the specified color. [03 ProductivityHelpers.lua] Returns true if Center 1P is being used. @@ -48,7 +51,8 @@ [03 Gameplay.lua] - CLAMP is an all-female Japanese mangaka group that formed in the mid 1980s. Erm, I mean... Clamps fValue between fLow and fHigh. + CLAMP is an all-female Japanese mangaka group that formed in the mid 1980s. + Erm, I mean... Clamps fValue between fLow and fHigh. Closes any connection to an online server. @@ -59,6 +63,21 @@ 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. + + [02 Colors.lua] Returns a darker tone of the color. (Specifically c[1]/2, c[2]/2, c[3]/2, c[4]) + + + [02 Colors.lua] Returns a lighter tone of the color. (Specifically c[1]+(c[1]/2), c[2]+(c[2]/2), c[3]+(c[3]/2), c[4]) + + + [02 Colors.lua] Returns a midtone of the color. (Specifically c[1]/1.5, c[2]/1.5, c[3]/1.5, c[4]) + + + [03 HSV.lua] Returns a hex representation for the specified color. + + + [03 HSV.lua] Takes in a color and returns a table with the HSV values. + [03 Gameplay.lua] Determines what TapNoteScore allows for continuing the combo. @@ -68,6 +87,12 @@ [03 Gameplay.lua] Determines if combo should be per row (Jump = 1) or per column (Jump = 2). + + [02 Other.lua] The combo trasform command. + + + [03 Gameplay.lua] Returns the UserPrefComboUnderField user preference value. + Tries to connect to the server at sAddress. @@ -77,14 +102,23 @@ Returns the current day of the year. + + [02 Serialize] Recursively deep-copy a table. + [01 base.lua] "Override Lua's dofile to use our loadfile." + + [02 Utilities.lua] + + + [02 Utilities.lua] Return the index of a true value in list. + [02 Utilities.lua] Find a key in tab with the given value. - - [02 Utilities.lua] Return the index of a true value in list. + + func takes a key and a value. Returns the number passed to the function followed by its suffix ("th", "nd", and so on). @@ -98,6 +132,12 @@ Returns the corresponding CustomDifficulty string for a StepsType/Difficulty (/optional CourseType) combination. + + [04 Scoring.lua] "Get the radar values directly. The individual steps aren't used much." + + + [02 Other.lua] Returns a string with the Edit Mode SubScreens. + [03 EnvUtils2.lua] Returns the value of name from the Env table. @@ -113,21 +153,45 @@ Returns a string representing the name of the operating system being used. (e.g. "Windows", "Linux", "Mac, "Unknown") + + [03 ProductivityHelpers.lua] "This returns a profile, preferably a player one. If there isn't one, [it falls] back on the machine profile." + [03 ThemePrefs.lua] Returns true if player pn is using ProTiming. [02 Utilities.lua] Returns a path to a random song background. + + [03 ProductivityHelpers.lua] + + + [03 ProductivityHelpers.lua] + + + Returns the display aspect ratio. + Returns the name of the currently connected server. [02 Utilities.lua] Returns a path to the current songs background. + + [03 Gameplay.lua] + Returns the theme's aspect ratio. + + [03 ThemePrefs.lua] (Alias for .) + + + Returns the current Timing difficulty. + + + [04 Scoring.lua] "Retrieve the amount of taps/holds/rolls involved." Used in some scoring formulas. + [03 UserPreferences2.lua] Themer-facing function for getting a user preference. @@ -140,9 +204,38 @@ [03 UserPreferences2.lua] Themer-facing function for getting a user preference as a number. + + [03 HSV.lua] Returns the color's alpha if it has any, otherwise returns 1. + + + [03 Gameplay.lua] Returns the value to start showing the combo at. + + + [03 Gameplay.lua] Returns true if you need to step on hold heads to activate them. + + + [03 Gameplay.lua] Returns 0 in pump mode, TimingWindowSecondsHold preference value in any other game mode. + Returns the current hour. + + [03 HSV.lua] Converts a color from HSV values to something StepMania can understand. + hue is from 0-360, saturation and value are 0..1 + + + [03 HSV.lua] Converts a color from HSV values with alpha to something StepMania can understand. + hue is from 0-360, saturation, value, and alpha are 0..1 + + + [03 HSV.lua] "Converts a set of HSV values to a color." + + + [03 HSV.lua] "Takes in a normal color and returns the hex representation. (Adapted from code in LuaBit)" + + + [03 HSV.lua] Changes the hue of the input color. + [03 ThemePrefs.lua] Initializes various user preferences. @@ -206,6 +299,9 @@ Returns the current Minute. + + [03 Gameplay.lua] Returns the value to start showing the miss combo at. + Returns the current month of the year. @@ -245,6 +341,9 @@ [02 Utilities.lua] Round a number. + + [03 HSV.lua] Modifies the saturation of the specified color + [03 Gameplay.lua] Returns the primary ScoreKeeper class to use. @@ -275,6 +374,9 @@ [03 Gameplay.lua] (soon to be deprecated) Returns a list of codes to use on ScreenSelectProfile. + + [02 Serialize.lua] Serialize the table t. + [03 EnvUtils2.lua] Sets the value of name to value in the Env table. @@ -367,9 +469,16 @@ + + Returns the for the file at sPath. + Returns true if sClassName is a registered Class. + + Loads all commands and sets X and Y for the specified Actor. + + @@ -414,6 +523,20 @@ + + Returns true if the type of v is sType. + + + Flushes log files to disk. + + + + Tries to read the file at sPath. If successful, it returns the file's contents. + If unsuccessful, it returns two values: nil and "error". + + + Calls func(...) with two LuaThreadVariables set, and returns the return values of func(). + Writes sString to log.txt. Aliased by . @@ -422,9 +545,6 @@ Writes sString to info.txt and log.txt as a warning. Aliased by . - - Flushes log files to disk. - @@ -563,7 +683,21 @@ [02 Actor.lua] - [02 Actor.lua] Centers an Actor. + [02 Actor.lua] Centers an Actor on the screen. (equivalent to x,SCREEN_CENTER_X;y,SCREEN_CENTER_Y) + + + [03 ProductivityHelpers.lua] Centers an Actor on the X axis. (equivalent to x,SCREEN_CENTER_X) + + + [03 ProductivityHelpers.lua] Centers an Actor on the y axis. (equivalent to y,SCREEN_CENTER_Y) + + + Determines if the z-buffer should be cleared or not. + + + [02 Actor.lua] Combines multiple interpolators for complex tweens. tweens + can either be a string like "linear,0.25,accelerate,0.75" or + a table with tween information { {Type="linear", Percent=0.25, Bezier=nil}, {Type="accelerate", Percent=0.75, Bezier=nil} } Crops percent of the Actor from the bottom, where percent is in the range 0..1. @@ -856,6 +990,9 @@ Stops any effect the Actor has. + + Stops any tweening. + Stretches the Actor to a rectangle of a specific size. @@ -880,6 +1017,12 @@ Set the z position of the Actor to zPos. + + Sets the z bias to fBias. + + + Enables/disables z-buffer depending on bUse. + Zooms the Actor to zoom scale. @@ -901,19 +1044,19 @@ Zooms the Actor to zoom scale on the Z axis. + + Sets the z testing mode to write on pass if true, turns it off if false + + + Sets the z testing mode to testMode. + + + Sets z writing to true or false based on bWrite. + [02 Actor.lua] - - [02 Actor.lua] Centers an Actor on the screen. (equivalent to x,SCREEN_CENTER_X;y,SCREEN_CENTER_Y) - - - [03 ProductivityHelpers.lua] Centers an Actor on the X axis. (equivalent to x,SCREEN_CENTER_X) - - - [03 ProductivityHelpers.lua] Centers an Actor on the y axis. (equivalent to y,SCREEN_CENTER_Y) - [02 Actor.lua] Stretches an Actor to cover the screen. (equivalent to stretchto,0,0,SCREEN_WIDTH,SCREEN_HEIGHT) @@ -1166,7 +1309,7 @@ Loads the card image from the specified Character. - + Loads the banner from the cache based on sPath (typically or ). Loads a Banner from a specified Course. @@ -1455,6 +1598,9 @@ Returns the MD5 hash for s. + + Returns the SHA-1 hash for the file at sPath. + Returns the SHA-1 hash for s. @@ -2007,6 +2153,9 @@ + + Changes the player's life by iNumLives. (Negative values subtract lives.) + Returns the number of lives remaining. @@ -2707,7 +2856,9 @@ - + + Returns the Profile for the specified profile ID. + @@ -2729,6 +2880,9 @@ Returns true if Song s has never been played before (according to the machine profile). + + Returns true if pn's Profile was loaded from a memory card. + Returns true if the last load of player pn's profile was a LastGood copy of the profile. @@ -2864,12 +3018,21 @@ Returns the name of the previous Screen. + + Returns the ScreenType for this Screen. + Locks input for f seconds. + + [02 Other.lua] Gets a metric from the current Screen. + Posts a message with the text sScreenMsg to the Screen. + + [02 Other.lua] Gets a string from the current Screen in the current language. + @@ -3340,6 +3503,9 @@ Load the song banner texture at sPath. + + [02 Sprite.lua] Loads the background from the current Song or the first Trail entry. + [02 Sprite.lua] Load the texture for song's background. @@ -3352,6 +3518,9 @@ Set the to mode. + + Sets the number of seconds into the animation to fSeconds. + Set the texture to texture. @@ -3797,7 +3966,9 @@ Returns the UnlockEntry index to celebrate. - + + Sets the preferred Song/Course to the specified sUnlockEntryID + Unlocks an entry by ID.