diff --git a/Docs/Luadoc/Lua.xml b/Docs/Luadoc/Lua.xml
index 2bd63dce12..062cc2b248 100644
--- a/Docs/Luadoc/Lua.xml
+++ b/Docs/Luadoc/Lua.xml
@@ -10,7 +10,7 @@
-
+
@@ -55,7 +55,6 @@
-
@@ -68,6 +67,8 @@
+
+
@@ -80,16 +81,14 @@
-
-
-
+
@@ -108,7 +107,6 @@
-
@@ -129,6 +127,7 @@
+
@@ -136,13 +135,11 @@
-
-
@@ -184,15 +181,11 @@
-
-
-
-
@@ -201,7 +194,6 @@
-
@@ -678,6 +670,11 @@
+
+
+
+
+
@@ -1019,6 +1016,8 @@
+
+
@@ -1142,6 +1141,7 @@
+
@@ -1207,6 +1207,7 @@
+
@@ -1681,6 +1682,7 @@
+
@@ -1689,6 +1691,7 @@
+
@@ -2285,6 +2288,8 @@
+
+
@@ -2301,9 +2306,8 @@
-
- StepMania v5.0 Preview 4
- 2011-11-27
+ StepMania v5.0 alpha 0
+ 2011-12-29
diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml
index a1d032d7e3..52532631bb 100644
--- a/Docs/Luadoc/LuaDocumentation.xml
+++ b/Docs/Luadoc/LuaDocumentation.xml
@@ -24,7 +24,7 @@
- [03 HSV.lua] Returns a color with the specified alpha.
+ [02 Colors.lua] Returns a color with the specified alpha.
[02 StageMods.lua]
@@ -42,10 +42,10 @@
[02 Colors.lua] Boosts the specified color by multiplying its values by fBoost.
- [03 HSV.lua] Modifies the brightness of the specified color.
+ [02 Colors.lua] Modifies the brightness of the specified color.
- [03 ProductivityHelpers.lua] Returns true if Center 1P is being used.
+ [02 Utilities.lua] Returns true if Center 1P is being used.
[03 Gameplay.lua] Returns true if checkpoint judgments and tap judgments
@@ -74,10 +74,10 @@
[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.
+ [02 Colors.lua] Returns a hex representation for the specified color.
- [03 HSV.lua] Takes in a color and returns a table with the HSV values.
+ [02 Colors.lua] Takes in a color and returns a table with the HSV values.
[03 Gameplay.lua] Determines what TapNoteScore allows for continuing the combo.
@@ -155,7 +155,7 @@
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."
+ [02 Utilities.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.
@@ -164,10 +164,10 @@
[02 Utilities.lua] Returns a path to a random song background.
- [03 ProductivityHelpers.lua]
+ [02 Actor.lua]
- [03 ProductivityHelpers.lua]
+ [02 Actor.lua]
Returns the display aspect ratio.
@@ -206,7 +206,7 @@
[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.
+ [02 Colors.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.
@@ -221,36 +221,36 @@
Returns the current hour.
- [03 HSV.lua] Converts a color from HSV values to something StepMania can understand.
+ [02 Colors.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.
+ [02 Colors.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."
+ [02 Colors.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)"
+ [02 Colors.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.
+ [02 Colors.lua] Changes the hue of the input color.
[03 ThemePrefs.lua] Initializes various user preferences.
- [03 ProductivityHelpers.lua] Returns true if the coin mode is not set to CoinMode_Home.
+ [02 Utilities.lua] Returns true if the coin mode is not set to CoinMode_Home.
Returns true if Event Mode is turned on.
- [03 ProductivityHelpers.lua] Returns true if Arcade and the coin mode is CoinMode_Free.
+ [02 Utilities.lua] Returns true if Arcade and the coin mode is CoinMode_Free.
- [03 ProductivityHelpers.lua] Returns true if the coin mode is set to CoinMode_Home.
+ [02 Utilities.lua] Returns true if the coin mode is set to CoinMode_Home.
Returns true if connected to the Internet.
@@ -330,10 +330,10 @@
will iterate over all key–value pairs of table t."
- [03 ProductivityHelpers.lua] Converts a PlayerNumber into a short string (e.g. "P1", "P2").
+ [02 Utilities.lua] Converts a PlayerNumber into a short string (e.g. "P1", "P2").
- [03 ProductivityHelpers.lua] Returns either p1val or p2val depending on pn.
+ [02 Actor.lua] Returns either p1val or p2val depending on pn.
[00 init.lua]
@@ -376,7 +376,7 @@
[02 Utilities.lua] Round a number.
- [03 HSV.lua] Modifies the saturation of the specified color
+ [02 Colors.lua] Modifies the saturation of the specified color
[03 Gameplay.lua] Returns the primary ScoreKeeper class to use.
@@ -459,7 +459,7 @@
[02 TextBanner.lua] This function defines how the TextBanner is laid out.
- [03 ProductivityHelpers.lua] Converts a string or number to a bool.
+ [02 Utilities.lua] Converts a string or number to a bool.
Tries to convert e to a number. Returns nil if
@@ -686,6 +686,9 @@
Plays the commands that follow at an accelerated rate (fRate * fRate), where fRate is in seconds.
+
+ Adds a command to the Actor.
+
Adds rot to the Actor's current x rotation.
@@ -759,10 +762,10 @@
[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)
+ [02 Actor.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] Centers an Actor on the y axis. (equivalent to y,SCREEN_CENTER_Y)
Determines if the z-buffer should be cleared or not.
@@ -796,6 +799,9 @@
Sets the Actor's alpha level to fAlpha, where fAlpha is in the range 0..1.
+
+ Makes the Actor switch between two colors immediately.
+
Sets the Actor's bottom edge color to c.
@@ -811,9 +817,15 @@
Sets the Actor's lower right corner color to c.
+
+ Makes the Actor switch between two colors, jumping back to the first after reaching the second.
+
Sets the Actor's right edge color to c.
+
+ Makes the Actor shift between two colors smoothly.
+
Sets the Actor's top edge color to c.
@@ -823,6 +835,9 @@
Sets the Actor's upper right corner color to c.
+
+ Tells the Actor to draw itself.
+
Sets the Actor's draworder to iOrder, where larger values display first.
@@ -913,6 +928,7 @@
Returns the Actor's current height.
+
Returns the Actor's current X rotation.
@@ -943,12 +959,19 @@
Sets the Actor's glow color.
+
+ Makes the Actor glow between two colors immediately.
+
-
+ Makes the Actor glow between two colors smoothly, jumping back to the first at the end.
+
+
+ Makes the Actor glow between two colors smoothly.
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.
@@ -976,6 +999,7 @@
Stops the Actor's movement. (Usually used for Sprites or Models.)
+
Starts the Actor's movement. (Usually used for Sprites or Models.)
@@ -997,6 +1021,7 @@
Makes the Actor change colors continually using colors of the rainbow.
+
Set the Actor's rotation on the X axis to fAlign.
@@ -1006,6 +1031,7 @@
Set the Actor's rotation on the Z axis to fAlign.
+
[02 Actor.lua] An alternative version of .
@@ -1060,6 +1086,7 @@
Tells the Actor to spin. Can use to define different spinning behavior.
+
Stops any effect the Actor has.
@@ -1069,6 +1096,10 @@
Stretches the Actor to a rectangle of a specific size.
+
+ Determines if the Actor should use texture wrapping or not.
+
+
Set the fractional vertical alignment of the Actor according to fAlign which should be a float in the range 0..1. An alignment of 0 is top aligned while an alignment of 1 is bottom aligned. See for the common case.
@@ -1081,6 +1112,9 @@
Sets an Actor's visibility to b.
+
+ Makes the Actor wag. Use to define different wag behavior.
+
Set the x position of the Actor to xPos.
@@ -1134,29 +1168,30 @@
[02 Actor.lua] Stretches an Actor to cover the screen. (equivalent to stretchto,0,0,SCREEN_WIDTH,SCREEN_HEIGHT)
- [03 ProductivityHelpers.lua] A customized version of pulse that is more appealing for on-beat effects.
+ [02 Actor.lua] A customized version of pulse that is more appealing for on-beat effects.
- [03 ProductivityHelpers.lua] Sets and Actor as a mask destination.
+ [02 Actor.lua] Sets and Actor as a mask destination.
- [03 ProductivityHelpers.lua] Sets an Actor as a mask source. (Also clears zbuffer; other mask sources need to not clear the zbuffer)
+ [02 Actor.lua] Sets an Actor as a mask source. (Also clears zbuffer; other mask sources need to not clear the zbuffer)
- [03 ProductivityHelpers.lua] Make graphics their true size at any resolution.
+ [02 Actor.lua] Make graphics their true size at any resolution.
- [03 ProductivityHelpers.lua] Scale things back up after they have already been scaled down.
+ [02 Actor.lua] Scale things back up after they have already been scaled down.
- [03 ProductivityHelpers.lua] A customized version of pulse that is more appealing for on-beat effects.
+ [02 Actor.lua] A customized version of pulse that is more appealing for on-beat effects.
- [03 ProductivityHelpers.lua] Sets the x and y location of the Actor in one command.
+ [02 Actor.lua] Sets the x and y location of the Actor in one command.
+ Adds a child to the ActorFrame from the specified path.
Sets the field of view for the ActorFrame.
@@ -1231,12 +1266,44 @@
Sets the vanishing point for the ActorFrame.
+
+
+ Creates the ActorFrameTexture.
+
+
+ Enables/disables the Alpha Buffer.
+
+
+ Enables/disables the Depth Buffer.
+
+
+ Enables/disables
+
+
+ Enables/disables the Preserve Texture option.
+
+
+ Returns the texture.
+
+
+ Sets the Texture's name to sName.
+
+
+
+ Adds a texture to the ActorMultiTexture. Returns the number of texture units.
+
- Clears all the textures from the MultiTexture.
+ Clears all the textures from the ActorMultiTexture.
- Sets the EffectMode on the MultiTexture.
+ Sets the EffectMode on the ActorMultiTexture.
+
+
+ Sets the size of the ActorMultiTexture from the specified texture.
+
+
+ Sets the coordinates of the ActorMultiTexture.
Sets a TextureMode on the specified index.
@@ -1447,7 +1514,7 @@
Clear all attributes associated with the BitmapText.
- [03 ProductivityHelpers.lua] Sets the diffuse and stroke color of text in one command.
+ [02 Actor.lua] Sets the diffuse and stroke color of text in one command.
Returns the text that is currently set.
@@ -1462,10 +1529,10 @@
Set the maximum width of the unzoomed text to fWidth. If fWidth is 0, then there is no maximum width.
- [03 ProductivityHelpers.lua] Remove any stroke color.
+ [02 Actor.lua] Remove any stroke color.
- [03 ProductivityHelpers.lua] Alias for setting to false.
+ [02 Actor.lua] Alias for setting to false.
If true, set each character of the text in turn to the rainbow colors in the metrics BitmapText::RainbowColor#.
@@ -1474,10 +1541,10 @@
Set the text to sText. This clears all attributes.
- [03 ProductivityHelpers.lua] Sets text using string.format(sFormat, ...).
+ [02 Actor.lua] Sets text using string.format(sFormat, ...).
- [03 ProductivityHelpers.lua] Alias for .
+ [02 Actor.lua] Alias for .
Sets the stroke color to c.
@@ -1775,6 +1842,12 @@
+
+ Returns true if notes are counted separately in this game.
+
+
+ Returns the mapped judgment for tns.
+
Returns the name of the game such as "dance" or "pump".
@@ -2295,6 +2368,7 @@
+ Returns the mouse wheel value.
Returns the X position of the mouse.
@@ -2497,6 +2571,17 @@
Sets the PercentageDisplay from the specified PlayerState and PlayerStageStats.
+
+
+ Returns the current TimingData for this player.
+
+
+ Sets Actor with Combo position.
+
+
+ Sets Actor with Judgment position.
+
+(PlayerInfo is a part of ScreenGameplay.)
@@ -2955,6 +3040,12 @@
Returns the value of X Mode.
+
+ Returns true if the current PlayerOptions makes the current Course/Trail easier.
+
+
+ Returns true if the current PlayerOptions makes the current Song/Steps easier.
+
Sets the X Mode percentage to fXModeVal.
@@ -3103,6 +3194,9 @@
Returns the SongPosition for this PlayerState.
+
+ Returns the current Super Meter level for this PlayerState.
+
Sets the player options to sPlayerOptions for the specified ModsLevel.
@@ -3218,6 +3312,9 @@
Returns the number of trails with the specified StepsType and Difficulty that you've scored a certain Grade g on.
+
+ Returns the user table for this Profile.
+
Returns how much the player weighs.
@@ -3750,7 +3847,7 @@
Returns true if the song has edits.
-
+
Returns true if the song has a jacket graphic.
@@ -3963,7 +4060,7 @@
Returns the Sprite's texture.
-
+
[02 Sprite.lua] Returns a Frames table consisting of iNumFrames frames lasting for a total of fSeconds seconds. This function is not a member function and should be used as Frames = Sprite.LinearFrames( 5, 2.6 ).
@@ -4218,7 +4315,7 @@
Returns true if the specified theme exists.
- [03 ProductivityHelpers.lua] Returns the absolute path of a file in the theme.
+ [02 Utilities.lua] Returns the absolute path of a file in the theme.
Returns the current language.
@@ -4277,7 +4374,7 @@
Reloads the current theme's metrics.
-
+
@@ -4433,6 +4530,12 @@
Returns the Song related to the UnlockEntry.
+
+ Get all of the steps locked based on StepsType.
+
+
+ Get all of the steps locked based on difficulty.
+
Returns the UnlockRewardType for this entry.
@@ -4448,12 +4551,14 @@
Makes the UnlockEntry require passing Hard steps.
+
+ Makes the UnlockEntry require passing Challenge steps.
+
Makes the UnlockEntry hide in Roulette.
- Sets the UnlockEntry's song to sSongName.
- sSongName also requires the group.
+ Sets the UnlockEntry's song to sSongName. sSongName also requires the group.
Example: song,"In The Groove/Pandemonium"
@@ -4518,6 +4623,9 @@
Returns the total number of items in the wheel.
+
+
+
Returns the WheelItem at index iIndex.
@@ -4542,6 +4650,9 @@
Returns the text of this wheel item.
+
+ Returns the type of this wheel item.
+