diff --git a/stepmania/Docs/LuaDocumentation.xml b/stepmania/Docs/LuaDocumentation.xml index 964b68c88d..323e556d09 100644 --- a/stepmania/Docs/LuaDocumentation.xml +++ b/stepmania/Docs/LuaDocumentation.xml @@ -143,16 +143,168 @@ Wrap the unzoomed text at iWidth pixels. If you or by x and you want the text wrapped at width, then you should use wrapwidthpixels(width/x). + + + Return the corresponding to sID. + + Returns the name of the game such as "dance" or "pump". + + + Return the first of the corresponding to game. + + + Return the localized string representation of st. + + + + + Set the music volume to fVolume for fDuration seconds. + + + + Return the sound balance for pn. + + + Play the sound at sPath one time. + + + + Returns true if any player has performed a feat worthy of ranking. + + + The second argument is optional. Apply the GameCommand represented by sCommand + for pn, if given. See . + + + Returns true if enough credits have been inserted to join. + + + Returns the environment table. See . + + + Returns the current . + + + Return the number of inserted but unused coins. This number is + decremented when players join. + + + Return the number of coins needed to join based on the current coin and premium modes + as well as the number of people joined, if that matters for the premium mode. See + and . + + + The s in a are numbered sequentially + starting from 0. Return the number of the current . + + + Return the current . + + + Return the current . + + + Return the current . + + + Return the current . + + + Return the current . + + + Return a variable number of arguments based on the being + played by all players. For each distinct being played by + the players, in increasing order, + the difficulty and description of the is returned as strings. +
For example,
+ local credits = {GAMESTATE:GetCurrentStepsCredits()};
+ will make a table of the difficulties and descriptions. +
+ + Return the current . + + + Return the current . + + + Return a string representation of the default song options. + + + Return the easiest of the + currently selected steps by all players. For example, if player 1 has + selected Hard steps and player 2 has selected Medium steps, Medium will + be returned. + + + + + + + Return the Edit Local or nil if + it does not exist. + + + + + + Return the source for the editor or nil + if it does not exist. + + + Return the current random seed for the game. + + + Return true if the gameplay lead in is enabled. If + false, gameplay begin immediately. + Returns an array of s corresponding to Human players.
+ + + Return the state for pn. + + + + + Broadcast the message to all listeners subscribed to sMessage. The + second argument is an optional table of parameters. It may be omitted or explicitly + set to nil. + + + + + Return the value of the preference sPreference. + + + Set the value of the preference sPreference to value. + + + Reset preference sPreference to the default value. + + + + + Return the height of the display. + + + Return the width of the display. + + + + + Return an array of connected input device descriptions. + + See for loading a sound.