actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

luadoc

Browse Source
This commit is contained in:
AJ Kelly
2011-08-20 16:51:48 -05:00
parent fb7e66db0a
commit 2467eaa09d
2 changed files with 98 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Luadoc/Lua.xml
+39 -6
View File
@@ -12,7 +12,6 @@
<Function name='Center1Player'/>
<Function name='CheckpointsTapsSeparateJudgment'/>
<Function name='CloseConnection'/>
<Function name='Color'/>
<Function name='ColorDarkTone'/>
<Function name='ColorLightTone'/>
<Function name='ColorMidTone'/>
@@ -33,6 +32,7 @@
<Function name='DayOfMonth'/>
<Function name='DayOfYear'/>
<Function name='DeepCopy'/>
<Function name='EvalUsesCheckpointsWithJudgments'/>
<Function name='FailCombo'/>
<Function name='FindSelection'/>
<Function name='FindValue'/>
@@ -42,6 +42,7 @@
<Function name='GameCompatibleModes'/>
<Function name='GamePrefComboOnRolls'/>
<Function name='GamePrefDefaultFail'/>
<Function name='GetCodeForGame'/>
<Function name='GetCoursesToShowRanking'/>
<Function name='GetCustomDifficulty'/>
<Function name='GetDefaultOptionLines'/>
@@ -94,6 +95,7 @@
<Function name='IsNetSMOnline'/>
<Function name='IsRoutine'/>
<Function name='IsSMOnlineLoggedIn'/>
<Function name='IsUsingTwoScreens'/>
<Function name='IsUsingWideScreen'/>
<Function name='IsW1Allowed'/>
<Function name='JudgmentLineToColor'/>
@@ -126,6 +128,7 @@
<Function name='PlayerNumberToString'/>
<Function name='PlayerScoreColor'/>
<Function name='PositionPerPlayer'/>
<Function name='PrettyPercent'/>
<Function name='PrintTable'/>
<Function name='ProductID'/>
<Function name='ProductVersion'/>
@@ -159,6 +162,9 @@
<Function name='SetUserPref'/>
<Function name='ShowHoldJudgments'/>
<Function name='ShowStandardDecoration'/>
<Function name='SongMeterDisplayCommand'/>
<Function name='SongMeterDisplayX'/>
<Function name='SongMeterDisplayY'/>
<Function name='SortOrderToLocalizedString'/>
<Function name='SpeedMods'/>
<Function name='StageAwardToLocalizedString'/>
@@ -178,11 +184,15 @@
<Function name='ToEnumShortString'/>
<Function name='Trace'/>
<Function name='TrailToCustomDifficulty'/>
<Function name='TwoPartConfirmsOnly'/>
<Function name='TwoPartSelection'/>
<Function name='URLEncode'/>
<Function name='UndocumentedFeature'/>
<Function name='UnlockRewardTypeToLocalizedString'/>
<Function name='UserPrefAutoSetStyle'/>
<Function name='UserPrefComboOnRolls'/>
<Function name='UserPrefComboUnderField'/>
<Function name='UserPrefFancyUIBG'/>
<Function name='UserPrefFlashyCombo'/>
<Function name='UserPrefGameplayFooter'/>
<Function name='UserPrefGameplayShowScore'/>
@@ -579,8 +589,8 @@
<Class name='CharacterManager'>
<Function name='GetAllCharacters'/>
<Function name='GetCharacter'/>
<Function name='GetRandomCharacter'/>
<Function name='GetCharacterCount'/>
<Function name='GetRandomCharacter'/>
</Class>
<Class base='ActorFrame' name='ComboGraph'>
<Function name='Load'/>
@@ -598,6 +608,7 @@
<Function name='GetCourseEntries'/>
<Function name='GetCourseEntry'/>
<Function name='GetCourseType'/>
<Function name='GetDescription'/>
<Function name='GetDisplayFullTitle'/>
<Function name='GetEstimatedNumStages'/>
<Function name='GetGoalSeconds'/>
@@ -615,6 +626,8 @@
<Function name='IsEndless'/>
<Function name='IsNonstop'/>
<Function name='IsOni'/>
<Function name='IsPlayableIn'/>
<Function name='IsRanking'/>
</Class>
<Class base='ActorScroller' name='CourseContentsList'>
<Function name='SetFromGameState'/>
@@ -707,6 +720,7 @@
<Function name='GetEditLocalProfile'/>
<Function name='GetEditLocalProfileID'/>
<Function name='GetEditSourceSteps'/>
<Function name='GetExpandedSectionName'/>
<Function name='GetGameSeed'/>
<Function name='GetGameplayLeadIn'/>
<Function name='GetHardestStepsDifficulty'/>
@@ -931,6 +945,7 @@
<Function name='GetInvert'/>
<Function name='GetLeft'/>
<Function name='GetLittle'/>
<Function name='GetMMod'/>
<Function name='GetMines'/>
<Function name='GetMini'/>
<Function name='GetMirror'/>
@@ -1286,6 +1301,7 @@
<Function name='IsTutorial'/>
<Function name='MusicLengthSeconds'/>
<Function name='NormallyDisplayed'/>
<Function name='ShowInDemonstrationAndRanking'/>
</Class>
<Class name='SongManager'>
<Function name='FindCourse'/>
@@ -1386,6 +1402,8 @@
<Function name='GetChartStyle'/>
<Function name='GetDescription'/>
<Function name='GetDifficulty'/>
<Function name='GetDisplayBPMType'/>
<Function name='GetDisplayBpms'/>
<Function name='GetFilename'/>
<Function name='GetHash'/>
<Function name='GetMeter'/>
@@ -1397,6 +1415,10 @@
<Function name='IsAPlayerEdit'/>
<Function name='IsAnEdit'/>
<Function name='IsAutogen'/>
<Function name='IsDisplayBpmConstant'/>
<Function name='IsDisplayBpmRandom'/>
<Function name='IsDisplayBpmSecret'/>
<Function name='PredictMeter'/>
<Function name='UsesSplitTiming'/>
</Class>
<Class base='ActorFrame' name='StepsDisplay'>
@@ -1436,6 +1458,7 @@
<Function name='GetThemeAuthor'/>
<Function name='GetThemeDisplayName'/>
<Function name='ReloadMetrics'/>
<Function name='RunLuaScripts'/>
</Class>
<Class name='TimingData'>
<Function name='GetActualBPM'/>
@@ -1455,6 +1478,7 @@
<Function name='GetTimeSignatures'/>
<Function name='GetWarps'/>
<Function name='HasBPMChanges'/>
<Function name='HasDelays'/>
<Function name='HasFakes'/>
<Function name='HasNegativeBPMs'/>
<Function name='HasScrollChanges'/>
@@ -1463,13 +1487,17 @@
<Function name='HasWarps'/>
</Class>
<Class name='Trail'>
<Function name='ContainsSong'/>
<Function name='GetArtists'/>
<Function name='GetDifficulty'/>
<Function name='GetLengthSeconds'/>
<Function name='GetMeter'/>
<Function name='GetRadarValues'/>
<Function name='GetStepsType'/>
<Function name='GetTotalMeter'/>
<Function name='GetTrailEntries'/>
<Function name='GetTrailEntry'/>
<Function name='IsSecret'/>
</Class>
<Class name='TrailEntry'>
<Function name='GetNormalModifiers'/>
@@ -1485,6 +1513,7 @@
<Function name='GetRequirePassHardSteps'/>
<Function name='GetRequirement'/>
<Function name='GetSong'/>
<Function name='GetStepByStepsType'/>
<Function name='GetUnlockRewardType'/>
<Function name='IsLocked'/>
<Function name='code'/>
@@ -1636,6 +1665,11 @@
<EnumValue name='&apos;Difficulty_Challenge&apos;' value='4'/>
<EnumValue name='&apos;Difficulty_Edit&apos;' value='5'/>
</Enum>
<Enum name='DisplayBPM'>
<EnumValue name='&apos;DisplayBPM_Actual&apos;' value='0'/>
<EnumValue name='&apos;DisplayBPM_Specified&apos;' value='1'/>
<EnumValue name='&apos;DisplayBPM_Random&apos;' value='2'/>
</Enum>
<Enum name='EarnedExtraStage'>
<EnumValue name='&apos;EarnedExtraStage_No&apos;' value='0'/>
<EnumValue name='&apos;EarnedExtraStage_Extra1&apos;' value='1'/>
@@ -2044,8 +2078,7 @@
<EnumValue name='&apos;StepsType_Techno_Double8&apos;' value='30'/>
<EnumValue name='&apos;StepsType_Pnm_Five&apos;' value='31'/>
<EnumValue name='&apos;StepsType_Pnm_Nine&apos;' value='32'/>
<EnumValue name='&apos;StepsType_Guitar_Five&apos;' value='33'/>
<EnumValue name='&apos;StepsType_Lights_Cabinet&apos;' value='34'/>
<EnumValue name='&apos;StepsType_Lights_Cabinet&apos;' value='33'/>
</Enum>
<Enum name='StyleType'>
<EnumValue name='&apos;StyleType_OnePlayerOneSide&apos;' value='0'/>
@@ -2137,6 +2170,6 @@
<Constant name='sGame' value='&apos;dance&apos;'/>
<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants>
<Version>StepMania 5 v5.0 Preview 2</Version>
<Date>2011-07-04</Date>
<Version>StepMania v5.0 Preview 3</Version>
<Date>2011-08-20</Date>
</Lua>
Docs/Luadoc/LuaDocumentation.xml
+59 -8
View File
@@ -1582,6 +1582,9 @@
<Function name='GetCourseType' renamed='true' return='CourseType' arguments=''>
Returns the Course's <Link class='ENUM' function='CourseType' />. (Returns CourseType in sm-ssc; integer in SM4)
</Function>
<Function name='GetDescription' return='string' arguments=''>
Returns the description for this Course.
</Function>
<Function name='GetDisplayFullTitle' return='string' arguments=''>
Returns the full display title of the Course.
</Function>
@@ -1633,6 +1636,12 @@
<Function name='IsOni' return='bool' arguments=''>
Returns <code>true</code> if the Course is Oni.
</Function>
<Function name='IsPlayableIn' return='bool' arguments='StepsType st'>
Returns <code>true</code> if the Course is playable in StepsType <code>st</code>.
</Function>
<Function name='IsRanking' return='bool' arguments=''>
Returns <code>true</code> if the Course is a ranking course.
</Function>
</Class>
<Class name='CourseContentsList'>
<Function name='SetFromGameState' return='void' arguments=''>
@@ -1784,7 +1793,7 @@
</Function>
<Function name='GetPlayerBalance' return='float' arguments='PlayerNumber pn'>
<!-- XXX: Presumably, 0 is all the way to the left, and 1 is all the way
to the right. -->
to the right. -->
Return the sound balance for <code>pn</code>.
</Function>
<Function name='PlayAnnouncer' return='void' arguments='string sPath'>
@@ -1892,6 +1901,9 @@
Return the source <Link class='Steps' /> for the editor or <code>nil</code>
if it does not exist.
</Function>
<Function name='GetExpandedSectionName' return='String' arguments=''>
Returns the name of the currently expanded section.
</Function>
<Function name='GetGameSeed' return='int' arguments=''>
Return the random seed for the game.
</Function>
@@ -3437,7 +3449,10 @@
Returns the length of the song in seconds.
</Function>
<Function name='NormallyDisplayed' return='bool' arguments=''>
Returns true if the song is normally displayed.
Returns <code>true</code> if the song is normally displayed.
</Function>
<Function name='ShowInDemonstrationAndRanking' return='bool' arguments=''>
Returns <code>true</code> if the song is shown in Demonstration and Ranking.
</Function>
</Class>
<Class name='SongManager'>
@@ -3713,6 +3728,12 @@
<Function name='GetDifficulty' return='Difficulty' arguments=''>
Returns the Steps difficulty.
</Function>
<Function name='GetDisplayBpms' return='{float}' arguments=''>
Returns a table with the minimum and maximum values from the DisplayBPM.
</Function>
<Function name='GetDisplayBPMType' return='DisplayBPM' arguments=''>
Returns the DisplayBPM type.
</Function>
<Function name='GetFilename' return='string' arguments=''>
Returns the Steps filename from the Cache.
</Function>
@@ -3725,9 +3746,9 @@
<Function name='HasAttacks' return='bool' arguments=''>
Returns <code>true</code> if the Steps has any attacks.
</Function>
<Function name='HasSignificantTimingChanges' return='bool' arguments=''>
Returns <code>true</code> if the Steps pattern has significant timing changes.
</Function>
<Function name='HasSignificantTimingChanges' return='bool' arguments=''>
Returns <code>true</code> if the Steps pattern has significant timing changes.
</Function>
<Function name='GetRadarValues' return='RadarValues' arguments='PlayerNumber pn'>
Returns the complete list of RadarValues for player <code>pn</code>. Use <Link class='RadarValues' function='GetValue' /> to grab a specific value.
</Function>
@@ -3746,6 +3767,18 @@
<Function name='IsAutogen' return='bool' arguments=''>
Returns <code>true</code> if the steps were automatically generated.
</Function>
<Function name='IsDisplayBpmConstant' return='' arguments=''>
Returns <code>true</code> if the DisplayBPM is constant.
</Function>
<Function name='IsDisplayBpmRandom' return='' arguments=''>
Returns <code>true</code> if the DisplayBPM is random.
</Function>
<Function name='IsDisplayBpmSecret' return='' arguments=''>
Returns <code>true</code> if the DisplayBPM is secret.
</Function>
<Function name='PredictMeter' return='float' arguments=''>
Returns the predicted meter for this Step.
</Function>
<Function name='UsesSplitTiming' return='bool' arguments=''>
Returns <code>true</code> if the Steps use different <code>TimingData</code> from the Song.
</Function>
@@ -3841,6 +3874,9 @@
<Function name='ReloadMetrics' return='void' arguments=''>
Reloads the current theme's metrics.
</Function>
<Function name='RunLuaScripts' return='void' arguments='string s'>
</Function>
</Class>
<Class name='TimingData'>
<Function name='GetActualBPM' return='{float}' arguments=''>
@@ -3894,6 +3930,9 @@
<Function name='HasBPMChanges' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains BPM changes.
</Function>
<Function name='HasDelays' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains delays.
</Function>
<Function name='HasNegativeBPMs' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains any BPM changes with a negative BPM.
</Function>
@@ -3903,9 +3942,9 @@
<Function name='HasWarps' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains warps.
</Function>
<Function name='HasFakes' return='bool' arguments=''>
returns <code>true</code> if the TimingData contains fake segments.
</Function>
<Function name='HasFakes' return='bool' arguments=''>
returns <code>true</code> if the TimingData contains fake segments.
</Function>
<Function name='HasSpeedChanges' return='bool' arguments=''>
Returns <code>true</code> if the TimingData contains speed scrolling changes.
</Function>
@@ -3914,12 +3953,18 @@
</Function>
</Class>
<Class name='Trail'>
<Function name='ContainsSong' return='bool' arguments='Song s'>
Returns <code>true</code> if song <code>s</code> is in the Trail.
</Function>
<Function name='GetArtists' return='{string}' arguments=''>
Returns an array with all the artists in the Trail.
</Function>
<Function name='GetDifficulty' return='Difficulty' arguments=''>
Returns the Trail's difficulty.
</Function>
<Function name='GetLengthSeconds' return='float' arguments=''>
Returns the length of this Trail in seconds.
</Function>
<Function name='GetTrailEntries' return='{TrailEntry}' arguments=''>
Returns a table of TrailEntry items.
</Function>
@@ -3932,9 +3977,15 @@
<Function name='GetStepsType' return='StepsType' arguments=''>
Returns the Trail's StepsType.
</Function>
<Function name='GetTotalMeter' return='int' arguments=''>
Returns the Trail's total meter
</Function>
<Function name='GetTrailEntry' return='TrailEntry' arguments='int iEntry'>
Returns the TrailEntry at index <code>iEntry</code>.
</Function>
<Function name='IsSecret' return='bool' arguments=''>
Returns <code>true</code> if any of the Trail entries are secret.
</Function>
</Class>
<Class name='TrailEntry'>
<Function name='GetNormalModifiers' return='string' arguments=''>