documentation update
This commit is contained in:
AJ Kelly
@@ -9,9 +9,35 @@ Not all changes are documented, for various reasons.
|
|||||||
supported but exist anyways.)
|
supported but exist anyways.)
|
||||||
_____________________________________________________________________________
|
_____________________________________________________________________________
|
||||||
|
|
||||||
|
20100417
|
||||||
|
--------
|
||||||
|
* Finally get rid of PLAYER_COLOR. ColorP1Command and ColorP2Command no
|
||||||
|
longer exist. The last things that were being diffused with player color
|
||||||
|
in the code included text in the Oni score display and ScreenSelectMusic score.
|
||||||
|
I'm sure you can diffuse ScoreDisplayOni Numbers, but I can't seem to find any
|
||||||
|
references to them in the metrics of any released theme. [AJ]
|
||||||
|
|
||||||
|
20100404
|
||||||
|
--------
|
||||||
|
* [SongManager] Added GetSongGroupNames(), GetSongsInGroup(string) Lua bindings
|
||||||
|
|
||||||
|
20100403
|
||||||
|
--------
|
||||||
|
* Fixed an issue where course banners were always cached, regardless of setting.
|
||||||
|
|
||||||
|
20100401
|
||||||
|
--------
|
||||||
|
(Not jokes)
|
||||||
|
* NextSong/PrevSong now work when TwoPartSelection=true and
|
||||||
|
TwoPartConfirmsOnly=true on ScreenSelectMusic. A new message
|
||||||
|
("TwoPartConfirmCanceled") was added to catch when this happens.
|
||||||
|
|
||||||
|
20100331
|
||||||
|
--------
|
||||||
|
* Added Lifts to PaneDisplay. (StepMania 3.9+/Plus Redux had them)
|
||||||
|
|
||||||
sm-ssc v1.0 Public Beta 2 | 20100331
|
sm-ssc v1.0 Public Beta 2 | 20100331
|
||||||
------------------------------------
|
------------------------------------
|
||||||
(Well, it was built on the 31st of March, anyways.)
|
|
||||||
|
|
||||||
20100329
|
20100329
|
||||||
--------
|
--------
|
||||||
|
|||||||
@@ -0,0 +1,209 @@
|
|||||||
|
A list of screen messages that can be used with
|
||||||
|
SCREENMAN:GetTopScreen():PostScreenMessage('SM_*', delaySeconds).
|
||||||
|
|
||||||
|
Duplicate screen messages may appear; the below lists include both
|
||||||
|
AutoScreenMessage()s and any messages that appear in
|
||||||
|
Screen*::HandleScreenMessage(const ScreenMessage SM).
|
||||||
|
Consider this a list of messages that screens can reply to.
|
||||||
|
|
||||||
|
[ScreenMessage.*]
|
||||||
|
SM_Invalid
|
||||||
|
SM_None
|
||||||
|
SM_MenuTimer Timer = 00
|
||||||
|
SM_DoneFadingIn Plays after sorting by draworder [ScreenWithMenuElements::BeginScreen()]
|
||||||
|
SM_BeginFadingOut Begins a fadeout?
|
||||||
|
SM_GoToNextScreen Goes to next screen?
|
||||||
|
SM_GoToPrevScreen Goes to prev screen?
|
||||||
|
SM_GainFocus
|
||||||
|
SM_LoseFocus
|
||||||
|
SM_Pause try it on Gameplay... :)
|
||||||
|
SM_Success
|
||||||
|
SM_Failure
|
||||||
|
|
||||||
|
[Inventory.*]
|
||||||
|
SM_BattleDamageLevel1
|
||||||
|
SM_BattleDamageLevel2
|
||||||
|
SM_BattleDamageLevel3
|
||||||
|
|
||||||
|
[Player.*]
|
||||||
|
SM_100Combo
|
||||||
|
SM_200Combo
|
||||||
|
SM_300Combo
|
||||||
|
SM_400Combo
|
||||||
|
SM_500Combo
|
||||||
|
SM_600Combo
|
||||||
|
SM_700Combo
|
||||||
|
SM_800Combo
|
||||||
|
SM_900Combo
|
||||||
|
SM_1000Combo
|
||||||
|
SM_ComboStopped
|
||||||
|
SM_ComboContinuing
|
||||||
|
|
||||||
|
[ScorekeeperNormal.*]
|
||||||
|
SM_PlayToasty what do you think it does
|
||||||
|
|
||||||
|
[ScreenAttract.*]
|
||||||
|
SM_GoToStartScreen
|
||||||
|
|
||||||
|
[ScreenGameplay.*]
|
||||||
|
SM_NotesEnded
|
||||||
|
SM_BeginFailed
|
||||||
|
SM_LeaveGameplay
|
||||||
|
SM_PlayGo
|
||||||
|
SM_LoadNextSong
|
||||||
|
SM_StartLoadingNextSong
|
||||||
|
SM_DoPrevScreen
|
||||||
|
SM_DoNextScreen
|
||||||
|
SM_StartHereWeGo
|
||||||
|
SM_StopHereWeGo
|
||||||
|
SM_BattleTrickLevel1
|
||||||
|
SM_BattleTrickLevel2
|
||||||
|
SM_BattleTrickLevel3
|
||||||
|
-- from elsewhere ----------
|
||||||
|
SM_PlayToasty
|
||||||
|
SM_100Combo - SM_1000Combo
|
||||||
|
|
||||||
|
[ScreenOptions.*]
|
||||||
|
SM_ExportOptions
|
||||||
|
|
||||||
|
[MusicWheel.*]
|
||||||
|
SM_SongChanged
|
||||||
|
SM_SortOrderChanging
|
||||||
|
SM_SortOrderChanged
|
||||||
|
|
||||||
|
[NetworkSyncManager.*]
|
||||||
|
SM_AddToChat
|
||||||
|
SM_ChangeSong
|
||||||
|
SM_GotEval
|
||||||
|
SM_UsersUpdate
|
||||||
|
SM_SMOnlinePack
|
||||||
|
|
||||||
|
[RoomInfoDisplay.*]
|
||||||
|
SM_RoomInfoRetract
|
||||||
|
SM_RoomInfoDeploy
|
||||||
|
|
||||||
|
[RoomWheel.*]
|
||||||
|
SM_BackFromRoomName
|
||||||
|
SM_RoomInfoRetract
|
||||||
|
SM_RoomInfoDeploy
|
||||||
|
|
||||||
|
[ScreenEdit.*]
|
||||||
|
SM_UpdateTextInfo
|
||||||
|
SM_BackFromMainMenu
|
||||||
|
SM_BackFromAreaMenu
|
||||||
|
SM_BackFromStepsInformation
|
||||||
|
SM_BackFromOptions
|
||||||
|
SM_BackFromSongInformation
|
||||||
|
SM_BackFromBGChange
|
||||||
|
SM_BackFromInsertTapAttack
|
||||||
|
SM_BackFromInsertTapAttackPlayerOptions
|
||||||
|
SM_BackFromInsertCourseAttack
|
||||||
|
SM_BackFromInsertCourseAttackPlayerOptions
|
||||||
|
SM_BackFromCourseModeMenu
|
||||||
|
SM_DoRevertToLastSave
|
||||||
|
SM_DoRevertFromDisk
|
||||||
|
SM_BackFromBPMChange
|
||||||
|
SM_BackFromStopChange
|
||||||
|
SM_DoSaveAndExit
|
||||||
|
SM_DoExit
|
||||||
|
SM_SaveSuccessful
|
||||||
|
SM_SaveFailed
|
||||||
|
|
||||||
|
[ScreenEditMenu.*]
|
||||||
|
SM_RefreshSelector
|
||||||
|
SM_BackFromEditDescription
|
||||||
|
|
||||||
|
[ScreenEvaluation.*]
|
||||||
|
SM_PlayCheer
|
||||||
|
SM_AddBonus
|
||||||
|
|
||||||
|
[ScreenMiniMenu.*]
|
||||||
|
SM_GoToOK
|
||||||
|
SM_GoToCancel
|
||||||
|
|
||||||
|
[ScreenNetEvaluation.*]
|
||||||
|
SM_GotEval
|
||||||
|
|
||||||
|
[ScreenNetRoom.*]
|
||||||
|
SM_SMOnlinePack
|
||||||
|
SM_BackFromRoomName
|
||||||
|
SM_BackFromRoomDesc
|
||||||
|
SM_BackFromRoomPass
|
||||||
|
SM_BackFromReqPass
|
||||||
|
SM_RoomInfoRetract
|
||||||
|
SM_RoomInfoDeploy
|
||||||
|
|
||||||
|
[ScreenNetSelectBase.*]
|
||||||
|
SM_AddToChat
|
||||||
|
SM_UsersUpdate
|
||||||
|
SM_SMOnlinePack
|
||||||
|
|
||||||
|
[ScreenNetSelectMusic.*]
|
||||||
|
SM_NoSongs
|
||||||
|
SM_ChangeSong
|
||||||
|
SM_SMOnlinePack
|
||||||
|
SM_SetWheelSong
|
||||||
|
SM_RefreshWheelLocation
|
||||||
|
SM_SongChanged
|
||||||
|
SM_UsersUpdate
|
||||||
|
SM_BackFromPlayerOptions
|
||||||
|
|
||||||
|
[ScreenNetworkOptions.*]
|
||||||
|
SM_DoneConnecting
|
||||||
|
|
||||||
|
[ScreenOptionsEditCourse.*]
|
||||||
|
SM_BackFromContextMenu
|
||||||
|
|
||||||
|
[ScreenOptionsEditCourseEntry.*]
|
||||||
|
SM_BackFromCoursePlayerOptions
|
||||||
|
|
||||||
|
[ScreenOptionsManageCourses]
|
||||||
|
SM_BackFromEnterNameForNew
|
||||||
|
SM_BackFromRename
|
||||||
|
SM_BackFromContextMenu
|
||||||
|
|
||||||
|
[ScreenOptionsManageEditSteps.*]
|
||||||
|
SM_BackFromRename
|
||||||
|
SM_BackFromDelete
|
||||||
|
SM_BackFromContextMenu
|
||||||
|
|
||||||
|
[ScreenOptionsManageProfiles.*]
|
||||||
|
SM_BackFromEnterNameForNew
|
||||||
|
SM_BackFromRename
|
||||||
|
SM_BackFromDeleteConfirm
|
||||||
|
SM_BackFromClearConfirm
|
||||||
|
SM_BackFromContextMenu
|
||||||
|
|
||||||
|
[ScreenOptionsManageWorkouts.*]
|
||||||
|
|
||||||
|
[ScreenOptionsReviewWorkout.*]
|
||||||
|
|
||||||
|
[ScreenPackages.*]
|
||||||
|
|
||||||
|
[ScreenRanking.*]
|
||||||
|
|
||||||
|
[ScreenSelectMaster.*]
|
||||||
|
|
||||||
|
[ScreenSelectMusic.*]
|
||||||
|
SM_AllowOptionsMenuRepeat
|
||||||
|
SM_SongChanged
|
||||||
|
SM_SortOrderChanging
|
||||||
|
SM_SortOrderChanged
|
||||||
|
|
||||||
|
[ScreenSMOnlineLogin.*]
|
||||||
|
SM_SMOnlinePack
|
||||||
|
SM_PasswordDone
|
||||||
|
SM_NoProfilesDefined
|
||||||
|
SM_GoToNextScreen
|
||||||
|
|
||||||
|
[ScreenSplash.*]
|
||||||
|
SM_PrepScreen
|
||||||
|
|
||||||
|
[ScreenStage.*]
|
||||||
|
SM_PrepScreen
|
||||||
|
|
||||||
|
[ScreenTestFonts.*]
|
||||||
|
SM_ChangeText
|
||||||
|
|
||||||
|
[WheelBase.*]
|
||||||
|
SM_SongChanged
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
all the known gamecommands (pre-sm-ssc)
|
||||||
|
|
||||||
|
"style"
|
||||||
|
"playmode"
|
||||||
|
"difficulty"
|
||||||
|
|
||||||
|
"announcer" {m_sAnnouncer = sValue;}
|
||||||
|
|
||||||
|
"name" {m_sName = sValue;}
|
||||||
|
|
||||||
|
"text" {m_sText = sValue;}
|
||||||
|
|
||||||
|
"mod" {m_sPreferredModifiers += sValue;}
|
||||||
|
|
||||||
|
"stagemod" {m_sStageModifiers += sValue;}
|
||||||
|
|
||||||
|
"lua"
|
||||||
|
|
||||||
|
"screen" {m_sScreen = sValue;}
|
||||||
|
|
||||||
|
"song"
|
||||||
|
"steps"
|
||||||
|
"course"
|
||||||
|
"trail"
|
||||||
|
|
||||||
|
"setenv" {
|
||||||
|
if( cmd.m_vsArgs.size() == 3 )
|
||||||
|
m_SetEnv[ cmd.m_vsArgs[1] ] = cmd.m_vsArgs[2]; }
|
||||||
|
|
||||||
|
"songgroup" {m_sSongGroup = sValue;}
|
||||||
|
|
||||||
|
"sort"
|
||||||
|
{
|
||||||
|
m_SortOrder = StringToSortOrder( sValue );
|
||||||
|
if( m_SortOrder == SortOrder_Invalid )
|
||||||
|
{
|
||||||
|
m_sInvalidReason = ssprintf( "SortOrder \"%s\" is not valid.", sValue.c_str() );
|
||||||
|
m_bInvalid |= true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
"weight" ){m_iWeightPounds = atoi( sValue );}
|
||||||
|
|
||||||
|
"goalcalories" {m_iGoalCalories = atoi( sValue );}
|
||||||
|
|
||||||
|
"goaltype" {m_GoalType = StringToGoalType( sValue );}
|
||||||
|
|
||||||
|
"profileid" {m_sProfileID = sValue;}
|
||||||
|
|
||||||
|
"url" {m_sUrl = sValue;}
|
||||||
|
|
||||||
|
"sound" {m_sSoundPath = sValue;}
|
||||||
|
|
||||||
|
"preparescreen" {m_vsScreensToPrepare.push_back( sValue );}
|
||||||
|
|
||||||
|
"insertcredit" {m_bInsertCredit = true;}
|
||||||
|
|
||||||
|
"clearcredits" {m_bClearCredits = true;}
|
||||||
|
|
||||||
|
"stopmusic" {m_bStopMusic = true;}
|
||||||
|
|
||||||
|
"applydefaultoptions" {m_bApplyDefaultOptions = true;}
|
||||||
@@ -0,0 +1,156 @@
|
|||||||
|
This file contains a list of messages that are used by certain actors.
|
||||||
|
The parameters are included within (), and will sometimes have the proper
|
||||||
|
type. (wip document lol)
|
||||||
|
================================================================================
|
||||||
|
GhostArrowRow
|
||||||
|
|
||||||
|
ColumnJudgmentMessage(
|
||||||
|
tns TapNoteScore
|
||||||
|
tns HoldNoteScore
|
||||||
|
bool Bright
|
||||||
|
)
|
||||||
|
===========================================
|
||||||
|
CourseContentsList
|
||||||
|
|
||||||
|
SetSongMessage(
|
||||||
|
PlayerNumber
|
||||||
|
Song
|
||||||
|
Steps
|
||||||
|
Difficulty
|
||||||
|
Meter
|
||||||
|
Number
|
||||||
|
Modifiers
|
||||||
|
Secret
|
||||||
|
)
|
||||||
|
===========================================
|
||||||
|
DifficultyMeter
|
||||||
|
|
||||||
|
SetMessage(
|
||||||
|
Steps
|
||||||
|
Trail
|
||||||
|
Meter
|
||||||
|
StepsType
|
||||||
|
Difficulty
|
||||||
|
IsCourseDifficulty
|
||||||
|
EditDescription
|
||||||
|
)
|
||||||
|
===========================================
|
||||||
|
EditMenu
|
||||||
|
|
||||||
|
SetMessage( Song )
|
||||||
|
===========================================
|
||||||
|
GameSoundManager
|
||||||
|
|
||||||
|
CrossedBeat( Beat )
|
||||||
|
|
||||||
|
===========================================
|
||||||
|
GameState
|
||||||
|
|
||||||
|
MessageIDToString(Message_PlayerJoined)Message( Player )
|
||||||
|
MessageIDToString(Message_PlayerUnjoined)Message( Player )
|
||||||
|
===========================================
|
||||||
|
LifeMeterBar
|
||||||
|
|
||||||
|
LifeChangedMessage(
|
||||||
|
Player
|
||||||
|
LifeMeter
|
||||||
|
)
|
||||||
|
===========================================
|
||||||
|
LifeMeterTime
|
||||||
|
|
||||||
|
LifeChangedMessage(
|
||||||
|
Player
|
||||||
|
TapNoteScore
|
||||||
|
HoldNoteScore
|
||||||
|
OldLife
|
||||||
|
Difference
|
||||||
|
LifeMeter
|
||||||
|
)
|
||||||
|
===========================================
|
||||||
|
MusicWheelItem
|
||||||
|
|
||||||
|
SetMessage(
|
||||||
|
Song
|
||||||
|
Course
|
||||||
|
Index
|
||||||
|
HasFocus
|
||||||
|
SongGroup
|
||||||
|
)
|
||||||
|
|
||||||
|
SetGradeMessage(
|
||||||
|
PlayerNumber
|
||||||
|
Grade
|
||||||
|
NumTimesPlayed
|
||||||
|
)
|
||||||
|
===========================================
|
||||||
|
NoteDisplay
|
||||||
|
|
||||||
|
SetAttackMessage( "Modifiers" )
|
||||||
|
===========================================
|
||||||
|
OptionRow
|
||||||
|
|
||||||
|
RefreshMessage( GameCommand )
|
||||||
|
===========================================
|
||||||
|
Player
|
||||||
|
|
||||||
|
TransformMessage(
|
||||||
|
Player
|
||||||
|
MultiPlayer
|
||||||
|
iEnabledPlayerIndex
|
||||||
|
iNumEnabledPlayers
|
||||||
|
bPlayerUsingBothSides
|
||||||
|
bReverse
|
||||||
|
bCentered
|
||||||
|
)
|
||||||
|
|
||||||
|
ComboChangedMessage(
|
||||||
|
Player
|
||||||
|
OldCombo
|
||||||
|
OldMissCombo
|
||||||
|
PlayerState
|
||||||
|
PlayerStageStats
|
||||||
|
)
|
||||||
|
|
||||||
|
StepMessage( PlayerNumber, MultiPlayer )
|
||||||
|
|
||||||
|
JudgmentMessage(
|
||||||
|
Player
|
||||||
|
MultiPlayer
|
||||||
|
TapNoteScore
|
||||||
|
Early
|
||||||
|
TapNoteOffset
|
||||||
|
HoldNoteScore
|
||||||
|
)
|
||||||
|
|
||||||
|
ComboMessage(
|
||||||
|
Combo
|
||||||
|
Misses
|
||||||
|
FullComboW1
|
||||||
|
FullComboW2
|
||||||
|
FullComboW3
|
||||||
|
)
|
||||||
|
===========================================
|
||||||
|
ScoreKeeper*
|
||||||
|
|
||||||
|
ScoreChangedMessage( PlayerNumber, MultiPlayer )
|
||||||
|
===========================================
|
||||||
|
ScreenContinue
|
||||||
|
|
||||||
|
HurryTimerMessage( PlayerNumber )
|
||||||
|
===========================================
|
||||||
|
ScreenGameplay
|
||||||
|
|
||||||
|
HealthStateChangedMessage(
|
||||||
|
PlayerNumber
|
||||||
|
HealthState
|
||||||
|
)
|
||||||
|
|
||||||
|
PlayerFailedMessage( PlayerNumber )
|
||||||
|
===========================================
|
||||||
|
ScreenManager
|
||||||
|
|
||||||
|
SystemMessageMessage( Message, NoAnimate )
|
||||||
|
===========================================
|
||||||
|
ScreenWithMenuElements
|
||||||
|
|
||||||
|
SetHelpTextMessage( Text )
|
||||||
Reference in New Issue
Block a user