diff --git a/stepmania/Docs/LuaDocumentation.xml b/stepmania/Docs/LuaDocumentation.xml index a1d853cbe7..ff9a688e3a 100644 --- a/stepmania/Docs/LuaDocumentation.xml +++ b/stepmania/Docs/LuaDocumentation.xml @@ -91,6 +91,11 @@ + + + Returns true if sClassName is a registered Class. + + Enumerated types are lookup tables associating a string to each numerical @@ -154,6 +159,19 @@ Flushes log files to disk. + + + Gets the credits message for Player pn. + + + + + Returns true if so has steps for st. + + + Returns true if so has a StepsType matching st. + + @@ -213,16 +231,19 @@ Set's the Actor's alpha level to fAlpha, where fAlpha is in the range 0..1. + + Set the Actor's diffuse color to c, ignoring any alpha value in c. + Set's the Actor's draworder to iOrder, where larger values display first. Set the Actor's effect clock to s. - + Sets the first effect color to c. - + Sets the second effect color to c. @@ -300,6 +321,9 @@ Sets a multi-framed Actor's state to iNewState. + + Sets the shadow's color to c. + Sets the Actor's shadow length to fLength. @@ -341,16 +365,47 @@ Sets the field of view for the ActorFrame. + + Returns the child with a name of sName. + Returns the number of children in the ActorFrame. Sets the field of view for the ActorFrame. + + Sets the ActorFrame's update function to the specified Lua function. + + + Sets the update function's rate to fRate. + + + Tells the ActorFrame to sort by draw order. + Sets the vanishing point for the ActorFrame. + + + Clears all the textures from the MultiTexture. + + + Sets the EffectMode on the MultiTexture. + + + Sets a TextureMode on the specified index. + + + + + Returns the target of the ActorProxy. + + + Sets the ActorProxy target to a. + + Specifies if the scroller should loop or not. @@ -431,6 +486,9 @@ Set the text to sText. This clears all attributes. + + Sets the stroke color to c. + If true, make all text uppercase. @@ -442,9 +500,15 @@ + + Returns a table of all the Trails in the Course. + Returns the path to the Course's banner. + + Gets the CourseEntry at iIndex from the Course. + Returns the Course's . @@ -476,6 +540,11 @@ Returns true if the Course was automatically generated. + + + Returns the Song that this CourseEntry corresponds to. + + Return the corresponding to sID. @@ -599,12 +668,18 @@ Returns the master player number. + + Returns true if the game is Multiplayer. + Returns the number of players enabled. Returns the number of sides joined. + + Returns the number of stages for the current Song and its Steps or the current Course. + Returns the number of stages left for player pn. @@ -617,6 +692,15 @@ Returns the current PlayMode. + + Returns the preferred difficulty. + + + Returns the preferred song. + + + Returns the preferred song group. + Returns the current Premium. @@ -625,7 +709,6 @@ Returns the current beat of the song. - Returns the current visible beat of the song. @@ -646,15 +729,33 @@ Return the random seed for the current stage. + + Returns true if an extra stage was earned. + + + Returns true if this is an extra stage. + + + Returns true if any human player is using a memory card. + Returns true if playing in a Course mode. Returns true if in Demonstration mode. + + Returns true if the match was a draw. + Returns true if Event Mode is on, temporary or otherwise. + + Returns true if this is the first extra stage. + + + Returns true if this is the second extra stage. + Returns true if player pn is human. @@ -762,6 +863,9 @@ Returns the number of judgments for a specified HoldNoteScore. + + Returns the player's life remaining seconds. + Returns the player's Dance Point percentage. @@ -778,6 +882,17 @@ Returns true if the player was disqualified from ranking. + + + Returns the player number for this PlayerState. + + + Sets the player options to sPlayerOptions for the specified ModsLevel. + + + Returns a string of player options for the specified ModsLevel. + + Return the value of the preference sPreference. @@ -811,9 +926,24 @@ Returns the number of times song s has been played with the profile. + + Returns the number of Hands stepped on. + + + Returns the number of successful Holds. + + + Returns the number of Jumps stepped on. + + + Returns the number of Mines stepped on. + Returns the total number of songs played with the profile. + + Returns the number of successful Rolls. + @@ -956,6 +1086,9 @@ Returns the group name that the song is in. + + Returns a Step object if the StepType and Difficulty exist. + Returns the song's directory. @@ -1018,6 +1151,12 @@ Returns a random song. + + Returns the song color of s. + + + Returns the song group color of sGroupName. + @@ -1104,11 +1243,22 @@ Returns true if the steps were automatically generated. + + + Returns the name of the Style. + + + Returns the StepsType for this Style. + + + Returns the StyleType for this Style. + + - + Loads the TextBanner's child elements from a . - + Loads the TextBanner's child elements from strings.