-
-NOTE: I am using -SM 3.95 for this tutorial. 3.9 works as well, and is probably better to use -for playback purposes. When a negative BPM hits in edit mode, 3.95 jumps very -quickly (but not instantly) to the next point in the chart, whereas 3.9 does -do it instantly.
-
-What are negative BPMs? -Negative BPMs are the act of "warping" to a -later place in the chart, skipping multiple lines of the chart and -ignoring anything within those areas.
-
-Once you understand how negative BPMs work, it shouldn't be too hard to -figure out.
-
-So, let's start out with a screenshot.
-
-
--We start off on measure 1, with a current second of 0.055, and a BPM of 150. -Take note of the current second (upper right), this is very important in -dealing with negative BPMs.
-
-
--We are now on measure 2, with a BPM of -150, the exact opposite of the normal -BPM. Look at the current second again. It took 1.600 seconds to scroll 1 -whole measure at 150 BPM. Right now the current second is 1.655. Also of -note, the BPM goes back to 150 starting on measure 3. Now, here's where the -magic happens.
-
-
-We are on measure 3, back into positive BPM territory, but take a look at the -current second again. It is 0.055 on measure 3, the same value as the current -second from measure 1. This makes sense, because it took -1.600 seconds to -scroll from measure 2 to measure 3, because the BPM was negative during that -measure.
-
-
-As you can see from the current second on measure 4, it is the same value as measure 2.
-
-This is how the warping happens. When the chart first reaches the negative BPM, -it will search for the next positive BPM value. -NOTE: if there is no -positive BPM after the last negative BPM, I believe that the song ends -instantly, because it has reached the highest time possible within the chart. -Once the negative BPM hits, the current second will start counting backwards -forever.
-
-So, once the negative BPM hits, the game attempts to find the next place in -the chart that matches the current second of -the exact moment the negative BPM hit. At measure 2, the current second -was 1.655, and from the picture above, we can see that the next place that the -current second is 1.655 would be measure 4. So, you've effectively created a -warp going from measure 2 to measure 4, skipping everything in between.
-
-
--So basically, it comes down to this: When making negative BPMs, make sure that -the space between the negative BPM and the next positive BPM is -doubled (assuming that you're using -the same BPM, which would be the easiest method anyway).
-
-Negative Stops -
-Negative stops work about the same way as negative BPMs, without the mess -of having to change around the BPMs. There is a little math involved, though.
-
-Let's say that you want to do a 2-measure warp, like the negative BPM example -above. You need to simulate going backwards by two measures. Normal stops keep -the current second going, even though the chart is at a standstill. Negative -stops keep the current second going as well, only backwards.
-
-First, find the time it would take to progress two measures. You can do this -by either checking the current second, going down two measures, check the -current second again, and take the difference. Or, you can calculate it like this:
-
-
60/[BPM] = [quarter note value, in seconds]-
[quarter note] x 8 = [2 measures, in seconds]-
-So that translates to:
-
-
60/150 = 0.400-0.400 x 8 = 3.200 seconds = two measures
-
-Now that we've got that out of the way, it's time to make the negative stop. -You might have noticed something though. StepMania doesn't let you input -negative stops. F9 to decrease the stop values in edit mode doesn't let you -go below 0.00, and adding a negative stop through Add Stop from the menu -doesn't work either.
-
-Unfortunately, you'll have to manually insert the negative stop into the .sm -file. NOTE: Before you -manually insert any negative stops, make sure to save your chart, otherwise -any unsaved data will be lost!
-
-This time, take note of the current beat -(again, upper right). Now, open up the .sm file and look for the #STOPS tag. -If you want to add a -3.200 long stop in at measure 2, it will look like this:
-
-
#STOPS:4.000=-3.200;-
-After you're done, save the .sm, and go back to StepMania (which should still -be open). Press ESC, and go to the menu option "Revert From Disk." It will -warn you that any unsaved changes will be lost (which is why I gave the warning -before explaining all of this). Choose yes, and you should see the negative -stop value appear on measure 2.
-
-
-
-If you scroll to measure 2, and then to measure 4, you will see that the -current second values are the same, meaning that you've successfully created -a warp with negative stops!
-
-NOTE: Using a lot of -negative stops in a short period of time tends to lag ITG machines a lot, -so be wary of this.
-
-That covers the basics of negative BPMs and negative stops. Hopefully this guide helps! - + + +
+
+NOTE: I am using +SM 3.95 for this tutorial. 3.9 works as well, and is probably better to use +for playback purposes. When a negative BPM hits in edit mode, 3.95 jumps very +quickly (but not instantly) to the next point in the chart, whereas 3.9 does +do it instantly.
+
+What are negative BPMs? +Negative BPMs are the act of "warping" to a +later place in the chart, skipping multiple lines of the chart and +ignoring anything within those areas.
+
+Once you understand how negative BPMs work, it shouldn't be too hard to +figure out.
+
+So, let's start out with a screenshot.
+
+
++We start off on measure 1, with a current second of 0.055, and a BPM of 150. +Take note of the current second (upper right), this is very important in +dealing with negative BPMs.
+
+
++We are now on measure 2, with a BPM of -150, the exact opposite of the normal +BPM. Look at the current second again. It took 1.600 seconds to scroll 1 +whole measure at 150 BPM. Right now the current second is 1.655. Also of +note, the BPM goes back to 150 starting on measure 3. Now, here's where the +magic happens.
+
+
+We are on measure 3, back into positive BPM territory, but take a look at the +current second again. It is 0.055 on measure 3, the same value as the current +second from measure 1. This makes sense, because it took -1.600 seconds to +scroll from measure 2 to measure 3, because the BPM was negative during that +measure.
+
+
+As you can see from the current second on measure 4, it is the same value as measure 2.
+
+This is how the warping happens. When the chart first reaches the negative BPM, +it will search for the next positive BPM value. +NOTE: if there is no +positive BPM after the last negative BPM, I believe that the song ends +instantly, because it has reached the highest time possible within the chart. +Once the negative BPM hits, the current second will start counting backwards +forever.
+
+So, once the negative BPM hits, the game attempts to find the next place in +the chart that matches the current second of +the exact moment the negative BPM hit. At measure 2, the current second +was 1.655, and from the picture above, we can see that the next place that the +current second is 1.655 would be measure 4. So, you've effectively created a +warp going from measure 2 to measure 4, skipping everything in between.
+
+
++So basically, it comes down to this: When making negative BPMs, make sure that +the space between the negative BPM and the next positive BPM is +doubled (assuming that you're using +the same BPM, which would be the easiest method anyway).
+
+Negative Stops +
+Negative stops work about the same way as negative BPMs, without the mess +of having to change around the BPMs. There is a little math involved, though.
+
+Let's say that you want to do a 2-measure warp, like the negative BPM example +above. You need to simulate going backwards by two measures. Normal stops keep +the current second going, even though the chart is at a standstill. Negative +stops keep the current second going as well, only backwards.
+
+First, find the time it would take to progress two measures. You can do this +by either checking the current second, going down two measures, check the +current second again, and take the difference. Or, you can calculate it like this:
+
+
60/[BPM] = [quarter note value, in seconds]+
[quarter note] x 8 = [2 measures, in seconds]+
+So that translates to:
+
+
60/150 = 0.400+0.400 x 8 = 3.200 seconds = two measures
+
+Now that we've got that out of the way, it's time to make the negative stop. +You might have noticed something though. StepMania doesn't let you input +negative stops. F9 to decrease the stop values in edit mode doesn't let you +go below 0.00, and adding a negative stop through Add Stop from the menu +doesn't work either.
+
+Unfortunately, you'll have to manually insert the negative stop into the .sm +file. NOTE: Before you +manually insert any negative stops, make sure to save your chart, otherwise +any unsaved data will be lost!
+
+This time, take note of the current beat +(again, upper right). Now, open up the .sm file and look for the #STOPS tag. +If you want to add a -3.200 long stop in at measure 2, it will look like this:
+
+
#STOPS:4.000=-3.200;+
+After you're done, save the .sm, and go back to StepMania (which should still +be open). Press ESC, and go to the menu option "Revert From Disk." It will +warn you that any unsaved changes will be lost (which is why I gave the warning +before explaining all of this). Choose yes, and you should see the negative +stop value appear on measure 2.
+
+
+
+If you scroll to measure 2, and then to measure 4, you will see that the +current second values are the same, meaning that you've successfully created +a warp with negative stops!
+
+NOTE: Using a lot of +negative stops in a short period of time tends to lag ITG machines a lot, +so be wary of this.
+
+That covers the basics of negative BPMs and negative stops. Hopefully this guide helps! + \ No newline at end of file diff --git a/Docs/Devdocs/SMLanProtocol.txt b/Docs/legacy/Devdocs/SMLanProtocol.txt similarity index 100% rename from Docs/Devdocs/SMLanProtocol.txt rename to Docs/legacy/Devdocs/SMLanProtocol.txt diff --git a/Docs/Devdocs/SMO_protocol-aj.txt b/Docs/legacy/Devdocs/SMO_protocol-aj.txt similarity index 100% rename from Docs/Devdocs/SMO_protocol-aj.txt rename to Docs/legacy/Devdocs/SMO_protocol-aj.txt diff --git a/Docs/Devdocs/SMXML.txt b/Docs/legacy/Devdocs/SMXML.txt similarity index 100% rename from Docs/Devdocs/SMXML.txt rename to Docs/legacy/Devdocs/SMXML.txt diff --git a/Docs/Devdocs/Sound Drivers.txt b/Docs/legacy/Devdocs/Sound Drivers.txt similarity index 100% rename from Docs/Devdocs/Sound Drivers.txt rename to Docs/legacy/Devdocs/Sound Drivers.txt diff --git a/Docs/Devdocs/SplitTiming.txt b/Docs/legacy/Devdocs/SplitTiming.txt similarity index 98% rename from Docs/Devdocs/SplitTiming.txt rename to Docs/legacy/Devdocs/SplitTiming.txt index 26470f103f..cc7ad676e4 100644 --- a/Docs/Devdocs/SplitTiming.txt +++ b/Docs/legacy/Devdocs/SplitTiming.txt @@ -1,96 +1,96 @@ -This document describes the implementation of TimingData in StepMania, as of -shortly after version 5.0 beta 1a. - - -== What is TimingData? == - -TimingData refers to the information in a chart (a "Steps") or a song which -maps real time to beats and vice versa. This includes all BPMs and the -initial offset, as well as time gimmicks like stops, warps, and delays. The -TimingData object itself only has a few members: -* the name of the file that specified the data (for display only) -* the beat 0 offset -* a vector of TimingSegments for each type (BPM, warp, label, etc.) - -Each TimingSegment specifies a starting point in the chart, as well as any -parameters which are specific to that segment type. For a list of the -different types of TimingSegments, see TimingSegments.h. - - -== Split Timing == - -TimingData is primarily used for charts and songs, to specify the BPM and -offset and to implement gimmicks, as well as to synchronize effects with -background music. (It also provides features such as labels and time -signatures which can be useful when editing a chart.) - -Prior to StepMania 5, each song had a single TimingData structure which was -then used by all of the charts associated with that song. StepMania 5 -introduces a feature known as Split Timing, wherein a chart can have -individual TimingData ("Steps Timing") which is independent of the song's -TimingData ("Song Timing"). This allows for Pump-style gimmicks which can -differ between difficulties on the same song. - - -== Implementation == - -In the code, Song Timing is contained in the m_SongTiming field of a Song -object. Song Timing is used by default for any chart which does not specify -its own timing information. - -If a chart has its own timing information, this is contained in the m_Timing -field of the Steps object. If the chart does not have separate timing -information, the m_Timing structure will be empty (i.e. none of the vectors -will contain any TimingSegments). The TimingData::empty() function provides a -simply way to determine this. - -The most common way to get the TimingData for a chart is to use the -GetTimingData() function of the Steps object. This function will perform the -appropriate fallback to Song Timing if the chart's timing is empty. If, as in -the editor or sync implementations, it is necessary to access the Steps Timing -or Song Timing individually, the corresponding fields can be used instead. - -=== Editing === - -The editor has a "timing mode" setting which can be toggled between Song -Timing and Steps Timing (in the code, GAMESTATE->m_bIsUsingStepTiming). This -mode determines which set of TimingData will be updated when changes are made -with hotkeys or the Timing menu. It defaults to Steps Timing if the chart -being loaded has individual TimingData, and Song Timing otherwise. -Considering that we also want this to behave according to whether a chart has -individual timing, there are four possibilities when making a change: - -1. Song Timing mode, chart DOES NOT HAVE individual timings: changes will be - made to the Song Timing, and the chart will not have individual timings - added to it. Because of this, the changes to Song Timing will "show - through" to this chart. -2. Song Timing mode, chart HAS individual timings: changes will be made to the - Song Timing only. The timings in the chart will be left untouched. Because - of this, the changes to Song Timing will not affect this chart. -3. Steps Timing mode, chart HAS individual timings: changes will be made to the - Steps Timing only and will affect only this chart. -4. Steps Timing mode, chart DOES NOT HAVE individual timings: first, the Song - Timing will be copied into this chart. The changes are then made to the - Steps Timing only and will affect only this chart. - -Case #4 describes how Steps Timing is added to a chart: simply select Steps -Timing mode and start making changes. To remove Steps Timing, use the -corresponding item in the Timing menu. - - -== File formats == - -A quick note is in order about Split Timing support in the different file -formats supported by StepMania: - -* SSC files support Split Timing natively. Timing tags such as #BPMS in the - file header apply to the song, whereas the same tags inside a #NOTEDATA - section apply only to the current chart. -* SM files do not support Split Timing, since there is no way to specify - individual timing for a chart. -* SMA files support Split Timing in a similar fashion to SSC files. -* The KSF and BMS formats use one file for each chart, and therefore already - have per-chart timing information. When reading these formats, *every - chart* has Steps Timing. -* The DWI format does not support Split Timing, so Steps Timing is not written - to DWI files. +This document describes the implementation of TimingData in StepMania, as of +shortly after version 5.0 beta 1a. + + +== What is TimingData? == + +TimingData refers to the information in a chart (a "Steps") or a song which +maps real time to beats and vice versa. This includes all BPMs and the +initial offset, as well as time gimmicks like stops, warps, and delays. The +TimingData object itself only has a few members: +* the name of the file that specified the data (for display only) +* the beat 0 offset +* a vector of TimingSegments for each type (BPM, warp, label, etc.) + +Each TimingSegment specifies a starting point in the chart, as well as any +parameters which are specific to that segment type. For a list of the +different types of TimingSegments, see TimingSegments.h. + + +== Split Timing == + +TimingData is primarily used for charts and songs, to specify the BPM and +offset and to implement gimmicks, as well as to synchronize effects with +background music. (It also provides features such as labels and time +signatures which can be useful when editing a chart.) + +Prior to StepMania 5, each song had a single TimingData structure which was +then used by all of the charts associated with that song. StepMania 5 +introduces a feature known as Split Timing, wherein a chart can have +individual TimingData ("Steps Timing") which is independent of the song's +TimingData ("Song Timing"). This allows for Pump-style gimmicks which can +differ between difficulties on the same song. + + +== Implementation == + +In the code, Song Timing is contained in the m_SongTiming field of a Song +object. Song Timing is used by default for any chart which does not specify +its own timing information. + +If a chart has its own timing information, this is contained in the m_Timing +field of the Steps object. If the chart does not have separate timing +information, the m_Timing structure will be empty (i.e. none of the vectors +will contain any TimingSegments). The TimingData::empty() function provides a +simply way to determine this. + +The most common way to get the TimingData for a chart is to use the +GetTimingData() function of the Steps object. This function will perform the +appropriate fallback to Song Timing if the chart's timing is empty. If, as in +the editor or sync implementations, it is necessary to access the Steps Timing +or Song Timing individually, the corresponding fields can be used instead. + +=== Editing === + +The editor has a "timing mode" setting which can be toggled between Song +Timing and Steps Timing (in the code, GAMESTATE->m_bIsUsingStepTiming). This +mode determines which set of TimingData will be updated when changes are made +with hotkeys or the Timing menu. It defaults to Steps Timing if the chart +being loaded has individual TimingData, and Song Timing otherwise. +Considering that we also want this to behave according to whether a chart has +individual timing, there are four possibilities when making a change: + +1. Song Timing mode, chart DOES NOT HAVE individual timings: changes will be + made to the Song Timing, and the chart will not have individual timings + added to it. Because of this, the changes to Song Timing will "show + through" to this chart. +2. Song Timing mode, chart HAS individual timings: changes will be made to the + Song Timing only. The timings in the chart will be left untouched. Because + of this, the changes to Song Timing will not affect this chart. +3. Steps Timing mode, chart HAS individual timings: changes will be made to the + Steps Timing only and will affect only this chart. +4. Steps Timing mode, chart DOES NOT HAVE individual timings: first, the Song + Timing will be copied into this chart. The changes are then made to the + Steps Timing only and will affect only this chart. + +Case #4 describes how Steps Timing is added to a chart: simply select Steps +Timing mode and start making changes. To remove Steps Timing, use the +corresponding item in the Timing menu. + + +== File formats == + +A quick note is in order about Split Timing support in the different file +formats supported by StepMania: + +* SSC files support Split Timing natively. Timing tags such as #BPMS in the + file header apply to the song, whereas the same tags inside a #NOTEDATA + section apply only to the current chart. +* SM files do not support Split Timing, since there is no way to specify + individual timing for a chart. +* SMA files support Split Timing in a similar fashion to SSC files. +* The KSF and BMS formats use one file for each chart, and therefore already + have per-chart timing information. When reading these formats, *every + chart* has Steps Timing. +* The DWI format does not support Split Timing, so Steps Timing is not written + to DWI files. diff --git a/Docs/Devdocs/TextEntry.txt b/Docs/legacy/Devdocs/TextEntry.txt similarity index 100% rename from Docs/Devdocs/TextEntry.txt rename to Docs/legacy/Devdocs/TextEntry.txt diff --git a/Docs/Devdocs/WarpNotes.txt b/Docs/legacy/Devdocs/WarpNotes.txt similarity index 100% rename from Docs/Devdocs/WarpNotes.txt rename to Docs/legacy/Devdocs/WarpNotes.txt diff --git a/Docs/Devdocs/ezsockets.txt b/Docs/legacy/Devdocs/ezsockets.txt similarity index 100% rename from Docs/Devdocs/ezsockets.txt rename to Docs/legacy/Devdocs/ezsockets.txt diff --git a/Docs/Devdocs/interesting_sm4_commit_logs.txt b/Docs/legacy/Devdocs/interesting_sm4_commit_logs.txt similarity index 100% rename from Docs/Devdocs/interesting_sm4_commit_logs.txt rename to Docs/legacy/Devdocs/interesting_sm4_commit_logs.txt diff --git a/Docs/Devdocs/negbpmtut/screen00214.jpg b/Docs/legacy/Devdocs/negbpmtut/screen00214.jpg similarity index 100% rename from Docs/Devdocs/negbpmtut/screen00214.jpg rename to Docs/legacy/Devdocs/negbpmtut/screen00214.jpg diff --git a/Docs/Devdocs/negbpmtut/screen00215.jpg b/Docs/legacy/Devdocs/negbpmtut/screen00215.jpg similarity index 100% rename from Docs/Devdocs/negbpmtut/screen00215.jpg rename to Docs/legacy/Devdocs/negbpmtut/screen00215.jpg diff --git a/Docs/Devdocs/negbpmtut/screen00216.jpg b/Docs/legacy/Devdocs/negbpmtut/screen00216.jpg similarity index 100% rename from Docs/Devdocs/negbpmtut/screen00216.jpg rename to Docs/legacy/Devdocs/negbpmtut/screen00216.jpg diff --git a/Docs/Devdocs/negbpmtut/screen00217.jpg b/Docs/legacy/Devdocs/negbpmtut/screen00217.jpg similarity index 100% rename from Docs/Devdocs/negbpmtut/screen00217.jpg rename to Docs/legacy/Devdocs/negbpmtut/screen00217.jpg diff --git a/Docs/Devdocs/negbpmtut/screen00218.jpg b/Docs/legacy/Devdocs/negbpmtut/screen00218.jpg similarity index 100% rename from Docs/Devdocs/negbpmtut/screen00218.jpg rename to Docs/legacy/Devdocs/negbpmtut/screen00218.jpg diff --git a/Docs/Devdocs/negbpmtut/screen00221.jpg b/Docs/legacy/Devdocs/negbpmtut/screen00221.jpg similarity index 100% rename from Docs/Devdocs/negbpmtut/screen00221.jpg rename to Docs/legacy/Devdocs/negbpmtut/screen00221.jpg diff --git a/Docs/Devdocs/possible memory leaks.txt b/Docs/legacy/Devdocs/possible memory leaks.txt similarity index 100% rename from Docs/Devdocs/possible memory leaks.txt rename to Docs/legacy/Devdocs/possible memory leaks.txt diff --git a/Docs/Devdocs/rivaldata.txt b/Docs/legacy/Devdocs/rivaldata.txt similarity index 100% rename from Docs/Devdocs/rivaldata.txt rename to Docs/legacy/Devdocs/rivaldata.txt diff --git a/Docs/Devdocs/versioning.txt b/Docs/legacy/Devdocs/versioning.txt similarity index 100% rename from Docs/Devdocs/versioning.txt rename to Docs/legacy/Devdocs/versioning.txt diff --git a/Docs/KnownIssues.txt b/Docs/legacy/KnownIssues.txt similarity index 97% rename from Docs/KnownIssues.txt rename to Docs/legacy/KnownIssues.txt index 04ff7449f6..d84d3763fa 100644 --- a/Docs/KnownIssues.txt +++ b/Docs/legacy/KnownIssues.txt @@ -1,53 +1,53 @@ -The following is a list of known issues with StepMania 5. - -* The course editor is not working. (It could stand to be rewritten.) - -* The scoring system needs to be made global for the game instead - of tying it to the theme. The current arrangement causes multiple problems - (themes not supporting scoring unless they explicitly add it to gameplay - decorations, the last note not being scored, and so on). - -* The C and V keys in the editor (related to attacks) still has - work to go. Crashes should hopefully be minimal if not otherwise - nonexistant. - -* Attacks involving noteskins do not work. They may never work again unless - some internal coding issues are figured out. - -* Routine mode (dance or pump) isn't perfect yet. - * Attempting to use the Jukebox to show Routine steps will lead to an infinite - loop that is not escapable short of killing the program. - * Attempting to select routine mode in the Practice menu causes a crash. - -* The attempted unlock code written around Previews 2-4 (?) does not seem to - work at this time. Assistance may be needed here. - -* Hold/Roll heads seem to be draw under preceding taps when they - shouldn't be all the time. - -* C-Mods have not been fully tested with all of the new segments yet. - Warp segments are ignored when C-Mods are used. - -* Split Timing needs adjustments with only one chart in place. - * Either that, or all tags must be allowable in song timing. - -* Language detection fails for Czech and possibly other things on OS X - (non-fatally, now) - -* Japanese font maps are too large and get resized on load to something - manageable. They should be cut into thirds vertically. - * This makes debug builds in particular load very slowly, and reduces quality. - -* The editor sometimes keeps playing music and won't scroll. - -* VBR MP3's don't seek correctly in the editor, which botches sync. - -* There is no make install target for linux systems - this is important for - packaging purposes in particular (it would be great to release .debs!) - -* LuaDriver works well, but without threading it has latency issues. - -* Survival courses crash if you set a noteskin in the player options - just before starting the course. - -* On some graphics cards, 3D models may cause crashes. +The following is a list of known issues with StepMania 5. + +* The course editor is not working. (It could stand to be rewritten.) + +* The scoring system needs to be made global for the game instead + of tying it to the theme. The current arrangement causes multiple problems + (themes not supporting scoring unless they explicitly add it to gameplay + decorations, the last note not being scored, and so on). + +* The C and V keys in the editor (related to attacks) still has + work to go. Crashes should hopefully be minimal if not otherwise + nonexistant. + +* Attacks involving noteskins do not work. They may never work again unless + some internal coding issues are figured out. + +* Routine mode (dance or pump) isn't perfect yet. + * Attempting to use the Jukebox to show Routine steps will lead to an infinite + loop that is not escapable short of killing the program. + * Attempting to select routine mode in the Practice menu causes a crash. + +* The attempted unlock code written around Previews 2-4 (?) does not seem to + work at this time. Assistance may be needed here. + +* Hold/Roll heads seem to be draw under preceding taps when they + shouldn't be all the time. + +* C-Mods have not been fully tested with all of the new segments yet. + Warp segments are ignored when C-Mods are used. + +* Split Timing needs adjustments with only one chart in place. + * Either that, or all tags must be allowable in song timing. + +* Language detection fails for Czech and possibly other things on OS X + (non-fatally, now) + +* Japanese font maps are too large and get resized on load to something + manageable. They should be cut into thirds vertically. + * This makes debug builds in particular load very slowly, and reduces quality. + +* The editor sometimes keeps playing music and won't scroll. + +* VBR MP3's don't seek correctly in the editor, which botches sync. + +* There is no make install target for linux systems - this is important for + packaging purposes in particular (it would be great to release .debs!) + +* LuaDriver works well, but without threading it has latency issues. + +* Survival courses crash if you set a noteskin in the player options + just before starting the course. + +* On some graphics cards, 3D models may cause crashes. diff --git a/Docs/Licenses.txt b/Docs/legacy/Licenses.txt similarity index 100% rename from Docs/Licenses.txt rename to Docs/legacy/Licenses.txt diff --git a/Docs/Luadoc/Lua.xml b/Docs/legacy/Luadoc/Lua.xml similarity index 97% rename from Docs/Luadoc/Lua.xml rename to Docs/legacy/Luadoc/Lua.xml index 8ac6b3a44d..25a18d2a7c 100644 --- a/Docs/Luadoc/Lua.xml +++ b/Docs/legacy/Luadoc/Lua.xml @@ -1,3553 +1,3553 @@ - - - -
color with the specified alpha.
- - Note: When you see the error "approach: speed 1 is negative." it means that the speed value passed was negative. The 1 is there because approach and multiapproach use the same internal function and can be ignored when using approach. -
v is false (or nil). Returns all arguments otherwise. sAssertMessage is an optional error message (the default is "assertion failed!").
- fBoost.
- true if Center 1P is being used.
- true if checkpoint judgments and tap judgments
- are considered separate, or false otherwise.
- fValue between fLow and fHigh.
- opt.
- color can be in hex ("#FFFFFFFF") or 0..1 values ("1.0,1.0,1.0,1.0"), in RGBA order.
- c[1]/2, c[2]/2, c[3]/2, c[4])
- c[1]+(c[1]/2), c[2]+(c[2]/2), c[3]+(c[3]/2), c[4])
- c[1]/1.5, c[2]/1.5, c[3]/1.5, c[4])
- UserPrefComboUnderField user preference value.
- -
number can be a string, an integer, or a float.-
comma is an optional argument that is used instead of a comma.- "commify(1234, 'cat')" will result in "1cat234".
-
dot is an optional argument that is used instead of a dot to find the end of the part that should be commified.- "commify('1234cat5678', ',', 'cat')" will result in "1,234cat5678", but "commify('1234cat5678')" will result in "12,34c,at5,678".
- The
comma and dot arguments are provided to ease compliance with locales or languages that do not use comma and dot in numbers the way English does.
- sAddress.
- dir for xml files of actors and
- converts them to equivalent lua files. See Docs/Themerdocs/XmlToLua.txt
- for details.
- - Strings that do not have an entry in the master language are considered unused.
- master_lang_name is the name of the ini file that contains the language with all strings used by the theme.
- Example: find_missing_strings_in_theme_translations("my_best_theme", "en.ini") -
list.
- tab with the given value.
- func takes a key and a value.
- fPercentDancePoints formatted as a percentage.
- name from the Env table.
- - If you are loading the sound into an ActorSound, ActorSound:get to get its RageSound then use RageSound's get_length function instead to avoid loading the file twice. -
true if player pn is using ProTiming.
- true if you need to step on hold heads to activate them.
- pump mode, TimingWindowSecondsHold preference value in any other game mode.
- 0-360, saturation and value are 0..1
- 0-360, saturation, value, and alpha are 0..1
- true if the coin mode is not set to CoinMode_Home.
- true if Event Mode is turned on.
- true if Arcade and the coin mode is CoinMode_Free.
- true if the current game is sGame.
- true if the coin mode is set to CoinMode_Home.
- true if connected to the Internet.
- true if connected to StepMania Online.
- true if Player pn is logged on to a SMOnline server.
- true if W1 is allowed (and tns == 'TapNoteScore_W2')
- true if Routine mode is being played.
- true if the aspect ratio is 16:10 (1.6) or higher.
- delimiter, returning a string of the results.
- sPath. If sPath points to a Lua file, any additional arguments will be passed to that script.
- sString.
- 0-11).
- m as a localized string.
- m as a string.
- currents in place, as well as returning currents.-
currents, goals, and speeds must all be the same size and contain only numbers.-
multiplier is optional. The speeds in the speeds table will be multiplied by multiplier. This makes it more convenient to use multiapproach in a per-frame update: pass in the frame delta and the speeds will be scaled to the time that passed.- Note: When you see the error "approach: speed 1 is negative." it means that a speed value passed was negative. The 1 tells you which entry in the table was invalid. -
next returns the next index of the table and its associated value."
- See the Lua manual for more details.
- t, and nil,
- so that the construction for k,v in pairs(t) do body end
- will iterate over all key–value pairs of table t."
- p1val or p2val depending on pn.
- numerator and denominator.
- v1 is equal to v2, without invoking any metamethod."
- t[index], without invoking any metamethod."
- t[index] to value, without invoking any metamethod."
- The modified t is then returned.
- optional is true, then a nil path is returned instead of emitting an error if no file is found.
- path and returns its contents.
- -
indent is an optional argument that will be prepended to every line.
- -
indent is an optional argument that will be prepended to every line.
- - Returns success and full path of the resulting screenshot. -
x, originally within low1 and high1, to fall between low2 and high2.
- fSecs to Minutes:Seconds:Milliseconds format using two digits for each section.
- fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Minutes (uses 1).
- fSecs to Minutes:Seconds format.
- fSecs to Minutes:Seconds.Milliseconds format.
- fSecs to Minutes:Seconds.Milliseconds format using two digits for each section.
- fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Milliseconds (uses 3).
- index is a number, returns all arguments after argument
- number index. Otherwise, index must be the string
- "#", and [it] returns the total number of extra arguments it received."
- t.
- name to value in the Env table.
- true if a decoration should be shown on the current screen or not.
- delimiter, returning a table of the results.
- t.
- num.
- e to a number. Returns nil if
- it can't convert the input to a number. (base is optional.)
- e to a string.
- P1.
- return list[i], list[i+1], ···, list[j]"
- (i and j are optional; "by default, i is 1 and j is the length of the list.")
- - This way, a theme can implement a custom interactive screen for adjusting those preferences. -
ar43 (4:3; 640px) and ar169 (16:9; 854px).
- buf to the file at path.
- prefName to its config file with value being tostring'd.
- sPath.
- true if sClassName is a registered Class.
- optional is true, then a nil path is returned instead of emitting an error if no file is found.
- iCol at beat fNoteBeat for the provided PlayerState. Y Offset is affected by Speed mods and Accel mods, and impacts most other arrow effects.
- iCol with a Y offset of fYOffset for the provided PlayerState.-
fYReverseOffsetPixels is the separation between targets with and without reverse. This argument is optional and will pull defaults from the metrics for [Player]
- iCol with a Y position of fYPos for the provided PlayerState.-
fYReverseOffsetPixels is the separation between targets with and without reverse. This argument is optional and will pull defaults from the metrics for [Player]
- iCol with a Y offset of fYOffset for the provided PlayerState.
- iCol with a Y offset of fYOffset for the provided PlayerState.
- fYOffset for the provided PlayerState.
- fYOffset for the provided PlayerState.
- fNoteBeat for the provided PlayerState.-
bIsHoldHead is an optional argument which defaults to false. If true, this function will return 0 if the [ArrowEffects] metric DizzyHoldHeads is false.
- iCol with a Y offset of fYOffset for the provided PlayerState.-
fPercentFadeToFail is optional and defaults to -1.-
fYReverseOffsetPixels is the separation between targets with and without reverse. This argument is optional and will pull defaults from the metrics for [Player]-
fDrawDistanceBeforeTargetsPixels is optional and will pull defaults from the [Player] metric DrawDistanceBeforeTargetsPixels-
fFadeInPercentOfDrawFar is optional and will pull defaults from the [NoteField] metric FadeBeforeTargetsPercent-
iCol with a Y offset of fYOffset for the provided PlayerState. The arguments are the same as for GetAlpha.
- fNoteBeat for the provided PlayerState.
- fYOffset for the provided PlayerState.fOverlappedTime is optional and will default to 0.
- [1] would be the
- string 'PlayerNumber_P1'.- The functions defined in the
Enum namespace are valid member
- functions of every Enum where the first argument is
- omitted and the name of the Enum is used in place
- of Enum. Instead of
- Enum.GetName(
- ) or
- Enum.Reverse(
- ), one can use
- :GetName() or
- :Reverse(), respectively.
- x and y need to be elements of the enumerated
- type e. Returns a value less than/greater than/equal to
- 0 corresponding to the numerical value of x being
- less than/greater than/equal to the numerical value of y as
- determined by
- Enum.Reverse( e ).
- e. For example,
- Enum.GetName( )
- will return the string 'PlayerNumber'.
- e. For
- example: local r =
- Enum.Reverse( );
- local n = r['PlayerNumber_P2'];- The value of
n in this case would be 1 corresponding
- to the 0-based indexing using in C++ and not 2 as might be
- expected for the 1-based indexing used in Lua.
- true if the type of v is sType.
- sPath. If successful, it returns the file's contents.
- If unsuccessful, it returns two values: nil and "error".
- - error is optional an defaults to "Script error occurred.". error_type is optional and defaults to "LUA_ERROR". -
func(...) with two LuaThreadVariables set, and returns the return values of func().
- sString to log.txt. Aliased by
- .
- sString to info.txt and log.txt as
- a warning. Aliased by .
- 0..1. With a single argument (n), the number is in the range of 1..n. With two arguments (lower, upper), the number is in the range of l..u.
- seed.
- pn.
- st) are playable.
- st) are playable.
- - The ActorFrame that is returned is the wrapper state, for convenience.
- An Actor can have any number of wrapper states. Use GetWrapperState to access wrapper states for the actor. -
nil if it doesn't have one.
- nil if it doesn't have one.
- b.
- fRate * fRate), where fRate is in seconds.
- rot to the Actor's current x rotation.
- rot to the Actor's current y rotation.
- rot to the Actor's current z rotation.
- xPos to the Actor's current x position.
- yPos to the Actor's current y position.
- zPos to the Actor's current z position.
- h and v are in the range 0..1.
- true, cull the Actor's back faces. See also: .
- fAlpha, where fAlpha is in the range 0..1.
- rot.
- rot.
- rot.
- zoom.
- zoom.
- zoom.
- zoom.
- x,SCREEN_CENTER_X;y,SCREEN_CENTER_Y)
- x,SCREEN_CENTER_X)
- y,SCREEN_CENTER_Y)
- tweens
- can either be a string like "linear,0.25,accelerate,0.75" or
- a table with tween information { {Type="linear", Percent=0.25, Bezier=nil}, {Type="accelerate", Percent=0.75, Bezier=nil} }
- percent of the Actor from the bottom, where percent is in the range 0..1.
- percent of the Actor from the left, where percent is in the range 0..1.
- percent of the Actor from the right, where percent is in the range 0..1.
- percent of the Actor from the top, where percent is in the range 0..1.
- mode.
- fRate) * (1-fRate)), where fRate is in seconds.
- c.
- fAlpha, where fAlpha is in the range 0..1.
- c.
- c, ignoring any alpha value in c.
- c.
- c.
- c.
- c.
- c.
- c.
- c.
- iOrder, where larger values display first.
- s.
- c.
- c.
- fTime. The offset is added to the time into the effect before calculating percent_through_effect.
- fTime.
- - hold_at_zero is before hold_at_full in the argument list for compatibility. A future version will probably swap them because it makes more sense to have hold_at_full come before hold_at_zero.
- All effect timings must be greater than or equal to zero, at least one of them must be greater than zero.
- The effect timing controls how long it takes an effect to cycle and how long it spends in each phase.
- Depending on the effect clock, the actor's time into effect is updated every frame. That time is then translated into a percent_through_effect using the parameters to this function.
-
- ramp_to_half is the amount of time for percent_through_effect to reach 0.5.
- hold_at_half is the amount of time percent_through_effect will stay at 0.5.
- ramp_to_full is the amount of time percent_through_effect will take to go from 0.5 to 1.0.
- hold_at_full is the amount of time percent_through_effect will stay at 1.0.
- After reaching the end of hold_at_full, percent_through_effect stays at 0 until hold_at_zero is over.
-
- The different effects use percent_through_effect in different ways. Some use it to calculate percent_between_colors with this sine wave: sin((percent_through_effect + 0.25f) * 2 * PI ) / 2 + 0.5f
- Some effects check the internal bool blink_on. blink_on is true if percent_through_effect is greater than 0.5 and false if percent_through_effect is less than or equal to 0.5.
- Check the effect functions for individual explanations: diffuseblink, diffuseshift, glowblink, glowshift, glowramp, rainbow, wag, bounce, bob, pulse, spin, vibrate. -
percent of the Actor from the bottom where percent is in the range 0..1.
- percent of the Actor from the left where percent is in the range 0..1.
- percent of the Actor from the right where percent is in the range 0..1.
- percent of the Actor from the top where percent is in the range 0..1.
- true if the Actor has a command named sCmdName.
- fAlign which should be a float in the range 0..1. An alignment of 0 is left aligned while an alignment of 1 is right aligned. See for the common case.
- fHeading.
- b is true, but don't unhide if b is false."
- align. See for fractional alignment.
- factor.
- fRate is in seconds.
- side ("Back" or "Front").
- sName.
- fPitch.
- sCommandName. params is passed to the command as an argument if it is a table.
- p being a human player.
- sCommandName to be played.
- !sMessageName (Note the ! at the beginning. The source code says this: "Hack: use "!" as a marker to broadcast a command, instead of playing a command, so we don't have to add yet another element to every tween state for this rarely-used command.")
- fRoll.
- fAlign.
- fAlign.
- fAlign.
- iNewState.
- c.
- fLength.
- fLength.
- fLength.
- fAmount.
- fAmount.
- fSeconds before executing the next command.
- - It's usually more convenient to use Actor:linear, Actor:accelerate, and so on, rather than using Actor:tween directly. -
fAlign which should be a float in the range 0..1. An alignment of 0 is top aligned while an alignment of 1 is bottom aligned. See for the common case.
- align. See for fractional alignment.
- xPos.
- yPos.
- zPos.
- fBias.
- bUse.
- zoom scale.
- zoomX and zoomY.
- zoom height. See also: .
- zoom width. See also: .
- zoom scale on the X axis.
- zoom scale on the Y axis.
- zoom scale on the Z axis.
- true, turns it off if false
- testMode.
- true or false based on bWrite.
- stretchto,0,0,SCREEN_WIDTH,SCREEN_HEIGHT)
- sName.- If there are multiple children with that name, returns an array of those children.
- The table also acts as a pass through layer, function calls pass through to the last child of that name. -
- The table is indexed by the names of the children.
- If there are multiple children with the same name, the entry for that name is an array of those children.
- The table also acts as a pass through layer, function calls pass through to the last child of that name. -
sCommandName command on the ActorFrame's children.
- sCommandName command on the ActorFrame's leaves.
- cmds on the ActorFrame's children.
- cmds on the ActorFrame's leaves.
- c.
- c.
- c.
- fRate.
- sName.
- - {{left, top, right, bottom}, delay}
- left, top, right, and bottom are pixel coordinates, starting at 0. If delay is 0 or negative, the state will last forever. -
- This works best when using DrawMode_Quads.
- AMV's can have animated textures like sprites. Each state tells the AMV what part of the texture to use, and how long the state lasts.
- Use AddState to add a state onto the end, or SetStateProperties to set all the states at once, or SetState to set a single state.
- Each quad has its own offset that is added to the current state. Use AddQuadState to add to the list of quad states, or SetQuadState to set an existing quad state. -
index with the properties provided. The tables of properties are each optional and can be provided in any order.
- vertices should themselves be tables, of the form provided to SetVertex. If vertices is the first argument it will start from vertex 1. If an integer is provided before vertices it will start from that vertex. It will add vertices as necessary.
- Example: self:SetVertices( { { { x1, y1, z1 } , { r1,g1,b1,a1 } , { tcx1,tcy1 } }; { { x2, y2, z2 } , { r2,g2,b2,a2 } , { tcx2,tcy2 } } } )
- - ("all the drawn verts" means all the verts between FirstToDraw and NumToDraw, the verts that are set to draw in the current tween state.)
- The parts of the ActorMultiVertex are evenly spaced along the spline in terms of t value.
- The exact behavior depends on the draw mode.
- DrawMode_Quads uses all 4 splines, one for each corner.
- DrawMode_QuadStrip and DrawMode_Strip use 2 splines, one for each edge of the strip.
- DrawMode_Fan uses one spline, for the edge verts of the fan. The first vert is not touched because it is the center.
- DrawMode_Triangles uses 3 splines, one for each corner.
- DrawMode_SymmetricQuadStrip uses 3 splines, one on each edge and one in the center.
- DrawMode_LineStrip uses 1 spline.
-
- ActorMultiVertex splines are not inside the tween state, and will not change the verts until you call SetVertsFromSplines. -
- Mode must be a DrawMode.
- First is the index of the first vertex to draw.
- Num is the number of vertices to draw. -1 for Num means draw all verts after First.
- Any value not in the table defaults to the already set value.
- Examples:
- -- Sets all three parts of the draw state.
- self:SetDrawState{Mode="DrawMode_Quads", First= 1, Num= -1}
- -- Set only the draw mode. First and Num remain unchanged from previous.
- self:SetDrawState{Mode="DrawMode_Quads"}
- -- Set the first and number to draw. Draw mode remains unchanged.
- self:SetDrawState{First= 3, Num= 4}
-
texture
- path.
- a.
- fWidth by fHeight pixels.
- fNumItems items.
- fSecs.
- fSeconds.
- - A value of
0 means the scroller will not scroll.
- fItemHeight.
- fItemWidth.
- - *
SupportPan - Let the sound pan from side to side.- *
SupportRateChanging - Let the sound change rate and pitch.- *
IsAction - If true, the sound is an action sound, and will be muted if the MuteActions preference is turned on.
- sPath.
- bPause.
- SupportPan = true on load.
- sAnnouncer exists.
- sNewAnnouncer.
- true if the application presently has focus.
- true if the Banner is currently scrolling.
- sPath (typically or ).
- attr to the string at position
- iPos.- The attribute is a table that must contain
Length
- which specifies how many (multi-byte) characters the attribute
- is to apply. If Length=-1, then the attribute applies
- until another attribute overrides it.- If the table contains
Diffuse, then the color value
- is applied to the range of text.- If the table contains
Diffuses, then it should be
- an array of 4 colors which specify the diffuse color for the
- top left, top right, bottom left, and bottom right.- If the table contains
Glow, then the color value
- is applied as a glow to the range of text.- Example:
-
attr = { Length = 10; Diffuse = color("#AABBCC"); }
- bJitter is true, move each character of the string around by a small random amount.
- fHeight. If fHeight is 0, then there is no maximum height.
- fWidth. If fWidth is 0, then there is no maximum width.
- false.
- true, set each character of the text in turn to the rainbow colors in the metrics BitmapText::RainbowColor#.
- sText. This clears all attributes.
- string.format(sFormat, ...).
- c.
- true, make all text uppercase.
- iSpacing pixels of padding between lines of text.
- iWidth pixels. If you or by x and you want the text wrapped at width, then you should use wrapwidthpixels(width/x).
- sID.
- sMetricsGroup.
- true if all of the songs in the course have been defined (as opposed to random songs).
- iIndex from the Course.
- true if the Course has a background.
- true if the Course has a banner.
- true if the Course has modifiers.
- true if the Course has timed modifiers.
- true if the Course is an edit.
- true if the Course was automatically generated.
- true if the Course is Endless.
- true if the Course is Nonstop.
- true if the Course is Oni.
- true if the Course is playable in StepsType st.
- true if the Course is a ranking course.
- true if this CourseEntry is a fixed song.
- true if this CourseEntry is secret.
- sPath.
- s.
- sPath.
- s.
- - This spline implementation is a cubic spline.
- A spline is a line calculated from a small set of points with mathematical smooting applied.
- Splines can have any number of dimensions, but splines owned by actors (the ones inside NCSplineHandler and ActorMultiVertex) always have 3 dimensions.
-
- t can range from 0 to the value returned by get_max_t().
- A normal spline will return its starting point for any t value less than 0 and its end point for any t value greater than the max.
- A looped spline adjust the t value to be within the its range by adding or subtracting the max t as needed. (so if the max t is 4 and you evaluate at 5, it will return the same as if you evaluated at 1.) -
- Second and third derivative functions exist because they're possible, not because they're expected to be useful. The fourth derivative would be 0 because the equation for evaluating the spline is "a + (b*t) + (c*t^2) + (d*t^3)". -
- Each table must contain a value for each dimension of the spline.
- Solving the spline normally should cover all normal usage, this is for people that want a spline with an abnormal behavior, so if you set the coefficients directly, expect to end up with an unsmooth shape. -
- The spatial extent exists to handle numbers that exist in a finite looped space, instead of the flat infinite space.
- To put it more concretely, spatial extent exists to allow a spline to control rotation with wrapping behavior at 0.0 and 2pi, instead of suddenly jerking from 2pi to 0.0. -
- Splines that are owned by actors (the ones inside ActorMultiVertex and NCSplineHandler) cannot have their number of dimensions changed because the actors require them to have 3 dimensions. -
pn,
- then sets the DifficultyIcon's state from the difficulty of Steps pSteps
- pn,
- then sets the DifficultyIcon's state from the difficulty of Trail pTrail
- pn.
- true if notes are counted separately in this game.
- tns.
- nil if there isn't one).
- game.
- true if any noteskins exist for the specified Game s.
- st.
- game.
- Game. The second argument is optional, and if provided will determine which theme is loaded when the game changes. If the second argument is not provided, the default theme from the preferences for the new game type will be loaded.- If only the game changes, the screen specified by the Common::AfterGameChangeScreen metric will be loaded.
- If the game and the theme both change, the screen specified by the Common::AfterGameAndThemeChangeScreen metric will be loaded.
- The Common::InitialScreen metric will be used if the appropriate metric for the change is blank or invalid. -
fVolume for fDuration seconds.
- pn.
- musicPath starting from musicStart for
- musicLength seconds one time. Both fadeIn and
- fadeOut can be customized as required. loop
- tells the sound manager to loop the music part. applyRate
- tells the sound manager to apply the current music rate. If alignBeat
- is true or nil, the length is automatically adjusted to cover an integer number of beats.
- sPath one time. is_action is optional, if it is true, the sound is an action sound, and will be muted if the MuteActions preference is turned on.
- true if any player has performed a feat worthy of ranking.
- sCommand
- for pn, if given. See .
- - Might not work in all cases, but will catch things like a player not having - steps set or no current song or style. Mainly exists for people with a custom ScreenSelectMusic replacement.
- Example:
- local can, reason= GAMESTATE:CanSafelyEnterGameplay()
- if not can then
- lua.ReportScriptError("Cannot safely enter gameplay: " .. tostring(reason))
- end
-
true if pn's options will disqualify them for ranking.
- true if enough credits have been inserted to join.
- For example,
-
local credits = {GAMESTATE:GetCurrentStepsCredits()};- will make a table of the difficulties and descriptions. -
nil if it does not exist.
- nil
- if it does not exist.
- true if the gameplay lead in is enabled. If
- false, gameplay begins immediately.
- true if the game is Multiplayer.
- pn.
- pn.
- pn.
- true if a delay is active in the song.
- true if the song is currently in a freeze.
- fBeat.
- pn.
- true if the workout goal is complete.
- true if an extra stage was earned.
- true if either player does not have a profile loaded, and there is a loadable profile.
- true if either player has a profile loaded.
- true if we are specifically in the Step Editor's
- editing portion. If in recording or playing mode, this will return
- false.
- iCoins number of coins. iCoins can be negative or positive.
- true if this is an extra stage.
- true if any human player is using a memory card.
- true if playing in Battle mode.
- true if playing in a Course mode.
- true if in Demonstration mode.
- true if the match was a draw.
- true if Event Mode is on, temporary or otherwise.
- true if this is the first extra stage.
- true if this is the second extra stage.
- true if player pn has completed the current Goal.
- true if player pn is human.
- true if player pn is enabled.
- true if player pn has joined the game.
- true if player pn is the winner.
- pn. Does not deduct coins.
- LoadEdits is true, or by default if the argument is omitted.
- true if player pn is using modifier sModifier.
- true if players can join the game.
- course.
- pm.
- song.
- pn's current Steps to steps.
- trail.
- iFields
- pn to Difficulty dc.
- song.
- sGroup.
- so using ModsLevel m.
- bOn.
- bOn.
- pn.
- sMetricsGroup.
- g.
- sMetricsGroup.
- pn to empty.
- pn from RadarValues rv
- pn to the specified (floating point) values in the table.
- fSeconds.
- tips (and optionally altTips).
- sTips using colons to separate new sections.
- hns.
- tns.
- true if this high score's name uses a fill-in marker.
- true if failing.
- true if the LifeMeter is "hot".
- true if in danger.
- iNumLives. (Negative values subtract lives.)
- true if player pn's card is locked.
- pn.
- true if player pn's name is available.
- fSeconds.
- bSilent.
- bStealth. If
- true, the timer will be invisible and silent.
- sMessage. The
- second argument is an optional table of parameters. It may be omitted or explicitly
- set to nil.
- fWidth.
- sAniName at fPlayRate speed (default 1.0).
- fRate.
- sAnimation at fPlayRate speed (default 1.0).
- pn from the Metrics in group sMetricsGroup.
- true if the order was changed.
- true if the MusicWheel is currently handling Roulette selection.
- false on failure.
- false on failure.
- sNoteSkin.
- sNoteSkin.
- sNoteSkin.
- sNoteSkin.
- sNoteSkin.
- sButton sElement.
- sButton sElement using NoteSkin sNoteSkin.
- sButton sElement.
- sButton sElement using NoteSkin sNoteSkin.
- true if the strName noteskin exists in the current gametype.
- - The spline handler holds info on how the spline is used by the engine.
- Each get/set pair of functions in this class is for a different aspect of the spline's behavior. -
- "NoteColumnSplineMode_Disabled" means the spline will not affect the notes or receptors at all.
- "NoteColumnSplineMode_Offset" means the spline will added to the effects from the mods.
- "NoteColumnSplineMode_Position" means only the spline affect the notes and mods will be ignored. (but only mods that affect the same aspect of the note as the spline will be disabled. So a rotation spline won't disable Mini or Tiny, but a zoom spline will, and a zoom spline won't disable Dizzy, Twirl, or Roll, but a rotation spline will.) -
- Position, rotation, and zoom each have separate spline handlers to allow them to have separate independent behavior.
- It is important to note that the spline handlers are inside the tween state, so whenever you start a new tween on the actor, you need to refetch the spline handlers.
-
- The rotation applied by the rotation spline is in radians.
- For convenience, the spatial extent of the rotation spline defaults to 2pi. -
-
- The callback for did_hold_note will not be called. -
- The callback for did_tap_note will not be called. -
- The callback function is passed the column, the TapNoteScore, and whether the explosion will be bright.
- The callback function can return changed values for the NoteField to use instead of the ones that were passed.
- Pass nil instead of a function to clear the callback. -
- The callback for set_pressed will not be called. -
- The callback function is passed the column for the press.
- The callback function can return changed values for the NoteField to use instead of the ones that were passed.
- Pass nil instead of a function to clear the callback. -
- The callback function is passed the column and the TapNoteScore for the step.
- The callback function can return changed values for the NoteField to use instead of the ones that were passed.
- Pass nil instead of a function to clear the callback. -
true if the first item in the row goes down.
- pn is on.
- true if this row is focused by player pn.
- true if this row forces one choice on all players.
- pn.
- index in the current steps queue.
- - This allows you to chain them like this:
- player_options:Twirl(5, 1, true):Roll(5, true):Dizzy(true):Twirl()
-
- Special note: Functions that take a bool as their arg must have true as the second arg to be used with chaining.
- "player_options:Backwards(true, true):Beat(5)" will chain, "player_options:Backwards(true):Beat(5)" will not chain.
-
- Most options fall into one of four types: float, int, bool, or enum.
- Float type options have this interface:
- Option(value, approach_speed)
- If value is a float, sets the TimeSpacing modifier to value.
- If approach_speed is a float, sets the speed of the transition to approach_speed. Returns the previous values of both.
- approach_speed is in units of n per second. value will be approached at the rate of approach_speed per second.
- Note that the value and the approach speed arguments are both independently optional.
- Example:
- a,b= options:Boost() -- Sets a to the current value and b to the current approach_speed.
- a,b= options:Boost(5, .5) -- Stores the previous values in a and b, NOT to 5 and .5. Sets the value to 5 and the approach speed to .5.
- a,b= options:Boost(5) -- Sets a and b to the previous values, NOT to 5 and .5. Sets the value to 5 and leaves the approach speed at whatever it was.
-
- Setting the approach speed only matters when modifying the PlayerOptions from ModsLevel_Song.
- Int type options are similar to float in that they return and take a number, but they do not have an approach speed.
- Bool type options have an almost identical interface, the difference is that they can not have an approach speed.
- Enum type options are almost identical to bool type. They take and return an enum value.
- For brevity, the functions are only given a description if the option requires careful handling or does not follow the float or bool interfaces.
-
- If the optional first argument is passed, sets the CMod to the value and disables any XMod or MMod that is set.
- If the optional second argument is passed, sets the speed at which the transition occurs. -
- Returns nil otherwise.
- If the optional first argument is passed, sets tilt to value and skew to zero.
- If the optional second argument is passed, sets the approach_speed for skew and tilt to it. -
true if the current PlayerOptions makes the current Course/Trail easier.
- true if the current PlayerOptions makes the current Song/Steps easier.
- - Returns nil otherwise.
- If the optional first argument is passed, sets tilt to negative value and skew to zero.
- Pass in a positive value for the familiar meaning of Hallway.
- If the optional second argument is passed, sets the approach_speed for skew and tilt to it. -
- Returns nil otherwise.
- If the optional first argument is passed, sets tilt to negative value and skew to value.
- Pass in a positive value for the familiar meaning of Incoming.
- If the optional second argument is passed, sets the approach_speed for skew and tilt to it. -
- Use CMod, XMod, or MMod to set the speed mod unless you have a good reason not to.
- It is the setting for the MMod.
- MMods are not tweenable or settable on ScreenGameplay. Use XMods if you need such an effect. -
- If the optional first argument is passed, sets the MMod to the value and disables any CMod or XMod that is set.
- If the optional second argument is passed, sets the speed at which the transition occurs.
- MMods are not tweenable or settable on ScreenGameplay. Use XMods if you need such an effect. -
- Changing the noteskin during a song is not supported.
- Example:
- note_name= options:NoteSkin() -- Sets note_name to the player's current noteskin.
- prev_note_name, succeeded= options:NoteSkin("cel") -- Sets prev_note_name to the noteskin the player had set, changes the current noteskin to "cel", sets succeeded to true if the "cel" noteskin exists.
-
- If true is passed, sets the tilt and skew to 0. -
- Use CMod, XMod, or MMod to set the speed mod unless you have a good reason not to.
- It is the setting for the CMod. -
- Use CMod, XMod, or MMod to set the speed mod unless you have a good reason not to.
- It is the setting for the XMod. -
- Skew moves the vanishing point for the note field away from the center of the screen.
- Skew has no effect in single mode if Center1Player is true.
- Skew has no effect in double mode.
-
- Returns nil otherwise.
- If the optional first argument is passed, sets tilt to value and skew to value.
- If the optional second argument is passed, sets the approach_speed for skew and tilt to it. -
- Use CMod, XMod, or MMod to set the speed mod unless you have a good reason not to.
- It controls whether the speed mod is in X mode or C mode. It should only be set to 0 or 1, and is only a float value to allow tweening between the two states. -
- Tilt tilts the note field forward and back. -
true if the player is using reverse. (equivalent to GetReverse() == 1.0)
- - If the optional first argument is passed, sets the XMod to the value and disables any CMod or MMod that is set.
- If the optional second argument is passed, sets the speed at which the transition occurs. -
true if a full combo (TNS_W3 and up) was obtained.
- true if a full combo (tns and up) was obtained.
- true if the player failed.
- tns.
- true if the player was disqualified from ranking.
- GetPlayerOptions before sm-ssc v1.2.3)
- sPlayerOptions for the specified ModsLevel.
- sPreference.
- sPreference exists.
- sPreference to value.
- sPreference to the default value.
- Course c, Trail t)
- Course c, Trail t)- If the profile does not have a HighScoreList for the Song and Steps, returns nil. Use this to avoid increasing the memory footprint of the profile when checking the score lists for every song and steps. -
s has been played with the profile.
- st.
- g on.
- g on.
- true if the player has passed any steps in the specified Song s.
- true if the specified code sUnlockEntryID is unlocked.
- iCals calories.
- iSecs seconds.
- gt.
- weightPounds.
- pn.
- pn.
- ProfileSlot.
- true if player pn's profile is persistent.
- true if Song s has never been played before (according to the machine profile).
- true if the profile from the memory card is new.
- true if pn's Profile was loaded from a memory card.
- true if the last load of player pn's profile was a LastGood copy of the profile.
- true if the last load of player pn's profile resulted in a tampered or corrupt profile.
- pn.
- rc from .
- - A RageBezier2D is two RageQuadratics, one for the x coordinate and one for the y.
- This class is provided as a tool for designers working with bezier tweens who need a tool that displays the tween curve visually.
- If you use Actor:tween(time, "TweenType_Bezier", {xa, ya, xb, yb, xc, yc, xd, yd}) to tween an actor, the actor creates a RageBezier2D internally and calls evaluate_y_from_x each frame to set where it is in the tween. -
true if the current position within the file is the end. (EOF = End of File)
- sPath (relative to the StepMania root directory).-
iAccessType can be set to read (1), write (2), stream (4) or flush to disk on close (8).- These can also be combined with addition. For example, to set up read and write, set
iAccessType to 3 (1+2).
- length bytes from the RageFile's current position.
- str.
- true if a file exists at sPath.
- sPath. The last two arguments are optional (and default to false).
- sPath.
- - a, b, c, d= quadratic:get_bezier() -
sProperty to fVal. The supported properties depend on how the associated was loaded.
- sProperty to fVal. The supported properties depend on how the associated was loaded.
- fPitch. The associated have SupportsRateChanging = true on load.
- fSpeed. The associated must have SupportsRateChanging = true on load.
- fVolume, which is between 0..1.
- {left, top, right, bottom}.
- bLoop.
- fPos.
- fRate.
- sGroupName.
- f.
- - This should not be used to provide text input because that would not handle localization or different keyboard layouts.
- The screen and the callbacks will both be passed input events, so be aware of what input the current screen responds to and consider the effects.
- Details of the table containing the event data:
- {
- DeviceInput= { -- The raw details of the event.
- device= string, -- The type of device. The first half of the string will be "Device_", the second half will be from InputDeviceNames in RageInputDevice.cpp.
- button= string, -- The button that was pressed. the first half of the string will be "DeviceButton_", the second half will be from InitNames in RageInputDevice.cpp.
- level= float, -- A floating point value for analog input.
- z= float, -- Mousewheel input.
- down= bool, -- Whether the button is down. This is level with a threshold and debouncing applied.
- ago= float, -- How long ago this input occurred, in seconds.
- is_joystick= bool, -- True if the device is a joystick.
- is_mouse= bool -- True if the device is a mouse.
- }, -- This ends the list of things inside the DeviceInput part of the table.
- controller= string, -- The game controller this event was mapped to. "GameController_1" or "GameController_2", or nil if the event wasn't mapped to either controller.
- button= string, -- The semi-raw button that was pressed. This is what the button was mapped to by the keymap settings, but without the conversions that occur when OnlyDedicatedMenuButtons is true. Will be empty if the button was not mapped.
- type= string, -- The type of event. "InputEventType_FirstPress", "InputEventType_Repeat", or "InputEventType_Release".
- GameButton= string, -- The cooked button that was pressed. This is button with mapping that occurs when OnlyDedicatedMenuButtons is true applied. This is nil for unmapped buttons.
- PlayerNumber= PlayerNumber, -- The player that the controller is mapped to, or nil.
- MultiPlayer= string, -- Unknown purpose.
- } -
f seconds.
- sScreenMsg to the Screen after fDelay seconds.
- true if a single has its NoteField centered.
- pn.
- pn.
- - This takes into account the current music rate and the current haste effect.
- If you are displaying the BPM on ScreenGameplay, this is what you should use to have correct behavior when Haste and/or a music rate mod are in effect. -
- Read Docs/Themerdocs/haste.txt. -
- Read Docs/Themerdocs/haste.txt. -
- Read Docs/Themerdocs/haste.txt. -
- Read Docs/Themerdocs/haste.txt. -
true if the game is paused.
- bPause.
- sMessage is an optional ScreenMessage posted once the new screen is finished.)
- true if screen class s exists.
- true if screen s is prepared.
- s.
- - This can be useful when putting a custom menu on a screen, and you want to disable the built in actors while the menu is open. Then you handle input through an input callback until the player closes the menu. -
true if Player pn backspaced successfully.
- true if Player pn was able to add sKey to their name.
- pn and returns true
- if successful.
- true if anyone is entering their name.
- true if anyone is still entering their name.- (As opposed to those who are Finalized; see ) -
true if Player pn is entering their name.
- true if Player pn is finished entering their name.
- pn.
- true if all active players are on the last options row.
- true if the specified player is on an items that ends the screen.
- pn is on. (Was previously GetCurrentRow.)
- true if we are going to PlayerOptions.
- true if there is a profile that can be loaded.
- true if there is a profile that can be saved.
- pn's current selected item as an integer.
- true if the player is going to the options screen.
- pn
- true
- if successful.
- pn to iProfileIndex.
- Please see docs/Themerdocs/ScreenTextEntry.txt for the TextEntrySettings format. -
true if the screen is currently transitioning.
- sScreenMsg. To go to the next screen, use "SM_GoToNextScreen" as the argument.
- - Each element of the table is one change like this:
- {start_beat= 1.0, rate= 1.0, transition= "example", effect= "example", file1= "example", file2= "example", color1= "#FFFFFFFF", color2= "#FFFFFFFF"} -
- GetMainTitle (this function) does not check that pref. Instead, it directly returns the title, exactly as it is in the #TITLE field in the simfile. -
nil otherwise.)
- st.
- true if the song has steps for the specified difficulty in st.
- true if the song has attacks.
- true if the song has a background.
- true if the song has a banner.
- true if the song has BGChanges.
- true if the song has a CD image.
- true if the song has a CDTitle.
- true if the song has a Disc graphic.
- true if the song has edits.
- true if the song has a jacket graphic.
- true if the song has lyrics.
- true if the song has music.
- true if the song has a preview video.
- true if the song has significant BPM changes or stops.
- true if the song has the specified StepsType.
- true if the song's DisplayBPM is constant.
- true if the song's DisplayBPM is random.
- true if the song's DisplayBPM is secret.
- true if the song is considered easy.
- true if the song is enabled.
- true if the song meets the criteria for a "Long Version".
- true if the song meets the criteria for "Marathon" length.
- true if the song and the specified steps have different timing.
- true if the song only has Beginner steps.
- true if the song is normally displayed.
- true if the song is shown in Demonstration and Ranking.
- true if the specified course group exists.
- true if the specified song group exists.
- sCourse is found.
- sSong is found.
- c.
- s. (If bExtra2 is true, it will use the second Extra Stage data instead of the first. Again, Lua.xsd sucks)
- s.
- st.
- sGroupName.
- s.
- sGroupName.
- {theme}/Other/SongManager sListName.txt.
- {theme}/Other/SongManager sListName.txt.
- true if the specified course was loaded from AdditionalCourses.
- true if the specified song was loaded from AdditionalSongs.
- true if a Delay is active.
- true if a Freeze is active.
- Frames table consisting of iNumFrames frames lasting for a total of fSeconds seconds. This function is not a member function and should be used as Frames = Sprite.LinearFrames( 5, 2.6 ).
- sPath is nil, then unload the texture. Otherwise, load the texture at path sPath.
- sPath.
- sPath.
- song's background.
- song's banner.
- mode.
- fSeconds.
- - Example:
- {{Frame= 0, Delay= .016, {0, 0}, {.25, .25}},
- {Frame= 1, Delay= .016, {0, 0}, {.25, .25}},
- {Frame= 2, Delay= .016, {0, 0}, {.25, .25}},
- {Frame= 3, Delay= .016, {0, 0}, {.25, .25}},
- }
- Frame is optional, defaulting to 0.
- Delay is optional, defaulting to 0.
- The two tables are optional upper left and lower right corners of the fraction of the frame to use. The example makes the sprite only use the upper left corner of each frame.
- Simpler example:
- {{Frame= 0, Delay= .016}, {Frame= 1, Delay= .016}, {Frame= 2, Delay= .016}, {Frame= 3, Delay= .016}}
- This example makes the sprite use the whole of each frame. -
texture.
- RageTexture:loop( bLoop ) on the texture.
- RageTexture:position( fPos ) on the texture.
- RageTexture:rate( fRate ) on the texture.
- fWidth and height fHeight clipping if the dimensions do not match.
- iNewState.
- use is true, then the sprite will use the effect clock for texcoordvelocity.
- fWidthxfHeight.
- fRate. Useful for Sprites that need to change by BPM (e.g. Tran from DDR 5th Mix, the cube from DS EuroMix 2).
- true if everyone failed.
- mp.
- pn.
- true if at least one person passed.
- true if player pn has a high score.
- pn's final grade.
- iAgo rounds ago.
- true if the Steps has any attacks.
- true if the Steps pattern has significant timing changes.
- pn. Use to grab a specific value.
- true if the Steps are an edit.
- true if the Steps are a player edit (loaded from a profile).
- true if the steps were automatically generated.
- true if the DisplayBPM is constant.
- true if the DisplayBPM is random.
- true if the DisplayBPM is secret.
- true if the Steps use different TimingData from the Song.
- sMetricsGroup.
- pn.
- pSteps.
- iMeter, and Difficulty.
- pTrail.
- true if this style locks the difficulty for both players.
- true if the specified language exists in the current theme.
- true if the specified theme exists.
- Element in Class from metrics.ini.
- Class from metrics.ini.
- ClassName Element in the BGAnimations folder.
- Element in Class for the currently loaded language.
- Class for the currently loaded language.
- true if the theme has the specified metric.
- true if the theme has the specified string.
- true if the specified theme is selectable.
- - After the theme changes, the screen specified by the Common::AfterThemeChangeScreen metric will be loaded.
- The Common::InitialScreen metric will be used if Common::AfterThemeChangeScreen is blank or invalid. -
- If false (or nothing) is the argument to these functions, they return tables of strings. The strings are numbers separated by '='.
- If the argument is true, they return tables of tables, and the inner tables contain numbers as described for each function.
- The first form is kept around and is the default for compatibility with older themes. The advantage of the second form is that you no longer need to have a bit of code in your theme to transform the string into a table of numbers before you can use it.
- Example:
- local bpmsand= timing_data:GetBPMsAndTimes()
- for i, s in ipairs(bpmsand) do
- local sand= split("=", s)
- bpmsand[i]= {tonumber(sand[1]), tonumber(sand[2])}
- end
- -- do something that looks at all the bpms and times.
- Becomes:
- local bpmsand= timing_data:GetBPMsAndTimes(true)
- -- do something that looks at all the bpms and times.
-
fElapsedTime.
- fBeat.
- fBeat.
- true if the TimingData contains BPM changes.
- true if the TimingData contains delays.
- true if the TimingData contains any BPM changes with a negative BPM.
- true if the TimingData contains stops.
- true if the TimingData contains warps.
- true if the TimingData contains fake segments.
- true if the TimingData contains speed scrolling changes.
- true if the TimingData contains general scrolling changes.
- true if song s is in the Trail.
- iEntry.
- true if any of the Trail entries are secret.
- m_sEntryID.
- sCourseName.- Example:
course,"Driven"
- true if the UnlockEntry requires you to pass Hard steps.
- true if the UnlockEntry requires you to pass Challenge steps.
- true if the UnlockEntry is locked.
- sModifier.
- m_fRequirement.
- sSongName. sSongName also requires the group.- Example:
song,"In The Groove/Pandemonium"
- - Example:
steps,"In The Groove/Pandemonium","expert"
- true if there are any unlocks to celebrate.
- sEntryID.
- sEntryID.
- iIndex.
- sUnlockEntryID
- iIndex.
- true if the wheel is locked.
- true if the wheel is settled/stopped moving.
- n.
- sSection.
- - A specific case where this is known to happen is commands that trigger on CurrentSongChanged because the music wheel clears the current song before it finishes loading if the current song is longer than the number of stages remaining. -
iSongIndex.
- color with the specified alpha.
+ + Note: When you see the error "approach: speed 1 is negative." it means that the speed value passed was negative. The 1 is there because approach and multiapproach use the same internal function and can be ignored when using approach. +
v is false (or nil). Returns all arguments otherwise. sAssertMessage is an optional error message (the default is "assertion failed!").
+ fBoost.
+ true if Center 1P is being used.
+ true if checkpoint judgments and tap judgments
+ are considered separate, or false otherwise.
+ fValue between fLow and fHigh.
+ opt.
+ color can be in hex ("#FFFFFFFF") or 0..1 values ("1.0,1.0,1.0,1.0"), in RGBA order.
+ c[1]/2, c[2]/2, c[3]/2, c[4])
+ c[1]+(c[1]/2), c[2]+(c[2]/2), c[3]+(c[3]/2), c[4])
+ c[1]/1.5, c[2]/1.5, c[3]/1.5, c[4])
+ UserPrefComboUnderField user preference value.
+ +
number can be a string, an integer, or a float.+
comma is an optional argument that is used instead of a comma.+ "commify(1234, 'cat')" will result in "1cat234".
+
dot is an optional argument that is used instead of a dot to find the end of the part that should be commified.+ "commify('1234cat5678', ',', 'cat')" will result in "1,234cat5678", but "commify('1234cat5678')" will result in "12,34c,at5,678".
+ The
comma and dot arguments are provided to ease compliance with locales or languages that do not use comma and dot in numbers the way English does.
+ sAddress.
+ dir for xml files of actors and
+ converts them to equivalent lua files. See Docs/Themerdocs/XmlToLua.txt
+ for details.
+ + Strings that do not have an entry in the master language are considered unused.
+ master_lang_name is the name of the ini file that contains the language with all strings used by the theme.
+ Example: find_missing_strings_in_theme_translations("my_best_theme", "en.ini") +
list.
+ tab with the given value.
+ func takes a key and a value.
+ fPercentDancePoints formatted as a percentage.
+ name from the Env table.
+ + If you are loading the sound into an ActorSound, ActorSound:get to get its RageSound then use RageSound's get_length function instead to avoid loading the file twice. +
true if player pn is using ProTiming.
+ true if you need to step on hold heads to activate them.
+ pump mode, TimingWindowSecondsHold preference value in any other game mode.
+ 0-360, saturation and value are 0..1
+ 0-360, saturation, value, and alpha are 0..1
+ true if the coin mode is not set to CoinMode_Home.
+ true if Event Mode is turned on.
+ true if Arcade and the coin mode is CoinMode_Free.
+ true if the current game is sGame.
+ true if the coin mode is set to CoinMode_Home.
+ true if connected to the Internet.
+ true if connected to StepMania Online.
+ true if Player pn is logged on to a SMOnline server.
+ true if W1 is allowed (and tns == 'TapNoteScore_W2')
+ true if Routine mode is being played.
+ true if the aspect ratio is 16:10 (1.6) or higher.
+ delimiter, returning a string of the results.
+ sPath. If sPath points to a Lua file, any additional arguments will be passed to that script.
+ sString.
+ 0-11).
+ m as a localized string.
+ m as a string.
+ currents in place, as well as returning currents.+
currents, goals, and speeds must all be the same size and contain only numbers.+
multiplier is optional. The speeds in the speeds table will be multiplied by multiplier. This makes it more convenient to use multiapproach in a per-frame update: pass in the frame delta and the speeds will be scaled to the time that passed.+ Note: When you see the error "approach: speed 1 is negative." it means that a speed value passed was negative. The 1 tells you which entry in the table was invalid. +
next returns the next index of the table and its associated value."
+ See the Lua manual for more details.
+ t, and nil,
+ so that the construction for k,v in pairs(t) do body end
+ will iterate over all key–value pairs of table t."
+ p1val or p2val depending on pn.
+ numerator and denominator.
+ v1 is equal to v2, without invoking any metamethod."
+ t[index], without invoking any metamethod."
+ t[index] to value, without invoking any metamethod."
+ The modified t is then returned.
+ optional is true, then a nil path is returned instead of emitting an error if no file is found.
+ path and returns its contents.
+ +
indent is an optional argument that will be prepended to every line.
+ +
indent is an optional argument that will be prepended to every line.
+ + Returns success and full path of the resulting screenshot. +
x, originally within low1 and high1, to fall between low2 and high2.
+ fSecs to Minutes:Seconds:Milliseconds format using two digits for each section.
+ fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Minutes (uses 1).
+ fSecs to Minutes:Seconds format.
+ fSecs to Minutes:Seconds.Milliseconds format.
+ fSecs to Minutes:Seconds.Milliseconds format using two digits for each section.
+ fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Milliseconds (uses 3).
+ index is a number, returns all arguments after argument
+ number index. Otherwise, index must be the string
+ "#", and [it] returns the total number of extra arguments it received."
+ t.
+ name to value in the Env table.
+ true if a decoration should be shown on the current screen or not.
+ delimiter, returning a table of the results.
+ t.
+ num.
+ e to a number. Returns nil if
+ it can't convert the input to a number. (base is optional.)
+ e to a string.
+ P1.
+ return list[i], list[i+1], ···, list[j]"
+ (i and j are optional; "by default, i is 1 and j is the length of the list.")
+ + This way, a theme can implement a custom interactive screen for adjusting those preferences. +
ar43 (4:3; 640px) and ar169 (16:9; 854px).
+ buf to the file at path.
+ prefName to its config file with value being tostring'd.
+ sPath.
+ true if sClassName is a registered Class.
+ optional is true, then a nil path is returned instead of emitting an error if no file is found.
+ iCol at beat fNoteBeat for the provided PlayerState. Y Offset is affected by Speed mods and Accel mods, and impacts most other arrow effects.
+ iCol with a Y offset of fYOffset for the provided PlayerState.+
fYReverseOffsetPixels is the separation between targets with and without reverse. This argument is optional and will pull defaults from the metrics for [Player]
+ iCol with a Y position of fYPos for the provided PlayerState.+
fYReverseOffsetPixels is the separation between targets with and without reverse. This argument is optional and will pull defaults from the metrics for [Player]
+ iCol with a Y offset of fYOffset for the provided PlayerState.
+ iCol with a Y offset of fYOffset for the provided PlayerState.
+ fYOffset for the provided PlayerState.
+ fYOffset for the provided PlayerState.
+ fNoteBeat for the provided PlayerState.+
bIsHoldHead is an optional argument which defaults to false. If true, this function will return 0 if the [ArrowEffects] metric DizzyHoldHeads is false.
+ iCol with a Y offset of fYOffset for the provided PlayerState.+
fPercentFadeToFail is optional and defaults to -1.+
fYReverseOffsetPixels is the separation between targets with and without reverse. This argument is optional and will pull defaults from the metrics for [Player]+
fDrawDistanceBeforeTargetsPixels is optional and will pull defaults from the [Player] metric DrawDistanceBeforeTargetsPixels+
fFadeInPercentOfDrawFar is optional and will pull defaults from the [NoteField] metric FadeBeforeTargetsPercent+
iCol with a Y offset of fYOffset for the provided PlayerState. The arguments are the same as for GetAlpha.
+ fNoteBeat for the provided PlayerState.
+ fYOffset for the provided PlayerState.fOverlappedTime is optional and will default to 0.
+ [1] would be the
+ string 'PlayerNumber_P1'.+ The functions defined in the
Enum namespace are valid member
+ functions of every Enum where the first argument is
+ omitted and the name of the Enum is used in place
+ of Enum. Instead of
+ Enum.GetName(
+ ) or
+ Enum.Reverse(
+ ), one can use
+ :GetName() or
+ :Reverse(), respectively.
+ x and y need to be elements of the enumerated
+ type e. Returns a value less than/greater than/equal to
+ 0 corresponding to the numerical value of x being
+ less than/greater than/equal to the numerical value of y as
+ determined by
+ Enum.Reverse( e ).
+ e. For example,
+ Enum.GetName( )
+ will return the string 'PlayerNumber'.
+ e. For
+ example: local r =
+ Enum.Reverse( );
+ local n = r['PlayerNumber_P2'];+ The value of
n in this case would be 1 corresponding
+ to the 0-based indexing using in C++ and not 2 as might be
+ expected for the 1-based indexing used in Lua.
+ true if the type of v is sType.
+ sPath. If successful, it returns the file's contents.
+ If unsuccessful, it returns two values: nil and "error".
+ + error is optional an defaults to "Script error occurred.". error_type is optional and defaults to "LUA_ERROR". +
func(...) with two LuaThreadVariables set, and returns the return values of func().
+ sString to log.txt. Aliased by
+ .
+ sString to info.txt and log.txt as
+ a warning. Aliased by .
+ 0..1. With a single argument (n), the number is in the range of 1..n. With two arguments (lower, upper), the number is in the range of l..u.
+ seed.
+ pn.
+ st) are playable.
+ st) are playable.
+ + The ActorFrame that is returned is the wrapper state, for convenience.
+ An Actor can have any number of wrapper states. Use GetWrapperState to access wrapper states for the actor. +
nil if it doesn't have one.
+ nil if it doesn't have one.
+ b.
+ fRate * fRate), where fRate is in seconds.
+ rot to the Actor's current x rotation.
+ rot to the Actor's current y rotation.
+ rot to the Actor's current z rotation.
+ xPos to the Actor's current x position.
+ yPos to the Actor's current y position.
+ zPos to the Actor's current z position.
+ h and v are in the range 0..1.
+ true, cull the Actor's back faces. See also: .
+ fAlpha, where fAlpha is in the range 0..1.
+ rot.
+ rot.
+ rot.
+ zoom.
+ zoom.
+ zoom.
+ zoom.
+ x,SCREEN_CENTER_X;y,SCREEN_CENTER_Y)
+ x,SCREEN_CENTER_X)
+ y,SCREEN_CENTER_Y)
+ tweens
+ can either be a string like "linear,0.25,accelerate,0.75" or
+ a table with tween information { {Type="linear", Percent=0.25, Bezier=nil}, {Type="accelerate", Percent=0.75, Bezier=nil} }
+ percent of the Actor from the bottom, where percent is in the range 0..1.
+ percent of the Actor from the left, where percent is in the range 0..1.
+ percent of the Actor from the right, where percent is in the range 0..1.
+ percent of the Actor from the top, where percent is in the range 0..1.
+ mode.
+ fRate) * (1-fRate)), where fRate is in seconds.
+ c.
+ fAlpha, where fAlpha is in the range 0..1.
+ c.
+ c, ignoring any alpha value in c.
+ c.
+ c.
+ c.
+ c.
+ c.
+ c.
+ c.
+ iOrder, where larger values display first.
+ s.
+ c.
+ c.
+ fTime. The offset is added to the time into the effect before calculating percent_through_effect.
+ fTime.
+ + hold_at_zero is before hold_at_full in the argument list for compatibility. A future version will probably swap them because it makes more sense to have hold_at_full come before hold_at_zero.
+ All effect timings must be greater than or equal to zero, at least one of them must be greater than zero.
+ The effect timing controls how long it takes an effect to cycle and how long it spends in each phase.
+ Depending on the effect clock, the actor's time into effect is updated every frame. That time is then translated into a percent_through_effect using the parameters to this function.
+
+ ramp_to_half is the amount of time for percent_through_effect to reach 0.5.
+ hold_at_half is the amount of time percent_through_effect will stay at 0.5.
+ ramp_to_full is the amount of time percent_through_effect will take to go from 0.5 to 1.0.
+ hold_at_full is the amount of time percent_through_effect will stay at 1.0.
+ After reaching the end of hold_at_full, percent_through_effect stays at 0 until hold_at_zero is over.
+
+ The different effects use percent_through_effect in different ways. Some use it to calculate percent_between_colors with this sine wave: sin((percent_through_effect + 0.25f) * 2 * PI ) / 2 + 0.5f
+ Some effects check the internal bool blink_on. blink_on is true if percent_through_effect is greater than 0.5 and false if percent_through_effect is less than or equal to 0.5.
+ Check the effect functions for individual explanations: diffuseblink, diffuseshift, glowblink, glowshift, glowramp, rainbow, wag, bounce, bob, pulse, spin, vibrate. +
percent of the Actor from the bottom where percent is in the range 0..1.
+ percent of the Actor from the left where percent is in the range 0..1.
+ percent of the Actor from the right where percent is in the range 0..1.
+ percent of the Actor from the top where percent is in the range 0..1.
+ true if the Actor has a command named sCmdName.
+ fAlign which should be a float in the range 0..1. An alignment of 0 is left aligned while an alignment of 1 is right aligned. See for the common case.
+ fHeading.
+ b is true, but don't unhide if b is false."
+ align. See for fractional alignment.
+ factor.
+ fRate is in seconds.
+ side ("Back" or "Front").
+ sName.
+ fPitch.
+ sCommandName. params is passed to the command as an argument if it is a table.
+ p being a human player.
+ sCommandName to be played.
+ !sMessageName (Note the ! at the beginning. The source code says this: "Hack: use "!" as a marker to broadcast a command, instead of playing a command, so we don't have to add yet another element to every tween state for this rarely-used command.")
+ fRoll.
+ fAlign.
+ fAlign.
+ fAlign.
+ iNewState.
+ c.
+ fLength.
+ fLength.
+ fLength.
+ fAmount.
+ fAmount.
+ fSeconds before executing the next command.
+ + It's usually more convenient to use Actor:linear, Actor:accelerate, and so on, rather than using Actor:tween directly. +
fAlign which should be a float in the range 0..1. An alignment of 0 is top aligned while an alignment of 1 is bottom aligned. See for the common case.
+ align. See for fractional alignment.
+ xPos.
+ yPos.
+ zPos.
+ fBias.
+ bUse.
+ zoom scale.
+ zoomX and zoomY.
+ zoom height. See also: .
+ zoom width. See also: .
+ zoom scale on the X axis.
+ zoom scale on the Y axis.
+ zoom scale on the Z axis.
+ true, turns it off if false
+ testMode.
+ true or false based on bWrite.
+ stretchto,0,0,SCREEN_WIDTH,SCREEN_HEIGHT)
+ sName.+ If there are multiple children with that name, returns an array of those children.
+ The table also acts as a pass through layer, function calls pass through to the last child of that name. +
+ The table is indexed by the names of the children.
+ If there are multiple children with the same name, the entry for that name is an array of those children.
+ The table also acts as a pass through layer, function calls pass through to the last child of that name. +
sCommandName command on the ActorFrame's children.
+ sCommandName command on the ActorFrame's leaves.
+ cmds on the ActorFrame's children.
+ cmds on the ActorFrame's leaves.
+ c.
+ c.
+ c.
+ fRate.
+ sName.
+ + {{left, top, right, bottom}, delay}
+ left, top, right, and bottom are pixel coordinates, starting at 0. If delay is 0 or negative, the state will last forever. +
+ This works best when using DrawMode_Quads.
+ AMV's can have animated textures like sprites. Each state tells the AMV what part of the texture to use, and how long the state lasts.
+ Use AddState to add a state onto the end, or SetStateProperties to set all the states at once, or SetState to set a single state.
+ Each quad has its own offset that is added to the current state. Use AddQuadState to add to the list of quad states, or SetQuadState to set an existing quad state. +
index with the properties provided. The tables of properties are each optional and can be provided in any order.
+ vertices should themselves be tables, of the form provided to SetVertex. If vertices is the first argument it will start from vertex 1. If an integer is provided before vertices it will start from that vertex. It will add vertices as necessary.
+ Example: self:SetVertices( { { { x1, y1, z1 } , { r1,g1,b1,a1 } , { tcx1,tcy1 } }; { { x2, y2, z2 } , { r2,g2,b2,a2 } , { tcx2,tcy2 } } } )
+ + ("all the drawn verts" means all the verts between FirstToDraw and NumToDraw, the verts that are set to draw in the current tween state.)
+ The parts of the ActorMultiVertex are evenly spaced along the spline in terms of t value.
+ The exact behavior depends on the draw mode.
+ DrawMode_Quads uses all 4 splines, one for each corner.
+ DrawMode_QuadStrip and DrawMode_Strip use 2 splines, one for each edge of the strip.
+ DrawMode_Fan uses one spline, for the edge verts of the fan. The first vert is not touched because it is the center.
+ DrawMode_Triangles uses 3 splines, one for each corner.
+ DrawMode_SymmetricQuadStrip uses 3 splines, one on each edge and one in the center.
+ DrawMode_LineStrip uses 1 spline.
+
+ ActorMultiVertex splines are not inside the tween state, and will not change the verts until you call SetVertsFromSplines. +
+ Mode must be a DrawMode.
+ First is the index of the first vertex to draw.
+ Num is the number of vertices to draw. -1 for Num means draw all verts after First.
+ Any value not in the table defaults to the already set value.
+ Examples:
+ -- Sets all three parts of the draw state.
+ self:SetDrawState{Mode="DrawMode_Quads", First= 1, Num= -1}
+ -- Set only the draw mode. First and Num remain unchanged from previous.
+ self:SetDrawState{Mode="DrawMode_Quads"}
+ -- Set the first and number to draw. Draw mode remains unchanged.
+ self:SetDrawState{First= 3, Num= 4}
+
texture
+ path.
+ a.
+ fWidth by fHeight pixels.
+ fNumItems items.
+ fSecs.
+ fSeconds.
+ + A value of
0 means the scroller will not scroll.
+ fItemHeight.
+ fItemWidth.
+ + *
SupportPan - Let the sound pan from side to side.+ *
SupportRateChanging - Let the sound change rate and pitch.+ *
IsAction - If true, the sound is an action sound, and will be muted if the MuteActions preference is turned on.
+ sPath.
+ bPause.
+ SupportPan = true on load.
+ sAnnouncer exists.
+ sNewAnnouncer.
+ true if the application presently has focus.
+ true if the Banner is currently scrolling.
+ sPath (typically or ).
+ attr to the string at position
+ iPos.+ The attribute is a table that must contain
Length
+ which specifies how many (multi-byte) characters the attribute
+ is to apply. If Length=-1, then the attribute applies
+ until another attribute overrides it.+ If the table contains
Diffuse, then the color value
+ is applied to the range of text.+ If the table contains
Diffuses, then it should be
+ an array of 4 colors which specify the diffuse color for the
+ top left, top right, bottom left, and bottom right.+ If the table contains
Glow, then the color value
+ is applied as a glow to the range of text.+ Example:
+
attr = { Length = 10; Diffuse = color("#AABBCC"); }
+ bJitter is true, move each character of the string around by a small random amount.
+ fHeight. If fHeight is 0, then there is no maximum height.
+ fWidth. If fWidth is 0, then there is no maximum width.
+ false.
+ true, set each character of the text in turn to the rainbow colors in the metrics BitmapText::RainbowColor#.
+ sText. This clears all attributes.
+ string.format(sFormat, ...).
+ c.
+ true, make all text uppercase.
+ iSpacing pixels of padding between lines of text.
+ iWidth pixels. If you or by x and you want the text wrapped at width, then you should use wrapwidthpixels(width/x).
+ sID.
+ sMetricsGroup.
+ true if all of the songs in the course have been defined (as opposed to random songs).
+ iIndex from the Course.
+ true if the Course has a background.
+ true if the Course has a banner.
+ true if the Course has modifiers.
+ true if the Course has timed modifiers.
+ true if the Course is an edit.
+ true if the Course was automatically generated.
+ true if the Course is Endless.
+ true if the Course is Nonstop.
+ true if the Course is Oni.
+ true if the Course is playable in StepsType st.
+ true if the Course is a ranking course.
+ true if this CourseEntry is a fixed song.
+ true if this CourseEntry is secret.
+ sPath.
+ s.
+ sPath.
+ s.
+ + This spline implementation is a cubic spline.
+ A spline is a line calculated from a small set of points with mathematical smooting applied.
+ Splines can have any number of dimensions, but splines owned by actors (the ones inside NCSplineHandler and ActorMultiVertex) always have 3 dimensions.
+
+ t can range from 0 to the value returned by get_max_t().
+ A normal spline will return its starting point for any t value less than 0 and its end point for any t value greater than the max.
+ A looped spline adjust the t value to be within the its range by adding or subtracting the max t as needed. (so if the max t is 4 and you evaluate at 5, it will return the same as if you evaluated at 1.) +
+ Second and third derivative functions exist because they're possible, not because they're expected to be useful. The fourth derivative would be 0 because the equation for evaluating the spline is "a + (b*t) + (c*t^2) + (d*t^3)". +
+ Each table must contain a value for each dimension of the spline.
+ Solving the spline normally should cover all normal usage, this is for people that want a spline with an abnormal behavior, so if you set the coefficients directly, expect to end up with an unsmooth shape. +
+ The spatial extent exists to handle numbers that exist in a finite looped space, instead of the flat infinite space.
+ To put it more concretely, spatial extent exists to allow a spline to control rotation with wrapping behavior at 0.0 and 2pi, instead of suddenly jerking from 2pi to 0.0. +
+ Splines that are owned by actors (the ones inside ActorMultiVertex and NCSplineHandler) cannot have their number of dimensions changed because the actors require them to have 3 dimensions. +
pn,
+ then sets the DifficultyIcon's state from the difficulty of Steps pSteps
+ pn,
+ then sets the DifficultyIcon's state from the difficulty of Trail pTrail
+ pn.
+ true if notes are counted separately in this game.
+ tns.
+ nil if there isn't one).
+ game.
+ true if any noteskins exist for the specified Game s.
+ st.
+ game.
+ Game. The second argument is optional, and if provided will determine which theme is loaded when the game changes. If the second argument is not provided, the default theme from the preferences for the new game type will be loaded.+ If only the game changes, the screen specified by the Common::AfterGameChangeScreen metric will be loaded.
+ If the game and the theme both change, the screen specified by the Common::AfterGameAndThemeChangeScreen metric will be loaded.
+ The Common::InitialScreen metric will be used if the appropriate metric for the change is blank or invalid. +
fVolume for fDuration seconds.
+ pn.
+ musicPath starting from musicStart for
+ musicLength seconds one time. Both fadeIn and
+ fadeOut can be customized as required. loop
+ tells the sound manager to loop the music part. applyRate
+ tells the sound manager to apply the current music rate. If alignBeat
+ is true or nil, the length is automatically adjusted to cover an integer number of beats.
+ sPath one time. is_action is optional, if it is true, the sound is an action sound, and will be muted if the MuteActions preference is turned on.
+ true if any player has performed a feat worthy of ranking.
+ sCommand
+ for pn, if given. See .
+ + Might not work in all cases, but will catch things like a player not having + steps set or no current song or style. Mainly exists for people with a custom ScreenSelectMusic replacement.
+ Example:
+ local can, reason= GAMESTATE:CanSafelyEnterGameplay()
+ if not can then
+ lua.ReportScriptError("Cannot safely enter gameplay: " .. tostring(reason))
+ end
+
true if pn's options will disqualify them for ranking.
+ true if enough credits have been inserted to join.
+ For example,
+
local credits = {GAMESTATE:GetCurrentStepsCredits()};+ will make a table of the difficulties and descriptions. +
nil if it does not exist.
+ nil
+ if it does not exist.
+ true if the gameplay lead in is enabled. If
+ false, gameplay begins immediately.
+ true if the game is Multiplayer.
+ pn.
+ pn.
+ pn.
+ true if a delay is active in the song.
+ true if the song is currently in a freeze.
+ fBeat.
+ pn.
+ true if the workout goal is complete.
+ true if an extra stage was earned.
+ true if either player does not have a profile loaded, and there is a loadable profile.
+ true if either player has a profile loaded.
+ true if we are specifically in the Step Editor's
+ editing portion. If in recording or playing mode, this will return
+ false.
+ iCoins number of coins. iCoins can be negative or positive.
+ true if this is an extra stage.
+ true if any human player is using a memory card.
+ true if playing in Battle mode.
+ true if playing in a Course mode.
+ true if in Demonstration mode.
+ true if the match was a draw.
+ true if Event Mode is on, temporary or otherwise.
+ true if this is the first extra stage.
+ true if this is the second extra stage.
+ true if player pn has completed the current Goal.
+ true if player pn is human.
+ true if player pn is enabled.
+ true if player pn has joined the game.
+ true if player pn is the winner.
+ pn. Does not deduct coins.
+ LoadEdits is true, or by default if the argument is omitted.
+ true if player pn is using modifier sModifier.
+ true if players can join the game.
+ course.
+ pm.
+ song.
+ pn's current Steps to steps.
+ trail.
+ iFields
+ pn to Difficulty dc.
+ song.
+ sGroup.
+ so using ModsLevel m.
+ bOn.
+ bOn.
+ pn.
+ sMetricsGroup.
+ g.
+ sMetricsGroup.
+ pn to empty.
+ pn from RadarValues rv
+ pn to the specified (floating point) values in the table.
+ fSeconds.
+ tips (and optionally altTips).
+ sTips using colons to separate new sections.
+ hns.
+ tns.
+ true if this high score's name uses a fill-in marker.
+ true if failing.
+ true if the LifeMeter is "hot".
+ true if in danger.
+ iNumLives. (Negative values subtract lives.)
+ true if player pn's card is locked.
+ pn.
+ true if player pn's name is available.
+ fSeconds.
+ bSilent.
+ bStealth. If
+ true, the timer will be invisible and silent.
+ sMessage. The
+ second argument is an optional table of parameters. It may be omitted or explicitly
+ set to nil.
+ fWidth.
+ sAniName at fPlayRate speed (default 1.0).
+ fRate.
+ sAnimation at fPlayRate speed (default 1.0).
+ pn from the Metrics in group sMetricsGroup.
+ true if the order was changed.
+ true if the MusicWheel is currently handling Roulette selection.
+ false on failure.
+ false on failure.
+ sNoteSkin.
+ sNoteSkin.
+ sNoteSkin.
+ sNoteSkin.
+ sNoteSkin.
+ sButton sElement.
+ sButton sElement using NoteSkin sNoteSkin.
+ sButton sElement.
+ sButton sElement using NoteSkin sNoteSkin.
+ true if the strName noteskin exists in the current gametype.
+ + The spline handler holds info on how the spline is used by the engine.
+ Each get/set pair of functions in this class is for a different aspect of the spline's behavior. +
+ "NoteColumnSplineMode_Disabled" means the spline will not affect the notes or receptors at all.
+ "NoteColumnSplineMode_Offset" means the spline will added to the effects from the mods.
+ "NoteColumnSplineMode_Position" means only the spline affect the notes and mods will be ignored. (but only mods that affect the same aspect of the note as the spline will be disabled. So a rotation spline won't disable Mini or Tiny, but a zoom spline will, and a zoom spline won't disable Dizzy, Twirl, or Roll, but a rotation spline will.) +
+ Position, rotation, and zoom each have separate spline handlers to allow them to have separate independent behavior.
+ It is important to note that the spline handlers are inside the tween state, so whenever you start a new tween on the actor, you need to refetch the spline handlers.
+
+ The rotation applied by the rotation spline is in radians.
+ For convenience, the spatial extent of the rotation spline defaults to 2pi. +
+
+ The callback for did_hold_note will not be called. +
+ The callback for did_tap_note will not be called. +
+ The callback function is passed the column, the TapNoteScore, and whether the explosion will be bright.
+ The callback function can return changed values for the NoteField to use instead of the ones that were passed.
+ Pass nil instead of a function to clear the callback. +
+ The callback for set_pressed will not be called. +
+ The callback function is passed the column for the press.
+ The callback function can return changed values for the NoteField to use instead of the ones that were passed.
+ Pass nil instead of a function to clear the callback. +
+ The callback function is passed the column and the TapNoteScore for the step.
+ The callback function can return changed values for the NoteField to use instead of the ones that were passed.
+ Pass nil instead of a function to clear the callback. +
true if the first item in the row goes down.
+ pn is on.
+ true if this row is focused by player pn.
+ true if this row forces one choice on all players.
+ pn.
+ index in the current steps queue.
+ + This allows you to chain them like this:
+ player_options:Twirl(5, 1, true):Roll(5, true):Dizzy(true):Twirl()
+
+ Special note: Functions that take a bool as their arg must have true as the second arg to be used with chaining.
+ "player_options:Backwards(true, true):Beat(5)" will chain, "player_options:Backwards(true):Beat(5)" will not chain.
+
+ Most options fall into one of four types: float, int, bool, or enum.
+ Float type options have this interface:
+ Option(value, approach_speed)
+ If value is a float, sets the TimeSpacing modifier to value.
+ If approach_speed is a float, sets the speed of the transition to approach_speed. Returns the previous values of both.
+ approach_speed is in units of n per second. value will be approached at the rate of approach_speed per second.
+ Note that the value and the approach speed arguments are both independently optional.
+ Example:
+ a,b= options:Boost() -- Sets a to the current value and b to the current approach_speed.
+ a,b= options:Boost(5, .5) -- Stores the previous values in a and b, NOT to 5 and .5. Sets the value to 5 and the approach speed to .5.
+ a,b= options:Boost(5) -- Sets a and b to the previous values, NOT to 5 and .5. Sets the value to 5 and leaves the approach speed at whatever it was.
+
+ Setting the approach speed only matters when modifying the PlayerOptions from ModsLevel_Song.
+ Int type options are similar to float in that they return and take a number, but they do not have an approach speed.
+ Bool type options have an almost identical interface, the difference is that they can not have an approach speed.
+ Enum type options are almost identical to bool type. They take and return an enum value.
+ For brevity, the functions are only given a description if the option requires careful handling or does not follow the float or bool interfaces.
+
+ If the optional first argument is passed, sets the CMod to the value and disables any XMod or MMod that is set.
+ If the optional second argument is passed, sets the speed at which the transition occurs. +
+ Returns nil otherwise.
+ If the optional first argument is passed, sets tilt to value and skew to zero.
+ If the optional second argument is passed, sets the approach_speed for skew and tilt to it. +
true if the current PlayerOptions makes the current Course/Trail easier.
+ true if the current PlayerOptions makes the current Song/Steps easier.
+ + Returns nil otherwise.
+ If the optional first argument is passed, sets tilt to negative value and skew to zero.
+ Pass in a positive value for the familiar meaning of Hallway.
+ If the optional second argument is passed, sets the approach_speed for skew and tilt to it. +
+ Returns nil otherwise.
+ If the optional first argument is passed, sets tilt to negative value and skew to value.
+ Pass in a positive value for the familiar meaning of Incoming.
+ If the optional second argument is passed, sets the approach_speed for skew and tilt to it. +
+ Use CMod, XMod, or MMod to set the speed mod unless you have a good reason not to.
+ It is the setting for the MMod.
+ MMods are not tweenable or settable on ScreenGameplay. Use XMods if you need such an effect. +
+ If the optional first argument is passed, sets the MMod to the value and disables any CMod or XMod that is set.
+ If the optional second argument is passed, sets the speed at which the transition occurs.
+ MMods are not tweenable or settable on ScreenGameplay. Use XMods if you need such an effect. +
+ Changing the noteskin during a song is not supported.
+ Example:
+ note_name= options:NoteSkin() -- Sets note_name to the player's current noteskin.
+ prev_note_name, succeeded= options:NoteSkin("cel") -- Sets prev_note_name to the noteskin the player had set, changes the current noteskin to "cel", sets succeeded to true if the "cel" noteskin exists.
+
+ If true is passed, sets the tilt and skew to 0. +
+ Use CMod, XMod, or MMod to set the speed mod unless you have a good reason not to.
+ It is the setting for the CMod. +
+ Use CMod, XMod, or MMod to set the speed mod unless you have a good reason not to.
+ It is the setting for the XMod. +
+ Skew moves the vanishing point for the note field away from the center of the screen.
+ Skew has no effect in single mode if Center1Player is true.
+ Skew has no effect in double mode.
+
+ Returns nil otherwise.
+ If the optional first argument is passed, sets tilt to value and skew to value.
+ If the optional second argument is passed, sets the approach_speed for skew and tilt to it. +
+ Use CMod, XMod, or MMod to set the speed mod unless you have a good reason not to.
+ It controls whether the speed mod is in X mode or C mode. It should only be set to 0 or 1, and is only a float value to allow tweening between the two states. +
+ Tilt tilts the note field forward and back. +
true if the player is using reverse. (equivalent to GetReverse() == 1.0)
+ + If the optional first argument is passed, sets the XMod to the value and disables any CMod or MMod that is set.
+ If the optional second argument is passed, sets the speed at which the transition occurs. +
true if a full combo (TNS_W3 and up) was obtained.
+ true if a full combo (tns and up) was obtained.
+ true if the player failed.
+ tns.
+ true if the player was disqualified from ranking.
+ GetPlayerOptions before sm-ssc v1.2.3)
+ sPlayerOptions for the specified ModsLevel.
+ sPreference.
+ sPreference exists.
+ sPreference to value.
+ sPreference to the default value.
+ Course c, Trail t)
+ Course c, Trail t)+ If the profile does not have a HighScoreList for the Song and Steps, returns nil. Use this to avoid increasing the memory footprint of the profile when checking the score lists for every song and steps. +
s has been played with the profile.
+ st.
+ g on.
+ g on.
+ true if the player has passed any steps in the specified Song s.
+ true if the specified code sUnlockEntryID is unlocked.
+ iCals calories.
+ iSecs seconds.
+ gt.
+ weightPounds.
+ pn.
+ pn.
+ ProfileSlot.
+ true if player pn's profile is persistent.
+ true if Song s has never been played before (according to the machine profile).
+ true if the profile from the memory card is new.
+ true if pn's Profile was loaded from a memory card.
+ true if the last load of player pn's profile was a LastGood copy of the profile.
+ true if the last load of player pn's profile resulted in a tampered or corrupt profile.
+ pn.
+ rc from .
+ + A RageBezier2D is two RageQuadratics, one for the x coordinate and one for the y.
+ This class is provided as a tool for designers working with bezier tweens who need a tool that displays the tween curve visually.
+ If you use Actor:tween(time, "TweenType_Bezier", {xa, ya, xb, yb, xc, yc, xd, yd}) to tween an actor, the actor creates a RageBezier2D internally and calls evaluate_y_from_x each frame to set where it is in the tween. +
true if the current position within the file is the end. (EOF = End of File)
+ sPath (relative to the StepMania root directory).+
iAccessType can be set to read (1), write (2), stream (4) or flush to disk on close (8).+ These can also be combined with addition. For example, to set up read and write, set
iAccessType to 3 (1+2).
+ length bytes from the RageFile's current position.
+ str.
+ true if a file exists at sPath.
+ sPath. The last two arguments are optional (and default to false).
+ sPath.
+ + a, b, c, d= quadratic:get_bezier() +
sProperty to fVal. The supported properties depend on how the associated was loaded.
+ sProperty to fVal. The supported properties depend on how the associated was loaded.
+ fPitch. The associated have SupportsRateChanging = true on load.
+ fSpeed. The associated must have SupportsRateChanging = true on load.
+ fVolume, which is between 0..1.
+ {left, top, right, bottom}.
+ bLoop.
+ fPos.
+ fRate.
+ sGroupName.
+ f.
+ + This should not be used to provide text input because that would not handle localization or different keyboard layouts.
+ The screen and the callbacks will both be passed input events, so be aware of what input the current screen responds to and consider the effects.
+ Details of the table containing the event data:
+ {
+ DeviceInput= { -- The raw details of the event.
+ device= string, -- The type of device. The first half of the string will be "Device_", the second half will be from InputDeviceNames in RageInputDevice.cpp.
+ button= string, -- The button that was pressed. the first half of the string will be "DeviceButton_", the second half will be from InitNames in RageInputDevice.cpp.
+ level= float, -- A floating point value for analog input.
+ z= float, -- Mousewheel input.
+ down= bool, -- Whether the button is down. This is level with a threshold and debouncing applied.
+ ago= float, -- How long ago this input occurred, in seconds.
+ is_joystick= bool, -- True if the device is a joystick.
+ is_mouse= bool -- True if the device is a mouse.
+ }, -- This ends the list of things inside the DeviceInput part of the table.
+ controller= string, -- The game controller this event was mapped to. "GameController_1" or "GameController_2", or nil if the event wasn't mapped to either controller.
+ button= string, -- The semi-raw button that was pressed. This is what the button was mapped to by the keymap settings, but without the conversions that occur when OnlyDedicatedMenuButtons is true. Will be empty if the button was not mapped.
+ type= string, -- The type of event. "InputEventType_FirstPress", "InputEventType_Repeat", or "InputEventType_Release".
+ GameButton= string, -- The cooked button that was pressed. This is button with mapping that occurs when OnlyDedicatedMenuButtons is true applied. This is nil for unmapped buttons.
+ PlayerNumber= PlayerNumber, -- The player that the controller is mapped to, or nil.
+ MultiPlayer= string, -- Unknown purpose.
+ } +
f seconds.
+ sScreenMsg to the Screen after fDelay seconds.
+ true if a single has its NoteField centered.
+ pn.
+ pn.
+ + This takes into account the current music rate and the current haste effect.
+ If you are displaying the BPM on ScreenGameplay, this is what you should use to have correct behavior when Haste and/or a music rate mod are in effect. +
+ Read Docs/Themerdocs/haste.txt. +
+ Read Docs/Themerdocs/haste.txt. +
+ Read Docs/Themerdocs/haste.txt. +
+ Read Docs/Themerdocs/haste.txt. +
true if the game is paused.
+ bPause.
+ sMessage is an optional ScreenMessage posted once the new screen is finished.)
+ true if screen class s exists.
+ true if screen s is prepared.
+ s.
+ + This can be useful when putting a custom menu on a screen, and you want to disable the built in actors while the menu is open. Then you handle input through an input callback until the player closes the menu. +
true if Player pn backspaced successfully.
+ true if Player pn was able to add sKey to their name.
+ pn and returns true
+ if successful.
+ true if anyone is entering their name.
+ true if anyone is still entering their name.+ (As opposed to those who are Finalized; see ) +
true if Player pn is entering their name.
+ true if Player pn is finished entering their name.
+ pn.
+ true if all active players are on the last options row.
+ true if the specified player is on an items that ends the screen.
+ pn is on. (Was previously GetCurrentRow.)
+ true if we are going to PlayerOptions.
+ true if there is a profile that can be loaded.
+ true if there is a profile that can be saved.
+ pn's current selected item as an integer.
+ true if the player is going to the options screen.
+ pn
+ true
+ if successful.
+ pn to iProfileIndex.
+ Please see docs/Themerdocs/ScreenTextEntry.txt for the TextEntrySettings format. +
true if the screen is currently transitioning.
+ sScreenMsg. To go to the next screen, use "SM_GoToNextScreen" as the argument.
+ + Each element of the table is one change like this:
+ {start_beat= 1.0, rate= 1.0, transition= "example", effect= "example", file1= "example", file2= "example", color1= "#FFFFFFFF", color2= "#FFFFFFFF"} +
+ GetMainTitle (this function) does not check that pref. Instead, it directly returns the title, exactly as it is in the #TITLE field in the simfile. +
nil otherwise.)
+ st.
+ true if the song has steps for the specified difficulty in st.
+ true if the song has attacks.
+ true if the song has a background.
+ true if the song has a banner.
+ true if the song has BGChanges.
+ true if the song has a CD image.
+ true if the song has a CDTitle.
+ true if the song has a Disc graphic.
+ true if the song has edits.
+ true if the song has a jacket graphic.
+ true if the song has lyrics.
+ true if the song has music.
+ true if the song has a preview video.
+ true if the song has significant BPM changes or stops.
+ true if the song has the specified StepsType.
+ true if the song's DisplayBPM is constant.
+ true if the song's DisplayBPM is random.
+ true if the song's DisplayBPM is secret.
+ true if the song is considered easy.
+ true if the song is enabled.
+ true if the song meets the criteria for a "Long Version".
+ true if the song meets the criteria for "Marathon" length.
+ true if the song and the specified steps have different timing.
+ true if the song only has Beginner steps.
+ true if the song is normally displayed.
+ true if the song is shown in Demonstration and Ranking.
+ true if the specified course group exists.
+ true if the specified song group exists.
+ sCourse is found.
+ sSong is found.
+ c.
+ s. (If bExtra2 is true, it will use the second Extra Stage data instead of the first. Again, Lua.xsd sucks)
+ s.
+ st.
+ sGroupName.
+ s.
+ sGroupName.
+ {theme}/Other/SongManager sListName.txt.
+ {theme}/Other/SongManager sListName.txt.
+ true if the specified course was loaded from AdditionalCourses.
+ true if the specified song was loaded from AdditionalSongs.
+ true if a Delay is active.
+ true if a Freeze is active.
+ Frames table consisting of iNumFrames frames lasting for a total of fSeconds seconds. This function is not a member function and should be used as Frames = Sprite.LinearFrames( 5, 2.6 ).
+ sPath is nil, then unload the texture. Otherwise, load the texture at path sPath.
+ sPath.
+ sPath.
+ song's background.
+ song's banner.
+ mode.
+ fSeconds.
+ + Example:
+ {{Frame= 0, Delay= .016, {0, 0}, {.25, .25}},
+ {Frame= 1, Delay= .016, {0, 0}, {.25, .25}},
+ {Frame= 2, Delay= .016, {0, 0}, {.25, .25}},
+ {Frame= 3, Delay= .016, {0, 0}, {.25, .25}},
+ }
+ Frame is optional, defaulting to 0.
+ Delay is optional, defaulting to 0.
+ The two tables are optional upper left and lower right corners of the fraction of the frame to use. The example makes the sprite only use the upper left corner of each frame.
+ Simpler example:
+ {{Frame= 0, Delay= .016}, {Frame= 1, Delay= .016}, {Frame= 2, Delay= .016}, {Frame= 3, Delay= .016}}
+ This example makes the sprite use the whole of each frame. +
texture.
+ RageTexture:loop( bLoop ) on the texture.
+ RageTexture:position( fPos ) on the texture.
+ RageTexture:rate( fRate ) on the texture.
+ fWidth and height fHeight clipping if the dimensions do not match.
+ iNewState.
+ use is true, then the sprite will use the effect clock for texcoordvelocity.
+ fWidthxfHeight.
+ fRate. Useful for Sprites that need to change by BPM (e.g. Tran from DDR 5th Mix, the cube from DS EuroMix 2).
+ true if everyone failed.
+ mp.
+ pn.
+ true if at least one person passed.
+ true if player pn has a high score.
+ pn's final grade.
+ iAgo rounds ago.
+ true if the Steps has any attacks.
+ true if the Steps pattern has significant timing changes.
+ pn. Use to grab a specific value.
+ true if the Steps are an edit.
+ true if the Steps are a player edit (loaded from a profile).
+ true if the steps were automatically generated.
+ true if the DisplayBPM is constant.
+ true if the DisplayBPM is random.
+ true if the DisplayBPM is secret.
+ true if the Steps use different TimingData from the Song.
+ sMetricsGroup.
+ pn.
+ pSteps.
+ iMeter, and Difficulty.
+ pTrail.
+ true if this style locks the difficulty for both players.
+ true if the specified language exists in the current theme.
+ true if the specified theme exists.
+ Element in Class from metrics.ini.
+ Class from metrics.ini.
+ ClassName Element in the BGAnimations folder.
+ Element in Class for the currently loaded language.
+ Class for the currently loaded language.
+ true if the theme has the specified metric.
+ true if the theme has the specified string.
+ true if the specified theme is selectable.
+ + After the theme changes, the screen specified by the Common::AfterThemeChangeScreen metric will be loaded.
+ The Common::InitialScreen metric will be used if Common::AfterThemeChangeScreen is blank or invalid. +
+ If false (or nothing) is the argument to these functions, they return tables of strings. The strings are numbers separated by '='.
+ If the argument is true, they return tables of tables, and the inner tables contain numbers as described for each function.
+ The first form is kept around and is the default for compatibility with older themes. The advantage of the second form is that you no longer need to have a bit of code in your theme to transform the string into a table of numbers before you can use it.
+ Example:
+ local bpmsand= timing_data:GetBPMsAndTimes()
+ for i, s in ipairs(bpmsand) do
+ local sand= split("=", s)
+ bpmsand[i]= {tonumber(sand[1]), tonumber(sand[2])}
+ end
+ -- do something that looks at all the bpms and times.
+ Becomes:
+ local bpmsand= timing_data:GetBPMsAndTimes(true)
+ -- do something that looks at all the bpms and times.
+
fElapsedTime.
+ fBeat.
+ fBeat.
+ true if the TimingData contains BPM changes.
+ true if the TimingData contains delays.
+ true if the TimingData contains any BPM changes with a negative BPM.
+ true if the TimingData contains stops.
+ true if the TimingData contains warps.
+ true if the TimingData contains fake segments.
+ true if the TimingData contains speed scrolling changes.
+ true if the TimingData contains general scrolling changes.
+ true if song s is in the Trail.
+ iEntry.
+ true if any of the Trail entries are secret.
+ m_sEntryID.
+ sCourseName.+ Example:
course,"Driven"
+ true if the UnlockEntry requires you to pass Hard steps.
+ true if the UnlockEntry requires you to pass Challenge steps.
+ true if the UnlockEntry is locked.
+ sModifier.
+ m_fRequirement.
+ sSongName. sSongName also requires the group.+ Example:
song,"In The Groove/Pandemonium"
+ + Example:
steps,"In The Groove/Pandemonium","expert"
+ true if there are any unlocks to celebrate.
+ sEntryID.
+ sEntryID.
+ iIndex.
+ sUnlockEntryID
+ iIndex.
+ true if the wheel is locked.
+ true if the wheel is settled/stopped moving.
+ n.
+ sSection.
+ + A specific case where this is known to happen is commands that trigger on CurrentSongChanged because the music wheel clears the current song before it finishes loading if the current song is longer than the number of stages remaining. +
iSongIndex.
+ DANCE WITH INTENSITY v2.50.00
-© SimWolf, 2003
-
-
- DISCLAIMER AND TERMS OF USE -
- WHAT'S NEW? -
- USING AND CONFIGURING DWI
-
-
- Basic Operation -
- Song Sorting -
- Selecting Song Modifiers -
- Special keys -
- Controller Configuration -
- Gameplay Settings -
- Sound Configuration -
- Changing the Display from Windowed to Full-screen -
- Sound effects -
- Command-line options -
- Testing a song -
- Setting Skins -
- Setting Announcer and Sound Effects -
- Folder- and Genre- Specific Banners -
- AVI Movie Support -
- Sonique Visualizations (SVP) Support -
- User Profiles -
- DWI FILE FORMAT
-
-
- Steps -
- Hold Arrows -
- Tags -
- Background Animations, Movies, and Visualizations -
- NONSTOP MODE AND CRS FILE FORMAT -
- LRC (LYRICS) FILE FORMAT -
- LIMITATIONS -
- VERSION HISTORY -
- FUTURE DEVELOPMENT AND THANKS -
1. DISCLAIMER AND TERMS OF USE
- -This program is provided for free, as-is. Although it has been tested on multiple systems for compatability and reliability, you run this program at your own risk. I cannot be held responsible if the program causes file loss or other problems.
- -THIS PROGRAM IS *NOT* FOR SALE!!! IT SHOULD NEVER BE BUNDLED WITH ANY OTHER FILES (MUSIC OR STEP FILES) ON ANY MEDIA, INCLUDING (BUT NOT LIMITED TO) CD's, DVD's, DISKS OR OTHER MEDIA.
- -DWI is Donation-Ware. Although you are not required to donate, it would be greatly appreciated if you enjoy the program that you contribute something towards the developers.
- -This program simulates a popular arcade and home video game. It was written to allow myself the ability to play songs from the games without having to switch CDs in my Playstation or Dreamcast, and also affords the ability to add new songs not currently available. It also allows for playing older songs with new play modes, such as downward-scrolling arrows. This program is being released to the public in the hopes that others would find it useful in the same manner.
- -As such, this program REQUIRES responsibility on the part of the end-user (ie. YOU) to use the program LEGALLY. You should *ONLY* play songs where you:
| a) | Own the game from which that music comes from. |
| or b) | Own the soundtrack CD from which the music comes from. |
| or c) | Legally own rights to the music being used (ie. other CDs, etc.) |
I own all the available soundtracks and videogames for the music I own, and respectfully ask that you support the games and purchase them. Thank you.
- - - --v2.50.00 - August 14, 2003. - - NEW: Addition of WAVE, BRAKE, and 0.25x modifiers. - - BUGFIX: Stage numbers and various other numbers are coloured again. - - BUGFIX: Bonus stages now default to Heavy/Maniac again. - - OTHER: Various other bugs I can't remember that have been fixed. - -- - - - -
BASIC OPERATION
- -When you first run DWI, you will receive a warning screen about responsible use of the program. This warning screen will appear *EVERY* time the program detects new songs.
- -DWI uses step-files with the extension ".DWI". These files go in their own folder along with their associated background and banner images. Optionally the music file can go in the same folder also.
- -DWI supports multiple collections of songs, so you can organise your songs as you see fit. To do this, just create different sub-directories in the "Songs" folder.
- -eg. For a song with a step-file of "abc.dwi", put into a collection called "My Songs", your directory structure should look like this:
- <INSTALL directory> - + Songs - + My Songs - + abc - + abc-banner.png (any name, the program will detect that it's a banner) - + abc-bg.png (any name, the program will detect that it's a background) - + abc.dwi (any name) - + (abc.mp3/wav) (optional - otherwise FILE: tag is used). - + (abc.lrc) (optional - should have same base as DWI file). -- - -
So, in each "song folder", there should be two image files (background and banner), the DWI file, and optionally the music file in MP3 or WAV format.
- -Song Sorting
- -When you are at the song select screen, simply press up or down to change the current collection you are in. Songs are organized alphabetically within each collection, and collections are organized alphabetically also.
- -Another option is to sort your music by genre. To activate this, go to "Options Menu", then "System Menu", and change the sort method to "GENRE" *. This requires your DWI files to have a tag defining the genre to put the music into (see DWI format, below). Multiple genres can be given (separated by a comma), to make the same song appear in different collections. At the song select screen, press up or down to change the genre.
- -You can also press Up-Left to change the sort method. This cycles through:
-
-
- Folder/Genre (default) -
- Folder/Genre, Separated -
- All Music (by title) -
- All Music (by artist) -
- BPM. -
- Player's Best (top 64) -
Selecting Song Modifiers
- -At the song-select screen, press the "Select" button/key, and use the arrows to change options. When done, press "Select" again. Alternatively, you can hold down "Start" when selecting a song and you will be taken to a -screen where you can set your options.
- -| Speed: | 1.5x, 2.0x, 3.0x, 4.0x, 5.0x, 8.0x, 0.5x, 0.75x, 0.25x |
| Boost: | BOOST, BRAKE, WAVE |
| Appear: | HIDDEN, SUDDEN, STEALTH |
| Turn: | LEFT, MIRROR, RIGHT, SHUFFLE |
| Other: | LITTLE, FLAT, SOLO |
| Dark: | DARK (can't see arrow indicators) |
| Scroll: | REVERSE |
| Freeze: | NOFREEZE |
| Power: | POWER-DROP (gauge starts full and depletes), DEATH (must full-combo song) |
For courses and bonus stages, use the same text as above in the course definition file when setting modifiers.
-eg. #SONG:Default\MySong:BASIC:1.5x,HIDDEN,LEFT,FLAT;
Special keys
- -The function keys will be used to adjust or enable various gameplay functions. Primarily these are designed for people creating DWI files and want to adjust timing.
- -| F1/F2 | - Restarts the song (developer mode only) |
| F3/F4 | - Adjust playback speed of song down/up (during song select/gameplay) |
| F5/F6 | - Adjust BPM value down/up by 0.50 BPM. (during gameplay) |
| F7/F8 | - Adjust BPM value down/up by 0.02 BPM. (during gameplay) |
| F9/F10 | - Adjust GAP value down/up by 5ms. (during gameplay) |
| F12 | - Toggle "Assist Click" on/off. (during song select/gameplay) |
Controller Configuration
- -To change the inputs, simply go to the Options Menu from the main screen and goto "Keyboard Configuration" or "Gamepad Configuration". Choose to configure either Player 1 or Player 2's inputs and you will be prompted to press each key, joystick button or dancepad square in turn. You cannot choose an input that is currently in use. To skip joystick buttons, press the "TAB" key.
- -When done, select "Return" to make the change take effect.
- -Gameplay Settings
- -Gameplay settings such as difficulty level, danger display, and end-of-game settings are selected from the Gameplay Configuration menu from the Options screen. These changes take effect immediately.
- -Extra Stages
- -If you AA a Heavy or Challenge mode song on the last stage and have Extra Stages enabled in the Game Options, you can play another song. The song(s) you can choose from are either generated randomly (3 for Extra Stage #1, one for Extra Stage #2), or can be defined in a CRS file.
- -| bonus-1.crs | Songs for Extra Stage #1 |
| bonus-2.crs | Songs for Extra Stage #2 |
NB: These CRS files go in the same directory as DWI2.exe, not the Courses folder.
- -Sound Configuration
- -The default sound settings for DWI are 44Khz, Stereo, 16-bit samples. However, you may want to lower these -settings on slower computers.
- -* NB: You must exit DWI and start it again for this change to take effect. - -Changing the Display from Windowed to Full-screen
-Go to the "System Menu" from the Options screen and change the display type.
- -* NB: You must exit DWI and start it again for this change to take effect. - -Sound effects
- -Sound effects are all in the "Sounds" directory. You can add or remove files to most directories, and the program will use the existing files during gameplay. However, files in the root of the sound-set directory and those in the "attract" and "combo" directories must be the same name in order for the program to find them and play them appropriately.
- - - -You can run DWI with various command line options to configure some values. (Please read the FAQ for details -on how to start the program with command line options). These options are available:
- -| /sdl | Starts DWI in the software-only graphics mode. |
| /16bpp | Runs DWI in 16-bit colour mode (SDL), or uses a 16-bit primary surface (DirectX) |
| /32bpp | Runs DWI in 32-bit colour modes/32-bit primary surface. |
| /fullscreen | Runs DWI in fullscreen mode (may need to use to start on some cards) |
| /window | Runs DWI in a window. Some cards won't support this so DWI will try fullscreen. |
| /log | Creates a 'dance.log' file that can be useful for debugging. |
| /anysize | In DirectX mode, this tries to make textures in any size, rather than creating textures to the nearest power-of-two value (ie. a 75x60 image is loaded into a texture that big instead of a 128x64 one). This can speed up performance on some cards and save memory, if your card can handle it. |
| /sw | In SDL mode, surfaces are created in regular memory (default) |
| /hw | In SDL mode, surfaces are created in hardware memory (can improve performance if your card can handle it). |
| /priority:x | can force DWI to run as a more "important" program under Windows. "1" starts it as "ABOVE NORMAL", "2" is "TIME CRITICAL". May improve performance in certain cases. (Use with caution if you're running many other processes at the same time). |
| /sdevice:x | tells DWI to use a given sound-device. Use "/log" and look in dance.log first for a list of available sound-devices. |
| /fps:xx | makes DWI try to stay at a given framerate (20..100). If you've got a fast machine, this can really save on computer cycles. |
| /showsm | will add songs with only SMANIAC steps to the song-select screen. |
| /skipsearch | will prevent DWI from searching the Songs folder at startup. |
| /dither:0 | will turn off the dithering effect DWI uses for semi-transparent images on old videocards that can't handle them. Some users may prefer this to remove the 'speckles' in the gameplay graphics. |
You can limit paging to virtual memory during gameplay (which can cause skips as Windows decides to write or retrieve data from disk) using these flags:
- -| /minRAM:xx | Instructs DWI to try to reserve at least this much physical memory from the Operating System. * |
| /maxRAM:xx | Instructs DWI to try to reserve at most this much physical memory from the Operating System. * * Only works in Windows NT, 2000, and XP. Default is 16-32MB. |
Use these flags to fix strange behavior in DWI...
- -| /key:nonexclusive | affect how DirectInput is initialized. Should be paired with one of /key:fg or /key:bg |
| /key:exclusive | |
| /key:fg | affect how DirectInput is intialized. |
| /key:bg | |
| /altcombo | for reasons known to the heavens and my machine in the basement, DWI would not display the 'lives' image in Nonstop Mode, instead locking up the computer. I'm convinced this is a videocard/driver issue, as the code to draw the image is exactly the same as the code to display any other image... but oh well. Using this command line argument will tell DWI to not try to display the image and instead write "X Lives" in its place, which seemed to make it work. Strange... but the option's there in case you run into the problem too. |
| /v5hack | some Voodoo card drivers seem to allocate space for textures incorrectly (off by one) - this should hopefully fix the problem. |
| /altmovie | Uses an alternate way of drawing the background movies and visualizations for older videocards that display solid-colour textures instead. |
| /noshade | Prevents the extra shading effect on the song-select wheel from being added. |
Testing a song
- -| /test:... | You can start DWI in test/developer mode by using the "/test:..." command line argument. Provide the *folder* the .dwi file is in. |
| /style:... | use this set of steps (SINGLE, DOUBLE, SOLO). Default is SINGLE. |
| /level:... | use this level of steps (BASIC, ANOTHER, MANIAC, SMANIAC). Default is BASIC. |
| /p2 | test using player 2's controls instead. |
| /speed:X | starts song at a given speed (1..5) |
| /scroll:X | starts song with given speed modifier (0.5, 0.75, 1.5, 2, 3, etc.) |
| /startat:<TIME> | jumps to a given time into the song (game-time). <TIME> can be given in minutes, seconds, or milliseconds.
-ie. /startat:1:05.5 (minutes) - /startat:65.5 (seconds) - /startat:65500 (ms) - all the same position. |
| /tick:1 | turns the assist click on at startup (default is off). |
| /dark | hides the fixed-place arrows during testing. |
Example:
- -"DWI.exe /test:.\Songs\Development\MyNewSong /style:SINGLE /level:MANIAC /p2 /speed:4 /scroll:2 /startat:1:00"
- -Starts testing the .dwi file found in \songs\development\mynewsong, in SINGLE mode, with MANIAC-level steps. Player 2's controls are used, and the song's speed is set to '4'. Arrows are displayed as though the "x2" modifier was active. The song starts at the 1-minute mark.
- -Setting Skins
- -Create different sub-directories within the "Skins" folder for each skin you wish to use. So, for example: -
- <INSTALL directory> - + Skins - + Default (leave as-is) - + Skin A - + Skin B - + ...- -
The filenames for each skin should be the same as in the default directory. If an image isn't found, the default is used. This way you can create skins that are relatively simple, or very elaborate ones. And you don't need to delete any of the original files. ;) There is a limit of 64 skins.
- -Changes will take effect when you leave the Skin Selection screen.
- -I do ask, however, that you keep the title of the program as "Dance With Intensity". Thank you. :)
- -Setting Announcer and Sound Effects
- -Similar to skins, just create new directories in the 'Sounds' folder for each sound set you wish to use. So, for example: -
- <INSTALL directory> - + Sounds - + Default (leave as-is) - + Jack - + Jill - + ...- -
The tree structure for each set should be the same as is used for the "Default" directory. For example: -
+ Jill
- + attract - files should be named attract-00.wav, attract-01.wav, attract-02.wav
- | (these are the sounds used on the title screen)
- + combo - files should be named combo-00.wav and combo-01.wav
- | ("100 Combo" and "Combo stopped")
- + danger - a set of files played when power level at danger or zero.
- + eval
- | + A
- | + B - sets of files to play at the evaluation screen based on grade
- | + ...
- + good - a set of files played when power level in the 'good' range
- + great - " " 'great' range
- + over
- | + fail - files played at game over screen (failure)
- | + pass - " " (cleared all stages)
- + select
- | + new - files played when #STATUS:NEW; is set in DWI file and song is selected
- | + song - files played when a song is selected
- + start
- + + go - files played at "Here we go!" screen.
- + + ready - files played at "Ready?" screen.
- + warning - a set of files played when the power gauge is in the 'warning' range.
-
-There should not be more than 64 sound effects in a single subdirectory. There is a limit of 64 sets. Changes will take effect once you leave the Announcer/Sound Select screen. Please keep the title sound effect (attract-00.wav) as "Dance With Intensity".
- -Folder- and Genre- Specific Banners
-You can make DWI display a special banner for each folder when it is highlighted on the Song-Select Screen. To do this, simply put a standard (horizontal) banner with the same name as the folder in the 'Songs' folder. (eg. a banner for 'Default Songs' would be ".\Songs\Default Songs.png").
- -If you have sorting by Genre on, you can have special banners for each Genre by putting banners in PNG format with the same name as the Genre referenced into ".\Genres". (eg. "Pop Music.png").
- -Folder-Specific Banners can also be made for Courses too. Just put a PNG file with the same name as the subfolder the CRS files are in, in the "Courses" directory.
- -AVI Movie Support
-AVI movies can be played in the background while you play. See the "Background Animation" section below for more details on how this is set up. From the System Menu, you can tell DWI whether to not play AVI files at all, or set the quality level from 1 (worst) to 10 (full). The default is 5. Changing this value could affect your framerate, so play with the values to determine what works best for your system.
- -Random animations are picked from the ./Movies/Random folder and played in the background of songs without a defined background script if enabled in the System Options menu. This folder can be changed by a flag in the DWI file also, enabling themes.
- -Sonique Visualizations (SVP) Support
-Sonique visualizations can be played in the background while you play. See the "Background Animation" section below for more details on how this is set up. From the System Menu, you can tell DWI whether to use them at all, or set the quality level from 1 (worst) to 10 (full). The default is 5. Changing this value could affect your framerate, so play with the values to determine what works best for your system.
- -Random visualizations are picked from the ./Vis folder and played in the background of songs without a defined background script if enabled in the System Options menu. Their behavior can often be changed by editing the 'vis.ini' file that is created after they are used in DWI, similar to in Sonique.
- - -DWI2.40 introduced 'user profiles' - a way that multiple users can play DWI on the same machine and keep their own individual records. Setting up a new profile is easy - simply create a new subdirectory in the "Profiles" directory with the name of the user (15 characters or less), and inside that folder, put a 64x64 PNG file called 'user.png' to represent you in the game. Look at the 'Profiles/Sample User' folder for an example.
- -When you use a profile, DWI will create an individual records file and profile information file in the same directory that keeps track of your individual achievements.
- -When you get a high score, it will be saved to your own profile's records ("New Personal Best"), and, if you beat the overall high score, it will also be saved to the system records ("It's a New Record!"), with your username registered with it.
- -Using a user-profile also lets you track some other statistics, such as overall high scores and combos for each mode. It will also store the last-used modifiers you used (eg. 2x speed modifier, Reverse) between sessions, so you don't have to set it again each time you start a new game.
- -This option can be disabled in the Game Options Menu if you prefer.
- -4. DWI FILE FORMAT - -Steps
- -DWI uses step-files that are similar to the ".MSD" file format. However, there are new additions and some tags are treated slightly differently, so the extension was changed to avoid confusion. DWI files with these new additions will not work properly in other simulators.
- -Step-patterns are defined in the same way as .MSD files - use the numeric keypad as a reference for most patterns: -
- 7=U+L 8=U 9=U+R - - 4=L 6=R - - 1=D+L 2=D 3=D+R - - (U+D = A and L+R = B) -- -
A '0' indicates no step. Each character defaults to one 1/8 of a beat. Surround a series of characters with the following brackets to change the rate at which the steps come: -
- (...) = 1/16 steps
- [...] = 1/24 steps
- {...} = 1/64 steps
- `...' = 1/192 steps
-
-6-panel (Solo) mode uses additional characters: -
- -\---- = C - ----/- = D - - L\---- = E - -\D--- = F - -\-U-- = G - -\---R = H - - L---/- = I - --D-/- = J - ---U/- = K - ----/R = L - - -\--/- = M- -
To do more than 2 panels at a time, you can join codes together with the "<..>" object, and they will all count as the same beat. So, to do a jump that involves Left, Right, Up-Left, and Up-Right, you could do: -
- -\--/- = M - L----R = B - ====== - L\--/R = <MB> (or <LE>, <IH>, <46M>, etc.)- -
MSD files from other simulators will work with DWI, with a change in the 'GAP' value being the only change usually necessary. DWI calculates the 'GAP' value differently than other simulators that use the MSD format.
- -DWI does not support the BMS file format. There is a utility available that can convert any BMS file into DWI format. Each song only requires one DWI file for all of its steps, so if you are converting BMS files please remember that all the different difficulties of step patterns will be contained in the same DWI file.
- -Hold Arrows
- -In the DWI file format a hold arrow is signified with the ! symbol. The string 8!8 will begin an 'up' hold arrow, and the arrow will be released the next time the program encounters an 'up' arrow: by itself or combined with another arrow (7, 8, 9, A, etc.) The characters 7!4 would show both 'up' and 'left' arrows but only the left arrow would be held. The format could best be described as "show!hold".
- -Tags
- -These tags should be in every DWI file:
- -| #TITLE:...; | title of the song. |
| #ARTIST:...; | artist of the song. |
| #GAP:...; | number of milliseconds that pass before the program starts counting beats. Used to sync the steps to the music. |
| #BPM:...; | BPM of the music |
Additionally, the following tags can be given:
- -| #DISPLAYTITLE:...; | -provides an alternate version of the song name that can also include special characters. | -
| #DISPLAYARTIST:...; | - provides an alternate version of the artist name that can also include special characters. - - Special Characters are denoted by giving filenames in curly-brackets. - eg. #DISPLAYTITLE:The {kanji.png} Song; - - The extra character files should be 50 pixels high and be black-and-white. The baseline for the font should be 34 pixels from the top. - |
-
| #DISPLAYBPM:...; | -tells DWI to display the BPM on the song select screen in a user-defined way. Options can be: - -* - BPM cycles randomly -a - BPM stays set at 'a' value (no cycling) -a..b - BPM cycles between 'a' and 'b' values - |
-
| #FILE:...; | - path to the music file to play (eg. /music/mysongs/abc.mp3 ) - (NB: if the file is not found, a .wav or .mp3 file in the same folder as the DWI file is used) |
-
| #MD5:...; | -an MD5 string for the music file. Helps ensure that same music file is used on all systems. | -
| #FREEZE:...; | -a value of the format "BBB=sss". Indicates that at 'beat' "BBB", the motion of the arrows should stop for "sss" milliseconds. Turn on beat-display in the System menu to help determine what values to use. Multiple freezes can be given by separating them with commas. | -
| #CHANGEBPM:...; | -a value of the format "BBB=nnn". Indicates that at 'beat' "BBB", the speed of the arrows will change to reflect a new BPM of "nnn". Multiple BPM changes can be given by separating them with commas. | -
| #STATUS:...; | -can be "NEW" or "NORMAL". Changes the display of songs on the song-select screen. | -
| #GENRE:...; | -a genre to assign to the song if "sort by Genre" is selected in the System Options. Multiple Genres can be given by separating them with commas. | -
| #CDTITLE:...; | -points to a small graphic file (64x40) that will display in the song selection screen in the bottom right of the background, showing which CD the song is from. The colour of the pixel in the upper-left will be made transparent. | -
| #SAMPLESTART:...; | -the time in the music file that the preview music should start at the song-select screen. Can be given in Milliseconds (eg. 5230), Seconds (eg. 5.23), or minutes (eg. 0:05.23). Prefix the number with a "+" to factor in the GAP value. | -
| #SAMPLELENGTH:...; | -how long to play the preview music for at the song-select screen. Can be in milliseconds, seconds, or minutes. | -
| #RANDSEED:x; | -provide a number that will influence what AVIs DWI picks and their order. Will be the same animation each time if AVI filenames and count doesn't change (default is random each time). | -
| #RANDSTART:x; | -tells DWI what beat to start the animations on. Default is 32. | -
| #RANDFOLDER:...; | -tells DWI to look in another folder when choosing AVIs, allowing 'themed' folders. | -
| #RANDLIST:...; | -a list of comma-separated filenames to use in the folder. | -
Each pattern of steps for different modes have the same basic format: -
#SINGLE:BASIC:X:...; - ^ ^ ^ ^ - | | | + step patterns. In doubles, the left pad's steps are given first, - | | | then the right pad's, separated by a colon (:). - | | | - | | + difficulty rating. Should be 1 or higher. - | | - | + Difficulty. Can be one of "BASIC", "ANOTHER", "MANIAC", or "SMANIAC" - | - + Style. Can be one of "SINGLE", "DOUBLE", "COUPLE", or "SOLO". "COUPLE" is - Battle-mode steps.- -
Comments can be used by using "//". Everything after this on the same line in the file will be ignored.
- -Background Animations, Movies, and Visualizations
- -DWI allows for background animations using a special script within the step-file. A script consists of static images, animated images, and/or an AVI movie. Using the script, you can create a variety of layered effects. A sample animation is described below: -
- #BACKGROUND: - - M:MOVIE:.\movies\sfx.avi STARTAT:-1.0 LAYER:0; - V:VIS:.\Vis\somevis.svp LAYER:0; - E:FILE:.\anim\equalizer.png ANIMATE:10,33 POSITION:-33,0 SPACING:40,40 LAYER:1; - D:FILE:.\anim\dancer-m1.png ANIMATE:24,66 SIZE:2 MULT:0,0.5,1 SPACING:30,30 LAYER:1; - X:LAYER:1 OFF; - - SCRIPT:M....................... - ................E............... - D...............X,V...............E...............D............... - X,M...............E...............D...............X,V............... - E...............D...............X,M...............E............... - D...............X,V...............E...............D............... - X,M...............E...............D...............X; - - #END;- -
The first part of the "BACKGROUND" definition defines the effects. Each effect is attributed to a letter or number ("a-z", "A-Z", "1-9"). The format for defining an effect is:
- -| The first four tags cannot be used together... | |
| FILE: | path to a file. Either a still image, or an animation (multiple frames of animation are stacked *vertically* in the image). |
| MOVIE: | path to a standard Windows AVI file. Note that the movie won't play unless you have the right codecs installed in Windows. Movies are currently stretched to fill the whole screen. |
| VIS: | path to a Sonique Visualization plug-in (SVP). Visualizations are currently stretched to fill the whole screen and are always put on Layer 0, and no other commands will affect it. |
| OFF | turns off a layer, effectively making it invisible. Will not turn off layer 0. |
| LAYER:l | the layer to use (required):
-0 - base layer. - (Image/Movie is always tiled and SPACING is ignored). - 1 - overlay layer - 2 - overlay layer - 3 - overlay layer |
| STARTAT:t | number of seconds into the AVI file to start at. If negative, the movie will wait that many seconds before playing. Can be decimal (eg. 1.3 = 1300ms). |
| MULT:r,g,b | Red, Green, and Blue pixels in the image/movie are tinted by the given amounts. This way the same image/movie can be used multiple times across DWI files and have different colours. |
| ANIMATE:f,n1,n2,...nF | indicates that the FILE contains multiple frames of animation. "f" is the number of frames of animation. Each following value is the number of milliseconds each frame of animation is displayed. If not enough time-values are given, the last given value is used. Ignored for MOVIE type. |
| MOVE:x,y | the image/movie is moved by the given number of pixels every millisecond. |
| SPACING:x,y | images are always tiled if they don't fill up the screen. This tag allows you to add some spacing between the images by the given number of pixels horizontally and vertically (Layer > 0) |
| SIZE:s | multiplies the image size by 's' in both directions. Must be a whole number. |
| KEEPPOS | normally when a new effect is turned on, its position is reset. This tag keeps the layer where it is, useful for keeping images moving smoothly. |
| KEEPTIME | (MOVIEs only) normally when a movie starts, it starts from the beginning or the time given in the "STARTAT" tag. Adding this tag will keep it playing so when that layer is enabled again, it will have kept going. |
Following the effect definition, comes the actual animation script. This is a sequence of characters in a similar way as the step-patterns are given - each character normally is 1/8 of a beat, though brackets can be used to change the time-values. In this way, background animations can be syched to the steps. It is suggested that the steps for "SINGLE:BASIC" are copied to after the "SCRIPT:" tag, and then the effects be set. In this way one knows that the script will match the same length of the music.
- -The animations take effect as that point in the song is reached. Multiple effects can occur at the same time if they are separated with a comma. A period (.) means no new effect should take place at that point. A zero (0) turns off all effects and returns the background to the original graphic.
- -More Information
- -Please check our website for more information and links to useful resources.
- -5. NONSTOP MODE AND CRS FILE FORMAT
- -DWI uses special CRS files that should be put in subfolders of the "Courses" directory. Now courses -can be shared with others if they have the same files and directory structure as you.
- -CRS files are similar to DWI files in structure. The file defines the basic details about the course, such as its name and which songs should be played. Currently these tags are supported:
- -Required tags:
- -| #COURSE:...; | the name of the course. |
| #DISPLAYCOURSE:...; | alternate name of course that can include special characters. Similar to #DISPLAYTITLE and #DISPLAYARTIST in DWI files. |
| #SONG:...; | defines a song in the course. This can either be a selection from the Player's Best (or Worst), a Random stage or a predefined stage. The syntax for each is given below: - PLAYER'S BEST/WORST STAGE: - #SONG:BESTx:[BASIC|ANOTHER|MANAIC|SMANIAC]; - #SONG:WORSTx:[BASIC|ANOTHER|MANAIC|SMANIAC]; - - choose a song with the given index 'x'. So BEST1 is the most popular - song, and WORST5 is the 5th least popular song. If the given - difficulty is not available, DWI will choose the next closest difficulty. - Songs that are equally popular will be put in random order. - - RANDOM STAGE: - #SONG:*:[a]|[a..b]; - - choose a random song, with a difficulty rating equal to or between 'a' and 'b'. - - if only 'a' is given, 'b' is assumed to be the same as 'a'. - - #SONG:*:[BASIC|ANOTHER|MANIAC|SMANAIC]; - - choose a random song with a given difficulty level. - - #SONG:folder\*:[a]|[a..b]|[BASIC|ANOTHER|MANIAC|SMANIAC]; - - choose a random song from a given folder. - - DEFINED STAGE: - #SONG:<FOLDER>\<SONG TITLE>:<DIFFICULTY>; - - will use a song from <FOLDER> with the given title. - So to play a song called "My Song", which is in - './Songs/Default/mysong/mysong.dwi', on MANIAC, - you would say: - - #SONG:Default\My Song:MANIAC;- - NB: Either the TITLE or folder the DWI file is in can be used. - -In addition, modifiers can be defined for each song by adding a list of comma-separated values to the end of the #SONG line. These modifiers are the same as listed above, plus - - xRANDOM - where 'x' is the number of random effects to apply. - 'x' can be 1 to 7. - AWARDx - where 'x' is the number of lives to award after - finishing the stage. -- So to play "My Song", Maniac, with 2.0x, Left, Hidden, and with one random effect, use: |
Optional tags:
- -| #REPEAT:...; | can be "YES" or "NO". If set, starts course over from the beginning after last song. |
| #COMBO:PERFECT; | during play, the combo counter will only go up if a "PERFECT" is made. |
| #COMBOMODE:1; | sets how much is added to the combo counter for jumps. Can be 1 or 2. |
| #LIVES:4; | sets the number of 'lives' given to each player at the start of game play. After each stage is cleared, a given number of lives is added, either by a value specified by the "AWARDx" tag in the CRS file, or using the scale below:
-Song was 6 feet or less - 1 life. - Song was 7 or 8 feet - 2 lives. - Song was 9 feet or more - 3 lives. - |
At the course selection screen, courses that have songs without steps for the current style (SINGLE, DOUBLE, etc) will be filtered out. Courses are loaded when DWI starts.
- - -DWI can display lyrics during a song if it finds a .LRC file in the same folder as the step-file. The file should have the same file-base as the .DWI file - so, for example, if your DWI file is called "mysong.dwi", the lyrics file should be called "mysong.lrc".
- -This file is a simple text-file that tells the program what text to display and when. It can also define the colour the text is displayed in.
- -Each line starts with a tag in the format [xxxxxx]. Currently, these tags are supported:
- -| [COLOUR] | Sets the colour for the following text. After the tag, a colour value is given in hex (ie. yellow would be 0xFFFF00). Up to 10 colour values can be given, separated by commas. |
| [offset:xxxx] | Makes timestamps following this tag have their times adjusted by 'xxxx' milliseconds. Use to fine-tune timings for lyrics. |
| [MM:SS.ss] | Sets a time. The text following the tag will be shown on the screen after this time has passed, replacing any text that was there before. To clear text, provide just a tag with no text after it. A line-break can be defined using the pipe "|" symbol. -A new colour can be selected from the defined colours by using "{cX}", where "X" is a number from 0 to 9. - |
Sample LRC file:
-[0:00.00]aye-aye-aye|aye-aye-aye|aye-aye-aye -[0:05.30]Where's my samurai? -[0:07.00] -[COLOUR]0xffff00 -[0:13.50]I've been searching for a man -[0:16.00]All across Japan. -...etc...- - - -
Partly due to the compiler and my own lack of knowledge in some areas, there are a number of limitations -imposed on the program that users should know about:
-
-
- No more than 2048 songs. -
- No more than 64 sound effects in a single subdirectory of 'soundfx' -
If the program runs slowly on your machine, try the following:
-
-
- Install the latest DirectX 8.1 drivers. -
- Update the video drivers for your video card. -
- Try running the game in fullscreen mode, and/or setting your screen resolution to 16-bit mode. -
- Lower the sound quality to Mono, 8-bit, and/or 11 or 22Khz. -
- Lower the quality of background movies if you use them a lot. -
- Try limiting the framerate (/fps:xx). -
v2.49.00 - May 22, 2003.
- - NEW: Addition of "Player's Best" and "Player's Worst" to CRS file format.
- - NEW: Expanded functionality of random song selection in CRS files. You can now
- choose a random song by difficulty (instead of just foot ratings), and also select a
- random song in a particular folder
- - NEW: Courses are now arranged in subfolders, allowing for different groupings of
- courses. One set could be for nonstop, others for challenge; or you can divide the
- courses up by mix or genre, etc. You can also give each folder its own banner, like
- in the song select interface.
- NOTE: You will have to move your existing courses into subfolders for them to
- be recognized!
- - NEW: #DISPLAYBPM:[xxx..xxx]|[xxx]|[*]; added, to force a certain display type on
- song select screen.
- - NEW: For users with old videocards that can't display semi-transparent images, you
- can now turn off the dithering effect that DWI uses if you like. Use the
- '/dither:0' command line argument.
- - Tweaks to how #RANDFOLDER:...; behaves, plus program now searches folder DWI file
- is in for a "Movies" sub-folder, or AVIs in the same folder first before using the
- default /Movies/Random folder.
- - Tweaks to banner display on Evaluation screen (for when song/course had no banner)
- - Tweaks to record-display for courses.
- - Tweak to beat-display in-game and in developers mode, so numbers won't 'jiggle'.
- - BUGFIX: 'tiled images' on song-select screen (BPM, stage #, difficulty) and during
- gameplay on some old videocards has been fixed. You should probably consider
- upgrading to a better card though anyway. ;^)
- - BUGFIX: Can now have up to 512 courses, instead of 64. Oops. ;)
- - BUGFIX: "combo continuing" playing on every step past 9999 combo. BTW, I hate you. ;)
- - BUGFIX: Game doesn't crash on entering course-select screen after you've added new
- CRS files.
- - OTHER: Other bugfixes and tweaks that I can't begin to remember. :P
-
-v2.41.00 - February 15, 2003.
- - CHANGE: Drawing of text made more efficient and slightly more readable, through better
- drawing of drop-shadows.
- - CHANGE: textures for SVP plug-ins to draw to now adjusted to nearest multiple of 2, as I
- suspect some assume it's supposed to be like that for efficiency reasons, and otherwise
- might cause problems overrunning memory.
- - BUGFIX: DWI2.log file now created properly again. (d'oh!!!)
- - BUGFIX: problem drawing certain images in 32bpp SDL mode fixed (eg. BPM display, star-wipe)
- - BUGFIX: extra 'N/A" box no longer appears in Solo mode "Select Profile" if started with P1.
- - BUGFIX: Better freeing of music samples after gameplay, credits, and on song-select screen.
-
-v2.40.00 - February 2, 2003.
- - NEW: Addition of "User Profiles", a system to keep user-specific records and high
- scores similar to the 'name entry' system from DWI1, but with more features. Individual
- users can tailor their own icon and (if directories are the same across systems) take
- their records with them between machines. Now tracks personal high scores and overall
- high scores, all viewable in the Records screen. (Can be disabled in Options menu if you
- prefer not to use it).
- - NEW: Arrow set for DWI completely redone to feature true colour-cycling arrows like the
- arcade. Also, arrows are drawn in last-to-first order now instead of first-to-last.
- (NB: Thanks to uKER for the help creating the new arrow set).
- - NEW: You can pause the game with the "Pause/Break" key. However, like autoplay, high
- score will not be saved.
- - CHANGE: Folder-specific banners treated differently - now DWI looks for a PNG file with
- the same name as the sub-folder, in the base "Songs" folder. Should be easier to
- manage the banners all in one folder now.
- - some freeze arrow behavior tweaked.
- - shading on song-select wheel made less dark.
- - more details on LRC file support added to this file.
- - style icon colours in default skin fixed (they were reversed).
- - if you pass a song reasonably well, you'll get that cheer as the 'Cleared' text appears.
- - BUGFIX: strange wrapping in View Records/Nonstop mode for some songs with two lines fixed.
- - BUGFIX: Song titles and artist names with special characters on Nonstop mode now display
- correctly
- - BUGFIX: Timing in Developer mode after adjusting GAP fixed. Actually tested it this time. ;)
- - BUGFIX: Realigning the word 'Test' in developer mode.
- - BUGFIX: /startat in developer mode is more accurrate.
- - BUGFIX: Bonus CRS files don't 'skip' songs that are next to each other in the songlist.
- - VARIOUS: other small tweaks I can't remember. ;)
-
-v2.30.01 - January 3, 2003.
- - AVI and SVP decoding optimized slightly to reduce load on main game function.
- - flag added to turn off shading on song select wheel, if desired.
- - BUGFIX: "Game Over" back in on failing in regular mode. Oops.
- - BUGFIX: "NEW!" status works. Expires after 2 weeks now. May require songlist reset.
- - BUGFIX: animation thread closes properly between stages.
- - BUGFIX: steps are judged better again. Oops x 2.
-
-v2.30.00 - January 1, 2003.
- - NEW: Implemented Sonique Visualization Plugins (SVP) for background animations.
- - NEW: Folder- and Genre- specific banners, plus banners for Roulette
- and Title/Artist sort options.
- - NEW: Sort by difficulty added to Song Select screen.
- - NEW: Multiple colours on same line of lyrics possible.
- - NEW: Can adjust the number of stages between breaks in Nonstop Mode.
- - NEW: Ability to disable Background Scripts.
- - NEW: Ability to set default sort method.
- - New 'default' banners and backgrounds.
- - Banner and Sample Start load time reduced.
- - Sort by BPM now much faster.
- - Paths in Background Scripts can now have spaces (use quotes around path).
- - Addition to Background Script commands to use Visualizations (on Layer 0).
- - Long song names with special characters now wrap.
- - Options Screens reorganized to group some things better.
- - Adjustments to GAP in Development mode handled properly if changed in DWI file.
- - Ability to change method for drawing movies/etc. to older method (slower, but good
- for old videocards that just give solid-colour images instead now).
- - CRS files can take either title or directory now.
- - Stage number/display now graphical, and colours can be assigned in skin CFG file.
- - "TAB" can be used in song-titles to force line-wrap.
- - Font updated to include missing '~' character.
- - Song select wheel now has some extra shading.
- - Support for semi-transparant images on older videocards improved by addition of
- pattern dithering instead of simply "off" or "on".
- - BUGFIX: Missing '0's in scores during gameplay.
- - BUGFIX: Rounding of scores to proper multiples of 10000000 on some processors.
- - BUGFIX: Early "GOOD" judgement on a freeze arrow + jump combination fixed.
- - BUGFIX: "New" tag treated properly again.
- - BUGFIX: Random AVI search assumed any file was an AVI, without checking extension.
- - BUGFIX: Skin CFG file with Hex values in uppercase read properly now.
-
-v2.20.30 - November 30, 2002.
- - General performance improvements.
- - Options left-over from main game removed in demo.
- - Command-line options added for fine-tuning memory usage (WinNT/2k/XP).
- - Time displayed in developer mode should be correct now at different speeds.
- - Can disable lyrics from the Options menu.
- - BUGFIX: Genre tag correctly parsed again.
- - BUGFIX: GeForce/Detonator drivers bug fixed.
- - BUGFIX: Corrections to Lyric file handling (timestamps, no return after last line)
-
-v2.20.10 - November 21, 2002.
- - Lyrics now displayed in Test mode
- - Lyrics now enabled for songs with positive GAP values
- - SMANIAC songs selectable in extra stages even if /showsm not used.
- - STREAM bar glows on final tally screen if you've AAA'd all songs(!)
- - backgrounds and banners with upper-case extensions now recognised correctly
- - in addition to PNG files, JPGs and BMPs can be used as backgrounds.
- - "OK" flash for Reverse-scrolling arrows added
- - Songlist.html only written if files added/updated/deleted
-
-v2.20.00 - November 20, 2002.
- - NEW: "Final Tally" screen added if number of stages not set to "Unlimited".
- - NEW: Timer added to developer mode.
- - NEW: Support for lyrics during songs added through use of "LRC" files.
- - NEW: "/skipsearch" command line argument added.
- - Ability to reset songlist completely from Options Menu.
- - BUGFIX: Groove Radar values calculated correctly again.
- - BUGFIX: "Lost life" sound playing during Arcade mode removed.
- - BUGFIX: Sample now played when combo jumps from 99..101.
- - BUGFIX: "Skipped" notes in autoplay fixed.
- - BUGFIX: Stream bar glows in Evaluation Screen if full combo and combo mode set
- to "ORIGINAL"
- - BUGFIX: Folders with no files in them handled better when searching for files.
-
-v2.10.00 - November 12, 2002.
- - NEW: Songlist rebuild is now automatic and time for incremental updates has been
- dramatically reduced, as the whole song database does not get rebuilt from
- scratch each time now. (NB: Special thanks to uKER for his code that
- implements this).
- - NEW: Extra stages implemented - extra stages can be defined in CRS files, or
- random songs are chosen automatically.
- - NEW: Extra character support in song titles, course titles, and artist names
- now possible with new tags to DWI format.
- - NEW: Various drop-shadow colours can be defined in the skin-configuration file.
- - NEW: "Flash" added for "OK" on freeze-arrows.
- - NEW: DWI now uses version 1.7 of the BASS sound library.
- - NEW: "/dark" added for Developer mode.
- - NEW: "+" modifier added to "#SAMPLESTART:" tag - the GAP value is used as a
- reference.
- - Autoplay now possible in Nonstop mode.
- - Centre positions for combo and judgement displays adjusted.
- - movie decoding performance improved slightly.
- - game starts at a default of 60FPS now. Adjust with '/fps:xx' command-line.
- - selecting difficulty on song-select screen requires discrete button presses, so
- it won't cycle accidentally.
- - BUGFIX: 'empty' space below song-names on Course selection screen corrected.
- - BUGFIX: Various graphical glitches corrected.
- - BUGFIX: 'negative percentages' in Nonstop mode fixed.
- - BUGFIX: 'broken freeze arrows' glitch fixed.
- - VARIOUS: various other tweaks and fixes that I can't remember. ;)
-
-v2.03.00 - September 12, 2002.
- - NEW: 'Global GAP' adjustment added to System Options (affects all files)
- - NEW: Ability to reset 'Player's Best" list added to Options.
- - NEW: Rebuilding songlist also creates 'dwi2-songlist.html', for easier reference.
- - colour for random songs in Nonstop mode brightened.
- - switching from a song with CHALLENGE steps to one without that set reverts to HEAVY, not LIGHT.
- - small graphical bug with freeze arrows ending cleaned up.
- - freeze arrow graphics updated for up-left/up-right.
- - new Nonstop course banner to replace the old ugly one. ;) (thanks, Cave)
- - more Q/A added to FAQ.html
- - BUGFIX: Scoring precision improved to make 'AAA'd songs add up correctly.
- - BUGFIX: extra 'ticks' being played with "Little" mode on.
- - BUGFIX: 'invisible' steps being played when Autoplay was on in "Little" mode.
- - BUGFIX: jumping to a specific spot with different speeds in Developer mode corrected.
- - BUGFIX: starting a song with "Start" in SDL mode won't automatically take you to Options screen.
- - BUGFIX: arrows loaded correctly when switching skins again.
-
-v2.02.00 - August 16, 2002.
- - NEW: Freeze arrows with normal steps at same time have both arrows in
- freeze-colour.
- - NEW: Up-left and up-right arrows in Solo mode redone to match other arrows.
- - NEW: SOLO arrow set available in Options.
- - NEW: Rebuilding Songlist now provides information on status
- instead of appearing to 'freeze'.
- - Numeric Keypad's 'ENTER' key now re-enabled.
- - BUGFIX: Grading system fixed ('points' value correctly calculated now).
- - BUGFIX: Problem with 'skipped' steps not registering in Nonstop mode fixed.
- - BUGFIX: ESCAPE handled better under new keyboard method.
- - BUGFIX: Can now exit developer mode properly.
- - BUGFIX: problem with REVERSE and HIDDEN in CRS files fixed.
- - BUGFIX: locking up in some DWIs with animated backgrounds fixed.
- - BUGFIX: jumps treated correctly again.
-
-v2.01.10 - August 12, 2002.
- - '/showsm' will show SMANIAC-only songs on the select screen, otherwise they're hidden
- - All keys now read using DirectInput (or SDL) instead of using old Windows interfaces. So
- problems with Escape and F1..F12 should be fixed now.
- - BUGFIX: doubling of time in Nonstop Versus mode fixed
- - BUGFIX: lives added properly now in Nonstop Doubles and Solo modes.
- - BUGFIX: after rebuilding songlist, starting in Single mode should behave now.
-
-v2.01.00 - August 11, 2002.
- - NEW: Press up-left ("sort") button on Results screen to switch to percentage-display
- - NEW: Credits screen finally added. Thanks to all who have helped. :)
- - NEW: Support for more than two panels at a time in a jump. (DWI specification tweaked slightly)
- - NEW: '/v5hack' command-line argument for some strange Voodoo card drivers. Might
- fix problems on Voodoo cards if you can't get it working right.
- - NEW: Ability to specify number of lives added after each stage in Nonstop mode. Also changed
- default behavior to give back lives in relation to difficulty of song just played.
- - Groove radar values calculated better; now Chaos gives a better value, and all values are in
- relation to the length of the song now (so extended-length songs don't give too-large values).
- - Songs with only SMANIAC steps are now selectable in regular song-select screen.
- - If current difficulty selected is 'bumped' when moving to a song that doesn't have that set of
- steps, it'll go back to that setting when the next song that does is selected.
- - Wrapping of song-titles tweaked to wrap on " -", not just "-".
- - Power bar 'sliding' behavior tweaked.
- - In Options Menu, currently-selected item is remembered when returning from sub-menus.
- - Maximum number of songs allowed upped to 2048.
- - BUGFIX: going to course-select screen after rebuilding songlist should work correctly now.
- - BUGFIX: starting a song with 'start' on a gamepad won't take you to the options screen unless
- you hold it now.
- - BUGFIX: 'beat' counter behavior fixed for when a BPM-pause/freeze occurs.
- - BUGFIX: animations should behave now when speed is altered.
-
-v2.00.52 - I released the DirectInput implementation too soon, sorry. This should solve the
- issues with DX mode in some operating systems, and SDL mode.
-
-v2.00.5 - August 2, 2002.
- - I now have WindowsXP... yay... so now I can test DWI in it...
- - 'white flashes' during video playback fixed.
- - grading system (rounding) bug fixed... (I think...).
- - keyboard input now uses DirectInput for most things, instead of Windows functions -
- should hopefully be faster and avoid some lag problems some have been experiencing.
- - second set of keyboard inputs can be configured now.
- - can't change sort method after choosing "ROULETTE" anymore.
-
-v2.00.3 - July 25, 2002.
- - fixes a number of graphical problems related to songs with positive GAP values.
- - groove radar calculations now a bit more tolerant of mistakes in files.
- - .75x and .5x modifiers corrected in Options screen.
- - Stealth now selectable through both methods.
- - New freeze arrow 'flash' animation as earlier version was getting mixed reviews. ;)
- - fixed Roulette when "Sort by Genre" is used.
- - Difficulty tweaked slightly.
- - Failure of stage behaves properly again.
-
- - IMPORTANT - I meant to do this with the first release of 2.00, but forgot -
- DWI2's configuration is stored in 'dwi2.cfg', 'dwi2.sng', 'dwi2.rec', etc.
- IF YOU HAVE BEEN RUNNING v2.00, PLEASE RENAME 'dance.*' 'dwi2.*'.
- Sorry for the inconvenience.
-
-v2.00.0 - July 22, 2002.
- - Completely overhauled DWI's interface. The 'brushed metal' look is out in favor
- of a new, more colourful design
- - New, more readable and stylish font
- - optional timer on gameplay screens to hurry things up
- - hold 'START' when selecting a song to open up a new 'select options' screen
- ('SELECT' will still let you change options as before also).
- - DWI2 has removed old interfaces that I feel are outdated and in the process makes
- it much easier to update. At the same time, the base skin has been updated
- considerably. (NB: old skins will not be recognized, sorry...)
- - Nonstop Mode now keeps track of time, percent, etc.
- - MAX2 scoring and grading system
- - Smooth animations for judgements, combo display
- - New animation for song start/end
- - Groove Radar implemented (values calculated when Songlist is rebuilt)
- - Roulette added to song-select screen
- - 5th/MAX-style power bars and gameplay interfaces, freeze arrows, etc.
- - completely redone evaluation screen
- - usernames taken out - they were a pain to put in anyway
- - Song banners now used on song-select screen if available. Can be horizontal or
- old diagonal-style (backgrounds used as before if no banner found)
- - Records screen now keeps track of Nonstop records too
- - new option '/fps:xx' lets you set a maximum framerate (20..100); saves processor
- time for other applications if you've got a fast machine
- - multiple bugs fixed.
-
-SPECIAL NOTE: DWI 2.0's skins require a file called 'dwi2-skin.cfg' to work. This is done
- to avoid accidentally choosing an old skin.
- The Sounds folder is very similar, but with new samples for some things. Users
- upgrading from 1.7 and lower should run 'convert.bat', which does the following:
- 1) copy all files from \eval\S to \eval\SS
- 2) rename \eval\SS \eval\AA
- 3) rename \eval\SSS \eval\AAA
- 4) remove \eval\S
- 5) move all files from \select\song to \start\ready
- 6) remove \select\song. (You can also delete \select\new)
-
-v1.70.0 - June 17, 2002.
- - New method for creating Nonstop Mode courses - introduction of "CRS" file format.
- This should allow for easier creation of Nonstop Mode courses. See below for details.
- - Removed all old Nonstop-mode sections.
- - New Nonstop Course selection screen. Banners can be given to a course. Also allows for
- playing defined courses in different modes.
- - Two people can play Nonstop mode courses at the same time.
- - Better record keeping for Nonstop mode courses.
- - Style Select Screen modified. SOLO mode is now selected by pressing up/down there.
- - New "Failed" sequence - arrows stop and fade out now instead of still scrolling.
- - Freeze arrow behavior tweaked.
- - Combo system can be chosen in Options Screen.
- - New command line argument "/sdevice:x" can tell DWI what sound device to use.
- (view dance.log to see a listing of available devices first).
-
-v1.65.5 - June 7, 2002.
- - Added sound effect for when you lose a life in Nonstop "Combo" mode.
- - Updated freeze arrows to behave more like MAX.
- - Freeze-arrows don't do as much damage as they used to. ;)
- - MAX-like combo system.
-
-v1.65.0 - May 26, 2002.
- - Added random background animations. Put looping AVIs into ./Movies/Random
- and DWI will use them automatically in the backgrounds for songs with
- no background script.
- - Random animations can be enabled/disabled in the System Options.
- - Addition of four new tags to DWI files:
- #RANDSEED:x; - provide a number that will influence what AVIs DWI picks.
- Will be the same animation each time if AVI filenames and count
- doesn't change (default is random each time).
- #RANDSTART:x; - tells DWI what beat to start the animations on. Default is 32.
- #RANDFOLDER:...; - tells DWI to look in another folder when choosing AVIs,
- allowing 'themed' folders.
- #RANDLIST:...; - a list of comma-separated filenames to use in the folder.
-
- - Ability to tweak timings for judging Perfect, Great, etc. steps in System Options.
- - New "Select Style" interface added (default now for "DWI (Second Interface)" skin).
- Use "SelectStyle=2" under "[GENERAL]" in the 'dwi-skin.cfg' file to enable.
- - Crowd cheers or moans during gameplay based on performance.
- - Music loop added to "Select Style" screens.
- - Routine for displaying background animations put into separate thread now.
- - New command-line argument: '/priority:x' can force DWI to run as a more "important"
- program under Windows. "1" starts it as "ABOVE NORMAL", "2" is "TIME CRITICAL". May
- improve performance in certain cases.
- - BUGFIX: Selecting an SMANIAC song after a previous one in 1st Interface fixed.
- - Other various bugfixes that I can't remember. ;)
-
-v1.62.3 - May 6, 2002.
- - Minor bug fixes. Main change is a tweak to the /test: command line arguments to
- accommodate folders on other drives to faciliate step-file creator authors.
-
-v1.62.2 - April 18, 2002.
- - Speed of song can now be set to faster than normal play using F3/F4 during gameplay or
- at song select screen (1..5..9).
- - bug fix: BPM shift won't reset background animation.
- - bug fix: GAP adjustment should behave better now.
- - More developer functions added:
- /startat:
-
-9. FUTURE DEVELOPMENT AND THANKS
- -A long time was spent making this program, and I believe that this first release is fairly complete in terms of features. New features will be considered as resources and interest permit.
- -Special thanks go to DjDraftHorse for the announcer files - I think he did a fantastic job, very professional. Also he has been a great beta-tester and a sounding board for new ideas. Much appreciated!
- -Also, a huge 'thank you' to BemaniRuler for beta-testing the program and your enthusiasm for the project. He's been a great help in creating the new interfaces and I appreciate him letting me incorporate some of his graphics from his earlier skins in the release of DWI 2.0.
- -Thanks also to Durikkan for his help in implementing the Groove Radar - the values used are based off of his algorithm.
- -BBW, for putting up with my incessant programming of the simulator and my exhorting of the joys of Bemani. ;)
- -LagGed and the others at "The Melting Pot" for the resources available there concerning the file formats and other simulators, and his offer to host the distribution files. uKER for taking it upon himself to write some better code for song-management which I was able to implement into the main DWI code. YrevaTeneb for his writeup on how to create DWI files at the Melting Pot, and for permission to list it here. Also a special thanks to Apocalypse for his insight in getting DirectX working.
- -Pawwaves to those in the furry community. :^)
- -Enjoy...
-SimWolf.
DANCE WITH INTENSITY v2.50.00
+© SimWolf, 2003
-
+
- DISCLAIMER AND TERMS OF USE +
- WHAT'S NEW? +
- USING AND CONFIGURING DWI
-
+
- Basic Operation +
- Song Sorting +
- Selecting Song Modifiers +
- Special keys +
- Controller Configuration +
- Gameplay Settings +
- Sound Configuration +
- Changing the Display from Windowed to Full-screen +
- Sound effects +
- Command-line options +
- Testing a song +
- Setting Skins +
- Setting Announcer and Sound Effects +
- Folder- and Genre- Specific Banners +
- AVI Movie Support +
- Sonique Visualizations (SVP) Support +
- User Profiles +
- DWI FILE FORMAT
-
+
- Steps +
- Hold Arrows +
- Tags +
- Background Animations, Movies, and Visualizations +
- NONSTOP MODE AND CRS FILE FORMAT +
- LRC (LYRICS) FILE FORMAT +
- LIMITATIONS +
- VERSION HISTORY +
- FUTURE DEVELOPMENT AND THANKS +
1. DISCLAIMER AND TERMS OF USE
+ +This program is provided for free, as-is. Although it has been tested on multiple systems for compatability and reliability, you run this program at your own risk. I cannot be held responsible if the program causes file loss or other problems.
+ +THIS PROGRAM IS *NOT* FOR SALE!!! IT SHOULD NEVER BE BUNDLED WITH ANY OTHER FILES (MUSIC OR STEP FILES) ON ANY MEDIA, INCLUDING (BUT NOT LIMITED TO) CD's, DVD's, DISKS OR OTHER MEDIA.
+ +DWI is Donation-Ware. Although you are not required to donate, it would be greatly appreciated if you enjoy the program that you contribute something towards the developers.
+ +This program simulates a popular arcade and home video game. It was written to allow myself the ability to play songs from the games without having to switch CDs in my Playstation or Dreamcast, and also affords the ability to add new songs not currently available. It also allows for playing older songs with new play modes, such as downward-scrolling arrows. This program is being released to the public in the hopes that others would find it useful in the same manner.
+ +As such, this program REQUIRES responsibility on the part of the end-user (ie. YOU) to use the program LEGALLY. You should *ONLY* play songs where you:
| a) | Own the game from which that music comes from. |
| or b) | Own the soundtrack CD from which the music comes from. |
| or c) | Legally own rights to the music being used (ie. other CDs, etc.) |
I own all the available soundtracks and videogames for the music I own, and respectfully ask that you support the games and purchase them. Thank you.
+ + + ++v2.50.00 - August 14, 2003. + - NEW: Addition of WAVE, BRAKE, and 0.25x modifiers. + - BUGFIX: Stage numbers and various other numbers are coloured again. + - BUGFIX: Bonus stages now default to Heavy/Maniac again. + - OTHER: Various other bugs I can't remember that have been fixed. + ++ + + + +
BASIC OPERATION
+ +When you first run DWI, you will receive a warning screen about responsible use of the program. This warning screen will appear *EVERY* time the program detects new songs.
+ +DWI uses step-files with the extension ".DWI". These files go in their own folder along with their associated background and banner images. Optionally the music file can go in the same folder also.
+ +DWI supports multiple collections of songs, so you can organise your songs as you see fit. To do this, just create different sub-directories in the "Songs" folder.
+ +eg. For a song with a step-file of "abc.dwi", put into a collection called "My Songs", your directory structure should look like this:
+ <INSTALL directory> + + Songs + + My Songs + + abc + + abc-banner.png (any name, the program will detect that it's a banner) + + abc-bg.png (any name, the program will detect that it's a background) + + abc.dwi (any name) + + (abc.mp3/wav) (optional - otherwise FILE: tag is used). + + (abc.lrc) (optional - should have same base as DWI file). ++ + +
So, in each "song folder", there should be two image files (background and banner), the DWI file, and optionally the music file in MP3 or WAV format.
+ +Song Sorting
+ +When you are at the song select screen, simply press up or down to change the current collection you are in. Songs are organized alphabetically within each collection, and collections are organized alphabetically also.
+ +Another option is to sort your music by genre. To activate this, go to "Options Menu", then "System Menu", and change the sort method to "GENRE" *. This requires your DWI files to have a tag defining the genre to put the music into (see DWI format, below). Multiple genres can be given (separated by a comma), to make the same song appear in different collections. At the song select screen, press up or down to change the genre.
+ +You can also press Up-Left to change the sort method. This cycles through:
-
+
- Folder/Genre (default) +
- Folder/Genre, Separated +
- All Music (by title) +
- All Music (by artist) +
- BPM. +
- Player's Best (top 64) +
Selecting Song Modifiers
+ +At the song-select screen, press the "Select" button/key, and use the arrows to change options. When done, press "Select" again. Alternatively, you can hold down "Start" when selecting a song and you will be taken to a +screen where you can set your options.
+ +| Speed: | 1.5x, 2.0x, 3.0x, 4.0x, 5.0x, 8.0x, 0.5x, 0.75x, 0.25x |
| Boost: | BOOST, BRAKE, WAVE |
| Appear: | HIDDEN, SUDDEN, STEALTH |
| Turn: | LEFT, MIRROR, RIGHT, SHUFFLE |
| Other: | LITTLE, FLAT, SOLO |
| Dark: | DARK (can't see arrow indicators) |
| Scroll: | REVERSE |
| Freeze: | NOFREEZE |
| Power: | POWER-DROP (gauge starts full and depletes), DEATH (must full-combo song) |
For courses and bonus stages, use the same text as above in the course definition file when setting modifiers.
+eg. #SONG:Default\MySong:BASIC:1.5x,HIDDEN,LEFT,FLAT;
Special keys
+ +The function keys will be used to adjust or enable various gameplay functions. Primarily these are designed for people creating DWI files and want to adjust timing.
+ +| F1/F2 | - Restarts the song (developer mode only) |
| F3/F4 | - Adjust playback speed of song down/up (during song select/gameplay) |
| F5/F6 | - Adjust BPM value down/up by 0.50 BPM. (during gameplay) |
| F7/F8 | - Adjust BPM value down/up by 0.02 BPM. (during gameplay) |
| F9/F10 | - Adjust GAP value down/up by 5ms. (during gameplay) |
| F12 | - Toggle "Assist Click" on/off. (during song select/gameplay) |
Controller Configuration
+ +To change the inputs, simply go to the Options Menu from the main screen and goto "Keyboard Configuration" or "Gamepad Configuration". Choose to configure either Player 1 or Player 2's inputs and you will be prompted to press each key, joystick button or dancepad square in turn. You cannot choose an input that is currently in use. To skip joystick buttons, press the "TAB" key.
+ +When done, select "Return" to make the change take effect.
+ +Gameplay Settings
+ +Gameplay settings such as difficulty level, danger display, and end-of-game settings are selected from the Gameplay Configuration menu from the Options screen. These changes take effect immediately.
+ +Extra Stages
+ +If you AA a Heavy or Challenge mode song on the last stage and have Extra Stages enabled in the Game Options, you can play another song. The song(s) you can choose from are either generated randomly (3 for Extra Stage #1, one for Extra Stage #2), or can be defined in a CRS file.
+ +| bonus-1.crs | Songs for Extra Stage #1 |
| bonus-2.crs | Songs for Extra Stage #2 |
NB: These CRS files go in the same directory as DWI2.exe, not the Courses folder.
+ +Sound Configuration
+ +The default sound settings for DWI are 44Khz, Stereo, 16-bit samples. However, you may want to lower these +settings on slower computers.
+ +* NB: You must exit DWI and start it again for this change to take effect. + +Changing the Display from Windowed to Full-screen
+Go to the "System Menu" from the Options screen and change the display type.
+ +* NB: You must exit DWI and start it again for this change to take effect. + +Sound effects
+ +Sound effects are all in the "Sounds" directory. You can add or remove files to most directories, and the program will use the existing files during gameplay. However, files in the root of the sound-set directory and those in the "attract" and "combo" directories must be the same name in order for the program to find them and play them appropriately.
+ + + +You can run DWI with various command line options to configure some values. (Please read the FAQ for details +on how to start the program with command line options). These options are available:
+ +| /sdl | Starts DWI in the software-only graphics mode. |
| /16bpp | Runs DWI in 16-bit colour mode (SDL), or uses a 16-bit primary surface (DirectX) |
| /32bpp | Runs DWI in 32-bit colour modes/32-bit primary surface. |
| /fullscreen | Runs DWI in fullscreen mode (may need to use to start on some cards) |
| /window | Runs DWI in a window. Some cards won't support this so DWI will try fullscreen. |
| /log | Creates a 'dance.log' file that can be useful for debugging. |
| /anysize | In DirectX mode, this tries to make textures in any size, rather than creating textures to the nearest power-of-two value (ie. a 75x60 image is loaded into a texture that big instead of a 128x64 one). This can speed up performance on some cards and save memory, if your card can handle it. |
| /sw | In SDL mode, surfaces are created in regular memory (default) |
| /hw | In SDL mode, surfaces are created in hardware memory (can improve performance if your card can handle it). |
| /priority:x | can force DWI to run as a more "important" program under Windows. "1" starts it as "ABOVE NORMAL", "2" is "TIME CRITICAL". May improve performance in certain cases. (Use with caution if you're running many other processes at the same time). |
| /sdevice:x | tells DWI to use a given sound-device. Use "/log" and look in dance.log first for a list of available sound-devices. |
| /fps:xx | makes DWI try to stay at a given framerate (20..100). If you've got a fast machine, this can really save on computer cycles. |
| /showsm | will add songs with only SMANIAC steps to the song-select screen. |
| /skipsearch | will prevent DWI from searching the Songs folder at startup. |
| /dither:0 | will turn off the dithering effect DWI uses for semi-transparent images on old videocards that can't handle them. Some users may prefer this to remove the 'speckles' in the gameplay graphics. |
You can limit paging to virtual memory during gameplay (which can cause skips as Windows decides to write or retrieve data from disk) using these flags:
+ +| /minRAM:xx | Instructs DWI to try to reserve at least this much physical memory from the Operating System. * |
| /maxRAM:xx | Instructs DWI to try to reserve at most this much physical memory from the Operating System. * * Only works in Windows NT, 2000, and XP. Default is 16-32MB. |
Use these flags to fix strange behavior in DWI...
+ +| /key:nonexclusive | affect how DirectInput is initialized. Should be paired with one of /key:fg or /key:bg |
| /key:exclusive | |
| /key:fg | affect how DirectInput is intialized. |
| /key:bg | |
| /altcombo | for reasons known to the heavens and my machine in the basement, DWI would not display the 'lives' image in Nonstop Mode, instead locking up the computer. I'm convinced this is a videocard/driver issue, as the code to draw the image is exactly the same as the code to display any other image... but oh well. Using this command line argument will tell DWI to not try to display the image and instead write "X Lives" in its place, which seemed to make it work. Strange... but the option's there in case you run into the problem too. |
| /v5hack | some Voodoo card drivers seem to allocate space for textures incorrectly (off by one) - this should hopefully fix the problem. |
| /altmovie | Uses an alternate way of drawing the background movies and visualizations for older videocards that display solid-colour textures instead. |
| /noshade | Prevents the extra shading effect on the song-select wheel from being added. |
Testing a song
+ +| /test:... | You can start DWI in test/developer mode by using the "/test:..." command line argument. Provide the *folder* the .dwi file is in. |
| /style:... | use this set of steps (SINGLE, DOUBLE, SOLO). Default is SINGLE. |
| /level:... | use this level of steps (BASIC, ANOTHER, MANIAC, SMANIAC). Default is BASIC. |
| /p2 | test using player 2's controls instead. |
| /speed:X | starts song at a given speed (1..5) |
| /scroll:X | starts song with given speed modifier (0.5, 0.75, 1.5, 2, 3, etc.) |
| /startat:<TIME> | jumps to a given time into the song (game-time). <TIME> can be given in minutes, seconds, or milliseconds.
+ie. /startat:1:05.5 (minutes) + /startat:65.5 (seconds) + /startat:65500 (ms) - all the same position. |
| /tick:1 | turns the assist click on at startup (default is off). |
| /dark | hides the fixed-place arrows during testing. |
Example:
+ +"DWI.exe /test:.\Songs\Development\MyNewSong /style:SINGLE /level:MANIAC /p2 /speed:4 /scroll:2 /startat:1:00"
+ +Starts testing the .dwi file found in \songs\development\mynewsong, in SINGLE mode, with MANIAC-level steps. Player 2's controls are used, and the song's speed is set to '4'. Arrows are displayed as though the "x2" modifier was active. The song starts at the 1-minute mark.
+ +Setting Skins
+ +Create different sub-directories within the "Skins" folder for each skin you wish to use. So, for example: +
+ <INSTALL directory> + + Skins + + Default (leave as-is) + + Skin A + + Skin B + + ...+ +
The filenames for each skin should be the same as in the default directory. If an image isn't found, the default is used. This way you can create skins that are relatively simple, or very elaborate ones. And you don't need to delete any of the original files. ;) There is a limit of 64 skins.
+ +Changes will take effect when you leave the Skin Selection screen.
+ +I do ask, however, that you keep the title of the program as "Dance With Intensity". Thank you. :)
+ +Setting Announcer and Sound Effects
+ +Similar to skins, just create new directories in the 'Sounds' folder for each sound set you wish to use. So, for example: +
+ <INSTALL directory> + + Sounds + + Default (leave as-is) + + Jack + + Jill + + ...+ +
The tree structure for each set should be the same as is used for the "Default" directory. For example: +
+ Jill
+ + attract - files should be named attract-00.wav, attract-01.wav, attract-02.wav
+ | (these are the sounds used on the title screen)
+ + combo - files should be named combo-00.wav and combo-01.wav
+ | ("100 Combo" and "Combo stopped")
+ + danger - a set of files played when power level at danger or zero.
+ + eval
+ | + A
+ | + B - sets of files to play at the evaluation screen based on grade
+ | + ...
+ + good - a set of files played when power level in the 'good' range
+ + great - " " 'great' range
+ + over
+ | + fail - files played at game over screen (failure)
+ | + pass - " " (cleared all stages)
+ + select
+ | + new - files played when #STATUS:NEW; is set in DWI file and song is selected
+ | + song - files played when a song is selected
+ + start
+ + + go - files played at "Here we go!" screen.
+ + + ready - files played at "Ready?" screen.
+ + warning - a set of files played when the power gauge is in the 'warning' range.
+
+There should not be more than 64 sound effects in a single subdirectory. There is a limit of 64 sets. Changes will take effect once you leave the Announcer/Sound Select screen. Please keep the title sound effect (attract-00.wav) as "Dance With Intensity".
+ +Folder- and Genre- Specific Banners
+You can make DWI display a special banner for each folder when it is highlighted on the Song-Select Screen. To do this, simply put a standard (horizontal) banner with the same name as the folder in the 'Songs' folder. (eg. a banner for 'Default Songs' would be ".\Songs\Default Songs.png").
+ +If you have sorting by Genre on, you can have special banners for each Genre by putting banners in PNG format with the same name as the Genre referenced into ".\Genres". (eg. "Pop Music.png").
+ +Folder-Specific Banners can also be made for Courses too. Just put a PNG file with the same name as the subfolder the CRS files are in, in the "Courses" directory.
+ +AVI Movie Support
+AVI movies can be played in the background while you play. See the "Background Animation" section below for more details on how this is set up. From the System Menu, you can tell DWI whether to not play AVI files at all, or set the quality level from 1 (worst) to 10 (full). The default is 5. Changing this value could affect your framerate, so play with the values to determine what works best for your system.
+ +Random animations are picked from the ./Movies/Random folder and played in the background of songs without a defined background script if enabled in the System Options menu. This folder can be changed by a flag in the DWI file also, enabling themes.
+ +Sonique Visualizations (SVP) Support
+Sonique visualizations can be played in the background while you play. See the "Background Animation" section below for more details on how this is set up. From the System Menu, you can tell DWI whether to use them at all, or set the quality level from 1 (worst) to 10 (full). The default is 5. Changing this value could affect your framerate, so play with the values to determine what works best for your system.
+ +Random visualizations are picked from the ./Vis folder and played in the background of songs without a defined background script if enabled in the System Options menu. Their behavior can often be changed by editing the 'vis.ini' file that is created after they are used in DWI, similar to in Sonique.
+ + +DWI2.40 introduced 'user profiles' - a way that multiple users can play DWI on the same machine and keep their own individual records. Setting up a new profile is easy - simply create a new subdirectory in the "Profiles" directory with the name of the user (15 characters or less), and inside that folder, put a 64x64 PNG file called 'user.png' to represent you in the game. Look at the 'Profiles/Sample User' folder for an example.
+ +When you use a profile, DWI will create an individual records file and profile information file in the same directory that keeps track of your individual achievements.
+ +When you get a high score, it will be saved to your own profile's records ("New Personal Best"), and, if you beat the overall high score, it will also be saved to the system records ("It's a New Record!"), with your username registered with it.
+ +Using a user-profile also lets you track some other statistics, such as overall high scores and combos for each mode. It will also store the last-used modifiers you used (eg. 2x speed modifier, Reverse) between sessions, so you don't have to set it again each time you start a new game.
+ +This option can be disabled in the Game Options Menu if you prefer.
+ +4. DWI FILE FORMAT + +Steps
+ +DWI uses step-files that are similar to the ".MSD" file format. However, there are new additions and some tags are treated slightly differently, so the extension was changed to avoid confusion. DWI files with these new additions will not work properly in other simulators.
+ +Step-patterns are defined in the same way as .MSD files - use the numeric keypad as a reference for most patterns: +
+ 7=U+L 8=U 9=U+R + + 4=L 6=R + + 1=D+L 2=D 3=D+R + + (U+D = A and L+R = B) ++ +
A '0' indicates no step. Each character defaults to one 1/8 of a beat. Surround a series of characters with the following brackets to change the rate at which the steps come: +
+ (...) = 1/16 steps
+ [...] = 1/24 steps
+ {...} = 1/64 steps
+ `...' = 1/192 steps
+
+6-panel (Solo) mode uses additional characters: +
+ -\---- = C + ----/- = D + + L\---- = E + -\D--- = F + -\-U-- = G + -\---R = H + + L---/- = I + --D-/- = J + ---U/- = K + ----/R = L + + -\--/- = M+ +
To do more than 2 panels at a time, you can join codes together with the "<..>" object, and they will all count as the same beat. So, to do a jump that involves Left, Right, Up-Left, and Up-Right, you could do: +
+ -\--/- = M + L----R = B + ====== + L\--/R = <MB> (or <LE>, <IH>, <46M>, etc.)+ +
MSD files from other simulators will work with DWI, with a change in the 'GAP' value being the only change usually necessary. DWI calculates the 'GAP' value differently than other simulators that use the MSD format.
+ +DWI does not support the BMS file format. There is a utility available that can convert any BMS file into DWI format. Each song only requires one DWI file for all of its steps, so if you are converting BMS files please remember that all the different difficulties of step patterns will be contained in the same DWI file.
+ +Hold Arrows
+ +In the DWI file format a hold arrow is signified with the ! symbol. The string 8!8 will begin an 'up' hold arrow, and the arrow will be released the next time the program encounters an 'up' arrow: by itself or combined with another arrow (7, 8, 9, A, etc.) The characters 7!4 would show both 'up' and 'left' arrows but only the left arrow would be held. The format could best be described as "show!hold".
+ +Tags
+ +These tags should be in every DWI file:
+ +| #TITLE:...; | title of the song. |
| #ARTIST:...; | artist of the song. |
| #GAP:...; | number of milliseconds that pass before the program starts counting beats. Used to sync the steps to the music. |
| #BPM:...; | BPM of the music |
Additionally, the following tags can be given:
+ +| #DISPLAYTITLE:...; | +provides an alternate version of the song name that can also include special characters. | +
| #DISPLAYARTIST:...; | + provides an alternate version of the artist name that can also include special characters. + + Special Characters are denoted by giving filenames in curly-brackets. + eg. #DISPLAYTITLE:The {kanji.png} Song; + + The extra character files should be 50 pixels high and be black-and-white. The baseline for the font should be 34 pixels from the top. + |
+
| #DISPLAYBPM:...; | +tells DWI to display the BPM on the song select screen in a user-defined way. Options can be: + +* - BPM cycles randomly +a - BPM stays set at 'a' value (no cycling) +a..b - BPM cycles between 'a' and 'b' values + |
+
| #FILE:...; | + path to the music file to play (eg. /music/mysongs/abc.mp3 ) + (NB: if the file is not found, a .wav or .mp3 file in the same folder as the DWI file is used) |
+
| #MD5:...; | +an MD5 string for the music file. Helps ensure that same music file is used on all systems. | +
| #FREEZE:...; | +a value of the format "BBB=sss". Indicates that at 'beat' "BBB", the motion of the arrows should stop for "sss" milliseconds. Turn on beat-display in the System menu to help determine what values to use. Multiple freezes can be given by separating them with commas. | +
| #CHANGEBPM:...; | +a value of the format "BBB=nnn". Indicates that at 'beat' "BBB", the speed of the arrows will change to reflect a new BPM of "nnn". Multiple BPM changes can be given by separating them with commas. | +
| #STATUS:...; | +can be "NEW" or "NORMAL". Changes the display of songs on the song-select screen. | +
| #GENRE:...; | +a genre to assign to the song if "sort by Genre" is selected in the System Options. Multiple Genres can be given by separating them with commas. | +
| #CDTITLE:...; | +points to a small graphic file (64x40) that will display in the song selection screen in the bottom right of the background, showing which CD the song is from. The colour of the pixel in the upper-left will be made transparent. | +
| #SAMPLESTART:...; | +the time in the music file that the preview music should start at the song-select screen. Can be given in Milliseconds (eg. 5230), Seconds (eg. 5.23), or minutes (eg. 0:05.23). Prefix the number with a "+" to factor in the GAP value. | +
| #SAMPLELENGTH:...; | +how long to play the preview music for at the song-select screen. Can be in milliseconds, seconds, or minutes. | +
| #RANDSEED:x; | +provide a number that will influence what AVIs DWI picks and their order. Will be the same animation each time if AVI filenames and count doesn't change (default is random each time). | +
| #RANDSTART:x; | +tells DWI what beat to start the animations on. Default is 32. | +
| #RANDFOLDER:...; | +tells DWI to look in another folder when choosing AVIs, allowing 'themed' folders. | +
| #RANDLIST:...; | +a list of comma-separated filenames to use in the folder. | +
Each pattern of steps for different modes have the same basic format: +
#SINGLE:BASIC:X:...; + ^ ^ ^ ^ + | | | + step patterns. In doubles, the left pad's steps are given first, + | | | then the right pad's, separated by a colon (:). + | | | + | | + difficulty rating. Should be 1 or higher. + | | + | + Difficulty. Can be one of "BASIC", "ANOTHER", "MANIAC", or "SMANIAC" + | + + Style. Can be one of "SINGLE", "DOUBLE", "COUPLE", or "SOLO". "COUPLE" is + Battle-mode steps.+ +
Comments can be used by using "//". Everything after this on the same line in the file will be ignored.
+ +Background Animations, Movies, and Visualizations
+ +DWI allows for background animations using a special script within the step-file. A script consists of static images, animated images, and/or an AVI movie. Using the script, you can create a variety of layered effects. A sample animation is described below: +
+ #BACKGROUND: + + M:MOVIE:.\movies\sfx.avi STARTAT:-1.0 LAYER:0; + V:VIS:.\Vis\somevis.svp LAYER:0; + E:FILE:.\anim\equalizer.png ANIMATE:10,33 POSITION:-33,0 SPACING:40,40 LAYER:1; + D:FILE:.\anim\dancer-m1.png ANIMATE:24,66 SIZE:2 MULT:0,0.5,1 SPACING:30,30 LAYER:1; + X:LAYER:1 OFF; + + SCRIPT:M....................... + ................E............... + D...............X,V...............E...............D............... + X,M...............E...............D...............X,V............... + E...............D...............X,M...............E............... + D...............X,V...............E...............D............... + X,M...............E...............D...............X; + + #END;+ +
The first part of the "BACKGROUND" definition defines the effects. Each effect is attributed to a letter or number ("a-z", "A-Z", "1-9"). The format for defining an effect is:
+ +| The first four tags cannot be used together... | |
| FILE: | path to a file. Either a still image, or an animation (multiple frames of animation are stacked *vertically* in the image). |
| MOVIE: | path to a standard Windows AVI file. Note that the movie won't play unless you have the right codecs installed in Windows. Movies are currently stretched to fill the whole screen. |
| VIS: | path to a Sonique Visualization plug-in (SVP). Visualizations are currently stretched to fill the whole screen and are always put on Layer 0, and no other commands will affect it. |
| OFF | turns off a layer, effectively making it invisible. Will not turn off layer 0. |
| LAYER:l | the layer to use (required):
+0 - base layer. + (Image/Movie is always tiled and SPACING is ignored). + 1 - overlay layer + 2 - overlay layer + 3 - overlay layer |
| STARTAT:t | number of seconds into the AVI file to start at. If negative, the movie will wait that many seconds before playing. Can be decimal (eg. 1.3 = 1300ms). |
| MULT:r,g,b | Red, Green, and Blue pixels in the image/movie are tinted by the given amounts. This way the same image/movie can be used multiple times across DWI files and have different colours. |
| ANIMATE:f,n1,n2,...nF | indicates that the FILE contains multiple frames of animation. "f" is the number of frames of animation. Each following value is the number of milliseconds each frame of animation is displayed. If not enough time-values are given, the last given value is used. Ignored for MOVIE type. |
| MOVE:x,y | the image/movie is moved by the given number of pixels every millisecond. |
| SPACING:x,y | images are always tiled if they don't fill up the screen. This tag allows you to add some spacing between the images by the given number of pixels horizontally and vertically (Layer > 0) |
| SIZE:s | multiplies the image size by 's' in both directions. Must be a whole number. |
| KEEPPOS | normally when a new effect is turned on, its position is reset. This tag keeps the layer where it is, useful for keeping images moving smoothly. |
| KEEPTIME | (MOVIEs only) normally when a movie starts, it starts from the beginning or the time given in the "STARTAT" tag. Adding this tag will keep it playing so when that layer is enabled again, it will have kept going. |
Following the effect definition, comes the actual animation script. This is a sequence of characters in a similar way as the step-patterns are given - each character normally is 1/8 of a beat, though brackets can be used to change the time-values. In this way, background animations can be syched to the steps. It is suggested that the steps for "SINGLE:BASIC" are copied to after the "SCRIPT:" tag, and then the effects be set. In this way one knows that the script will match the same length of the music.
+ +The animations take effect as that point in the song is reached. Multiple effects can occur at the same time if they are separated with a comma. A period (.) means no new effect should take place at that point. A zero (0) turns off all effects and returns the background to the original graphic.
+ +More Information
+ +Please check our website for more information and links to useful resources.
+ +5. NONSTOP MODE AND CRS FILE FORMAT
+ +DWI uses special CRS files that should be put in subfolders of the "Courses" directory. Now courses +can be shared with others if they have the same files and directory structure as you.
+ +CRS files are similar to DWI files in structure. The file defines the basic details about the course, such as its name and which songs should be played. Currently these tags are supported:
+ +Required tags:
+ +| #COURSE:...; | the name of the course. |
| #DISPLAYCOURSE:...; | alternate name of course that can include special characters. Similar to #DISPLAYTITLE and #DISPLAYARTIST in DWI files. |
| #SONG:...; | defines a song in the course. This can either be a selection from the Player's Best (or Worst), a Random stage or a predefined stage. The syntax for each is given below: + PLAYER'S BEST/WORST STAGE: + #SONG:BESTx:[BASIC|ANOTHER|MANAIC|SMANIAC]; + #SONG:WORSTx:[BASIC|ANOTHER|MANAIC|SMANIAC]; + - choose a song with the given index 'x'. So BEST1 is the most popular + song, and WORST5 is the 5th least popular song. If the given + difficulty is not available, DWI will choose the next closest difficulty. + Songs that are equally popular will be put in random order. + + RANDOM STAGE: + #SONG:*:[a]|[a..b]; + - choose a random song, with a difficulty rating equal to or between 'a' and 'b'. + - if only 'a' is given, 'b' is assumed to be the same as 'a'. + + #SONG:*:[BASIC|ANOTHER|MANIAC|SMANAIC]; + - choose a random song with a given difficulty level. + + #SONG:folder\*:[a]|[a..b]|[BASIC|ANOTHER|MANIAC|SMANIAC]; + - choose a random song from a given folder. + + DEFINED STAGE: + #SONG:<FOLDER>\<SONG TITLE>:<DIFFICULTY>; + - will use a song from <FOLDER> with the given title. + So to play a song called "My Song", which is in + './Songs/Default/mysong/mysong.dwi', on MANIAC, + you would say: + + #SONG:Default\My Song:MANIAC;+ + NB: Either the TITLE or folder the DWI file is in can be used. + +In addition, modifiers can be defined for each song by adding a list of comma-separated values to the end of the #SONG line. These modifiers are the same as listed above, plus + + xRANDOM - where 'x' is the number of random effects to apply. + 'x' can be 1 to 7. + AWARDx - where 'x' is the number of lives to award after + finishing the stage. ++ So to play "My Song", Maniac, with 2.0x, Left, Hidden, and with one random effect, use: |
Optional tags:
+ +| #REPEAT:...; | can be "YES" or "NO". If set, starts course over from the beginning after last song. |
| #COMBO:PERFECT; | during play, the combo counter will only go up if a "PERFECT" is made. |
| #COMBOMODE:1; | sets how much is added to the combo counter for jumps. Can be 1 or 2. |
| #LIVES:4; | sets the number of 'lives' given to each player at the start of game play. After each stage is cleared, a given number of lives is added, either by a value specified by the "AWARDx" tag in the CRS file, or using the scale below:
+Song was 6 feet or less - 1 life. + Song was 7 or 8 feet - 2 lives. + Song was 9 feet or more - 3 lives. + |
At the course selection screen, courses that have songs without steps for the current style (SINGLE, DOUBLE, etc) will be filtered out. Courses are loaded when DWI starts.
+ + +DWI can display lyrics during a song if it finds a .LRC file in the same folder as the step-file. The file should have the same file-base as the .DWI file - so, for example, if your DWI file is called "mysong.dwi", the lyrics file should be called "mysong.lrc".
+ +This file is a simple text-file that tells the program what text to display and when. It can also define the colour the text is displayed in.
+ +Each line starts with a tag in the format [xxxxxx]. Currently, these tags are supported:
+ +| [COLOUR] | Sets the colour for the following text. After the tag, a colour value is given in hex (ie. yellow would be 0xFFFF00). Up to 10 colour values can be given, separated by commas. |
| [offset:xxxx] | Makes timestamps following this tag have their times adjusted by 'xxxx' milliseconds. Use to fine-tune timings for lyrics. |
| [MM:SS.ss] | Sets a time. The text following the tag will be shown on the screen after this time has passed, replacing any text that was there before. To clear text, provide just a tag with no text after it. A line-break can be defined using the pipe "|" symbol. +A new colour can be selected from the defined colours by using "{cX}", where "X" is a number from 0 to 9. + |
Sample LRC file:
+[0:00.00]aye-aye-aye|aye-aye-aye|aye-aye-aye +[0:05.30]Where's my samurai? +[0:07.00] +[COLOUR]0xffff00 +[0:13.50]I've been searching for a man +[0:16.00]All across Japan. +...etc...+ + + +
Partly due to the compiler and my own lack of knowledge in some areas, there are a number of limitations +imposed on the program that users should know about:
-
+
- No more than 2048 songs. +
- No more than 64 sound effects in a single subdirectory of 'soundfx' +
If the program runs slowly on your machine, try the following:
-
+
- Install the latest DirectX 8.1 drivers. +
- Update the video drivers for your video card. +
- Try running the game in fullscreen mode, and/or setting your screen resolution to 16-bit mode. +
- Lower the sound quality to Mono, 8-bit, and/or 11 or 22Khz. +
- Lower the quality of background movies if you use them a lot. +
- Try limiting the framerate (/fps:xx). +
v2.49.00 - May 22, 2003.
+ - NEW: Addition of "Player's Best" and "Player's Worst" to CRS file format.
+ - NEW: Expanded functionality of random song selection in CRS files. You can now
+ choose a random song by difficulty (instead of just foot ratings), and also select a
+ random song in a particular folder
+ - NEW: Courses are now arranged in subfolders, allowing for different groupings of
+ courses. One set could be for nonstop, others for challenge; or you can divide the
+ courses up by mix or genre, etc. You can also give each folder its own banner, like
+ in the song select interface.
+ NOTE: You will have to move your existing courses into subfolders for them to
+ be recognized!
+ - NEW: #DISPLAYBPM:[xxx..xxx]|[xxx]|[*]; added, to force a certain display type on
+ song select screen.
+ - NEW: For users with old videocards that can't display semi-transparent images, you
+ can now turn off the dithering effect that DWI uses if you like. Use the
+ '/dither:0' command line argument.
+ - Tweaks to how #RANDFOLDER:...; behaves, plus program now searches folder DWI file
+ is in for a "Movies" sub-folder, or AVIs in the same folder first before using the
+ default /Movies/Random folder.
+ - Tweaks to banner display on Evaluation screen (for when song/course had no banner)
+ - Tweaks to record-display for courses.
+ - Tweak to beat-display in-game and in developers mode, so numbers won't 'jiggle'.
+ - BUGFIX: 'tiled images' on song-select screen (BPM, stage #, difficulty) and during
+ gameplay on some old videocards has been fixed. You should probably consider
+ upgrading to a better card though anyway. ;^)
+ - BUGFIX: Can now have up to 512 courses, instead of 64. Oops. ;)
+ - BUGFIX: "combo continuing" playing on every step past 9999 combo. BTW, I hate you. ;)
+ - BUGFIX: Game doesn't crash on entering course-select screen after you've added new
+ CRS files.
+ - OTHER: Other bugfixes and tweaks that I can't begin to remember. :P
+
+v2.41.00 - February 15, 2003.
+ - CHANGE: Drawing of text made more efficient and slightly more readable, through better
+ drawing of drop-shadows.
+ - CHANGE: textures for SVP plug-ins to draw to now adjusted to nearest multiple of 2, as I
+ suspect some assume it's supposed to be like that for efficiency reasons, and otherwise
+ might cause problems overrunning memory.
+ - BUGFIX: DWI2.log file now created properly again. (d'oh!!!)
+ - BUGFIX: problem drawing certain images in 32bpp SDL mode fixed (eg. BPM display, star-wipe)
+ - BUGFIX: extra 'N/A" box no longer appears in Solo mode "Select Profile" if started with P1.
+ - BUGFIX: Better freeing of music samples after gameplay, credits, and on song-select screen.
+
+v2.40.00 - February 2, 2003.
+ - NEW: Addition of "User Profiles", a system to keep user-specific records and high
+ scores similar to the 'name entry' system from DWI1, but with more features. Individual
+ users can tailor their own icon and (if directories are the same across systems) take
+ their records with them between machines. Now tracks personal high scores and overall
+ high scores, all viewable in the Records screen. (Can be disabled in Options menu if you
+ prefer not to use it).
+ - NEW: Arrow set for DWI completely redone to feature true colour-cycling arrows like the
+ arcade. Also, arrows are drawn in last-to-first order now instead of first-to-last.
+ (NB: Thanks to uKER for the help creating the new arrow set).
+ - NEW: You can pause the game with the "Pause/Break" key. However, like autoplay, high
+ score will not be saved.
+ - CHANGE: Folder-specific banners treated differently - now DWI looks for a PNG file with
+ the same name as the sub-folder, in the base "Songs" folder. Should be easier to
+ manage the banners all in one folder now.
+ - some freeze arrow behavior tweaked.
+ - shading on song-select wheel made less dark.
+ - more details on LRC file support added to this file.
+ - style icon colours in default skin fixed (they were reversed).
+ - if you pass a song reasonably well, you'll get that cheer as the 'Cleared' text appears.
+ - BUGFIX: strange wrapping in View Records/Nonstop mode for some songs with two lines fixed.
+ - BUGFIX: Song titles and artist names with special characters on Nonstop mode now display
+ correctly
+ - BUGFIX: Timing in Developer mode after adjusting GAP fixed. Actually tested it this time. ;)
+ - BUGFIX: Realigning the word 'Test' in developer mode.
+ - BUGFIX: /startat in developer mode is more accurrate.
+ - BUGFIX: Bonus CRS files don't 'skip' songs that are next to each other in the songlist.
+ - VARIOUS: other small tweaks I can't remember. ;)
+
+v2.30.01 - January 3, 2003.
+ - AVI and SVP decoding optimized slightly to reduce load on main game function.
+ - flag added to turn off shading on song select wheel, if desired.
+ - BUGFIX: "Game Over" back in on failing in regular mode. Oops.
+ - BUGFIX: "NEW!" status works. Expires after 2 weeks now. May require songlist reset.
+ - BUGFIX: animation thread closes properly between stages.
+ - BUGFIX: steps are judged better again. Oops x 2.
+
+v2.30.00 - January 1, 2003.
+ - NEW: Implemented Sonique Visualization Plugins (SVP) for background animations.
+ - NEW: Folder- and Genre- specific banners, plus banners for Roulette
+ and Title/Artist sort options.
+ - NEW: Sort by difficulty added to Song Select screen.
+ - NEW: Multiple colours on same line of lyrics possible.
+ - NEW: Can adjust the number of stages between breaks in Nonstop Mode.
+ - NEW: Ability to disable Background Scripts.
+ - NEW: Ability to set default sort method.
+ - New 'default' banners and backgrounds.
+ - Banner and Sample Start load time reduced.
+ - Sort by BPM now much faster.
+ - Paths in Background Scripts can now have spaces (use quotes around path).
+ - Addition to Background Script commands to use Visualizations (on Layer 0).
+ - Long song names with special characters now wrap.
+ - Options Screens reorganized to group some things better.
+ - Adjustments to GAP in Development mode handled properly if changed in DWI file.
+ - Ability to change method for drawing movies/etc. to older method (slower, but good
+ for old videocards that just give solid-colour images instead now).
+ - CRS files can take either title or directory now.
+ - Stage number/display now graphical, and colours can be assigned in skin CFG file.
+ - "TAB" can be used in song-titles to force line-wrap.
+ - Font updated to include missing '~' character.
+ - Song select wheel now has some extra shading.
+ - Support for semi-transparant images on older videocards improved by addition of
+ pattern dithering instead of simply "off" or "on".
+ - BUGFIX: Missing '0's in scores during gameplay.
+ - BUGFIX: Rounding of scores to proper multiples of 10000000 on some processors.
+ - BUGFIX: Early "GOOD" judgement on a freeze arrow + jump combination fixed.
+ - BUGFIX: "New" tag treated properly again.
+ - BUGFIX: Random AVI search assumed any file was an AVI, without checking extension.
+ - BUGFIX: Skin CFG file with Hex values in uppercase read properly now.
+
+v2.20.30 - November 30, 2002.
+ - General performance improvements.
+ - Options left-over from main game removed in demo.
+ - Command-line options added for fine-tuning memory usage (WinNT/2k/XP).
+ - Time displayed in developer mode should be correct now at different speeds.
+ - Can disable lyrics from the Options menu.
+ - BUGFIX: Genre tag correctly parsed again.
+ - BUGFIX: GeForce/Detonator drivers bug fixed.
+ - BUGFIX: Corrections to Lyric file handling (timestamps, no return after last line)
+
+v2.20.10 - November 21, 2002.
+ - Lyrics now displayed in Test mode
+ - Lyrics now enabled for songs with positive GAP values
+ - SMANIAC songs selectable in extra stages even if /showsm not used.
+ - STREAM bar glows on final tally screen if you've AAA'd all songs(!)
+ - backgrounds and banners with upper-case extensions now recognised correctly
+ - in addition to PNG files, JPGs and BMPs can be used as backgrounds.
+ - "OK" flash for Reverse-scrolling arrows added
+ - Songlist.html only written if files added/updated/deleted
+
+v2.20.00 - November 20, 2002.
+ - NEW: "Final Tally" screen added if number of stages not set to "Unlimited".
+ - NEW: Timer added to developer mode.
+ - NEW: Support for lyrics during songs added through use of "LRC" files.
+ - NEW: "/skipsearch" command line argument added.
+ - Ability to reset songlist completely from Options Menu.
+ - BUGFIX: Groove Radar values calculated correctly again.
+ - BUGFIX: "Lost life" sound playing during Arcade mode removed.
+ - BUGFIX: Sample now played when combo jumps from 99..101.
+ - BUGFIX: "Skipped" notes in autoplay fixed.
+ - BUGFIX: Stream bar glows in Evaluation Screen if full combo and combo mode set
+ to "ORIGINAL"
+ - BUGFIX: Folders with no files in them handled better when searching for files.
+
+v2.10.00 - November 12, 2002.
+ - NEW: Songlist rebuild is now automatic and time for incremental updates has been
+ dramatically reduced, as the whole song database does not get rebuilt from
+ scratch each time now. (NB: Special thanks to uKER for his code that
+ implements this).
+ - NEW: Extra stages implemented - extra stages can be defined in CRS files, or
+ random songs are chosen automatically.
+ - NEW: Extra character support in song titles, course titles, and artist names
+ now possible with new tags to DWI format.
+ - NEW: Various drop-shadow colours can be defined in the skin-configuration file.
+ - NEW: "Flash" added for "OK" on freeze-arrows.
+ - NEW: DWI now uses version 1.7 of the BASS sound library.
+ - NEW: "/dark" added for Developer mode.
+ - NEW: "+" modifier added to "#SAMPLESTART:" tag - the GAP value is used as a
+ reference.
+ - Autoplay now possible in Nonstop mode.
+ - Centre positions for combo and judgement displays adjusted.
+ - movie decoding performance improved slightly.
+ - game starts at a default of 60FPS now. Adjust with '/fps:xx' command-line.
+ - selecting difficulty on song-select screen requires discrete button presses, so
+ it won't cycle accidentally.
+ - BUGFIX: 'empty' space below song-names on Course selection screen corrected.
+ - BUGFIX: Various graphical glitches corrected.
+ - BUGFIX: 'negative percentages' in Nonstop mode fixed.
+ - BUGFIX: 'broken freeze arrows' glitch fixed.
+ - VARIOUS: various other tweaks and fixes that I can't remember. ;)
+
+v2.03.00 - September 12, 2002.
+ - NEW: 'Global GAP' adjustment added to System Options (affects all files)
+ - NEW: Ability to reset 'Player's Best" list added to Options.
+ - NEW: Rebuilding songlist also creates 'dwi2-songlist.html', for easier reference.
+ - colour for random songs in Nonstop mode brightened.
+ - switching from a song with CHALLENGE steps to one without that set reverts to HEAVY, not LIGHT.
+ - small graphical bug with freeze arrows ending cleaned up.
+ - freeze arrow graphics updated for up-left/up-right.
+ - new Nonstop course banner to replace the old ugly one. ;) (thanks, Cave)
+ - more Q/A added to FAQ.html
+ - BUGFIX: Scoring precision improved to make 'AAA'd songs add up correctly.
+ - BUGFIX: extra 'ticks' being played with "Little" mode on.
+ - BUGFIX: 'invisible' steps being played when Autoplay was on in "Little" mode.
+ - BUGFIX: jumping to a specific spot with different speeds in Developer mode corrected.
+ - BUGFIX: starting a song with "Start" in SDL mode won't automatically take you to Options screen.
+ - BUGFIX: arrows loaded correctly when switching skins again.
+
+v2.02.00 - August 16, 2002.
+ - NEW: Freeze arrows with normal steps at same time have both arrows in
+ freeze-colour.
+ - NEW: Up-left and up-right arrows in Solo mode redone to match other arrows.
+ - NEW: SOLO arrow set available in Options.
+ - NEW: Rebuilding Songlist now provides information on status
+ instead of appearing to 'freeze'.
+ - Numeric Keypad's 'ENTER' key now re-enabled.
+ - BUGFIX: Grading system fixed ('points' value correctly calculated now).
+ - BUGFIX: Problem with 'skipped' steps not registering in Nonstop mode fixed.
+ - BUGFIX: ESCAPE handled better under new keyboard method.
+ - BUGFIX: Can now exit developer mode properly.
+ - BUGFIX: problem with REVERSE and HIDDEN in CRS files fixed.
+ - BUGFIX: locking up in some DWIs with animated backgrounds fixed.
+ - BUGFIX: jumps treated correctly again.
+
+v2.01.10 - August 12, 2002.
+ - '/showsm' will show SMANIAC-only songs on the select screen, otherwise they're hidden
+ - All keys now read using DirectInput (or SDL) instead of using old Windows interfaces. So
+ problems with Escape and F1..F12 should be fixed now.
+ - BUGFIX: doubling of time in Nonstop Versus mode fixed
+ - BUGFIX: lives added properly now in Nonstop Doubles and Solo modes.
+ - BUGFIX: after rebuilding songlist, starting in Single mode should behave now.
+
+v2.01.00 - August 11, 2002.
+ - NEW: Press up-left ("sort") button on Results screen to switch to percentage-display
+ - NEW: Credits screen finally added. Thanks to all who have helped. :)
+ - NEW: Support for more than two panels at a time in a jump. (DWI specification tweaked slightly)
+ - NEW: '/v5hack' command-line argument for some strange Voodoo card drivers. Might
+ fix problems on Voodoo cards if you can't get it working right.
+ - NEW: Ability to specify number of lives added after each stage in Nonstop mode. Also changed
+ default behavior to give back lives in relation to difficulty of song just played.
+ - Groove radar values calculated better; now Chaos gives a better value, and all values are in
+ relation to the length of the song now (so extended-length songs don't give too-large values).
+ - Songs with only SMANIAC steps are now selectable in regular song-select screen.
+ - If current difficulty selected is 'bumped' when moving to a song that doesn't have that set of
+ steps, it'll go back to that setting when the next song that does is selected.
+ - Wrapping of song-titles tweaked to wrap on " -", not just "-".
+ - Power bar 'sliding' behavior tweaked.
+ - In Options Menu, currently-selected item is remembered when returning from sub-menus.
+ - Maximum number of songs allowed upped to 2048.
+ - BUGFIX: going to course-select screen after rebuilding songlist should work correctly now.
+ - BUGFIX: starting a song with 'start' on a gamepad won't take you to the options screen unless
+ you hold it now.
+ - BUGFIX: 'beat' counter behavior fixed for when a BPM-pause/freeze occurs.
+ - BUGFIX: animations should behave now when speed is altered.
+
+v2.00.52 - I released the DirectInput implementation too soon, sorry. This should solve the
+ issues with DX mode in some operating systems, and SDL mode.
+
+v2.00.5 - August 2, 2002.
+ - I now have WindowsXP... yay... so now I can test DWI in it...
+ - 'white flashes' during video playback fixed.
+ - grading system (rounding) bug fixed... (I think...).
+ - keyboard input now uses DirectInput for most things, instead of Windows functions -
+ should hopefully be faster and avoid some lag problems some have been experiencing.
+ - second set of keyboard inputs can be configured now.
+ - can't change sort method after choosing "ROULETTE" anymore.
+
+v2.00.3 - July 25, 2002.
+ - fixes a number of graphical problems related to songs with positive GAP values.
+ - groove radar calculations now a bit more tolerant of mistakes in files.
+ - .75x and .5x modifiers corrected in Options screen.
+ - Stealth now selectable through both methods.
+ - New freeze arrow 'flash' animation as earlier version was getting mixed reviews. ;)
+ - fixed Roulette when "Sort by Genre" is used.
+ - Difficulty tweaked slightly.
+ - Failure of stage behaves properly again.
+
+ - IMPORTANT - I meant to do this with the first release of 2.00, but forgot -
+ DWI2's configuration is stored in 'dwi2.cfg', 'dwi2.sng', 'dwi2.rec', etc.
+ IF YOU HAVE BEEN RUNNING v2.00, PLEASE RENAME 'dance.*' 'dwi2.*'.
+ Sorry for the inconvenience.
+
+v2.00.0 - July 22, 2002.
+ - Completely overhauled DWI's interface. The 'brushed metal' look is out in favor
+ of a new, more colourful design
+ - New, more readable and stylish font
+ - optional timer on gameplay screens to hurry things up
+ - hold 'START' when selecting a song to open up a new 'select options' screen
+ ('SELECT' will still let you change options as before also).
+ - DWI2 has removed old interfaces that I feel are outdated and in the process makes
+ it much easier to update. At the same time, the base skin has been updated
+ considerably. (NB: old skins will not be recognized, sorry...)
+ - Nonstop Mode now keeps track of time, percent, etc.
+ - MAX2 scoring and grading system
+ - Smooth animations for judgements, combo display
+ - New animation for song start/end
+ - Groove Radar implemented (values calculated when Songlist is rebuilt)
+ - Roulette added to song-select screen
+ - 5th/MAX-style power bars and gameplay interfaces, freeze arrows, etc.
+ - completely redone evaluation screen
+ - usernames taken out - they were a pain to put in anyway
+ - Song banners now used on song-select screen if available. Can be horizontal or
+ old diagonal-style (backgrounds used as before if no banner found)
+ - Records screen now keeps track of Nonstop records too
+ - new option '/fps:xx' lets you set a maximum framerate (20..100); saves processor
+ time for other applications if you've got a fast machine
+ - multiple bugs fixed.
+
+SPECIAL NOTE: DWI 2.0's skins require a file called 'dwi2-skin.cfg' to work. This is done
+ to avoid accidentally choosing an old skin.
+ The Sounds folder is very similar, but with new samples for some things. Users
+ upgrading from 1.7 and lower should run 'convert.bat', which does the following:
+ 1) copy all files from \eval\S to \eval\SS
+ 2) rename \eval\SS \eval\AA
+ 3) rename \eval\SSS \eval\AAA
+ 4) remove \eval\S
+ 5) move all files from \select\song to \start\ready
+ 6) remove \select\song. (You can also delete \select\new)
+
+v1.70.0 - June 17, 2002.
+ - New method for creating Nonstop Mode courses - introduction of "CRS" file format.
+ This should allow for easier creation of Nonstop Mode courses. See below for details.
+ - Removed all old Nonstop-mode sections.
+ - New Nonstop Course selection screen. Banners can be given to a course. Also allows for
+ playing defined courses in different modes.
+ - Two people can play Nonstop mode courses at the same time.
+ - Better record keeping for Nonstop mode courses.
+ - Style Select Screen modified. SOLO mode is now selected by pressing up/down there.
+ - New "Failed" sequence - arrows stop and fade out now instead of still scrolling.
+ - Freeze arrow behavior tweaked.
+ - Combo system can be chosen in Options Screen.
+ - New command line argument "/sdevice:x" can tell DWI what sound device to use.
+ (view dance.log to see a listing of available devices first).
+
+v1.65.5 - June 7, 2002.
+ - Added sound effect for when you lose a life in Nonstop "Combo" mode.
+ - Updated freeze arrows to behave more like MAX.
+ - Freeze-arrows don't do as much damage as they used to. ;)
+ - MAX-like combo system.
+
+v1.65.0 - May 26, 2002.
+ - Added random background animations. Put looping AVIs into ./Movies/Random
+ and DWI will use them automatically in the backgrounds for songs with
+ no background script.
+ - Random animations can be enabled/disabled in the System Options.
+ - Addition of four new tags to DWI files:
+ #RANDSEED:x; - provide a number that will influence what AVIs DWI picks.
+ Will be the same animation each time if AVI filenames and count
+ doesn't change (default is random each time).
+ #RANDSTART:x; - tells DWI what beat to start the animations on. Default is 32.
+ #RANDFOLDER:...; - tells DWI to look in another folder when choosing AVIs,
+ allowing 'themed' folders.
+ #RANDLIST:...; - a list of comma-separated filenames to use in the folder.
+
+ - Ability to tweak timings for judging Perfect, Great, etc. steps in System Options.
+ - New "Select Style" interface added (default now for "DWI (Second Interface)" skin).
+ Use "SelectStyle=2" under "[GENERAL]" in the 'dwi-skin.cfg' file to enable.
+ - Crowd cheers or moans during gameplay based on performance.
+ - Music loop added to "Select Style" screens.
+ - Routine for displaying background animations put into separate thread now.
+ - New command-line argument: '/priority:x' can force DWI to run as a more "important"
+ program under Windows. "1" starts it as "ABOVE NORMAL", "2" is "TIME CRITICAL". May
+ improve performance in certain cases.
+ - BUGFIX: Selecting an SMANIAC song after a previous one in 1st Interface fixed.
+ - Other various bugfixes that I can't remember. ;)
+
+v1.62.3 - May 6, 2002.
+ - Minor bug fixes. Main change is a tweak to the /test: command line arguments to
+ accommodate folders on other drives to faciliate step-file creator authors.
+
+v1.62.2 - April 18, 2002.
+ - Speed of song can now be set to faster than normal play using F3/F4 during gameplay or
+ at song select screen (1..5..9).
+ - bug fix: BPM shift won't reset background animation.
+ - bug fix: GAP adjustment should behave better now.
+ - More developer functions added:
+ /startat:
+
+9. FUTURE DEVELOPMENT AND THANKS
+ +A long time was spent making this program, and I believe that this first release is fairly complete in terms of features. New features will be considered as resources and interest permit.
+ +Special thanks go to DjDraftHorse for the announcer files - I think he did a fantastic job, very professional. Also he has been a great beta-tester and a sounding board for new ideas. Much appreciated!
+ +Also, a huge 'thank you' to BemaniRuler for beta-testing the program and your enthusiasm for the project. He's been a great help in creating the new interfaces and I appreciate him letting me incorporate some of his graphics from his earlier skins in the release of DWI 2.0.
+ +Thanks also to Durikkan for his help in implementing the Groove Radar - the values used are based off of his algorithm.
+ +BBW, for putting up with my incessant programming of the simulator and my exhorting of the joys of Bemani. ;)
+ +LagGed and the others at "The Melting Pot" for the resources available there concerning the file formats and other simulators, and his offer to host the distribution files. uKER for taking it upon himself to write some better code for song-management which I was able to implement into the main DWI code. YrevaTeneb for his writeup on how to create DWI files at the Melting Pot, and for permission to list it here. Also a special thanks to Apocalypse for his insight in getting DirectX working.
+ +Pawwaves to those in the furry community. :^)
+ +Enjoy...
+SimWolf.
+ The ActorFrame that is returned is the wrapper state, for convenience.
+ An Actor can have any number of wrapper states. Use GetWrapperState to access wrapper states for the actor. + @return ActorFrame +--]] +function Actor:AddWrapperState() +end + +--[[-- + Returns the number of wrapper states the actor has. + @return ActorFrame +--]] +function Actor:GetNumWrapperStates() +end + +--[[-- + Returns the wrapper state at index i. Think of wrapper states with a higher index as being "further out". Actor is inside Wrapper 1, Wrapper 1 is inside Wrapper 2, Wrapper 2 is inside Wrapper 3, and so on. + @return ActorFrame +--]] +function Actor:GetWrapperState(i) +end + +--[[-- + Removes the wrapper state at index i. + @return +--]] +function Actor:RemoveWrapperState(int, i) +end + +--[[-- + Returns the Actor's parent, or
nil if it doesn't have one.
+ @return Actor
+--]]
+function Actor:GetParent()
+end
+
+--[[--
+ Returns the Actor's fake parent, or nil if it doesn't have one.
+ @return Actor
+--]]
+function Actor:GetFakeParent()
+end
+
+--[[--
+ Sets the Actor's fake parent to p, or clears it if p is nil.
+ @return
+--]]
+function Actor:SetFakeParent(Actor, p)
+end
+
+--[[--
+ Returns the Actor's visibility.
+ @return bool
+--]]
+function Actor:GetVisible()
+end
+
+--[[--
+ Returns the Actor's x position.
+ @return float
+--]]
+function Actor:GetX()
+end
+
+--[[--
+ Returns the Actor's y position.
+ @return float
+--]]
+function Actor:GetY()
+end
+
+--[[--
+ Returns the Actor's z position.
+ @return float
+--]]
+function Actor:GetZ()
+end
+
+--[[--
+ Returns what the Actor's x position will be when it reaches its destination tween state.
+ @return float
+--]]
+function Actor:GetDestX()
+end
+
+--[[--
+ Returns what the Actor's y position will be when it reaches its destination tween state.
+ @return float
+--]]
+function Actor:GetDestY()
+end
+
+--[[--
+ Returns what the Actor's z position will be when it reaches its destination tween state.
+ @return float
+--]]
+function Actor:GetDestZ()
+end
+
+--[[--
+ Returns the Actor's zoom.
+ @return float
+--]]
+function Actor:GetZoom()
+end
+
+--[[--
+ Returns the Actor's X zoom.
+ @return float
+--]]
+function Actor:GetZoomX()
+end
+
+--[[--
+ Returns the Actor's Y zoom.
+ @return float
+--]]
+function Actor:GetZoomY()
+end
+
+--[[--
+ Returns the Actor's Z zoom.
+ @return float
+--]]
+function Actor:GetZoomZ()
+end
+
+--[[--
+ Sets Texture Filtering for an Actor to b.
+ @return void
+--]]
+function Actor:SetTextureFiltering(bool, b)
+end
+
+--[[--
+ Plays the commands that follow at an accelerated rate (fRate * fRate), where fRate is in seconds.
+ @return void
+--]]
+function Actor:accelerate(float, fRate)
+end
+
+--[[--
+ Adds a command to the Actor.
+ @return void
+--]]
+function Actor:addcommand(string, sName, ActorCommand, cmd)
+end
+
+--[[--
+ Adds rot to the Actor's current x rotation.
+ @return void
+--]]
+function Actor:addrotationx(float, rot)
+end
+
+--[[--
+ Adds rot to the Actor's current y rotation.
+ @return void
+--]]
+function Actor:addrotationy(float, rot)
+end
+
+--[[--
+ Adds rot to the Actor's current z rotation.
+ @return void
+--]]
+function Actor:addrotationz(float, rot)
+end
+
+--[[--
+ Adds xPos to the Actor's current x position.
+ @return void
+--]]
+function Actor:addx(float, xPos)
+end
+
+--[[--
+ Adds yPos to the Actor's current y position.
+ @return void
+--]]
+function Actor:addy(float, yPos)
+end
+
+--[[--
+ Adds zPos to the Actor's current z position.
+ @return void
+--]]
+function Actor:addz(float, zPos)
+end
+
+--[[--
+ Sets the alignment of an Actor, where h and v are in the range 0..1.
+ @return void
+--]]
+function Actor:align(h, v)
+end
+
+--[[--
+ Sets whether or not the Actor should animate.
+ @return void
+--]]
+function Actor:animate(bool, b)
+end
+
+--[[--
+ Sets the Actor's aux value. (This can be a solution for coupling data with an Actor.)
+ @return void
+--]]
+function Actor:aux(float, fAux)
+end
+
+--[[--
+ If true, cull the Actor's back faces. See also: .
+ @return void
+--]]
+function Actor:backfacecull(bool, b)
+end
+
+--[[--
+ Sets the Actor's base alpha to fAlpha, where fAlpha is in the range 0..1.
+ @return void
+--]]
+function Actor:basealpha(float, fAlpha)
+end
+
+--[[--
+ Sets the Actor's base X rotation to rot.
+ @return void
+--]]
+function Actor:baserotationx(float, rot)
+end
+
+--[[--
+ Sets the Actor's base Y rotation to rot.
+ @return void
+--]]
+function Actor:baserotationy(float, rot)
+end
+
+--[[--
+ Sets the Actor's base Z rotation to rot.
+ @return void
+--]]
+function Actor:baserotationz(float, rot)
+end
+
+--[[--
+ Sets the Actor's base zoom to zoom.
+ @return void
+--]]
+function Actor:basezoom(float, zoom)
+end
+
+--[[--
+ Sets the Actor's base X zoom to zoom.
+ @return void
+--]]
+function Actor:basezoomx(float, zoom)
+end
+
+--[[--
+ Sets the Actor's base Y zoom to zoom.
+ @return void
+--]]
+function Actor:basezoomy(float, zoom)
+end
+
+--[[--
+ Sets the Actor's base Z zoom to zoom.
+ @return void
+--]]
+function Actor:basezoomz(float, zoom)
+end
+
+--[[--
+ Sets the Actor to use the specified blend mode.
+ @return void
+--]]
+function Actor:blend(BlendMode, mode)
+end
+
+--[[--
+ Makes the Actor bob up and down. Can use to define different bobbing behavior.
+ @return void
+--]]
+function Actor:bob()
+end
+
+--[[--
+ Makes the Actor bounce, similar to bob but with one point acting as the ground. Can use to define different bouncing behavior (with effectmagnitude values relating to x, y, and z movement).
+ @return void
+--]]
+function Actor:bounce()
+end
+
+--[[--
+ --]]
+function Actor:bounce(time)
+end
+
+--[[--
+ --]]
+function Actor:bouncebegin(time)
+end
+
+--[[--
+ --]]
+function Actor:bounceend(time)
+end
+
+--[[--
+ Centers an Actor on the screen. (equivalent to x,SCREEN_CENTER_X;y,SCREEN_CENTER_Y)
+ --]]
+function Actor:Center(time)
+end
+
+--[[--
+ Centers an Actor on the X axis. (equivalent to x,SCREEN_CENTER_X)
+ --]]
+function Actor:CenterX(time)
+end
+
+--[[--
+ Centers an Actor on the y axis. (equivalent to y,SCREEN_CENTER_Y)
+ --]]
+function Actor:CenterY(time)
+end
+
+--[[--
+ Determines if the z-buffer should be cleared or not.
+ @return void
+--]]
+function Actor:clearzbuffer(bool, bClear)
+end
+
+--[[--
+ Combines multiple interpolators for complex tweens. tweens
+ can either be a string like "linear,0.25,accelerate,0.75" or
+ a table with tween information { {Type="linear", Percent=0.25, Bezier=nil}, {Type="accelerate", Percent=0.75, Bezier=nil} }
+ @tparam number length
+ @tparam string tweens
+ @return void
+--]]
+function Actor:compound(length, tweens)
+end
+
+--[[--
+ Crops percent of the Actor from the bottom, where percent is in the range 0..1.
+ @return void
+--]]
+function Actor:cropbottom(float, percent)
+end
+
+--[[--
+ Crops percent of the Actor from the left, where percent is in the range 0..1.
+ @return void
+--]]
+function Actor:cropleft(float, percent)
+end
+
+--[[--
+ Crops percent of the Actor from the right, where percent is in the range 0..1.
+ @return void
+--]]
+function Actor:cropright(float, percent)
+end
+
+--[[--
+ Crops percent of the Actor from the top, where percent is in the range 0..1.
+ @return void
+--]]
+function Actor:croptop(float, percent)
+end
+
+--[[--
+ Sets the Actor's cull mode to mode.
+ @return void
+--]]
+function Actor:cullmode(CullMode, mode)
+end
+
+--[[--
+ Plays the commands that follow at an decelerated rate (1 - (1-fRate) * (1-fRate)), where fRate is in seconds.
+ @return void
+--]]
+function Actor:decelerate(float, fRate)
+end
+
+--[[--
+ Set the Actor's diffuse color to c.
+ @return void
+--]]
+function Actor:diffuse(color, c)
+end
+
+--[[--
+ Sets the Actor's alpha level to fAlpha, where fAlpha is in the range 0..1.
+ @return void
+--]]
+function Actor:diffusealpha(float, fAlpha)
+end
+
+--[[--
+ Makes the Actor switch between two colors immediately. See Themerdocs/effect_colors.txt for an example.
+ @return void
+--]]
+function Actor:diffuseblink()
+end
+
+--[[--
+ Sets the Actor's bottom edge color to c.
+ @return void
+--]]
+function Actor:diffusebottomedge()
+end
+
+--[[--
+ Set the Actor's diffuse color to c, ignoring any alpha value in c.
+ @return void
+--]]
+function Actor:diffusecolor(color, c)
+end
+
+--[[--
+ Sets the Actor's left edge color to c.
+ @return void
+--]]
+function Actor:diffuseleftedge(color, c)
+end
+
+--[[--
+ Sets the Actor's lower left corner color to c.
+ @return void
+--]]
+function Actor:diffuselowerleft(color, c)
+end
+
+--[[--
+ Sets the Actor's lower right corner color to c.
+ @return void
+--]]
+function Actor:diffuselowerright(color, c)
+end
+
+--[[--
+ Makes the Actor switch between two colors, jumping back to the first after reaching the second. See Themerdocs/effect_colors.txt for an example.
+ @return void
+--]]
+function Actor:diffuseramp()
+end
+
+--[[--
+ Sets the Actor's right edge color to c.
+ @return void
+--]]
+function Actor:diffuserightedge(color, c)
+end
+
+--[[--
+ Makes the Actor shift between two colors smoothly. See Themerdocs/effect_colors.txt for an example.
+ @return void
+--]]
+function Actor:diffuseshift()
+end
+
+--[[--
+ Sets the Actor's top edge color to c.
+ @return void
+--]]
+function Actor:diffusetopedge(color, c)
+end
+
+--[[--
+ Sets the Actor's upper left corner color to c.
+ @return void
+--]]
+function Actor:diffuseupperleft(color, c)
+end
+
+--[[--
+ Sets the Actor's upper right corner color to c.
+ @return void
+--]]
+function Actor:diffuseupperright(color, c)
+end
+
+--[[--
+ Tells the Actor to draw itself.
+ @return void
+--]]
+function Actor:Draw()
+end
+
+--[[--
+ Sets the Actor's draworder to iOrder, where larger values display first.
+ @return void
+--]]
+function Actor:draworder(int, iOrder)
+end
+
+--[[--
+ Set the Actor's effect clock to s.
+ @return void
+--]]
+function Actor:drop(time)
+end
+
+--[[--
+ Set the Actor's effect clock to s.
+ @return void
+--]]
+function Actor:ease(time, ease)
+end
+
+--[[--
+ Set the Actor's effect clock to s.
+ @return void
+--]]
+function Actor:effectclock(string, s)
+end
+
+--[[--
+ Sets the first effect color to c.
+ @return void
+--]]
+function Actor:effectcolor1(color, c)
+end
+
+--[[--
+ Sets the second effect color to c.
+ @return void
+--]]
+function Actor:effectcolor2(color, c)
+end
+
+--[[--
+ Set the Actor's effect magnitude in each direction to the given values.
+ @return void
+--]]
+function Actor:effectmagnitude(float, fX, float, fY, float, fZ)
+end
+
+--[[--
+ Set the Actor's effect offset to fTime. The offset is added to the time into the effect before calculating percent_through_effect.
+ @return void
+--]]
+function Actor:effectoffset(float, fTime)
+end
+
+--[[--
+ Set the Actor's effect period to fTime.
+ @return void
+--]]
+function Actor:effectperiod(float, fTime)
+end
+
+--[[--
+ Set the Actor's effect timing.+ hold_at_zero is before hold_at_full in the argument list for compatibility. A future version will probably swap them because it makes more sense to have hold_at_full come before hold_at_zero.
+ All effect timings must be greater than or equal to zero, at least one of them must be greater than zero.
+ The effect timing controls how long it takes an effect to cycle and how long it spends in each phase.
+ Depending on the effect clock, the actor's time into effect is updated every frame. That time is then translated into a percent_through_effect using the parameters to this function.
+
+ ramp_to_half is the amount of time for percent_through_effect to reach 0.5.
+ hold_at_half is the amount of time percent_through_effect will stay at 0.5.
+ ramp_to_full is the amount of time percent_through_effect will take to go from 0.5 to 1.0.
+ hold_at_full is the amount of time percent_through_effect will stay at 1.0.
+ After reaching the end of hold_at_full, percent_through_effect stays at 0 until hold_at_zero is over.
+
+ The different effects use percent_through_effect in different ways. Some use it to calculate percent_between_colors with this sine wave: sin((percent_through_effect + 0.25f) * 2 * PI ) / 2 + 0.5f
+ Some effects check the internal bool blink_on. blink_on is true if percent_through_effect is greater than 0.5 and false if percent_through_effect is less than or equal to 0.5.
+ Check the effect functions for individual explanations: diffuseblink, diffuseshift, glowblink, glowshift, glowramp, rainbow, wag, bounce, bob, pulse, spin, vibrate. + @return void +--]] +function Actor:effecttiming( + float, + ramp_to_half, + float, + hold_at_half, + float, + ramp_to_full, + float, + hold_at_zero, + float, + hold_at_full) +end + +--[[-- + Set the hold_at_full part of the effect timing while leaving the others unchanged. + @return void +--]] +function Actor:effect_hold_at_full(float, hold_at_full) +end + +--[[-- + Fades
percent of the Actor from the bottom where percent is in the range 0..1.
+ @return void
+--]]
+function Actor:fadebottom(float, percent)
+end
+
+--[[--
+ Fades percent of the Actor from the left where percent is in the range 0..1.
+ @return void
+--]]
+function Actor:fadeleft(float, percent)
+end
+
+--[[--
+ Fades percent of the Actor from the right where percent is in the range 0..1.
+ @return void
+--]]
+function Actor:faderight(float, percent)
+end
+
+--[[--
+ Fades percent of the Actor from the top where percent is in the range 0..1.
+ @return void
+--]]
+function Actor:fadetop(float, percent)
+end
+
+--[[--
+ Finishes up an Actor's tween immediately.
+ @return void
+--]]
+function Actor:finishtweening()
+end
+
+--[[--
+ Stretches an Actor to fill the entire screen.
+ @return void
+--]]
+function Actor:FullScreen()
+end
+
+--[[--
+ Returns the Actor's aux value.
+ @return float
+--]]
+function Actor:getaux()
+end
+
+--[[--
+ Returns the Actor's base X zoom value.
+ @return float
+--]]
+function Actor:GetBaseZoomX()
+end
+
+--[[--
+ Returns the Actor's base Y zoom value.
+ @return float
+--]]
+function Actor:GetBaseZoomY()
+end
+
+--[[--
+ Returns the Actor's base Z zoom value.
+ @return float
+--]]
+function Actor:GetBaseZoomZ()
+end
+
+--[[--
+ Returns true if the Actor has a command named sCmdName.
+ @return bool
+--]]
+function Actor:GetCommand(string, sCmdName)
+end
+
+--[[--
+ Returns the Actor's current diffuse color.
+ @return color
+--]]
+function Actor:GetDiffuse()
+end
+
+--[[--
+ Returns the Actor's current diffusealpha.
+ @return float
+--]]
+function Actor:GetDiffuseAlpha()
+end
+
+--[[--
+ Returns the Actor's current effect delta.
+ @return float
+--]]
+function Actor:GetEffectDelta()
+end
+
+--[[--
+ Returns the Actor's current effect magnitude as three floats (not one; I hate Lua.xsd).
+ @return float
+--]]
+function Actor:geteffectmagnitude()
+end
+
+--[[--
+ Returns the Actor's current glow color.
+ @return color
+--]]
+function Actor:GetGlow()
+end
+
+--[[--
+ Returns the Actor's horizontal alignment as a number in the range 0..1.
+ @return float
+--]]
+function Actor:GetHAlign()
+end
+
+--[[--
+ Returns the Actor's name.
+ @return string
+--]]
+function Actor:GetName()
+end
+
+--[[--
+ Returns the number of states the Actor has.
+ @return int
+--]]
+function Actor:GetNumStates()
+end
+
+--[[--
+ Returns the Actor's current height.
+ @return float
+--]]
+function Actor:GetHeight()
+end
+
+--[[--
+ Returns the Actor's current X rotation.
+ @return float
+--]]
+function Actor:GetRotationX()
+end
+
+--[[--
+ Returns the Actor's current Y rotation.
+ @return float
+--]]
+function Actor:GetRotationY()
+end
+
+--[[--
+ Returns the Actor's current Z rotation.
+ @return float
+--]]
+function Actor:GetRotationZ()
+end
+
+--[[--
+ Returns the number of seconds into the currently running effect (e.g. diffuseshift, bob).
+ @return float
+--]]
+function Actor:GetSecsIntoEffect()
+end
+
+--[[--
+ Returns how much time is remaining for the current tween.
+ @return float
+--]]
+function Actor:GetTweenTimeLeft()
+end
+
+--[[--
+ Returns the Actor's vertical alignment as a number in the range 0..1.
+ @return float
+--]]
+function Actor:GetVAlign()
+end
+
+--[[--
+ Returns the Actor's current width.
+ @return float
+--]]
+function Actor:GetWidth()
+end
+
+--[[--
+ Returns the zoomed height of an Actor.
+ @return float
+--]]
+function Actor:GetZoomedHeight()
+end
+
+--[[--
+ Returns the zoomed width of an Actor.
+ @return float
+--]]
+function Actor:GetZoomedWidth()
+end
+
+--[[--
+ Returns true if this actor is currently set to use the effect delta for tweening.
+ @return bool
+--]]
+function Actor:get_tween_uses_effect_delta()
+end
+
+--[[--
+ Sets the Actor's glow color.
+ @return void
+--]]
+function Actor:glow(color, c)
+end
+
+--[[--
+ Makes the Actor glow between two colors immediately. See Themerdocs/effect_colors.txt for an example.
+ @return void
+--]]
+function Actor:glowblink()
+end
+
+--[[--
+ Makes the Actor glow between two colors smoothly, jumping back to the first at the end. See Themerdocs/effect_colors.txt for an example.
+ @return void
+--]]
+function Actor:glowramp()
+end
+
+--[[--
+ Makes the Actor glow between two colors smoothly. See Themerdocs/effect_colors.txt for an example.
+ @return void
+--]]
+function Actor:glowshift()
+end
+
+--[[--
+ Set the fractional horizontal alignment of the Actor according to fAlign which should be a float in the range 0..1. An alignment of 0 is left aligned while an alignment of 1 is right aligned. See for the common case.
+ @return void
+--]]
+function Actor:halign(float, fAlign)
+end
+
+--[[--
+ Sets the heading of this Actor to fHeading.
+ @return void
+--]]
+function Actor:heading(float, fHeading)
+end
+
+--[[--
+ Hides the Actor for the specified amount of time.
+ @return void
+--]]
+function Actor:hibernate(float, fTime)
+end
+
+--[[--
+ Compatibility alias for the hidden command, which was removed in sm-ssc. Use instead.
+ @tparam boolean b
+ @return void
+--]]
+function Actor:hidden(b)
+end
+
+--[[--
+ Compatibility alias for the hidden command, which was removed in sm-ssc. Use `visible` instead.
+ @tparam boolean b
+ @return void
+--]]
+function Actor:hide_if(b)
+end
+
+--[[--
+ Set the horizontal alignment of the Actor according to align. See for fractional alignment.
+ @return void
+--]]
+function Actor:horizalign(HorizAlign, align)
+end
+
+--[[--
+ Hurries up an Actor's tweening by factor.
+ @return void
+--]]
+function Actor:hurrytweening(float, factor)
+end
+
+--[[--
+ Plays the commands that follow at a normal rate, where fRate is in seconds.
+ @return void
+--]]
+function Actor:linear(float, fRate)
+end
+
+--[[--
+ Plays the lyric command for the specified side ("Back" or "Front").
+ @tparam string side
+ @return void
+--]]
+function Actor:linear(side)
+end
+
+--[[--
+ Sets the Actor's name to sName.
+ @return void
+--]]
+function Actor:name(string, sName)
+end
+
+--[[--
+ Stops the Actor's movement. (Usually used for Sprites or Models.)
+ @return void
+--]]
+function Actor:pause()
+end
+
+--[[--
+ Sets the pitch of this Actor to fPitch.
+ @return void
+--]]
+function Actor:pitch(float, fPitch)
+end
+
+--[[--
+ Starts the Actor's movement. (Usually used for Sprites or Models.)
+ @return void
+--]]
+function Actor:play()
+end
+
+--[[--
+ Plays a command named sCommandName. params is passed to the command as an argument if it is a table.
+ @return void
+--]]
+function Actor:playcommand(string, sCommandName, table, params)
+end
+
+--[[--
+ Sets the visibility of the Actor based on p being a human player.
+ @return void
+--]]
+function Actor:playcommand(playerNumber)
+end
+
+--[[--
+ Makes the Actor grow and shrink. Can use to define different pulsing behavior.
+ @return void
+--]]
+function Actor:pulse()
+end
+
+--[[--
+ Queues a command named sCommandName to be played.
+ @return void
+--]]
+function Actor:queuecommand(string, sCommandName)
+end
+
+--[[--
+ Basically creates a command named !sMessageName (Note the ! at the beginning. The source code says this: "Hack: use "!" as a marker to broadcast a command, instead of playing a command, so we don't have to add yet another element to every tween state for this rarely-used command.")
+ @return void
+--]]
+function Actor:queuemessage(string, sMessageName)
+end
+
+--[[--
+ Makes the Actor change colors continually using colors of the rainbow. Each channel follows a cosine wave, red starts at 0, green starts at 2pi/3, and blue starts at 4pi/3.
+ @return void
+--]]
+function Actor:rainbow()
+end
+
+--[[--
+ Sets the roll of this Actor to fRoll.
+ @return void
+--]]
+function Actor:roll(float, fRoll)
+end
+
+--[[--
+ Set the Actor's rotation on the X axis to fAlign.
+ @return void
+--]]
+function Actor:rotationx(float, fRotation)
+end
+
+--[[--
+ Set the Actor's rotation on the Y axis to fAlign.
+ @return void
+--]]
+function Actor:rotationy(float, fRotation)
+end
+
+--[[--
+ Set the Actor's rotation on the Z axis to fAlign.
+ @return void
+--]]
+function Actor:rotationz(float, fRotation)
+end
+
+--[[--
+ Set the Actor's rotation on the Z axis to fAlign.
+ @return void
+--]]
+function Actor:rotationz(float, fRotation)
+end
+
+--[[--
+ Set the Actor's rotation on the Z axis to fAlign.
+ @return void
+--]]
+function Actor:rotationz(float, fRotation)
+end
+
+--[[--
+ An alternative version of `scale_or_crop_background`
+ @return void
+--]]
+function Actor:scale_or_crop_alternative(float, fRotation)
+end
+
+--[[--
+
+ @return void
+--]]
+function Actor:scale_or_crop_background(float, fRotation)
+end
+
+--[[--
+ Scales the Actor to cover a rectangle defined by the four float arguments.
+ @return void
+--]]
+function Actor:scaletocover(float, fLeft, float, fTop, float, fRight, float, fBottom)
+end
+
+--[[--
+ Scales the Actor to fit inside a rectangle defined by the four float arguments.
+ @return void
+--]]
+function Actor:scaletofit(float, fLeft, float, fTop, float, fRight, float, fBottom)
+end
+
+--[[--
+ Sets the height of the Actor.
+ @return void
+--]]
+function Actor:SetHeight(float, height)
+end
+
+--[[--
+ Sets the size of the Actor.
+ @return void
+--]]
+function Actor:setsize(width, height)
+end
+
+--[[--
+ Alias for setsize.
+ @return void
+--]]
+function Actor:SetSize(width, height)
+end
+
+--[[--
+ Sets a multi-framed Actor's state to iNewState.
+ @return void
+--]]
+function Actor:setstate(int, iNewState)
+end
+
+--[[--
+ Sets the width of the Actor.
+ @return void
+--]]
+function Actor:SetWidth(float, width)
+end
+
+--[[--
+ Use this to make the actor use the effect clock to tween instead of using the global frame delta.
+ @return
+--]]
+function Actor:set_tween_uses_effect_delta(bool)
+end
+
+--[[--
+ Sets the shadow's color to c.
+ @return void
+--]]
+function Actor:shadowcolor(color, c)
+end
+
+--[[--
+ Sets the Actor's shadow length to fLength.
+ @return void
+--]]
+function Actor:shadowlength(float, fLength)
+end
+
+--[[--
+ Sets the Actor's horizontal shadow length to fLength.
+ @return void
+--]]
+function Actor:shadowlengthx(float, fLength)
+end
+
+--[[--
+ Sets the Actor's vertical shadow length to fLength.
+ @return void
+--]]
+function Actor:shadowlengthy(float, fLength)
+end
+
+--[[--
+ Skews the Actor on the x axis by fAmount.
+ @return void
+--]]
+function Actor:skewx(float, fAmount)
+end
+
+--[[--
+ Skews the Actor on the y axis by fAmount.
+ @return void
+--]]
+function Actor:skewy(float, fAmount)
+end
+
+--[[--
+ Waits fSeconds before executing the next command.
+ @return void
+--]]
+function Actor:sleep(float, fSeconds)
+end
+
+--[[--
+
+ @return void
+--]]
+function Actor:smooth(time)
+end
+
+--[[--
+ Tells the Actor to spin. Can use to define different spinning behavior.
+ @return void
+--]]
+function Actor:spin()
+end
+
+--[[--
+ Stops any effect the Actor has.
+ @return void
+--]]
+function Actor:stopeffect()
+end
+
+--[[--
+ Stops any tweening.
+ @return void
+--]]
+function Actor:stoptweening()
+end
+
+--[[--
+ Stretches the Actor to a rectangle of a specific size.
+ @return void
+--]]
+function Actor:stretchto(float, x1, float, y1, float, x2, float, y2)
+end
+
+--[[--
+ Translates the texture of the actor by x and y.
+ @return void
+--]]
+function Actor:texturetranslate(float, x, float, y)
+end
+
+--[[--
+ Determines if the Actor should use texture wrapping or not.
+ @return void
+--]]
+function Actor:texturewrapping(bool, bWrap)
+end
+
+--[[--
+ Uses type to determine the tween to use. The type must be one of the TweenType enum values. If the type is note TweenType_Bezier, the params table is ignored. If the type is TweenType_Bezier, then the params table must have 4 or 8 numbers. 4 numbers in the params creates a 1 dimensional bezier curve, 8 numbers creates a 2 dimensional bezier curve.+ It's usually more convenient to use Actor:linear, Actor:accelerate, and so on, rather than using Actor:tween directly. + @return void +--]] +function Actor:tween(time, tweentype, params) +end + +--[[-- + Set the fractional vertical alignment of the Actor according to
fAlign which should be a float in the range 0..1. An alignment of 0 is top aligned while an alignment of 1 is bottom aligned. See for the common case.
+ @return void
+--]]
+function Actor:valign(float, fAlign)
+end
+
+--[[--
+ Set the vertical alignment of the Actor according to align. See for fractional alignment.
+ @return void
+--]]
+function Actor:vertalign(VertAlign, align)
+end
+
+--[[--
+ Makes the Actor vibrate violently. Can use to define different vibration behavior.
+ @return void
+--]]
+function Actor:vibrate()
+end
+
+--[[--
+ Sets an Actor's visibility to b.
+ @return void
+--]]
+function Actor:visible(bool, b)
+end
+
+--[[--
+ Makes the Actor wag. Use to define different wag behavior.
+ @return void
+--]]
+function Actor:wag()
+end
+
+--[[--
+ Set the x position of the Actor to xPos.
+ @return void
+--]]
+function Actor:x(float, xPos)
+end
+
+--[[--
+ Set the y position of the Actor to yPos.
+ @return void
+--]]
+function Actor:y(float, yPos)
+end
+
+--[[--
+ Set the z position of the Actor to zPos.
+ @return void
+--]]
+function Actor:z(float, zPos)
+end
+
+--[[--
+ Sets the z bias to fBias.
+ @return void
+--]]
+function Actor:zbias(float, fBias)
+end
+
+--[[--
+ Enables/disables z-buffer depending on bUse.
+ @return void
+--]]
+function Actor:zbuffer(bool, bUse)
+end
+
+--[[--
+ Zooms the Actor to zoom scale.
+ @return void
+--]]
+function Actor:zoom(float, zoom)
+end
+
+--[[--
+ Zooms the Actor on both the X and Y axis using zoomX and zoomY.
+ @return void
+--]]
+function Actor:zoomto(float, zoomX, float, zoomY)
+end
+
+--[[--
+ Zooms the Actor to zoom height. See also: .
+ @return void
+--]]
+function Actor:zoomtoheight(float, zoom)
+end
+
+--[[--
+ Zooms the Actor to zoom width. See also: .
+ @return void
+--]]
+function Actor:zoomtowidth(float, zoom)
+end
+
+--[[--
+ Zooms the Actor to zoom scale on the X axis.
+ @return void
+--]]
+function Actor:zoomx(float, zoom)
+end
+
+--[[--
+ Zooms the Actor to zoom scale on the Y axis.
+ @return void
+--]]
+function Actor:zoomy(float, zoom)
+end
+
+--[[--
+ Zooms the Actor to zoom scale on the Z axis.
+ @return void
+--]]
+function Actor:zoomz(float, zoom)
+end
+
+--[[--
+ Sets the z testing mode to write on pass if true, turns it off if false
+ @return void
+--]]
+function Actor:ztest(bool, bTest)
+end
+
+--[[--
+ Sets the z testing mode to testMode.
+ @return void
+--]]
+function Actor:ztestmode(ZTestMode, testMode)
+end
+
+--[[--
+ Sets z writing to true or false based on bWrite.
+ @return void
+--]]
+function Actor:zwrite(bool, bWrite)
+end
+
+--[[--
+ Plays the commands that follow using a bezier curve to determine the rate. The curve must have 4 or 8 elements. This is a convenience wrapper around calling Actor:tween with TweenType_Bezier.
+ @return void
+--]]
+function Actor:bezier(time, curve)
+end
+
+--[[--
+ Stretches an Actor to cover the screen. (equivalent to stretchto,0,0,SCREEN_WIDTH,SCREEN_HEIGHT)
+ @return void
+--]]
+function Actor:FullScreen()
+end
+
+--[[--
+ Sets and Actor as a mask destination.
+ @return void
+--]]
+function Actor:MaskDest()
+end
+
+--[[--
+ Sets an Actor as a mask source. (Also clears zbuffer; other mask sources need to not clear the zbuffer)
+ @return void
+--]]
+function Actor:MaskSource()
+end
+
+--[[--
+ Make graphics their true size at any resolution.
+ @return void
+--]]
+function Actor:Real(f)
+end
+
+--[[--
+ Scale things back up after they have already been scaled down.
+ @return void
+--]]
+function Actor:RealInverse(f)
+end
+
+--[[--
+ A customized version of pulse that is more appealing for on-beat effects.
+ @return void
+--]]
+function Actor:thump(fEffectPeriod)
+end
+
+--[[--
+ Sets the x and y location of the Actor in one command.
+ @return void
+--]]
+function Actor:xy(float, actorX, float, actorY)
+end
diff --git a/Themes/_fallback/docs/ActorFrame.luadoc b/Themes/_fallback/docs/ActorFrame.luadoc
new file mode 100644
index 0000000000..eee51464f3
--- /dev/null
+++ b/Themes/_fallback/docs/ActorFrame.luadoc
@@ -0,0 +1,108 @@
+--- Actor container/composite
+-- @classmod ActorFrame
+
+
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:playcommandonchildren() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:playcommandonleaves() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:runcommandsonleaves() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:RunCommandsOnChildren() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:propagate() end // deprecated
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:fov() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:SetUpdateRate() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:GetUpdateRate() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:SetFOV() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:vanishpoint() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:GetChild() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:GetChildren() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:GetNumChildren() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:SetDrawByZPosition() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:SetDrawFunction() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:GetDrawFunction() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:SetUpdateFunction() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:SortByDrawOrder() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:SetAmbientLightColor() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:SetDiffuseLightColor() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:SetSpecularLightColor() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:SetLightDirection() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:AddChild() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:AddChildFromPath() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:RemoveChild() end
+
+---
+-- @treturn ActorFrame self
+function ActorFrame:RemoveAllChildren() end
\ No newline at end of file
diff --git a/Themes/_fallback/docs/ActorFrameTexture.luadoc b/Themes/_fallback/docs/ActorFrameTexture.luadoc
new file mode 100644
index 0000000000..2c77f0625b
--- /dev/null
+++ b/Themes/_fallback/docs/ActorFrameTexture.luadoc
@@ -0,0 +1,51 @@
+--- ActorFrameTexture (Inherits ActorFrame)
+-- @classmod ActorFrameTexture
+
+--[[--
+ Creates the ActorFrameTexture.
+ @return void
+--]]
+function ActorFrameTexture:Create()
+end
+
+--[[--
+ Enables/disables the Alpha Buffer.
+ @return void
+--]]
+function ActorFrameTexture:EnableAlphaBuffer(bool, bEnable)
+end
+
+--[[--
+ Enables/disables the Depth Buffer.
+ @return void
+--]]
+function ActorFrameTexture:EnableDepthBuffer(bool, bEnable)
+end
+
+--[[--
+ Enables/disables
+ @return void
+--]]
+function ActorFrameTexture:EnableFloat(bool, bEnable)
+end
+
+--[[--
+ Enables/disables the Preserve Texture option.
+ @return void
+--]]
+function ActorFrameTexture:EnablePreserveTexture(bool, bEnable)
+end
+
+--[[--
+ Returns the texture.
+ @return RageTexture
+--]]
+function ActorFrameTexture:GetTexture()
+end
+
+--[[--
+ Sets the Texture's name to sName.
+ @return void
+--]]
+function ActorFrameTexture:SetTextureName(string, sName)
+end
diff --git a/Themes/_fallback/docs/ActorMultiVertex.luadoc b/Themes/_fallback/docs/ActorMultiVertex.luadoc
new file mode 100644
index 0000000000..eeca14db66
--- /dev/null
+++ b/Themes/_fallback/docs/ActorMultiVertex.luadoc
@@ -0,0 +1,306 @@
+--- ActorMultiVertex (Inherits `Actor`)
+-- @classmod ActorMultiVertex
+
+--[[--
+ The list of quad states is used to determine which animation state is used for each quad. The offset is added to the AMV's current state, and the resulting state is used.
+ @return
+--]]
+function ActorMultiVertex:AddQuadState(offset)
+end
+
+--[[--
+ Adds an animation state to the ActorMultiVertex. The state_data table must be like this:+ {{left, top, right, bottom}, delay}
+ left, top, right, and bottom are pixel coordinates, starting at 0. If delay is 0 or negative, the state will last forever. + @return +--]] +function ActorMultiVertex:AddState(table, state_data) +end + +--[[-- + Forces the AMV to update the texture coordinates on all its quads, even if the current state has not changed. + @return +--]] +function ActorMultiVertex:ForceStateUpdate() +end + +--[[-- + Returns whether the AMV uses the animation state. + @return bool +--]] +function ActorMultiVertex:GetUseAnimationState() +end + +--[[-- + Sets whether the AMV uses the animation state.
+ This works best when using DrawMode_Quads.
+ AMV's can have animated textures like sprites. Each state tells the AMV what part of the texture to use, and how long the state lasts.
+ Use AddState to add a state onto the end, or SetStateProperties to set all the states at once, or SetState to set a single state.
+ Each quad has its own offset that is added to the current state. Use AddQuadState to add to the list of quad states, or SetQuadState to set an existing quad state. + @tparam boolean use + @return void +--]] +function ActorMultiVertex:SetUseAnimationState(use) +end + +--[[-- + Returns the number of states the AMV has. + @return int +--]] +function ActorMultiVertex:GetNumStates() +end + +--[[-- + Returns the number of quad states in the destination tween state for the AMV. + @return int +--]] +function ActorMultiVertex:GetNumQuadStates() +end + +--[[-- + Returns the id of the current state. + @return int +--]] +function ActorMultiVertex:GetState() +end + +--[[-- + Gets whether the AMV should call the decode function for its texture during updates. + @return bool +--]] +function ActorMultiVertex:GetDecodeMovie() +end + +--[[-- + Sets whether the AMV should call the decode function for its texture during updates. + @return +--]] +function ActorMultiVertex:SetDecodeMovie(bool, decode) +end + +--[[-- + Sets vertex number
index with the properties provided. The tables of properties are each optional and can be provided in any order.
+ @tparam number index
+ @tparam table { table pos, table color, table textcoords }
+ @return void
+--]]
+function ActorMultiVertex:SetVertex(index, table)
+end
+
+--[[--
+ Sets multiple vertices at once. The elements of vertices should themselves be tables, of the form provided to SetVertex. If vertices is the first argument it will start from vertex 1. If an integer is provided before vertices it will start from that vertex. It will add vertices as necessary.
+ Example: self:SetVertices( { { { x1, y1, z1 } , { r1,g1,b1,a1 } , { tcx1,tcy1 } }; { { x2, y2, z2 } , { r2,g2,b2,a2 } , { tcx2,tcy2 } } } )
+ @return void
+--]]
+function ActorMultiVertex:SetVertices(first, vertices)
+end
+
+--[[--
+ Sets all the drawn verts of the ActorMultiVertex by evaluating the splines.+ ("all the drawn verts" means all the verts between FirstToDraw and NumToDraw, the verts that are set to draw in the current tween state.)
+ The parts of the ActorMultiVertex are evenly spaced along the spline in terms of t value.
+ The exact behavior depends on the draw mode.
+ DrawMode_Quads uses all 4 splines, one for each corner.
+ DrawMode_QuadStrip and DrawMode_Strip use 2 splines, one for each edge of the strip.
+ DrawMode_Fan uses one spline, for the edge verts of the fan. The first vert is not touched because it is the center.
+ DrawMode_Triangles uses 3 splines, one for each corner.
+ DrawMode_SymmetricQuadStrip uses 3 splines, one on each edge and one in the center.
+ DrawMode_LineStrip uses 1 spline.
+ @return +--]] +function ActorMultiVertex:SetVertsFromSplines() +end + +--[[-- + Returns the requested spline. Spline indices range from 1 to 4.
+ ActorMultiVertex splines are not inside the tween state, and will not change the verts until you call SetVertsFromSplines. + @return CubicSplineN +--]] +function ActorMultiVertex:GetSpline(i) +end + +--[[-- + Sets the number of vertices. + @return void +--]] +function ActorMultiVertex:SetNumVertices(num) +end + +--[[-- + Returns the number of vertices + @return void +--]] +function ActorMultiVertex:GetNumVertices(void) +end + +--[[-- + Sets the draw state variables to the values in the table.
+ Mode must be a DrawMode.
+ First is the index of the first vertex to draw.
+ Num is the number of vertices to draw. -1 for Num means draw all verts after First.
+ Any value not in the table defaults to the already set value.
+ Examples:
+ -- Sets all three parts of the draw state.
+ self:SetDrawState{Mode="DrawMode_Quads", First= 1, Num= -1}
+ -- Set only the draw mode. First and Num remain unchanged from previous.
+ self:SetDrawState{Mode="DrawMode_Quads"}
+ -- Set the first and number to draw. Draw mode remains unchanged.
+ self:SetDrawState{First= 3, Num= 4}
+ @tparam table table { Mode= mode, First= first, Num= num } + @return void +--]] +function ActorMultiVertex:SetDrawState(table) +end + +--[[-- + Sets the current state. + @return void +--]] +function ActorMultiVertex:SetState(int) +end + +--[[-- + Returns the offset of the requested quad state. + @return int +--]] +function ActorMultiVertex:GetQuadState(void) +end + +--[[-- + Sets the offset of the requested quad state. + @return void +--]] +function ActorMultiVertex:SetQuadState(id, offset) +end + +--[[-- + Returns a table containing the data for the requested state. + @return table +--]] +function ActorMultiVertex:GetStateData(id) +end + +--[[-- + Sets the requested state to the data in state_data. Similar to AddState, but SetStateData only works on states that have already been added. + @return void +--]] +function ActorMultiVertex:SetStateData(id, table) +end + +--[[-- + Each element of the table must be a state_data and is used to construct one state. The table as a whole is the entire list of all states for the AMV. + @tparam table table {state_data, ...} + @return void +--]] +function ActorMultiVertex:SetStateProperties(table) +end + +--[[-- + Removes the requested state from the state list. +--]] +function ActorMultiVertex:RemoveState(id) +end + +--[[-- + Removes the requested quad state from the quad state list. + @return table +--]] +function ActorMultiVertex:RemoveQuadState(id) +end + +--[[-- + Sets the delay for every state to delay. (seconds) +--]] +function ActorMultiVertex:SetAllStateDelays(delay) +end + +--[[-- + Sets how far into its animation the AMV is. + @return table +--]] +function ActorMultiVertex:SetSecondsIntoAnimation(seconds) +end + +--[[-- + Get the DrawMode of the destination tween state. + @return DrawMode +--]] +function ActorMultiVertex:GetDestDrawMode(void) +end + +--[[-- + Get the FirstToDraw of the destination tween state. + @return int +--]] +function ActorMultiVertex:GetDestFirstToDraw(void) +end + +--[[-- + Get the NumToDraw of the destination tween state. + @return int +--]] +function ActorMultiVertex:GetDestNumToDraw(void) +end + +--[[-- + Get the DrawMode of the current tween state. + @return DrawMode +--]] +function ActorMultiVertex:GetCurrDrawMode(void) +end + +--[[-- + Get the FirstToDraw of the current tween state. + @return int +--]] +function ActorMultiVertex:GetCurrFirstToDraw(void) +end + +--[[-- + Get the NumToDraw of the current tween state. + @return int +--]] +function ActorMultiVertex:GetCurrNumToDraw(void) +end + +--[[-- + Returns the ActorMultiVertex's texture. + @return RageTexture +--]] +function ActorMultiVertex:GetTexture() +end + +--[[-- + Sets the EffectMode of the ActorMultiVertex. + @return void +--]] +function ActorMultiVertex:SetEffectMode(EffectMode, em) +end + +--[[-- + Sets the TextureMode of the ActorMultiVertex. + @return void +--]] +function ActorMultiVertex:SetTextureMode(TextureMode, tm) +end + +--[[-- + Sets the width of the line for DrawMode_LineStrip. + @return void +--]] +function ActorMultiVertex:SetLineWidth(float, width) +end + +--[[-- + Sets the texture to
texture
+ @return void
+--]]
+function ActorMultiVertex:SetTexture(RageTexture, texture)
+end
+
+--[[--
+ Sets the texture at from the file path path.
+ @return void
+--]]
+function ActorMultiVertex:LoadTexture(string, path)
+end
diff --git a/Themes/_fallback/docs/BitmapText.luadoc b/Themes/_fallback/docs/BitmapText.luadoc
new file mode 100644
index 0000000000..0a88128e9b
--- /dev/null
+++ b/Themes/_fallback/docs/BitmapText.luadoc
@@ -0,0 +1,74 @@
+--- Font actor
+-- @classmod BitmapText
+
+
+---
+-- @treturn BitmapText self
+function BitmapText:wrapwidthpixels() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:maxwidth() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:maxheight() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:max_dimension_use_zoom() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:vertspacing() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:settext() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:rainbowscroll() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:jitter() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:distort() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:undistort() end
+ ADD_GET_SET_METHODS(mult_attrs_with_diffuse);
+
+---
+-- @treturn BitmapText self
+function BitmapText:GetText() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:AddAttribute() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:ClearAttributes() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:strokecolor() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:getstrokecolor() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:uppercase() end
+
+---
+-- @treturn BitmapText self
+function BitmapText:textglowmode() end
+ // ADD_METHOD( LoadFromFont );
+// ADD_METHOD( LoadFromTextureAndChars );
\ No newline at end of file
diff --git a/Themes/_fallback/docs/DownloadManager.luadoc b/Themes/_fallback/docs/DownloadManager.luadoc
new file mode 100644
index 0000000000..082a113657
--- /dev/null
+++ b/Themes/_fallback/docs/DownloadManager.luadoc
@@ -0,0 +1,149 @@
+--- DownloadManager singleton
+-- @classmod DownloadManager
+
+--[[--
+ Returns the packlist (Which is requested at startup automatically).
+ @return PackList
+--]]
+function DownloadManager:GetPacklist()
+end
+
+--[[--
+ Returns an indexed table of the currently downloading downloadable packs.
+ @return {DownloadablePack}
+--]]
+function DownloadManager:GetDownloadingPacks()
+end
+
+--[[--
+ Returns the currently logged in user's username (Or an empty string if not logged in)
+ @return string
+--]]
+function DownloadManager:GetUsername()
+end
+
+--[[--
+ Returns the currently logged in user's online rank for the provided skillset
+ @return PackList
+--]]
+function DownloadManager:GetSkillsetRank(string)
+end
+
+--[[--
+ Returns the currently logged in user's online MSD rating for the provided skillset
+ @return PackList
+--]]
+function DownloadManager:GetSkillsetRating()
+end
+
+--[[--
+ Returns an indexed table with all the currently downloading download tables.
+ @return {Download}
+--]]
+function DownloadManager:GetDownloads()
+end
+
+--[[--
+ Returns a boolean that indicates if the player is currently logged in to the API server
+ @return bool
+--]]
+function DownloadManager:IsLoggedIn()
+end
+
+--[[--
+ Begins an asynchronous attempt to login with the provided username (First parameter) and password (Second one)
+ @return void
+--]]
+function DownloadManager:Login(string, string)
+end
+
+--[[--
+ Begins an asynchronous attempt to login with the provided auth Token
+ @return void
+--]]
+function DownloadManager:LoginWithToken(string)
+end
+
+--[[--
+ Ends the current session (If it exists)
+ @return void
+--]]
+function DownloadManager:Logout()
+end
+
+--[[--
+ Returns the string for the latest version (According to the API server)
+ @return string
+--]]
+function DownloadManager:GetLastVersion()
+end
+
+--[[--
+ Returns the Nth (First parameter) top online score for the given skillset (Second param)
+ The lua tables for Online Profile Scores are defined here: https://github.com/etternagame/etterna/blob/develop/src/DownloadManager.cpp#L1645-L1659
+ TODO: Properly document online profile cores
+ @return OnlineProfileScore
+--]]
+function DownloadManager:GetTopSkillsetScore(float, string)
+end
+
+--[[--
+ Returns the amount of leaderboard scores for the given chart
+ @return float
+--]]
+function DownloadManager:GetTopChartScoreCount(string)
+end
+
+--[[--
+ Returns the Nth (Second parameter) top online score for the given skillset (First param)
+ The lua tables for Online Chart Leaderboard Scores are defined here: https://github.com/etternagame/etterna/blob/develop/src/DownloadManager.cpp#L1686-L1727
+ TODO: Properly document online chart leaderboard scores
+ @return ChartLeaderboardScore
+--]]
+function DownloadManager:GetTopChartScore(string, float)
+end
+
+--[[--
+ Returns the packs in the core bundle in an indexed table.
+ Additionally, the table has key TotalSize and AveragePackDifficulty
+ with the appropiate values in it for ease of use.
+ @return {DownloadablePack}
+--]]
+function DownloadManager:GetCoreBundle(string)
+end
+
+--[[--
+ Queues all the packs in the bundle named after the first parameter for download.
+ @return void
+--]]
+function DownloadManager:DownloadCoreBundle(string)
+end
+
+--[[--
+ Returns the current Authenthication Token used for the server API.
+ It is recommended that themes store this to automatically relogin and not the username/password for security reasons.
+ @return string
+--]]
+function DownloadManager:GetToken()
+end
+
+--[[--
+ Recieves a chartkey, and returns the online leaderboard for that chart.
+ @return {HighScore}
+--]]
+function DownloadManager:RequestChartLeaderBoard(string)
+end
+
+--[[--
+ RetuSets rate filtering to the boolean passed for the chart leaderboards
+ @return void
+--]]
+function DownloadManager:ToggleRateFilter(bool)
+end
+
+--[[--
+ Returns true if rate filtering is enabled for the chart leaderboards
+ @return bool
+--]]
+function DownloadManager:GetCurrentRateFilter()
+end
diff --git a/Themes/_fallback/docs/ScreenManager.luadoc b/Themes/_fallback/docs/ScreenManager.luadoc
new file mode 100644
index 0000000000..988fbf2529
--- /dev/null
+++ b/Themes/_fallback/docs/ScreenManager.luadoc
@@ -0,0 +1,101 @@
+--- ScreenManager singleton
+-- @classmod ScreenManager
+
+--[[--
+ Adds a screen at the top of the screen stack. (sMessage is an optional ScreenMessage posted once the new screen is finished.)
+ @return void
+--]]
+function ScreenManager:AddNewScreenToTop(string, sScreenName, string, sMessage)
+end
+
+--[[--
+ Gets the screen at the top of the screen stack.
+ @return Screen
+--]]
+function ScreenManager:GetTopScreen()
+end
+
+--[[--
+ Returns whether the input for the player has been redirected away from the normal screen input function. Input that has been redirected is only sent to lua input callbacks.
+ @return bool
+--]]
+function ScreenManager:get_input_redirected(PlayerNumber, pn)
+end
+
+--[[--
+ Plays the invalid sound.
+ @return
+--]]
+function ScreenManager:PlayInvalidSound()
+end
+
+--[[--
+ Plays the start sound.
+ @return
+--]]
+function ScreenManager:PlayStartSound()
+end
+
+--[[--
+ Plays the coin sound.
+ @return
+--]]
+function ScreenManager:PlayCoinSound()
+end
+
+--[[--
+ Plays the cancel sound.
+ @return
+--]]
+function ScreenManager:PlayCancelSound()
+end
+
+--[[--
+ Plays the screenshot sound.
+ @return
+--]]
+function ScreenManager:PlayScreenshotSound()
+end
+
+--[[--
+ Reloads any loaded overlay screens.
+ @return void
+--]]
+function ScreenManager:ReloadOverlayScreens()
+end
+
+--[[--
+ Returns true if screen class s exists.
+ @return bool
+--]]
+function ScreenManager:ScreenClassExists(string, s)
+end
+
+--[[--
+ Returns true if screen s is prepared.
+ @return bool
+--]]
+function ScreenManager:ScreenIsPrepped(string, s)
+end
+
+--[[--
+ Sets the next screen to s.
+ @return void
+--]]
+function ScreenManager:SetNewScreen(string, s)
+end
+
+--[[--
+ Sets whether the input for the player has been redirected away from the normal screen input function. Input that has been redirected is only sent to lua input callbacks.+ This can be useful when putting a custom menu on a screen, and you want to disable the built in actors while the menu is open. Then you handle input through an input callback until the player closes the menu. + @return bool +--]] +function ScreenManager:set_input_redirected(PlayerNumber, pn, bool, redir) +end + +--[[-- + Broadcasts a system message. + @return void +--]] +function ScreenManager:SystemMessage(string, s) +end diff --git a/Themes/_fallback/docs/SongManager.luadoc b/Themes/_fallback/docs/SongManager.luadoc new file mode 100644 index 0000000000..c4a59162d4 --- /dev/null +++ b/Themes/_fallback/docs/SongManager.luadoc @@ -0,0 +1,275 @@ +--- SongManager singleton +-- @classmod SongManager + +--[[-- + Returns
true if the specified course group exists.
+ @return bool
+--]]
+function SongManager:DoesCourseGroupExist(string, sGroup)
+end
+
+--[[--
+ Returns true if the specified song group exists.
+ @return bool
+--]]
+function SongManager:DoesSongGroupExist(string, sGroup)
+end
+
+--[[--
+ Returns a Course if one matching sCourse is found.
+ @return Course
+--]]
+function SongManager:FindCourse(string, sCourse)
+end
+
+--[[--
+ Returns a Song if one matching sSong is found.
+ @return Song
+--]]
+function SongManager:FindSong(string, sSong)
+end
+
+--[[--
+ Returns an array of all the installed courses.
+ @return {Course}
+--]]
+function SongManager:GetAllCourses(bool, bIncludeAutogen)
+end
+
+--[[--
+ Returns an array of all the installed songs.
+ @return {Song}
+--]]
+function SongManager:GetAllSongs()
+end
+
+--[[--
+ Returns the course color of Course c.
+ @return color
+--]]
+function SongManager:GetCourseColor(Course, c)
+end
+
+--[[--
+ Returns the path to the specified course group's banner.
+ @return string
+--]]
+function SongManager:GetCourseGroupBannerPath(string, sGroup)
+end
+
+--[[--
+ Returns a table containing all of the course group names.
+ @return {string}
+--]]
+function SongManager:GetCourseGroupNames()
+end
+
+--[[--
+ Returns a table with all of the courses in the specified group.
+ @return {Course}
+--]]
+function SongManager:GetCoursesInGroup(string, sGroup, bool, bIncludeAutogen)
+end
+
+--[[--
+ Returns the extra stage info (Song, Steps) for the specified Style s. (If bExtra2 is true, it will use the second Extra Stage data instead of the first. Again, Lua.xsd sucks)
+ @return various
+--]]
+function SongManager:GetExtraStageInfo(bool, bExtra2, Style, s)
+end
+
+--[[--
+ Returns the number of courses loaded via Additional folders.
+ @return int
+--]]
+function SongManager:GetNumAdditionalCourses()
+end
+
+--[[--
+ Returns the number of songs loaded via Additional folders.
+ @return int
+--]]
+function SongManager:GetNumAdditionalSongs()
+end
+
+--[[--
+ Returns the number of course groups.
+ @return int
+--]]
+function SongManager:GetNumCourseGroups()
+end
+
+--[[--
+ Returns the number of courses.
+ @return int
+--]]
+function SongManager:GetNumCourses()
+end
+
+--[[--
+ Returns the number of selectable and unlocked songs.
+ @return int
+--]]
+function SongManager:GetNumSelectableAndUnlockedSongs()
+end
+
+--[[--
+ Returns the number of song groups.
+ @return int
+--]]
+function SongManager:GetNumSongGroups()
+end
+
+--[[--
+ Returns the number of songs.
+ @return int
+--]]
+function SongManager:GetNumSongs()
+end
+
+--[[--
+ Returns the number of locked songs, regardless of reason for locking.
+ @return int
+--]]
+function SongManager:GetNumLockedSongs()
+end
+
+--[[--
+ Returns the number of unlocked songs.
+ @return int
+--]]
+function SongManager:GetNumUnlockedSongs()
+end
+
+--[[--
+ Returns a table of popular courses for the specified CourseType.
+ @return {Course}
+--]]
+function SongManager:GetPopularCourses(CourseType, ct)
+end
+
+--[[--
+ Returns a table of popular songs.
+ @return {Song}
+--]]
+function SongManager:GetPopularSongs()
+end
+
+--[[--
+ Returns a table of courses as they'd appear in preferred sort.
+ @return {Course}
+--]]
+function SongManager:GetPreferredSortCourses(CourseType, ct, bool, bIncludeAutogen)
+end
+
+--[[--
+ Returns a table of songs as they'd appear in preferred sort.
+ @return {Song}
+--]]
+function SongManager:GetPreferredSortSongs()
+end
+
+--[[--
+ Returns a random course.
+ @return Course
+--]]
+function SongManager:GetRandomCourse()
+end
+
+--[[--
+ Returns a random song.
+ @return Song
+--]]
+function SongManager:GetRandomSong()
+end
+
+--[[--
+ Returns the song color of Song s.
+ @return color
+--]]
+function SongManager:GetSongColor(Song, s)
+end
+
+--[[--
+ Returns a Song given a set of Steps st.
+ @return Song
+--]]
+function SongManager:GetSongFromSteps(Steps, st)
+end
+
+--[[--
+ Returns the path to the specified song group's banner.
+ @return string
+--]]
+function SongManager:GetSongGroupBannerPath(string, sGroup)
+end
+
+--[[--
+ Returns the song group color of sGroupName.
+ @return color
+--]]
+function SongManager:GetSongGroupColor(string, sGroupName)
+end
+
+--[[--
+ Returns a table containing all of the song group names.
+ @return {string}
+--]]
+function SongManager:GetSongGroupNames()
+end
+
+--[[--
+ Returns the rank (popularity) of Song s.
+ @return int
+--]]
+function SongManager:GetSongRank(Song, s)
+end
+
+--[[--
+ Returns a table containing all of the songs in group sGroupName.
+ @return {Song}
+--]]
+function SongManager:GetSongsInGroup(string, sGroupName)
+end
+
+--[[--
+ Returns the shortened group name (based on entries in Translations.xml).
+ @return string
+--]]
+function SongManager:ShortenGroupName(string, sGroupName)
+end
+
+--[[--
+ Loads preferred courses from {theme}/Other/SongManager sListName.txt.
+ @return void
+--]]
+function SongManager:SetPreferredCourses(string, sListName)
+end
+
+--[[--
+ Loads preferred songs from {theme}/Other/SongManager sListName.txt.
+ @return void
+--]]
+function SongManager:SetPreferredSongs(string, sListName)
+end
+
+--[[--
+ Returns the preferred sort section name for the specified Song.
+ @return string
+--]]
+function SongManager:SongToPreferredSortSectionName(Song, s)
+end
+
+--[[--
+ Returns true if the specified course was loaded from AdditionalCourses.
+ @return bool
+--]]
+function SongManager:WasLoadedFromAdditionalCourses(Course, c)
+end
+
+--[[--
+ Returns true if the specified song was loaded from AdditionalSongs.
+ @return bool
+--]]
+function SongManager:WasLoadedFromAdditionalSongs(Song, s)
+end
diff --git a/Themes/_fallback/docs/Sprite.luadoc b/Themes/_fallback/docs/Sprite.luadoc
new file mode 100644
index 0000000000..78f3ef705d
--- /dev/null
+++ b/Themes/_fallback/docs/Sprite.luadoc
@@ -0,0 +1,242 @@
+--- Sprite
+-- @classmod Sprite
+
+--[[-- Returns the length of the animation in seconds.
+ @return float
+--]]
+function Sprite:GetAnimationLengthSeconds()
+end
+
+--[[-- Gets whether the Sprite should call the decode function for its texture during updates.
+ @return bool
+--]]
+function Sprite:GetDecodeMovie()
+end
+
+--[[-- Return the number of states this Sprite has.
+ @return int
+--]]
+function Sprite:GetNumStates()
+end
+
+--[[-- Returns the Sprite's current state (frame number in a multi-frame sprite).
+ @return int
+--]]
+function Sprite:GetState()
+end
+
+--[[-- Returns the Sprite's texture.
+ @return RageTexture
+--]]
+function Sprite:GetTexture()
+end
+
+--[[-- Returns a Frames table consisting of iNumFrames frames lasting for a total of fSeconds seconds. This function is not a member function and should be used as Frames = Sprite.LinearFrames( 5, 2.6 ).
+ @return Frames
+--]]
+function Sprite:LinearFrames()
+end
+
+--[[-- If sPath is nil, then unload the texture. Otherwise, load the texture at path sPath.
+ @return void
+--]]
+function Sprite:Load(string, sPath)
+end
+
+--[[-- Load the song background texture at sPath.
+ @return void
+--]]
+function Sprite:LoadBackground(string, sPath)
+end
+
+--[[-- Load the song banner texture at sPath.
+ @return void
+--]]
+function Sprite:LoadBanner(string, sPath)
+end
+
+--[[-- Loads the image of type sType from the cache based on sPath.
+ Internal types: "Banner", "Background", "CDTitle", "Jacket", "CDImage" and "Disc".
+ @return void
+--]]
+function Sprite:LoadFromCached(string, sType, string, sPath)
+end
+
+--[[-- Loads the background from the current Song or the first Trail entry.
+ @return void
+--]]
+function Sprite:LoadFromCurrentSongBackground()
+end
+
+--[[-- Load the texture for `Song` background.
+ @tparam Song song
+ @return void
+--]]
+function Sprite:LoadFromSongBackground(song)
+end
+
+--[[-- Load the texture for `Song` banner.
+ @tparam Song song
+ @return void
+--]]
+function Sprite:LoadFromSongBanner(song)
+end
+
+--[[-- Sets the custom image rectangle. (Works in image pixel space.)
+ @return void
+--]]
+function Sprite:SetCustomImageRect(float, fLeft, float, fTop, float, fRight, float, fBottom)
+end
+
+--[[-- Sets custom offsets for the corners of the Sprite. Coordinates are paired,
+ corner order is upper left, lower left, lower right, upper right.
+ @return void
+--]]
+function Sprite:SetCustomPosCoords(
+ float,
+ ulx,
+ float,
+ uly,
+ float,
+ llx,
+ float,
+ lly,
+ float,
+ lrx,
+ float,
+ lry,
+ float,
+ urx,
+ float,
+ ury)
+end
+
+--[[-- Turns off the custom pos coords for the sprite.
+ @return void
+--]]
+function Sprite:StopUsingCustomPosCoords()
+end
+
+--[[-- Sets whether the Sprite should call the decode function for its texture during updates.
+ @return
+--]]
+function Sprite:SetDecodeMovie(bool, decode)
+end
+
+--[[-- Set the to mode.
+ @return void
+--]]
+function Sprite:SetEffectMode(EffectMode, mode)
+end
+
+--[[-- Sets the number of seconds into the animation to fSeconds.
+ @return void
+--]]
+function Sprite:SetSecondsIntoAnimation(float, fSeconds)
+end
+
+--[[-- Sets the properties of the states of the sprite. The properties table is identical to the "Frames" table that can be put in the sprite when calling Def.Sprite.+ Example:
+ {{Frame= 0, Delay= .016, {0, 0}, {.25, .25}},
+ {Frame= 1, Delay= .016, {0, 0}, {.25, .25}},
+ {Frame= 2, Delay= .016, {0, 0}, {.25, .25}},
+ {Frame= 3, Delay= .016, {0, 0}, {.25, .25}},
+ }
+ Frame is optional, defaulting to 0.
+ Delay is optional, defaulting to 0.
+ The two tables are optional upper left and lower right corners of the fraction of the frame to use. The example makes the sprite only use the upper left corner of each frame.
+ Simpler example:
+ {{Frame= 0, Delay= .016}, {Frame= 1, Delay= .016}, {Frame= 2, Delay= .016}, {Frame= 3, Delay= .016}}
+ This example makes the sprite use the whole of each frame. + @return void +--]] +function Sprite:SetStateProperties(table) +end + +--[[-- Set the texture to
texture.
+ @return void
+--]]
+function Sprite:SetTexture(RageTexture, texture)
+end
+
+--[[--
+ @return void
+--]]
+function Sprite:addimagecoords(float, fX, float, fY)
+end
+
+--[[-- Allows the themer to set a custom texture rectangle that effects the way the texture is drawn.
+ @return void
+--]]
+function Sprite:customtexturerect(float, fLeft, float, fTop, float, fRight, float, fBottom)
+end
+
+--[[-- Returns true if the sprite is using the effect clock for texcoordvelocity.
+ @return bool
+--]]
+function Sprite:get_use_effect_clock_for_texcoords()
+end
+
+--[[-- Call loop on the `RageTexture`
+ @return bool
+--]]
+function Sprite:loop(bLoop)
+end
+
+--[[-- Call position on the `RageTexture`
+ @return bool
+--]]
+function Sprite:position(fPos)
+end
+
+--[[-- Call rate on the `RageTexture`
+ @return bool
+--]]
+function Sprite:rate(fRate)
+end
+
+--[[-- Scale the Sprite to width fWidth and height fHeight clipping if the dimensions do not match.
+ @return void
+--]]
+function Sprite:scaletoclipped(float, fWidth, float, fHeight)
+end
+
+--[[-- Set the Sprite's state to iNewState.
+ @return void
+--]]
+function Sprite:setstate(iNewState)
+end
+
+--[[-- If use is true, then the sprite will use the effect clock for texcoordvelocity.
+ @return
+--]]
+function Sprite:set_use_effect_clock_for_texcoords(bool, use)
+end
+
+--[[--
+ @return void
+--]]
+function Sprite:stretchtexcoords(float, fX, float, fY)
+end
+
+--[[-- Set the texture coordinate velocity which controls how the Sprite changes as it animates. A velocity of 1 makes the texture scroll all the way once per second.
+ @return void
+--]]
+function Sprite:texcoordvelocity(float, fVelX, float, fVelY)
+end
+
+--[[-- Crops the Sprite to fWidthxfHeight.
+ @return void
+--]]
+function Sprite:CropTo(float, fWidth, float, fHeight)
+end
+
+--- Alias for CropTo
+function Sprite:cropto(float, fWidth, float, fHeight)
+end
+
+--[[-- Sets all the state delays to fRate. Useful for Sprites that need to change by BPM (e.g. Tran from DDR 5th Mix, the cube from DS EuroMix 2).
+ @return void
+--]]
+function Sprite:SetAllStateDelays(float, fRate)
+end
diff --git a/Themes/_fallback/docs/markdown/Actor-Commands.md b/Themes/_fallback/docs/markdown/Actor-Commands.md
new file mode 100644
index 0000000000..77c01ef96b
--- /dev/null
+++ b/Themes/_fallback/docs/markdown/Actor-Commands.md
@@ -0,0 +1,187 @@
+#Actor Commands
+
+## Command
+
+A command is basically an `Actor` function defined by lua. These can be called instantly using playcommand(commandStringName) or queued for the next frame using queuecommand(commandStringName) on an actor. Usually, they identify certain events that happen, and are called accordingly. Parameters to Commands are '(self, params)' with params being an optional table of named parameters. Note that the command's name must be stripped of the suffix 'Command' when playing/queueing it.
+
+ Def.ActorFrame {
+ InitCommand = function(self)
+ self:x(5)
+ end
+ }
+
+## MessageCommand
+
+A 'message' command is registered as XMessageCommand (Instead of XCommand), and the registered command will still be called X, but it will be flagged as a message command. This means that if someone broadcasts a message (Using `MSGMAN` a.k.a message manager) it will trigger/execute that command (Meaning, that function). Parameters to MessageCommands are '(self, params)' with params being an optional table of named parameters.
+
+## Universal Commands
+
+These are Commands which are usable for all actors, regardless of screen.
+
+### InitCommand
+
+Executed before the screen displays it's 'on' state. Useful to initialize actor state (Like position, sizes, storing the reference to the actor in a file-local variable)
+
+### OnCommand
+
+Executed as the screen is displayed (After all InitCommands). Useful, for example, to begin animations as the player enters a screen.
+
+### OffCommand
+
+Executed as the screen is being exited.
+
+### AnimationFinishedCommand
+
+Executed when an animation is finished (If one was executed on this actor)
+
+### CodeMessageCommand
+
+Executed when any button specified in metrics is pressed. You must have CodeNames set in the respective screen in metrics.ini for this to function correctly.
+
+ params = {
+ PlayerNumber = PLAYER_1 or PLAYER_2 ,
+ Name = the name of the code you specified. So if you have `Codeleft="Left"` in metrics.ini and you press left, params.Name would be "left"
+ }
+
+Example metrics:
+
+ CodeNames="ResetJudge,PrevJudge,NextJudge,ToggleHands"
+ CodeResetJudge="MenuUp"
+ CodeNextJudge="EffectUp"
+ CodePrevJudge="EffectDown"
+ CodeToggleHands="MenuDown"
+
+# Screen Specific
+
+Note: In case something is missing in any particular screen, you can check the ScreenX.cpp files under /src/ in the github repository, checking what is broadcasted by MESSAGEMAN.
+
+## ScreenSelectMusic
+
+### SetMessageCommand
+
+Broadcast when a `MusicWheelItem`' is being set with new information, such as when scrolling up and down. Gets the `Song` currently selected in the `MusicWheel`
+
+ params = {
+ Song = An instance of the `Song` that was just set to the `MusicWheelItem`,
+ Index = The index of the `MusicWheelItem` that was just set,
+ HasFocus = If the `MusicWheelItem` is focused or not,
+ Text = The name of the song group this `MusicWheelItem` is from,
+ }
+
+### CurrentStepsP1ChangedMessageCommand
+
+Triggered when the currently selected `Steps` (a.k.a chart within a `Song`) change, whether it be by changing the difficulty or selecting another song.
+
+### CurrentSongChangedMessageCommand
+
+Triggered when the `MusicWheel` current `Song` changes.
+
+### PreviousSongMessageCommand or NextSongMessageCommand
+
+Triggered when the player selects a different `Song` in the `MusicWheel` by tapping left or right.
+
+### ChangeStepsMessageCommand
+
+Triggered when `Steps` are changed. Need to check player & direction using ChangeStepsMessageCommand=function(self, params) then params.Player and params.Direction.
+
+ params = {
+ Player =PLAYER_1 or PLAYER_2,
+ Direction = 1 or -1,
+ }
+
+## ScreenGameplay
+
+### LifeChangedMessageCommand
+
+Activated whenever a player's life changes.
+
+| Parameters | Description |
+| ---------- | --------------------------------------- |
+| Player | Either PLAYER_1 or PLAYER_2 |
+| LifeMeter | Amount of life in a decimal from 0 to 1 |
+
+If the lifebar is type is battery it will also have LivesLeft and LostLife.
+
+### HealthStateChangedMessageCommand
+
+Activated whenever a player's health state changes...
+
+| Parameters | Description |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| PlayerNumber | Either PLAYER_1 or PLAYER_2 |
+| HealthState | A HealthState Enum, which is either `HealthState_Hot`, `HealthState_Alive`, `HealthState_Danger`, or `HealthState_Dead`. |
+| OldHealthState | self explanatory. |
+
+### PlayerFailedMessageCommand
+
+This one's obvious.
+
+| Parameters | Description |
+| ------------ | --------------------------- |
+| PlayerNumber | Either PLAYER_1 or PLAYER_2 |
+
+### ScoreChangedMessageCommand
+
+Activated whenever a player's score changes. Params include PlayerNumber and MultiPlayer, but can also include ToastyCombo in certain cases.
+
+| Parameters | Description |
+| ------------ | --------------------------- |
+| PlayerNumber | Either PLAYER_1 or PLAYER_2 |
+| MultiPlayer | ??? |
+
+### JudgmentMessageCommand
+
+Triggered when a judgment happens, either because a player stepped on a note or they completely missed it.
+
+| Parameters | Description |
+| ------------- | -------------------------------- |
+| Player | Either PLAYER_1 or PLAYER_2 |
+| MultiPlayer | If they're multiplayer, probably |
+| TapNoteSccre | The TapNoteScore |
+| Early | True if early, false if late |
+| TapNoteOffset | Offset of the judgement |
+| HoldNoteScore | The HoldNoteScore |
+
+### ComboChangedMessageCommand
+
+Activated whenever a combo changes.
+
+| Parameters | Description |
+| ---------------- | ---------------------------------------------------------------- |
+| Player | Either PLAYER_1 or PLAYER_2 |
+| OldCombo | ??? |
+| OldMissCombo | ??? |
+| PlayerState | An instance of PlayerState. This may not always be present. |
+| PlayerStageStats | An instance of PlayerStageStats. This may not always be present. |
+
+### ToastyAchievedMessageCommand
+
+| Parameters | Description |
+| ------------ | --------------------------- |
+| PlayerNumber | Either PLAYER_1 or PLAYER_2 |
+| ToastyCombo | ??? |
+| Level | ??? |
+
+### ToastyDroppedMessageCommand
+
+| Parameters | Description |
+| ------------ | --------------------------- |
+| PlayerNumber | Either PLAYER_1 or PLAYER_2 |
+
+### DoneLoadingNextSongMessageCommand
+
+Unknown, might be triggered during course mode
+
+## ActorScroller specific
+
+### GainFocusCommand
+
+Triggered when the ActorScroller is selected
+
+### LoseFocusCommand
+
+Triggered when the ActorScroller is deselected
+
+## Downloads
+
+###
diff --git a/Themes/_fallback/docs/markdown/QuickStart.md b/Themes/_fallback/docs/markdown/QuickStart.md
new file mode 100644
index 0000000000..7f1eb042b8
--- /dev/null
+++ b/Themes/_fallback/docs/markdown/QuickStart.md
@@ -0,0 +1,15 @@
+# QuickStart
+
+A lua file is plain text. To create and edit these you need a plain text editor such as notepad.
+
+You can use any text editor, but to make your life easier, we recommend that you use [vscode](https://code.visualstudio.com/Download). Extensions you may want to use with [vscode](https://code.visualstudio.com/Download) would definitely be the [vscode-lua](https://marketplace.visualstudio.com/items?itemName=trixnz.vscode-lua) generic lua extension and the [ettlua](https://marketplace.visualstudio.com/items?itemName=Nick12.ettlua-for-vscode) extension.
+
+If you have no programming language experience whatsoever or you are not familiar with lua and don't think you would be comfortable infering the syntax, it is recommended that you read some lua book or material (Like [Programming In Lua](https://www.lua.org/pil/contents.html), chapter 1 being optional, chapters 2 to 5 recommended and 13,19 and 20 also optional. You're free to read the whole book, but you will probably not get a lot of useful things for lua in this game from the rest).
+
+## Basic Structure
+
+The game defines a number of `Screens`. It's possible to define custom `Screens`, but that's not inmediately relevant. Each `Screen` is a container for `Actors`. Pretty much every Drawable thing is an `Actor`. A container for `Actors` is actually called an `ActorFrame` (So, `Screens` are `ActorFrames`). Lua comes into play in the game when loading `Screens`. Some lua code is executed when initializing `Screens`, and it tells the game which `Actors` it needs to create and add to it. It can also registers a number of `Commands`, which are just lua functions executed on certain events (Usually called by the game engine). Lua code is also executed when the game is executed, on startup, usually to initialize whatever global state it needs to use later, and to define functions globally so they can be available everywhere (Note: Usually it's recommended to "namespace" your global functions, putting them under a table, so as to not pollute the global namespace). A lua file executed at startup is called a `Script` within the context of this game. Sometimes, Screen lua files are called `BGAnimations`, or "BackGround Animations" (Sometimes abbreviated BGAnims).
+
+## Screens
+
+I mentioned lua code can be executed on `Screen` initialization. However, `Screens` have a second component to them that is of relatively big importance to someone dealing with BGAnims: metrics.ini
diff --git a/Themes/_fallback/metrics.ini b/Themes/_fallback/metrics.ini
index ea525f433c..eb0037c210 100644
--- a/Themes/_fallback/metrics.ini
+++ b/Themes/_fallback/metrics.ini
@@ -1,4 +1,4 @@
-# This probably is hard to understand from the way it was made in the first
+ get it to work and put it anywher# This probably is hard to understand from the way it was made in the first
# place, so instead just pay attention to each group, which has tons of notes.
# 01 # Global
@@ -1816,7 +1816,8 @@ UpdateOnMessage=""
#
NumChoicesOnPage1=100
DefaultChoice="GameStart"
-ChoiceNames="GameStart,Options,Edit,Jukebox,GameSelect,Exit"
+#ChoiceNames="GameStart,Options,Edit,Jukebox,GameSelect,Exit"
+ChoiceNames="GameStart,Options,GameSelect,AV,Exit"
ChoiceGameStart="applydefaultoptions;text,Game Start;screen,"..Branch.AfterTitleMenu()
#ChoiceQuickPlay="applydefaultoptions;text,Quick Play;"
ChoiceOptions="screen,ScreenOptionsService;text,Options"
@@ -1829,6 +1830,7 @@ ChoiceGameSelect="screen,ScreenSelectGame;text,Select Game"
ChoiceJukebox="screen,ScreenJukeboxMenu;text,Jukebox"
ChoiceReportBug="urlnoexit,https://github.com/etternagame/etterna/issues;text,Report Bug"
ChoiceSandbox="screen,ScreenTest;text,Sandbox"
+ChoiceAV="urlnoexit,https://www.ddrnl.com/viewtopic.php?f=13&t=156;text,Editor"
#
AllowRepeatingInput=true
ShowCursor=false
@@ -1984,7 +1986,7 @@ PrevScreen=Branch.TitleMenu()
TimerSeconds=30
#
DefaultChoice="Normal"
-ChoiceNames="Normal,Rave,Nonstop,Oni,Endless"
+ChoiceNames="Normal"
#
PerChoiceScrollElement=false
PerChoiceIconElement=false
@@ -2066,6 +2068,8 @@ Fallback="ScreenWithMenuElements"
NextScreen=Branch.PlayerOptions()
PrevScreen=Branch.TitleMenu()
#
+PlayerOptionsScreen="ScreenPlayerOptions"
+#
MusicWheelType="MusicWheel"
Codes=""
#
@@ -2955,7 +2959,7 @@ PrevScreen="ScreenOptionsInputSub"
Fallback="ScreenOptionsServiceChild"
PrevScreen="ScreenOptionsService"
NextScreen="ScreenOptionsService"
-LineNames="1,2,3,4,5,FNR,6,7,8,9,FA,10,11,12,13,14,15,16,17,18,19,20,21,22"
+LineNames="1,2,3,4,5,FNR,6,7,8,9,FA,12,13,14,15,16,17,18,20,21"
Line1="conf,Windowed"
Line2="conf,DisplayResolution"
Line3="conf,DisplayAspectRatio"
@@ -2967,8 +2971,6 @@ Line7="conf,TimingWindowScale"
Line8="conf,LifeDifficulty"
Line9="conf,AllowW1"
LineFA="conf,DefaultFailType"
-Line10="conf,AutogenSteps"
-Line11="conf,ShowBanners"
Line12="conf,ShowCaution"
Line13="conf,ShowInstructions"
Line14="conf,ShowDanger"
@@ -2976,10 +2978,8 @@ Line15="conf,ShowSongOptions"
Line16="conf,EasterEggs"
Line17="conf,Theme"
Line18="conf,DefaultNoteskin"
-Line19="conf,PercentageScoring"
Line20="conf,BGBrightness"
Line21="conf,Center1Player"
-Line22="conf,EventMode"
[ScreenOptionsGraphicsSound]
Fallback="ScreenOptionsServiceChild"
@@ -3047,12 +3047,9 @@ LineNSA="conf,FullTapExplosions"
Fallback="ScreenOptionsServiceChild"
NextScreen="ScreenOptionsDisplaySub"
PrevScreen="ScreenOptionsDisplaySub"
-LineNames="1,3,4,6,7,8,9,10,11,12,14"
+LineNames="1,6,8,9,10,11,12,14"
Line1="conf,Center1Player"
-Line3="conf,DancePointsForOni"
-Line4="conf,MenuTimer"
Line6="conf,MusicWheelUsesSections"
-Line7="conf,ShowBanners"
Line8="conf,ShowCaution"
Line9="conf,ShowDanger"
Line10="conf,ShowInstructions"
@@ -3080,8 +3077,7 @@ Fallback="ScreenOptionsServiceChild"
NextScreen="ScreenOptionsService"
PrevScreen="ScreenOptionsService"
# stuff tied to arcade features
-LineNames="8,9"
-Line8="conf,ComboContinuesBetweenSongs"
+LineNames="9"
Line9="conf,Disqualification"
[ScreenOptionsTheme]
@@ -3113,7 +3109,7 @@ TimerSeconds=-1
[ScreenOptionsEditProfile]
Class="ScreenOptionsEditProfile"
-PageOnCommand=visible,false
+PageOnCommand=visible,true
[ScreenOptionsCustomizeProfile]
Class="ScreenWithMenuElements"
@@ -4307,7 +4303,7 @@ Users4Command=draworder,2;diffuse,color("1.0,0.5,0.5,1.0")
[ScreenNetSelectMusic]
Class="ScreenNetSelectMusic"
-Fallback="ScreenNetSelectBase"
+Fallback="ScreenSelectMusic"
PrevScreen="ScreenNetRoom"
NextScreen="ScreenNetStageInformation"
DisconnectScreen="ScreenSelectMusic"
diff --git a/Utils/config.ld b/Utils/config.ld
index 53f963890c..72e41496c4 100644
--- a/Utils/config.ld
+++ b/Utils/config.ld
@@ -1,8 +1,13 @@
+project = "Etterna"
title = "Etterna lua docs"
description = "Spread 4k focused rhythm game"
-project = "Etterna"
-file = {"../Themes/_fallback/Scripts"}
+file = {"../Themes/_fallback/Scripts", "../Themes/_fallback/docs"}
+topics = '../Themes/_fallback/docs/markdown'
+use_markdown_titles = true
+format = 'discount'
+style = '!fixed'
all = true
pretty = true
--prettify_files = true
-not_luadoc = true
\ No newline at end of file
+not_luadoc = true
+alias('ret',{'return',modifiers={type="$1"}})
\ No newline at end of file
diff --git a/src/Actor.cpp b/src/Actor.cpp
index 4083f49139..af0a60becb 100644
--- a/src/Actor.cpp
+++ b/src/Actor.cpp
@@ -14,7 +14,10 @@
#include "ThemeManager.h"
#include "XmlFile.h"
#include -
+#include