scripts update + hierarchy.txt fleshed out some more

This commit is contained in:
AJ Kelly
2010-04-25 18:49:32 -05:00
parent 873166719e
commit bf25127a2d
3 changed files with 36 additions and 9 deletions
+1 -1
View File
@@ -53,7 +53,7 @@ function date(format,...)
if ... then
-- convert value
else
-- convert today
-- convert current time
end;
end;
@@ -6,7 +6,7 @@
AspectRatios = {
ThreeFour = 0.75, -- (576x760 at 1024x768)
OneOne = 1.0, -- 480x480 (uses Y)
FiveFour = 1.25, -- 600x480 (1280x1024 is a real use)
FiveFour = 1.25, -- 600x480 (1280x1024 is a real use case)
FourThree = 1.33333, --* 640x480
SixteenTen = 1.6, --* 720x480
SixteenNine = 1.77778, --* 853x480
@@ -65,5 +65,7 @@ function Actor:PositionX(normalX,widescreenX)
end;
end;
-- take and use it as you like, I don't care -aj
-- (although I should mention this file was specific to moonlight and was pretty
-- bad before some editing. -aj)
function WideScale(AR4_3, AR16_9) return scale( SCREEN_WIDTH, 640, 854, AR4_3, AR16_9 ); end
+32 -7
View File
@@ -4,22 +4,47 @@ Hello, and welcome to the sm-ssc Scripts directory. You'll notice that our Lua
scripts have numbers at the beginning of them. This is to control the order of
execution.
In sm-ssc, scripts in subdirectories of Scripts/
(e.g. Scripts/01/somescript.lua) are loaded before scripts in the root of
Scripts/ (e.g. Scripts/01 base.lua). This is important to know when making a
theme for sm-ssc.
In sm-ssc, scripts in subdirectories of Scripts/ (e.g. Scripts/01/somescript.lua)
are loaded before scripts in the root of Scripts/ (e.g. Scripts/01 base.lua).
This is important to know when making a theme for sm-ssc. It's also important
to know that StepMania 4 (as of alpha 5) will not read scripts in subdirectories.
In sm-ssc, there are five rings of script execution:
00 - Initialization
________________________________________________________________________________
01 - Base
There are three base scripts. "01 base.lua" is taken from StepMania 4's default
theme and sets up very important function overrides and the "Var" alias (for
lua.GetThreadVariable). The other two base scripts are sm-ssc specific.
"01 alias.lua" contains non-compatibility aliases. To quote the file itself:
"This is mainly here for making commands case-insensitive without needing to
clutter up the C++ code. It can also be used to add custom functions that
wouldn't otherwise belong somewhere else."
"01 compat.lua" sets up compatibility aliases for some commands. Some commands
were deprecated in sm-ssc (e.g. hidden), while others were renamed. If a problem
was solved differently in sm-ssc, the corresponding StepMania 4 functions should
live in here, and not the C++ code. (The prime example of this being
PlayerStageStats:IsFullComboW* from SM4, whereas we have
PlayerStageStats:FullComboOfScore, with the tap note score being passed in.)
________________________________________________________________________________
02 - Defaults
The "02" scripts are pretty much the same scripts you'd find in StepMania 4's
default theme. Some scripts do exhibit differences, however. The most notable
of these changes is to "02 Color.lua", which adds a color library to the old
StepMania 4 Colors script.
________________________________________________________________________________
03 - Extensions
Scripts that extend normal (StepMania 4 default theme) functionality belong
in the fourth ring. A number of these scripts come from KKI Labs (EnvUtils2,
CustomSpeedMods, UserPreferences2), while others are from other themes (HSV)
or written for sm-ssc (DateTime, Gameplay).
________________________________________________________________________________
04 - ?
FileUtils and WidescreenHelpers are in the fifth ring. To be honest, I don't
know why they were moved out here. -aj
================================================================================
previously: