From bfa8f30d4e98dfe717524ab0ebfd84a993d637e6 Mon Sep 17 00:00:00 2001 From: AJ Kelly Date: Wed, 24 Mar 2010 21:40:55 -0500 Subject: [PATCH] documentation updates --- Docs/Luadoc/Lua.xml | 29 ++++++++++++++++--- Docs/Luadoc/LuaDocumentation.xml | 34 ++++++++++++++++++++++ Docs/Themerdocs/recommended_practices.txt | 10 ++++++- Docs/Themerdocs/sm-ssc_themeguide.txt | 35 +++++++++++++++++++---- 4 files changed, 97 insertions(+), 11 deletions(-) diff --git a/Docs/Luadoc/Lua.xml b/Docs/Luadoc/Lua.xml index 5eea152620..2b789f1f1e 100644 --- a/Docs/Luadoc/Lua.xml +++ b/Docs/Luadoc/Lua.xml @@ -111,6 +111,7 @@ + @@ -485,6 +486,7 @@ + @@ -514,6 +516,7 @@ + @@ -797,6 +800,7 @@ + @@ -806,9 +810,14 @@ + + + + + @@ -958,6 +967,9 @@ + + + @@ -973,6 +985,9 @@ + + + @@ -1051,6 +1066,7 @@ + @@ -1737,6 +1753,11 @@ + + + + + @@ -1779,13 +1800,13 @@ - + - + - + @@ -1798,5 +1819,5 @@ sm-ssc v1.0 beta 1 - 2010-02-28 + 2010-03-24 diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml index 4671a149b1..9b0cf1ae03 100644 --- a/Docs/Luadoc/LuaDocumentation.xml +++ b/Docs/Luadoc/LuaDocumentation.xml @@ -952,6 +952,9 @@ Sets the stroke color to c. + + If the text is glowing, specify if just the stroke layer, just the inner layer, or both are affected by the glow. + If true, make all text uppercase. @@ -1734,6 +1737,9 @@ Returns a table of played steps. + + Gets the percentage of taps that were scored as tns. + Returns the player's Dance Point percentage. @@ -1755,6 +1761,18 @@ Returns the number of judgments for a specified TapNoteScore. + + [01 compat.lua] Returns true if the player got a full combo of all W1s. + + + [01 compat.lua] Returns true if the player got a full combo of all W2s. + + + [01 compat.lua] Returns true if the player got a full combo of all W3s. + + + [01 compat.lua] Returns true if the player got a full combo of all W4s. + Returns the max combo for this performance. @@ -1763,6 +1781,9 @@ + + Returns the multiplayer number for this PlayerState. + Returns the PlayerController for this PlayerState. @@ -2133,6 +2154,11 @@ Gets the currently selected letter of Player pn. + + + Returns the number of active players. + + Returns true if all active players are on the last options row. @@ -2162,6 +2188,11 @@ Returns true if there is a profile that can be saved. + + + Returns player pn's current selected item as an integer. + + Tells the screen to go to the previous screen. @@ -2362,6 +2393,9 @@ Returns the song group color of sGroupName. + + Returns the shortened group name (based on entries in Translations.xml). + diff --git a/Docs/Themerdocs/recommended_practices.txt b/Docs/Themerdocs/recommended_practices.txt index 9a062184e8..264dda8e5e 100644 --- a/Docs/Themerdocs/recommended_practices.txt +++ b/Docs/Themerdocs/recommended_practices.txt @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/Docs/Themerdocs/sm-ssc_themeguide.txt b/Docs/Themerdocs/sm-ssc_themeguide.txt index 19b1eb450c..33bfb9cb3e 100644 --- a/Docs/Themerdocs/sm-ssc_themeguide.txt +++ b/Docs/Themerdocs/sm-ssc_themeguide.txt @@ -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