From 20b5325486209cef4c4c4f47d874a0cc5fac513f Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Sat, 6 Jun 2009 20:20:20 +0000 Subject: [PATCH] some more lua documentation additions --- stepmania/Docs/LuaDocumentation.xml | 140 ++++++++++++++++++++++++++++ 1 file changed, 140 insertions(+) diff --git a/stepmania/Docs/LuaDocumentation.xml b/stepmania/Docs/LuaDocumentation.xml index 092335c4bd..53425d82ed 100644 --- a/stepmania/Docs/LuaDocumentation.xml +++ b/stepmania/Docs/LuaDocumentation.xml @@ -32,6 +32,9 @@ hex ("#FFFFFFFF") or 0..1 values ("1.0,1.0,1.0,1.0"), in RGBA order. + + Tries to connect to the server at sAddress. + Returns the current day of the month. @@ -65,6 +68,10 @@ Returns true if connected to StepMania Online. + + Returns true if Player pn is logged on to + a SMOnline server. + 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. @@ -74,6 +81,12 @@ Returns the current month of the year. + + Returns Month m as a localized string. + + + Returns Month m as a string. + Returns the current second. @@ -1575,21 +1588,80 @@ Broadcasts a system message. + + + Returns true if Player pn backspaced successfully. + + + Returns true if Player pn was able to add sKey to their name. + + + Attempts to finish Player pn and returns true + if successful. + + + Returns true if anyone is entering their name. + + + Returns true if anyone is still entering their name.
+ (As opposed to those who are Finalized; see ) + + + Returns true if Player pn is entering their name. + + + Returns true if Player pn is finished entering their name. + + + Gets the currently selected letter of Player pn. + + Returns the current row that player pn is on. + + + Returns true if we are going to PlayerOptions. + + + + Continues to the next screen. + Returns true if there is a profile that can be loaded. + + Continues to the next screen. + Returns true if there is a profile that can be saved. + + + Tells the screen to go to the previous screen. + + + Attempts to finish the screen and returns true + if successful. + + + Returns the profile index of the specified Player. + + + Sets the profile index of Player pn to iProfileIndex. + + + + + Tells the screen to go to the previous screen. + + Returns an array of all the available objects for a . @@ -1609,6 +1681,9 @@ Returns the displayed main title of the song. + + Returns the displayed subtitle of the song. + Returns the genre of the song. @@ -1636,6 +1711,9 @@ Returns the transliterated main title of the song. + + Returns the transliterated subtitle of the song. + Returns true if the song has steps for the specified difficulty in st. @@ -1701,6 +1779,9 @@ Returns the song color of song s. + + Returns a Song given a set of Steps st. + Returns the song group color of sGroupName. @@ -1850,6 +1931,23 @@ Returns true if the steps were automatically generated. + + + Loads the StepsDisplay commands from the Metrics in group sMetricsGroup. + + + Sets the StepsDisplay from the GameState using Player pn. + + + Sets the StepsDisplay based on Steps pSteps. + + + Sets the StepsDisplay based on the passed in StepsType, iMeter, and Difficulty. + + + Sets the StepsDisplay based on Trail pTrail. + + Returns the name of the Style. @@ -1915,18 +2013,52 @@ + + Sets the UnlockEntry's ID to m_sEntryID. + + + Sets the UnlockEntry's course to sCourseName.
+ Example: course,"Driven" + Returns the unlock description. Returns the UnlockRequirement. + + Returns true if the UnlockEntry requires you to pass Hard steps. + Returns the Song related to the UnlockEntry. + + Returns the UnlockRewardType for this entry. + Returns true if the UnlockEntry is locked. + + Sets the UnlockEntry's modifier to sModifier. + + + + + + Makes the UnlockEntry require passing Hard steps. + + + Makes the UnlockEntry hide in Roulette. + + + Sets the UnlockEntry's song to sSongName.
+ sSongName also requires the group.
+ Example: song,"In The Groove/Pandemonium" + + + Sets the UnlockEntry to unlock a specified song's steps.
+ Example: steps,"In The Groove/Pandemonium","expert" + @@ -1969,6 +2101,14 @@ Returns the WheelItem at index iIndex. + + + Sets the WorkoutGraph from the current Workout. + + + Sets the WorkoutGraph from GameState and song index iSongIndex. + +