Filesystem/romfs/Stage/StageSequenceInfo: Difference between revisions
(Created StageSequenceInfo page, and documented all parameters, though the SequencePath parameters lack any information.) |
m (Added position column to better show a parameters position.) |
||
| Line 5: | Line 5: | ||
{| class="wikitable" | {| class="wikitable" | ||
|+Main Properties | |+Main Properties | ||
!Position | |||
!Properties | !Properties | ||
!Type | !Type | ||
| Line 10: | Line 11: | ||
!Example Data | !Example Data | ||
|- | |- | ||
|StageSequenceInfo/ | |||
|StageType | |StageType | ||
|String | |String | ||
| Line 15: | Line 17: | ||
|Examples: <code>CourseMap</code>, <code>Demo</code>, <code>FriendMatchSetting</code>, <code>TitleStage</code>, <code>WorldMap</code>. | |Examples: <code>CourseMap</code>, <code>Demo</code>, <code>FriendMatchSetting</code>, <code>TitleStage</code>, <code>WorldMap</code>. | ||
|- | |- | ||
|StageSequenceInfo/ | |||
|$parent | |$parent | ||
|String | |String | ||
| Line 22: | Line 25: | ||
{| class="wikitable" | {| class="wikitable" | ||
|+SequencePath | |+SequencePath | ||
!Position | |||
!Properties | !Properties | ||
!Type | !Type | ||
| Line 27: | Line 31: | ||
!Example Data | !Example Data | ||
|- | |- | ||
|StageSequenceInfo/SequencePath | |||
|Enter | |Enter | ||
|String | |String | ||
| Line 33: | Line 38: | ||
Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Enter_PostInitialize.module.ain</code>. | Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Enter_PostInitialize.module.ain</code>. | ||
|- | |- | ||
|StageSequenceInfo/SequencePath | |||
|InitializeStageInfo | |InitializeStageInfo | ||
|String | |String | ||
| Line 39: | Line 45: | ||
Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_InitializeStageInfo.module.ain</code>, except for <code>Demo</code>, which instead is formatted as <code>Work/Sequence/Module/StageCommon/DoNothing.module.ain</code>. | Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_InitializeStageInfo.module.ain</code>, except for <code>Demo</code>, which instead is formatted as <code>Work/Sequence/Module/StageCommon/DoNothing.module.ain</code>. | ||
|- | |- | ||
|StageSequenceInfo/SequencePath | |||
|Leave | |Leave | ||
|String | |String | ||
| Line 45: | Line 52: | ||
Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Leave_FinalizeLT.module.ain</code>. | Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Leave_FinalizeLT.module.ain</code>. | ||
|- | |- | ||
|StageSequenceInfo/SequencePath | |||
|Load | |Load | ||
|String | |String | ||
| Line 51: | Line 59: | ||
Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Load_InitializeLT.module.ain</code>. | Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Load_InitializeLT.module.ain</code>. | ||
|- | |- | ||
|StageSequenceInfo/SequencePath | |||
|Retry | |Retry | ||
|String | |String | ||
| Line 57: | Line 66: | ||
Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Retry.module.ain</code>. | Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Retry.module.ain</code>. | ||
|- | |- | ||
|StageSequenceInfo/SequencePath | |||
|SubSequence1 | |SubSequence1 | ||
|String | |String | ||
| Line 63: | Line 73: | ||
Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Update_NetSeq.module.ain</code>, except for <code>Demo</code>, which instead is formatted as <code>Work/Sequence/Module/StageCommon/DoNothing.module.ain</code>. | Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Update_NetSeq.module.ain</code>, except for <code>Demo</code>, which instead is formatted as <code>Work/Sequence/Module/StageCommon/DoNothing.module.ain</code>. | ||
|- | |- | ||
|StageSequenceInfo/SequencePath | |||
|UpdateStage | |UpdateStage | ||
|String | |String | ||
| Line 69: | Line 80: | ||
Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Update.module.ain</code>. | Usually formatted as <code>Work/Sequence/Module/XXXXX/XXXXX_Update.module.ain</code>. | ||
|- | |- | ||
|StageSequenceInfo/SequencePath | |||
|UpdateUI | |UpdateUI | ||
|String | |String | ||
Latest revision as of 18:14, 19 November 2023
The StageSequenceInfo contains all of the files that serve to link a stage type to the modules that initialize, load, and update the game.
Parameters[edit | edit source]
The StageSequenceInfo files consist of the Main Properties and a single sub node called SequencePath.
| Position | Properties | Type | Information | Example Data |
|---|---|---|---|---|
| StageSequenceInfo/ | StageType | String | Describes what sequence the file is corresponded to. | Examples: CourseMap, Demo, FriendMatchSetting, TitleStage, WorldMap.
|
| StageSequenceInfo/ | $parent | String | A link to a file to serve as default settings for the StageSequenceInfo.
|
Example: Work/Stage/StageSequenceInfo/Course.game__stage__StageSequenceInfo.gyml.
|
| Position | Properties | Type | Information | Example Data |
|---|---|---|---|---|
| StageSequenceInfo/SequencePath | Enter | String | Defaulted to .
Usually formatted as | |
| StageSequenceInfo/SequencePath | InitializeStageInfo | String | Defaulted to .
Usually formatted as | |
| StageSequenceInfo/SequencePath | Leave | String | Defaulted to .
Usually formatted as | |
| StageSequenceInfo/SequencePath | Load | String | Defaulted to .
Usually formatted as | |
| StageSequenceInfo/SequencePath | Retry | String | Defaulted to .
Usually formatted as | |
| StageSequenceInfo/SequencePath | SubSequence1 | String | Defaulted to .
Usually formatted as | |
| StageSequenceInfo/SequencePath | UpdateStage | String | Defaulted to .
Usually formatted as | |
| StageSequenceInfo/SequencePath | UpdateUI | String | Defaulted to .
Usually formatted as |
Folders[edit | edit source]
- None
Files[edit | edit source]
| Filename | Format | Information |
|---|---|---|
| Course.game__stage__StageSequenceInfo.BGYML | BGYML | |
| Demo.game__stage__StageSequenceInfo.BGYML | BGYML | |
| FriendMatchSetting.game__stage__StageSequenceInfo.BGYML | BGYML | |
| StaffCreditCourse.game__stage__StageSequenceInfo.BGYML | BGYML | |
| Title.game__stage__StageSequenceInfo.BGYML | BGYML | |
| WorldMap.game__stage__StageSequenceInfo.BGYML | BGYML |