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

documentation updates

Browse Source
This commit is contained in:
AJ Kelly
2010-03-24 21:40:55 -05:00
parent 554336543e
commit bfa8f30d4e
4 changed files with 97 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Luadoc/Lua.xml
+25 -4
View File
@@ -111,6 +111,7 @@
<Function name='RollBodyIncrementsCombo'/>
<Function name='SMOnlineScreen'/>
<Function name='Saturation'/>
<Function name='ScoreKeeperClass'/>
<Function name='ScoreMissedHoldsAndRolls'/>
<Function name='Second'/>
<Function name='SecondsToHHMMSS'/>
@@ -485,6 +486,7 @@
<Function name='settext'/>
<Function name='settextf'/>
<Function name='strokecolor'/>
<Function name='textglowmode'/>
<Function name='uppercase'/>
<Function name='vertspacing'/>
<Function name='wrapwidthpixels'/>
@@ -514,6 +516,7 @@
</Class>
<Class name='Course'>
<Function name='GetAllTrails'/>
<Function name='GetBackgroundPath'/>
<Function name='GetBannerPath'/>
<Function name='GetCourseEntry'/>
<Function name='GetCourseType'/>
@@ -797,6 +800,7 @@
<Function name='GetMachineHighScoreIndex'/>
<Function name='GetPeakComboAward'/>
<Function name='GetPercentDancePoints'/>
<Function name='GetPercentageOfTaps'/>
<Function name='GetPersonalHighScoreIndex'/>
<Function name='GetPlayedSteps'/>
<Function name='GetPossibleDancePoints'/>
@@ -806,9 +810,14 @@
<Function name='GetSurvivalSeconds'/>
<Function name='GetTapNoteScores'/>
<Function name='IsDisqualified'/>
<Function name='IsFullComboW1'/>
<Function name='IsFullComboW2'/>
<Function name='IsFullComboW3'/>
<Function name='IsFullComboW4'/>
<Function name='MaxCombo'/>
</Class>
<Class name='PlayerState'>
<Function name='GetMultiPlayerNumber'/>
<Function name='GetPlayerNumber'/>
<Function name='GetPlayerOptions'/>
<Function name='SetPlayerOptions'/>
@@ -958,6 +967,9 @@
<Function name='GetFinalized'/>
<Function name='GetSelection'/>
</Class>
<Class base='ScreenEvaluation' name='ScreenNetEvaluation'>
<Function name='GetNumActivePlayers'/>
</Class>
<Class base='ScreenWithMenuElements' name='ScreenOptions'>
<Function name='AllAreOnLastRow'/>
<Function name='GetCurrentRow'/>
@@ -973,6 +985,9 @@
<Function name='Continue'/>
<Function name='HaveProfileToSave'/>
</Class>
<Class base='ScreenWithMenuElements' name='ScreenSelectMaster'>
<Function name='GetSelectionIndex'/>
</Class>
<Class base='ScreenWithMenuElements' name='ScreenSelectMusic'>
<Function name='GetGoToOptions'/>
<Function name='setupcoursestagemods'/>
@@ -1051,6 +1066,7 @@
<Function name='GetSongColor'/>
<Function name='GetSongFromSteps'/>
<Function name='GetSongGroupColor'/>
<Function name='ShortenGroupName'/>
</Class>
<Class base='Actor' name='Sprite'>
<Function name='CropTo'/>
@@ -1737,6 +1753,11 @@
<EnumValue name='&apos;TapNoteScoreJudgeType_MinimumScore&apos;' value='0'/>
<EnumValue name='&apos;TapNoteScoreJudgeType_LastScore&apos;' value='1'/>
</Enum>
<Enum name='TextGlowMode'>
<EnumValue name='&apos;TextGlowMode_Inner&apos;' value='0'/>
<EnumValue name='&apos;TextGlowMode_Stroke&apos;' value='1'/>
<EnumValue name='&apos;TextGlowMode_Both&apos;' value='2'/>
</Enum>
<Enum name='TextureMode'>
<EnumValue name='&apos;TextureMode_Modulate&apos;' value='0'/>
<EnumValue name='&apos;TextureMode_Glow&apos;' value='1'/>
@@ -1779,13 +1800,13 @@
<Constant name='ASPECT_SCALE_FACTOR' value='1'/>
<Constant name='NUM_PLAYERS' value='2'/>
<Constant name='SCREEN_BOTTOM' value='480'/>
<Constant name='SCREEN_CENTER_X' value='384'/>
<Constant name='SCREEN_CENTER_X' value='427'/>
<Constant name='SCREEN_CENTER_Y' value='240'/>
<Constant name='SCREEN_HEIGHT' value='480'/>
<Constant name='SCREEN_LEFT' value='0'/>
<Constant name='SCREEN_RIGHT' value='768'/>
<Constant name='SCREEN_RIGHT' value='854'/>
<Constant name='SCREEN_TOP' value='0'/>
<Constant name='SCREEN_WIDTH' value='768'/>
<Constant name='SCREEN_WIDTH' value='854'/>
<Constant name='PLAYER_1' value='&apos;PlayerNumber_P1&apos;'/>
<Constant name='PLAYER_2' value='&apos;PlayerNumber_P2&apos;'/>
<Constant name='_VERSION' value='&apos;Lua 5.1&apos;'/>
@@ -1798,5 +1819,5 @@
<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants>
<Version>sm-ssc v1.0 beta 1</Version>
<Date>2010-02-28</Date>
<Date>2010-03-24</Date>
</Lua>
Docs/Luadoc/LuaDocumentation.xml
+34
View File
@@ -952,6 +952,9 @@
<Function name='strokecolor' return='void' arguments='color c'>
Sets the stroke color to <code>c</code>.
</Function>
<Function name='textglowmode' sm-ssc='true' return='void' arguments='TextGlowMode tgm'>
If the text is glowing, specify if just the stroke layer, just the inner layer, or both are affected by the glow.
</Function>
<Function name='uppercase' return='void' arguments='bool b'>
If <code>true</code>, make all text uppercase.
</Function>
@@ -1734,6 +1737,9 @@
<Function name='GetPlayedSteps' return='{Steps}' arguments=''>
Returns a table of played steps.
</Function>
<Function name='GetPercentageOfTaps' sm-ssc='true' return='float' arguments='TapNoteScore tns'>
Gets the percentage of taps that were scored as <code>tns</code>.
</Function>
<Function name='GetPercentDancePoints' return='float' arguments=''>
Returns the player's Dance Point percentage.
</Function>
@@ -1755,6 +1761,18 @@
<Function name='GetTapNoteScores' return='int' arguments='TapNoteScore tns'>
Returns the number of judgments for a specified TapNoteScore.
</Function>
<Function name='IsFullComboW1' renamed='true' return='bool' arguments=''>
[01 compat.lua] Returns <code>true</code> if the player got a full combo of all W1s.
</Function>
<Function name='IsFullComboW2' renamed='true' return='bool' arguments=''>
[01 compat.lua] Returns <code>true</code> if the player got a full combo of all W2s.
</Function>
<Function name='IsFullComboW3' renamed='true' return='bool' arguments=''>
[01 compat.lua] Returns <code>true</code> if the player got a full combo of all W3s.
</Function>
<Function name='IsFullComboW4' renamed='true' return='bool' arguments=''>
[01 compat.lua] Returns <code>true</code> if the player got a full combo of all W4s.
</Function>
<Function name='MaxCombo' return='int' arguments=''>
Returns the max combo for this performance.
</Function>
@@ -1763,6 +1781,9 @@
</Function>
</Class>
<Class name='PlayerState'>
<Function name='GetMultiPlayerNumber' sm-ssc='true' return='MultiPlayer' arguments=''>
Returns the multiplayer number for this PlayerState.
</Function>
<Function name='GetPlayerController' sm-ssc='true' return='PlayerController' arguments=''>
Returns the PlayerController for this PlayerState.
</Function>
@@ -2133,6 +2154,11 @@
Gets the currently selected letter of Player <code>pn</code>.
</Function>
</Class>
<Class name='ScreenNetEvaluation'>
<Function name='GetNumActivePlayers' sm-ssc='true' return='int' arguments=''>
Returns the number of active players.
</Function>
</Class>
<Class name='ScreenOptions'>
<Function name='AllAreOnLastRow' return='bool' sm-ssc='true' arguments=''>
Returns <code>true</code> if all active players are on the last options row.
@@ -2162,6 +2188,11 @@
Returns <code>true</code> if there is a profile that can be saved.
</Function>
</Class>
<Class name='ScreenSelectMaster'>
<Function name='GetSelectionIndex' sm-ssc='true' return='int' arguments='PlayerNumber pn'>
Returns player <code>pn</code>'s current selected item as an integer.
</Function>
</Class>
<Class name='ScreenSelectProfile'>
<Function name='Cancel' return='void' arguments=''>
Tells the screen to go to the previous screen.
@@ -2362,6 +2393,9 @@
<Function name='GetSongGroupColor' return='color' arguments='string sGroupName'>
Returns the song group color of <code>sGroupName</code>.
</Function>
<Function name='ShortenGroupName' sm-ssc='true' return='string' arguments='string sGroupName'>
Returns the shortened group name (based on entries in Translations.xml).
</Function>
</Class>
<Class name='Sprite'>
<Function name='GetAnimationLengthSeconds' return='float' arguments=''>
Docs/Themerdocs/recommended_practices.txt
+9 -1
View File
@@ -26,4 +26,12 @@ recognize it.
With this "SSC guard" in place, you can now wrap things in "if SSC then"
statements if they won't work on SM4. You can also provide alternatives if the
player isn't using sm-ssc, since sometimes SM4 will have an approximation or
alternate way to get the data.
alternate way to get the data.
3) When dealing with frame size errors or theme code errors, don't just hide the
dialog and pretend they don't exist. Good themers fix these problems instead of
releasing the theme and saying "oh, just play it in fullscreen mode".
If you have hidden the error dialogs, you'll need to modify Preferences.ini.
Find the IgnoredDialogs= line and remove everything after the = sign. You will
now recieve the error messages in windowed mode again.
Docs/Themerdocs/sm-ssc_themeguide.txt
+29 -6
View File
@@ -130,7 +130,8 @@ By leaving out a key in your custom language, you tell StepMania to look in
the default language (typically en.ini)
2.2. BGAnimations ______________________________________________________________
Easily where you'll be spending the most time when making a theme, the
BGAnimations provide a way for you to customize various theme parts.
There are multiple names StepMania recognizes for BGAnimation folders. Some
screens won't support all of these.
@@ -185,17 +186,39 @@ aren't on Windows, your choices are then limited to whatever image editor you
can find (typically Photoshop or The GIMP).
fontini.txt in the ThemerDocs folder contains a list of all the known
font .ini values. It lacks explanation, however.
font .ini values. The file is reprinted here:
================================================================================
[common]
CapitalsOnly - If set to 1, lowercase letters are drawn with uppercase letters instead.
RightToLeft - If set to 1, font will be rendered as right to left.
DefaultStrokeColor - Sets default stroke color. (e.g. #00000000)
[Common]
CapitalsOnly
RightToLeft
DefaultStrokeColor
[main]
import - Imports a font page into the current font.
(per-page)
DrawExtraPixelsLeft - How many pixels to draw to the left of a character.
DrawExtraPixelsRight - How many pixels to draw to the right of a character.
AddToAllWidths - Adds x amount of pixels to all widths.
ScaleAllWidthsBy - Scales widths by the factor specified.
LineSpacing - Modifies line spacing.
Top - Specifies the top of the character. (in pixels)
Baseline - Specifies the baseline of the character. (in pixels)
DefaultWidth - Default width for a glyph.
AdvanceExtraPixels - Rudimentary way to control letter spacing
TextureHints - An alternative to throwing the TextureHints in the filename.
(general commands)
MAP - Maps a keyword to a frame number. (e.g. map up=0)
RANGE - Defines a Unicode range to use.
LINE - (e.g. Line 1=ABCDEFGH)
================================================================================
2.5. Sounds ____________________________________________________________________
sm-ssc can load Lua files as music, allowing for conditional music/sounds.
conditional_music.txt in the ThemerDocs folder explains it in more detail with
code examples.
2.6. Scripts ___________________________________________________________________
Scripts allow you to define functions which can then be referenced in Metrics