diff --git a/stepmania/Docs/LuaDocumentation.xml b/stepmania/Docs/LuaDocumentation.xml index da1d38b6f1..ff524486d3 100644 --- a/stepmania/Docs/LuaDocumentation.xml +++ b/stepmania/Docs/LuaDocumentation.xml @@ -11,7 +11,7 @@ To add a link to a function in the current class: addx() To add a link to a function in another class: - ActorFrame:propogate() + ActorFrame:propagate() To add a link to a class: ActorFrame To add a link to a global function: @@ -23,57 +23,63 @@ - - Returns the base name of file path. - - - Returns the current day of the month. - - - Returns the current day of the year. - - - Returns the number passed to the function followed by its suffix ("th", "nd", and so on). - - - Returns the current hour. - - - Returns true if Event Mode is turned on. - - - 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. - - - Returns the current Minute. - - - Returns the current month of the year. - - - Returns the current second. - - - Converts fSecs to Minutes:Seconds.Milliseconds format. - - - Alias for . - - - Alias for . - - - Writes sString to log.txt. Aliased by . - - - Writes sString to info.txt and log.txt as a warning. Aliased by . - - - Flushes log files to disk. - - - Returns the length of the multi-byte character string sString. - + + Returns the base name of file path. + + + Returns the current day of the month. + + + Returns the current day of the year. + + + Returns the number passed to the function followed by its suffix ("th", "nd", and so on). + + + Returns fPercentDancePoints formatted as a percentage. + + + Return's the theme's aspect ratio. + + + Returns the current hour. + + + Returns true if Event Mode is turned on. + + + 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. + + + Returns the current Minute. + + + Returns the current month of the year. + + + Returns the current second. + + + Converts fSecs to Minutes:Seconds.Milliseconds format. + + + Alias for . + + + Alias for . + + + Writes sString to log.txt. Aliased by . + + + Writes sString to info.txt and log.txt as a warning. Aliased by . + + + Flushes log files to disk. + + + Returns the length of the multi-byte character string sString. + @@ -118,6 +124,9 @@ Set the fractional horizontal alignment of the Actor according to fAlign which should be a float in the range 0..1. An alignment of 0 is left aligned while an alignment of 1 is right aligned. See for the common case. + + Sets an Actor's hidden value to b. Deprecated, use instead. + Set the horizontal alignment of the Actor according to align. See for fractional alignment. @@ -127,6 +136,9 @@ Set the vertical alignment of the Actor according to align. See for fractional alignment. + + Sets an Actor's visibility to b. + Set the x position of the Actor to xPos. @@ -213,6 +225,26 @@ 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). + + + Returns the path to the course's banner. + + + Returns the course's . + + + Returns the full display title of the course. + + + Returns the course's group name. + + + Returns the full transliterated title of the course. + + + Returns true if the course was automatically generated. + + Return the corresponding to sID. @@ -348,9 +380,20 @@ Returns the number of stages left for player pn. + + + Returns true if failing. + + + Returns true if the LifeMeter is "hot". + + + Returns true if in danger. + + - Return the state for pn. + Return the state for player pn. @@ -371,6 +414,11 @@ set to nil. + + + Returns the of player pn. + + Returns true if a full combo (TNS_W3 and up) was obtained. @@ -548,9 +596,21 @@ + + Returns the Steps description. + + + Returns the Steps filename. + + + Returns the numerical difficulty of the Steps. + Returns the complete list of RadarValues for player pn. Use to grab a specific value. + + Returns true if the steps were automatically generated. + @@ -561,6 +621,9 @@ + + Returns the value of Element in Class from metrics.ini. + Returns the number of selectable themes. @@ -576,6 +639,9 @@ Returns the path of an element in the Sounds folder. + + Returns the value of Element in Class for the currently loaded language. +