From 0d94c6594eb94426a46a8ed2feb4a8bdaacdc2de Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Sat, 25 Apr 2009 09:16:55 +0000 Subject: [PATCH] additions and fixes --- stepmania/Docs/LuaDocumentation.xml | 225 +++++++++++++++++++++++++++- 1 file changed, 222 insertions(+), 3 deletions(-) diff --git a/stepmania/Docs/LuaDocumentation.xml b/stepmania/Docs/LuaDocumentation.xml index 70d1d2fa28..6a59812dca 100644 --- a/stepmania/Docs/LuaDocumentation.xml +++ b/stepmania/Docs/LuaDocumentation.xml @@ -27,6 +27,11 @@ Returns the base name of file path. + + 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. + Returns the current day of the month. @@ -171,10 +176,10 @@ - Returns true if so has steps for st. + Returns true if the song's steps (st) are playable. - Returns true if so has a StepsType matching st. + Returns true if the song's StepsType (st) are playable. @@ -665,12 +670,29 @@ Returns true if the Course was automatically generated. + + Returns true if the Course is Endless. + Returns the Song that this CourseEntry corresponds to. + + + Returns the path to the character's card graphic. + + + Returns the path to the character's icon. + + + Returns the path to the character's ScreenSelectMode icon. + + + Returns the path to the character's ScreenStage icon. + + Return the corresponding to sID. @@ -962,6 +984,43 @@ set to nil. + + + Controls if the model should loop or not. + + + Plays animation sAniName at fPlayRate speed (default 1.0). + + + Sets how far into the animation the model is. + + + Sets the current animation's playback rate to fRate. + + + Sets the model's default animation to sAnimation at fPlayRate speed (default 1.0). + + + + + Returns a command from the specified element and value. + + + Returns a bool from the specified element and value. + + + Returns a float from the specified element and value. + + + Returns a integer from the specified element and value. + + + Returns the path for the specified sButton sElement. + + + Returns the actor for the specified sButton sElement. + + Returns the of player pn. @@ -992,9 +1051,24 @@ Returns the number of judgments for a specified HoldNoteScore. + + Returns the player's actual score on the lesson. + + + Returns the score needed to pass the lesson. + Returns the player's life remaining seconds. + + Returns the machine high score index for this performance. + + + Returns the peak combo award for this performance. + + + Returns the personal high score index for this performance. + Returns the player's Dance Point percentage. @@ -1004,9 +1078,18 @@ Returns the score. + + Returns the stage award for this performance. + + + Returns how long the player survived in seconds. + Returns the number of judgments for a specified TapNoteScore. + + Returns the max combo for this performance. + Returns true if the player was disqualified from ranking. @@ -1182,6 +1265,9 @@ Returns true if screen class s exists. + + Returns true if screen s is prepared. + Sets the next screen to s. @@ -1189,6 +1275,11 @@ Broadcasts a system message. + + + Returns the current row that player pn is on. + + Returns true if there is a profile that can be loaded. @@ -1230,6 +1321,9 @@ Returns the song's directory. + + Returns a table of Steps that have StepsType st. + Returns the song's TimingData. @@ -1259,12 +1353,21 @@ + + Returns a Course if one matching sCourse is found. + + + Returns a Song if one matching sSong is found. + Returns an array of all the installed courses. Returns an array of all the installed songs. + + Returns the course color of course c. + Returns the number of courses loaded via Additional folders. @@ -1277,12 +1380,18 @@ Returns the number of courses. + + Returns the number of selectable and unlocked songs. + Returns the number of song groups. Returns the number of songs. + + Returns the number of unlocked songs. + Returns a random course. @@ -1290,7 +1399,7 @@ Returns a random song. - Returns the song color of s. + Returns the song color of song s. Returns the song group color of sGroupName. @@ -1358,6 +1467,66 @@ Set the texture coordinate velocity which controls how the Sprite changes as it animates. + + + Returns true if everyone failed. + + + Returns the EarnedExtraStage value. + + + Returns the number of seconds played. + + + Returns the PlayerStageStats of multiplayer mp. + + + + Returns the PlayerStageStats of player pn. + + + + Returns the Stage value. + + + Returns the stage index. + + + Returns true if at least one person passed. + + + Returns true if player pn has a high score. + + + + + Returns the accumulated played StageStats. + + + Returns the best final grade. + + + Returns the best grade. + + + Returns the current StageStats. + + + Returns player pn's final grade. + + + Get the StageStats from iAgo rounds ago. + + + Returns the number of stages played. + + + Returns the worst grade. + + + Resets the stats. + + Returns the Steps description. @@ -1445,6 +1614,56 @@ Returns the Trail's StepsType. + + + Returns the unlock description. + + + Returns the UnlockRequirement. + + + Returns the Song related to the UnlockEntry. + + + Returns true if the UnlockEntry is locked. + + + + + Returns true if there are any unlocks to celebrate. + + + Returns the associated EntryID. + + + Returns the number of unlocked items. + + + Returns the number of all unlock items, regardless of status. + + + Returns the number of points until the next unlock. + + + Returns a table of songs unlocked by UnlockEntry sEntryID. + + + Returns a table of steps unlocked by UnlockEntry sEntryID. + + + Returns the UnlockEntry at iIndex. + + + Returns the UnlockEntry index to celebrate. + + + + Unlocks an entry by ID. + + + Unlocks an entry by index. + + Returns the WheelItem at index iIndex.