From bf422c667b9f4528a7fb4ec6dc098c61ffd8bd31 Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Tue, 17 Nov 2009 18:50:20 +0000 Subject: [PATCH] add more info to Profile, GameState; add GameManager, ScreenEvaluation --- stepmania/Docs/LuaDocumentation.xml | 100 ++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) diff --git a/stepmania/Docs/LuaDocumentation.xml b/stepmania/Docs/LuaDocumentation.xml index 91d8ecbda5..43e722a992 100644 --- a/stepmania/Docs/LuaDocumentation.xml +++ b/stepmania/Docs/LuaDocumentation.xml @@ -895,6 +895,14 @@ Returns the display text. + + + Returns the first StepsType for the specified Game. + + + Returns a localized string for the specified StepsType. + + Set the music volume to fVolume for fDuration seconds. @@ -1069,6 +1077,9 @@ Return the random seed for the current stage. + + Returns true if the workout goal is complete. + Returns true if an extra stage was earned. @@ -1096,6 +1107,9 @@ Returns true if this is the second extra stage. + + Returns true if player pn has completed the current Goal. + Returns true if player pn is human. @@ -1105,6 +1119,9 @@ Returns true if player pn has joined the game. + + Returns true if player pn is the winner. + Returns true if player pn is using modifier sModifier. @@ -1424,9 +1441,36 @@ Returns the number of calories burned during the current day. + + Returns the Character being used by this profile. + + + Returns a composite of your high scores over courses with the specified StepsType and Difficulty. + + + Returns the percentage of courses that you've completed with the specified StepsType and Difficulty. + + + Returns the possible score of courses with the specified StepsType and Difficulty. + Returns the profile's display name. + + Return the number of calories burned as a string. + + + Returns the number of calories needed to reach the goal. + + + Returns the number of seconds needed to reach the goal. + + + Returns the current goal type. + + + Gets the profile's HighScoreList for a specified Song and Steps. (Alternate arguments for Courses: Course c, Trail t) + Returns the number of Toasties gotten using the specified profile. @@ -1442,6 +1486,21 @@ Returns the number of times song s has been played with the profile. + + Returns a composite of your high scores over songs with the specified StepsType and Difficulty. + + + Returns the percent complete for all songs and courses for the specified StepsType st. + + + Returns the percentage of songs that you've completed with the specified StepsType and Difficulty. + + + Returns the possible score of songs with the specified StepsType and Difficulty. + + + Return the total number of calories burned. + Returns the number of Hands stepped on. @@ -1460,6 +1519,36 @@ Returns the number of successful Rolls. + + Returns the number of steps with the specified StepsType and Difficulty that you've scored a certain Grade g on. + + + Returns the number of Taps and successful Holds. + + + Returns the number of trails with the specified StepsType and Difficulty that you've scored a certain Grade g on. + + + Returns how much the player weighs. + + + Returns true if the player has passed any steps in the specified Song s. + + + Returns true if the specified code sUnlockEntryID is unlocked. + + + Sets the goal to iCals calories. + + + Sets the goal to iSecs seconds. + + + Sets the current goal type to gt. + + + Sets how much the player weighs (in pounds) to weightPounds. + @@ -1468,6 +1557,12 @@ Retuns the amount of local profiles. + + Retuns the Profile for Player pn. + + + Retuns true if the Profile for Player pn is persistent. + Saves the machine profile. @@ -1569,6 +1664,11 @@ Posts a message with the text sScreenMsg to the Screen. + + + Returns the StageStats. + + Returns true if a single has its NoteField centered.