Added documentation for a few undocumented API functions.
This commit is contained in:
@@ -66,6 +66,7 @@
|
|||||||
<Function name='GetThemeAspectRatio'/>
|
<Function name='GetThemeAspectRatio'/>
|
||||||
<Function name='GetThemePref'/>
|
<Function name='GetThemePref'/>
|
||||||
<Function name='GetTimingDifficulty'/>
|
<Function name='GetTimingDifficulty'/>
|
||||||
|
<Function name='GetTimeSinceStart'/>
|
||||||
<Function name='GetTitleSafeH'/>
|
<Function name='GetTitleSafeH'/>
|
||||||
<Function name='GetTitleSafeV'/>
|
<Function name='GetTitleSafeV'/>
|
||||||
<Function name='GetUnlockEntryIndexToCelebrate'/>
|
<Function name='GetUnlockEntryIndexToCelebrate'/>
|
||||||
@@ -399,6 +400,7 @@
|
|||||||
<Function name='stopeffect'/>
|
<Function name='stopeffect'/>
|
||||||
<Function name='stoptweening'/>
|
<Function name='stoptweening'/>
|
||||||
<Function name='stretchto'/>
|
<Function name='stretchto'/>
|
||||||
|
<Function name='texturetranslate'/>
|
||||||
<Function name='texturewrapping'/>
|
<Function name='texturewrapping'/>
|
||||||
<Function name='thump'/>
|
<Function name='thump'/>
|
||||||
<Function name='tween'/>
|
<Function name='tween'/>
|
||||||
@@ -931,6 +933,8 @@
|
|||||||
</Class>
|
</Class>
|
||||||
<Class name='NoteSkinManager'>
|
<Class name='NoteSkinManager'>
|
||||||
<Function name='DoesNoteSkinExist'/>
|
<Function name='DoesNoteSkinExist'/>
|
||||||
|
<Function name='GetMetric'/>
|
||||||
|
<Function name='GetMetricForNoteSkin'/>
|
||||||
<Function name='GetMetricA'/>
|
<Function name='GetMetricA'/>
|
||||||
<Function name='GetMetricAForNoteSkin'/>
|
<Function name='GetMetricAForNoteSkin'/>
|
||||||
<Function name='GetMetricB'/>
|
<Function name='GetMetricB'/>
|
||||||
@@ -1276,6 +1280,7 @@
|
|||||||
<Class base='ScreenWithMenuElements' name='ScreenGameplay'>
|
<Class base='ScreenWithMenuElements' name='ScreenGameplay'>
|
||||||
<Function name='Center1Player'/>
|
<Function name='Center1Player'/>
|
||||||
<Function name='GetDummyPlayerInfo'/>
|
<Function name='GetDummyPlayerInfo'/>
|
||||||
|
<Function name='GetHasteRate'/>
|
||||||
<Function name='GetLifeMeter'/>
|
<Function name='GetLifeMeter'/>
|
||||||
<Function name='GetNextCourseSong'/>
|
<Function name='GetNextCourseSong'/>
|
||||||
<Function name='GetPlayerInfo'/>
|
<Function name='GetPlayerInfo'/>
|
||||||
@@ -1573,6 +1578,8 @@
|
|||||||
<Function name='GetName'/>
|
<Function name='GetName'/>
|
||||||
<Function name='GetStepsType'/>
|
<Function name='GetStepsType'/>
|
||||||
<Function name='GetStyleType'/>
|
<Function name='GetStyleType'/>
|
||||||
|
<Function name='GetColumnInfo'/>
|
||||||
|
<Function name='GetColumnDrawOrder'/>
|
||||||
<Function name='LockedDifficulty'/>
|
<Function name='LockedDifficulty'/>
|
||||||
<Function name='NeedsZoomOutWith2Players'/>
|
<Function name='NeedsZoomOutWith2Players'/>
|
||||||
</Class>
|
</Class>
|
||||||
|
|||||||
@@ -217,6 +217,9 @@ save yourself some time, copy this for undocumented things:
|
|||||||
<Function name='GetTimingDifficulty' return='int' arguments=''>
|
<Function name='GetTimingDifficulty' return='int' arguments=''>
|
||||||
Returns the current Timing difficulty.
|
Returns the current Timing difficulty.
|
||||||
</Function>
|
</Function>
|
||||||
|
<Function name='GetTimeSinceStart' return='float' arguments=''>
|
||||||
|
Returns the current time since the program was started. Includes time that was spent loading songs.
|
||||||
|
</Function>
|
||||||
<Function name='GetTitleSafeH' theme='_fallback' return='float' arguments='float fPercent'>
|
<Function name='GetTitleSafeH' theme='_fallback' return='float' arguments='float fPercent'>
|
||||||
[01 alias.lua]
|
[01 alias.lua]
|
||||||
</Function>
|
</Function>
|
||||||
@@ -1188,6 +1191,9 @@ save yourself some time, copy this for undocumented things:
|
|||||||
<Function name='stretchto' return='void' arguments='float x1, float y1, float x2, float y2'>
|
<Function name='stretchto' return='void' arguments='float x1, float y1, float x2, float y2'>
|
||||||
Stretches the Actor to a rectangle of a specific size.
|
Stretches the Actor to a rectangle of a specific size.
|
||||||
</Function>
|
</Function>
|
||||||
|
<Function name='texturetranslate' return='void' arguments='float x, float y'>
|
||||||
|
Translates the texture of the actor by x and y.
|
||||||
|
</Function>
|
||||||
<Function name='texturewrapping' return='void' arguments='bool bWrap'>
|
<Function name='texturewrapping' return='void' arguments='bool bWrap'>
|
||||||
Determines if the Actor should use texture wrapping or not.
|
Determines if the Actor should use texture wrapping or not.
|
||||||
</Function>
|
</Function>
|
||||||
@@ -2728,6 +2734,12 @@ save yourself some time, copy this for undocumented things:
|
|||||||
</Function>
|
</Function>
|
||||||
</Class>
|
</Class>
|
||||||
<Class name='NoteSkinManager'>
|
<Class name='NoteSkinManager'>
|
||||||
|
<Function name='GetMetric' return='string' arguments='string sElement, string sValue'>
|
||||||
|
Returns a string from the specified element and value.
|
||||||
|
</Function>
|
||||||
|
<Function name='GetMetricForNoteSkin' return='string' arguments='string sElement, string sValue, string sNoteSkin'>
|
||||||
|
Returns a string from the specified element and value using NoteSkin <code>sNoteSkin</code>.
|
||||||
|
</Function>
|
||||||
<Function name='GetMetricA' return='ActorCommand' arguments='string sElement, string sValue'>
|
<Function name='GetMetricA' return='ActorCommand' arguments='string sElement, string sValue'>
|
||||||
Returns a command from the specified element and value.
|
Returns a command from the specified element and value.
|
||||||
</Function>
|
</Function>
|
||||||
@@ -3574,6 +3586,9 @@ save yourself some time, copy this for undocumented things:
|
|||||||
<Function name='GetDummyPlayerInfo' return='PlayerInfo' arguments='int index'>
|
<Function name='GetDummyPlayerInfo' return='PlayerInfo' arguments='int index'>
|
||||||
Returns a dummy PlayerInfo for the specified index.
|
Returns a dummy PlayerInfo for the specified index.
|
||||||
</Function>
|
</Function>
|
||||||
|
<Function name='GetHasteRate' return='float' arguments=''>
|
||||||
|
Returns the current haste rate. HasteRate * MusicRate is the current total rate the music is multiplied by.
|
||||||
|
</Function>
|
||||||
<Function name='GetLifeMeter' return='LifeMeter' arguments='PlayerNumber pn'>
|
<Function name='GetLifeMeter' return='LifeMeter' arguments='PlayerNumber pn'>
|
||||||
Returns the <Link class='LifeMeter' /> for the specified <Link class='ENUM' function='PlayerNumber' /> <code>pn</code>.
|
Returns the <Link class='LifeMeter' /> for the specified <Link class='ENUM' function='PlayerNumber' /> <code>pn</code>.
|
||||||
</Function>
|
</Function>
|
||||||
@@ -4363,6 +4378,12 @@ save yourself some time, copy this for undocumented things:
|
|||||||
<Function name='GetStyleType' return='StyleType' arguments=''>
|
<Function name='GetStyleType' return='StyleType' arguments=''>
|
||||||
Returns the StyleType for this Style.
|
Returns the StyleType for this Style.
|
||||||
</Function>
|
</Function>
|
||||||
|
<Function name='GetColumnInfo' return='{Track= int, XOffset= int, Name= string}' arguments='int column'>
|
||||||
|
Returns a table containing the Track, XOffset, and Name of the column.
|
||||||
|
</Function>
|
||||||
|
<Function name='GetColumnDrawOrder' return='int' arguments='int column'>
|
||||||
|
Returns the draw order of the column.
|
||||||
|
</Function>
|
||||||
<Function name='LockedDifficulty' return='bool' arguments=''>
|
<Function name='LockedDifficulty' return='bool' arguments=''>
|
||||||
Returns <code>true</code> if this style locks the difficulty for both players.
|
Returns <code>true</code> if this style locks the difficulty for both players.
|
||||||
</Function>
|
</Function>
|
||||||
|
|||||||
Reference in New Issue
Block a user