From 543d533f7586cc3aebdd2c572468d1e9181e2d21 Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Sat, 6 Jun 2009 08:05:38 +0000 Subject: [PATCH] update lua docs --- stepmania/Docs/LuaDocumentation.xml | 300 ++++++++++++++++++++++++++++ 1 file changed, 300 insertions(+) diff --git a/stepmania/Docs/LuaDocumentation.xml b/stepmania/Docs/LuaDocumentation.xml index 6a59812dca..092335c4bd 100644 --- a/stepmania/Docs/LuaDocumentation.xml +++ b/stepmania/Docs/LuaDocumentation.xml @@ -237,6 +237,9 @@ Adds zPos to the Actor's current z position. + + Sets the alignment of an Actor, where h and v are in the range 0..1. + Sets whether or not the Actor should animate. @@ -268,6 +271,12 @@ Sets the Actor to use the specified blend mode. + + Makes the Actor bob up and down. Can use to define different bobbing behavior. + + + Centers an Actor. + Crops percent of the Actor from the bottom where percent is in the range 0..1. @@ -355,6 +364,9 @@ Finishes up an Actor's tween immediately. + + Stretches an Actor to fill the entire screen. + Returns the Actor's aux value. @@ -377,6 +389,12 @@ Returns the Actor's current width. + + Returns the zoomed height of an Actor. + + + Returns the zoomed width of an Actor. + Sets the Actor's glow color. @@ -499,9 +517,18 @@ Returns an table of all the children in the ActorFrame. + + Gets the ActorFrame's Draw function. + Returns the number of children in the ActorFrame. + + Sets if the ActorFrame should draw by Z position. + + + Sets the ActorFrame's Draw function to the specified Lua function. + Sets the field of view for the ActorFrame. @@ -538,9 +565,49 @@ + + Returns the number of seconds until the scroller reaches its destination. + + + Positions the scroller items. + + + Scrolls through all the items in the scroller. + + + Scrolls through all the items in the scroller with padding at the beginning and end. + + + Sets the item the scroller should scroll to next and makes it the current item. + + + Sets the item the scroller should scroll to next. + + + Sets if the scroller should catch up fast. + Specifies if the scroller should loop or not. + + Sets the scroller's mask to a Quad that is fWidth by fHeight pixels. + + + Sets the number of subdivisions in the scroller. + + + Sets the scroller's pause countdown to fSecs. + + + Sets the scroller's pause between items to fSeconds. + + + Sets how many seconds the scroller should spend on each item.
+ A value of 0 means the scroller will not scroll. + + + Sets the scroller's transform function to the specified Lua function. + Sets the scroller's transform function from fItemHeight. @@ -568,6 +635,18 @@ + + Loads the background from an UnlockEntry. + + + Loads the banner from an UnlockEntry. + + + Loads the card image from the specified Character. + + + + Loads a Banner from a specified Course. @@ -577,6 +656,15 @@ Loads a Banner from a specified Song Group. + + Loads an icon from the specified Character. + + + See . + + + See . + @@ -630,6 +718,27 @@ 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). + + + Sets the BPMDisplay from the GameState. + + + + + Loads the ComboGraph commands from the Metrics in group sMetricsGroup. + + + Sets the values of the ComboGraph using the specified StageStats and PlayerStageStats. + + + + + Loads the ControllerStateDisplay from the specified GameController. + + + Loads the ControllerStateDisplay from the specified MultiPlayer. + + Returns a table of all the Trails in the Course. @@ -649,6 +758,9 @@ Returns the estimated number of stages for the Course. + + Returns the goal seconds for the Course. + Returns the Course's group name. @@ -674,6 +786,11 @@ Returns true if the Course is Endless. + + + Sets the CourseContentsList from the GameState. + + Returns the Song that this CourseEntry corresponds to. @@ -698,11 +815,61 @@ Return the corresponding to sID. + + + Sets the DifficultyIcon's state from the difficulty passed in. + + + Sets the DifficultyIcon's Player to pn, + then sets the DifficultyIcon's state from the difficulty of Steps pSteps + + + Sets the DifficultyIcon's Player to pn, + then sets the DifficultyIcon's state from the difficulty of Trail pTrail + + + Sets the DifficultyIcon's Player to pn. + + + Blanks the DifficultyIcon. + + + + + Sets the DifficultyList from the GameState. + + Returns the name of the game such as "dance" or "pump". + + + Returns the index of this item. + + + Returns any MultiPlayer that may have been set. + + + Returns the choice name. + + + Returns any Profile ID that may have been set. + + + Returns any Song that may have been set. + + + Returns the name of any song group that may have been set. + + + Returns any Style that may have been set. + + + Returns the display text. + + Set the music volume to fVolume for fDuration seconds. @@ -919,9 +1086,92 @@ Returns true if players can join the game. + + Resets the GameState. + Saves the bookkeeping and machine profile data. + + Sets the current Course to course. + + + Sets the current Song to song. + + + Sets the current Steps to steps. + + + Sets the current Trail to trail. + + + Sets if the Jukebox should use modifiers. + + + Sets the number of multiplayer notefields to iFields + + + Sets the preferred difficulty of Player pn to Difficulty dc. + + + Sets the preferred Song to song. + + + Sets the preferred song group to sGroup. + + + Sets the Song Options from so using ModsLevel m. + + + Turns temporary Event Mode on or off, depending on bOn. + + + Determines if Judgment W1 should be shown based on bOn. + + + + + Loads the GradeDisplay commands from the Metrics in group sMetricsGroup. + + + Sets the GradeDisplay to show Grade g. + + + + + Loads the GraphDisplay commands from the Metrics in group sMetricsGroup. + + + Sets the values of the GraphDisplay using the specified StageStats and PlayerStageStats. + + + + + Sets the GrooveRadar values for Player pn to empty. + + + Sets the GrooveRadar values for Player pn from RadarValues rv + + + Tweens the GrooveRadar off screen. + + + Tweens the GrooveRadar on screen. + + + + + Returns two tables representing the tips and alternate tips in the HelpDisplay. + + + Sets the seconds between switches of tips to fSeconds. + + + Sets the HelpDisplay's tips using tips (and optionally altTips). + + + Sets the HelpDisplay's text from sTips using colons to separate new sections. + @@ -940,6 +1190,14 @@ Returns the number of seconds survived associated with the high score. + + + You can get a HighScoreList using . + + + Returns a table of the high scores. + + Returns the amount of life left in the LifeMeter as a float in the range 0..1. @@ -1001,6 +1259,11 @@ Sets the model's default animation to sAnimation at fPlayRate speed (default 1.0). + + + Loads the ModIconRow of Player pn from the Metrics in group sMetricsGroup. + + Returns a command from the specified element and value. @@ -1021,6 +1284,16 @@ Returns the actor for the specified sButton sElement. + + + Sets the PaneDisplay from the GameState. + + + + + Sets the PaneDisplay from the specified PlayerState and PlayerStageStats. + + Returns the of player pn. @@ -1069,12 +1342,18 @@ Returns the personal high score index for this performance. + + Returns a table of played steps. + Returns the player's Dance Point percentage. Returns the number of possible Dance Points. + + Returns a table of possible steps. + Returns the score. @@ -1189,11 +1468,32 @@ Closes the file and releases it from memory. + + Safely deletes the file handle. + + + Gets the last error message and returns it. + + + Gets a line and returns it. + Opens a file at sPath (relative to the StepMania root directory).
iAccessType can be set to read (1), write (2), stream (4) or flush to disk on close (8).
These can also be combined with addition. For example, to set up read and write, set iAccessType to 3 (1+2). + + Puts a new line in the file. + + + Returns a string containing the entire contents of the file. + + + Seeks to a position in the file and returns the new position. + + + Writes a file with the contents of str. +