update lua documentation. also, the schema validator moved; updated its location
This commit is contained in:
+9
-12
@@ -3,6 +3,7 @@
|
|||||||
|
|
||||||
<Lua xmlns='http://www.stepmania.com' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.stepmania.com Lua.xsd'>
|
<Lua xmlns='http://www.stepmania.com' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.stepmania.com Lua.xsd'>
|
||||||
<GlobalFunctions>
|
<GlobalFunctions>
|
||||||
|
<Function name='AllowOptionsMenu'/>
|
||||||
<Function name='Alpha'/>
|
<Function name='Alpha'/>
|
||||||
<Function name='AreStagePlayerModsForced'/>
|
<Function name='AreStagePlayerModsForced'/>
|
||||||
<Function name='AreStageSongModsForced'/>
|
<Function name='AreStageSongModsForced'/>
|
||||||
@@ -39,7 +40,6 @@
|
|||||||
<Function name='FormatNumberAndSuffix'/>
|
<Function name='FormatNumberAndSuffix'/>
|
||||||
<Function name='FormatPercentScore'/>
|
<Function name='FormatPercentScore'/>
|
||||||
<Function name='GameCompatibleModes'/>
|
<Function name='GameCompatibleModes'/>
|
||||||
<Function name='GamePrefComboOnRolls'/>
|
|
||||||
<Function name='GamePrefDefaultFail'/>
|
<Function name='GamePrefDefaultFail'/>
|
||||||
<Function name='GetCodeForGame'/>
|
<Function name='GetCodeForGame'/>
|
||||||
<Function name='GetCoursesToShowRanking'/>
|
<Function name='GetCoursesToShowRanking'/>
|
||||||
@@ -184,16 +184,7 @@
|
|||||||
<Function name='URLEncode'/>
|
<Function name='URLEncode'/>
|
||||||
<Function name='UndocumentedFeature'/>
|
<Function name='UndocumentedFeature'/>
|
||||||
<Function name='UnlockRewardTypeToLocalizedString'/>
|
<Function name='UnlockRewardTypeToLocalizedString'/>
|
||||||
<Function name='UserPrefAutoSetStyle'/>
|
|
||||||
<Function name='UserPrefComboUnderField'/>
|
|
||||||
<Function name='UserPrefFlashyCombo'/>
|
|
||||||
<Function name='UserPrefGameplayFooter'/>
|
|
||||||
<Function name='UserPrefGameplayShowScore'/>
|
|
||||||
<Function name='UserPrefGameplayShowStepsDisplay'/>
|
|
||||||
<Function name='UserPrefLongFail'/>
|
|
||||||
<Function name='UserPrefNotePosition'/>
|
|
||||||
<Function name='UserPrefScoringMode'/>
|
<Function name='UserPrefScoringMode'/>
|
||||||
<Function name='UserPrefShowLotsaOptions'/>
|
|
||||||
<Function name='Var'/>
|
<Function name='Var'/>
|
||||||
<Function name='VersionDate'/>
|
<Function name='VersionDate'/>
|
||||||
<Function name='VersionTime'/>
|
<Function name='VersionTime'/>
|
||||||
@@ -776,6 +767,7 @@
|
|||||||
<Function name='GetSongPercent'/>
|
<Function name='GetSongPercent'/>
|
||||||
<Function name='GetSongPosition'/>
|
<Function name='GetSongPosition'/>
|
||||||
<Function name='GetSortOrder'/>
|
<Function name='GetSortOrder'/>
|
||||||
|
<Function name='GetStageResult'/>
|
||||||
<Function name='GetStageSeed'/>
|
<Function name='GetStageSeed'/>
|
||||||
<Function name='GetWorkoutGoalComplete'/>
|
<Function name='GetWorkoutGoalComplete'/>
|
||||||
<Function name='HasEarnedExtraStage'/>
|
<Function name='HasEarnedExtraStage'/>
|
||||||
@@ -2196,6 +2188,11 @@
|
|||||||
<EnumValue name=''StageAward_90PercentW3'' value='8'/>
|
<EnumValue name=''StageAward_90PercentW3'' value='8'/>
|
||||||
<EnumValue name=''StageAward_100PercentW3'' value='9'/>
|
<EnumValue name=''StageAward_100PercentW3'' value='9'/>
|
||||||
</Enum>
|
</Enum>
|
||||||
|
<Enum name='StageResult'>
|
||||||
|
<EnumValue name=''StageResult_Win'' value='0'/>
|
||||||
|
<EnumValue name=''StageResult_Lose'' value='1'/>
|
||||||
|
<EnumValue name=''StageResult_Draw'' value='2'/>
|
||||||
|
</Enum>
|
||||||
<Enum name='StepsType'>
|
<Enum name='StepsType'>
|
||||||
<EnumValue name=''StepsType_Dance_Single'' value='0'/>
|
<EnumValue name=''StepsType_Dance_Single'' value='0'/>
|
||||||
<EnumValue name=''StepsType_Dance_Double'' value='1'/>
|
<EnumValue name=''StepsType_Dance_Double'' value='1'/>
|
||||||
@@ -2343,6 +2340,6 @@
|
|||||||
<Constant name='right' value=''HorizAlign_Right''/>
|
<Constant name='right' value=''HorizAlign_Right''/>
|
||||||
<Constant name='top' value=''VertAlign_Top''/>
|
<Constant name='top' value=''VertAlign_Top''/>
|
||||||
</Constants>
|
</Constants>
|
||||||
<Version>StepMania v5.0 alpha 1a</Version>
|
<Version>StepMania v5.0 alpha 2</Version>
|
||||||
<Date>2012-03-20</Date>
|
<Date>2012-04-02</Date>
|
||||||
</Lua>
|
</Lua>
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
|
|
||||||
<!-- Before checking the documentation in, make sure that it validates by
|
<!-- Before checking the documentation in, make sure that it validates by
|
||||||
going to http://tools.decisionsoft.com/schemaValidate/ and using
|
going to http://www.corefiling.com/opensource/schemaValidate.html and using
|
||||||
Lua.xsd for the XML Schema and this file for the XML Instance. -->
|
Lua.xsd for the XML Schema and this file for the XML Instance. -->
|
||||||
|
|
||||||
<!-- Using Link:
|
<!-- Using Link:
|
||||||
@@ -697,6 +697,14 @@ save yourself some time, copy this for undocumented things:
|
|||||||
a warning. Aliased by <Link class='GLOBAL' function='Warn' />.
|
a warning. Aliased by <Link class='GLOBAL' function='Warn' />.
|
||||||
</Function>
|
</Function>
|
||||||
</Namespace>
|
</Namespace>
|
||||||
|
<Namespace name='MersenneTwister'>
|
||||||
|
<Function name='Random' return='float' arguments='...'>
|
||||||
|
Returns a random number. Without arguments, the number is in the range <code>0..1</code>. With a single argument (<code>n</code>), the number is in the range of <code>1..n</code>. With two arguments (<code>lower</code>, <code>upper</code>), the number is in the range of <code>l..u</code>.
|
||||||
|
</Function>
|
||||||
|
<Function name='Seed' return='void' arguments='int seed'>
|
||||||
|
Sets the seed of the random number generator to <code>seed</code>.
|
||||||
|
</Function>
|
||||||
|
</Namespace>
|
||||||
<Namespace name='RageFileUtil'>
|
<Namespace name='RageFileUtil'>
|
||||||
<Function name='CreateRageFile' return='RageFile' arguments=''>
|
<Function name='CreateRageFile' return='RageFile' arguments=''>
|
||||||
Creates a RageFile handle with which one can use the commands in <Link class='RageFile' />.
|
Creates a RageFile handle with which one can use the commands in <Link class='RageFile' />.
|
||||||
@@ -1976,6 +1984,9 @@ save yourself some time, copy this for undocumented things:
|
|||||||
<Function name='GetSortOrder' return='SortOder' arguments=''>
|
<Function name='GetSortOrder' return='SortOder' arguments=''>
|
||||||
Returns the sort order, if the GameCommand has set one.
|
Returns the sort order, if the GameCommand has set one.
|
||||||
</Function>
|
</Function>
|
||||||
|
<Function name='GetStageResult' return='StageResult' arguments='PlayerNumber pn'>
|
||||||
|
Returns the StageResult for player <code>pn</code>.
|
||||||
|
</Function>
|
||||||
<Function name='GetStageModifiers' return='string' arguments=''>
|
<Function name='GetStageModifiers' return='string' arguments=''>
|
||||||
Returns any stage modifiers that may have been set.
|
Returns any stage modifiers that may have been set.
|
||||||
</Function>
|
</Function>
|
||||||
@@ -3297,7 +3308,7 @@ save yourself some time, copy this for undocumented things:
|
|||||||
Returns a PlayerOptions object for the specified ModsLevel.
|
Returns a PlayerOptions object for the specified ModsLevel.
|
||||||
</Function>
|
</Function>
|
||||||
<Function name='GetPlayerOptionsString' return='string' arguments='ModsLevel ml'>
|
<Function name='GetPlayerOptionsString' return='string' arguments='ModsLevel ml'>
|
||||||
Returns a string of player options for the specified ModsLevel. (was GetPlayerOptions in v1.2.2 and prior)
|
Returns a string of player options for the specified ModsLevel. (was <code>GetPlayerOptions</code> before sm-ssc v1.2.3)
|
||||||
</Function>
|
</Function>
|
||||||
<Function name='GetPlayerOptionsArray' return='{string}' arguments='ModsLevel ml'>
|
<Function name='GetPlayerOptionsArray' return='{string}' arguments='ModsLevel ml'>
|
||||||
Returns a table of strings, containing the player options for the specified ModsLevel.
|
Returns a table of strings, containing the player options for the specified ModsLevel.
|
||||||
@@ -3823,7 +3834,7 @@ save yourself some time, copy this for undocumented things:
|
|||||||
</Class>
|
</Class>
|
||||||
<Class name='ScreenTextEntry'>
|
<Class name='ScreenTextEntry'>
|
||||||
<Description>
|
<Description>
|
||||||
See the Changelog for details on TextEntrySetting's format.
|
TextEntrySettings is implemented similar to the Attributes in BitmapText. Formatting issues prevent the sample from being properly shown here; please see Changelog_sm-ssc.txt for the TextEntrySettings format.
|
||||||
</Description>
|
</Description>
|
||||||
<Function name='Load' return='void' arguments='TextEntrySettings args'>
|
<Function name='Load' return='void' arguments='TextEntrySettings args'>
|
||||||
Sets up a ScreenTextEntry's values.
|
Sets up a ScreenTextEntry's values.
|
||||||
|
|||||||
Reference in New Issue
Block a user