Main Menu: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
= Main menu = | = Main menu = | ||
The '''main menu''' is the primary user interface presented when '''[[PC Simulator]]''' starts. It is implemented in the Menu scene and provides access to saved games, the [[Tutorial]], configuration options, and application exit. Save data uses the <code>.pc</code> format documented at [[Save]]; external editing is described at [[Save Editor]]. Discoverable interactions that load preset saves are summarized at [[Secrets]]; the hidden-room achievement context appears at [[Achievements:The Hidden Room]]. | |||
{| style="float:right; width:280px; margin:0 0 1em 1em; border-collapse:collapse; border:1px solid #c8ccd1; background:#f8f9fa; font-size:92%;" | {| style="float:right; width:280px; margin:0 0 1em 1em; border-collapse:collapse; border:1px solid #c8ccd1; background:#f8f9fa; font-size:92%;" | ||
|+ style="background:#eaecf0; border:1px solid #c8ccd1; padding:6px; font-weight:bold;" | | |+ style="background:#eaecf0; border:1px solid #c8ccd1; padding:6px; font-weight:bold;" | Summary | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:6px;" | ''' | | style="border:1px solid #c8ccd1; padding:6px;" | '''Function''' | ||
| style="border:1px solid #c8ccd1; padding:6px;" | | | style="border:1px solid #c8ccd1; padding:6px;" | Front-end hub for starting play, managing saves, and adjusting session settings | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:6px;" | ''' | | style="border:1px solid #c8ccd1; padding:6px;" | '''Save format''' | ||
| style="border:1px solid #c8ccd1; padding:6px;" | | | style="border:1px solid #c8ccd1; padding:6px;" | <code>.pc</code> files; see [[Save]] | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:6px;" | ''' | | style="border:1px solid #c8ccd1; padding:6px;" | '''Related economy''' | ||
| style="border:1px solid #c8ccd1; padding:6px;" | | | style="border:1px solid #c8ccd1; padding:6px;" | [[Bitcoin]] and in-game mining ([[EZ Mining]]) apply after gameplay begins | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:6px;" | ''' | | style="border:1px solid #c8ccd1; padding:6px;" | '''Presentation''' | ||
| style="border:1px solid #c8ccd1; padding:6px;" | The title | | style="border:1px solid #c8ccd1; padding:6px;" | The title text alternates to simulate a blinking cursor | ||
|} | |} | ||
<div style="clear:both;"></div> | <div style="clear:both;"></div> | ||
== | == Purpose and functions == | ||
The main menu exposes the following capabilities: | |||
* '''Game load:''' Saved games are listed, typically ordered by most recent file modification time. Saves flagged as hardcore may display a dedicated indicator in the user interface. | |||
* '''Tutorial access:''' If the stored tutorial revision is older than the value configured in the build, a prompt object is shown. Accepting the tutorial updates the stored revision and loads the Tutorial scene. | |||
* '''Settings:''' Frame rate and resolution preferences are restored when the menu initializes so that the initial view matches prior configuration. | |||
* '''Audio:''' Master volume is read from <code>PlayerPrefs</code> and applied to the audio listener before extended playback. | |||
* '''Import:''' External <code>.pc</code> files may be selected, validated, and copied into the user save directory. Invalid or incompatible files produce an error message. This workflow supports distribution and [[Modding]]. | |||
* '''Exit:''' The application requests termination via <code>Application.Quit</code>. Behaviour depends on platform; the Unity Editor may show no visible shutdown. | |||
== Load sequence (overview) == | |||
# The player selects a save entry, or the application loads a preset or example file. | |||
# The active <code>DataLoader</code> instance is registered for the subsequent scene. | |||
# The target scene index is derived from saved <code>GameData.room</code> relative to a configured base build index. | |||
Certain [[Secrets]] and achievement-related paths load example content from streaming assets rather than the user save folder. The programmatic path parallels normal save loading once the file contents are obtained. See [[Achievements:The Hidden Room]] for the documented hidden-room case. | |||
== In-depth == | == In-depth == | ||
The following subsection describes implementation-level behaviour consistent with the decompiled project structure. Asset extraction is discussed at [[Decompile]]; extension of behaviour at [[Modding]]. | |||
=== | === Core components === | ||
{| style="border-collapse:collapse; width:100%; border:1px solid #c8ccd1;" | {| style="border-collapse:collapse; width:100%; border:1px solid #c8ccd1;" | ||
|- style="background:#eaecf0;" | |- style="background:#eaecf0;" | ||
! style="border:1px solid #c8ccd1; padding:8px; text-align:left; width:22%;" | | ! style="border:1px solid #c8ccd1; padding:8px; text-align:left; width:22%;" | Type | ||
! style="border:1px solid #c8ccd1; padding:8px; text-align:left;" | | ! style="border:1px solid #c8ccd1; padding:8px; text-align:left;" | Description | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | <code>MainMenu</code> | | style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | <code>MainMenu</code> | ||
| style="border:1px solid #c8ccd1; padding:8px;" | | | style="border:1px solid #c8ccd1; padding:8px;" | MonoBehaviour singleton exposed as <code>MainMenu.Instance</code>. Initializes localization, restores display settings, controls tutorial gating, drives the title animation, performs asynchronous scene loads, loads example files, and invokes quit. | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | <code>MenuManager</code> | | style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | <code>MenuManager</code> | ||
| style="border:1px solid #c8ccd1; padding:8px;" | | | style="border:1px solid #c8ccd1; padding:8px;" | Maintains a stack of active menu <code>GameObject</code> roots. <code>ShowMenu(string)</code> activates the child whose object name matches the argument (for example <code>Loading</code>). <code>Back</code> removes the current page when the stack depth exceeds one. <code>HideMenu</code> toggles visibility of the top entry without altering stack order. Optional audio feedback may be enabled. | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | <code>FileMenu</code> | | style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | <code>FileMenu</code> | ||
| style="border:1px solid #c8ccd1; padding:8px;" | | | style="border:1px solid #c8ccd1; padding:8px;" | Enumerates save files, constructs list entries, supports metadata editing through <code>FileInformation</code>, deletion, and import via native file selection. | ||
|} | |} | ||
=== Localization === | === Localization === | ||
During <code>Awake</code>, <code>MainMenu</code> invokes <code>Localization.CreateContent()</code>, sets the active language from stored preferences or from <code>Application.systemLanguage</code>, and registers a handler so language changes persist. Further string tables and language codes may be documented at [[Localization]]. | |||
=== Tutorial revision flag === | |||
The integer <code>TutorialVersion</code> in <code>PlayerPrefs</code> is compared to the serialized <code>tutorialVersion</code> field. When the stored value is lower, the guide object is enabled. The <code>Tutorial()</code> method writes the current revision and loads the scene named <code>Tutorial</code>. | |||
=== Asynchronous loading === | |||
Scene transitions display a <code>Loading</code> menu page, then execute an asynchronous load. Reported progress is scaled so that the engine’s <code>0.9</code> completion point maps to a 100 percent display value. After reaching that threshold, the interface shows 100 percent, delays for a fixed interval, then permits scene activation. A dedicated article may appear at [[Loading screen]]. | |||
=== Save and example loading === | |||
<code>LoadFile(DataLoader loader)</code> assigns <code>SaveManager.Loader</code> and loads the build index <code>startRoomSceneIndex + GameData.room</code>. The inspector-configured <code>startRoomSceneIndex</code> aligns logical room identifiers with the editor build order. | |||
<code>LoadExample(string name)</code> reads <code>StreamingAssets/Examples/{name}.pc</code>. On Android | <code>LoadExample(string name)</code> reads <code>StreamingAssets/Examples/{name}.pc</code>. On Android and WebGL the implementation uses <code>UnityWebRequest</code>; on other platforms it uses direct file read APIs. The payload is passed to <code>DataLoader.LoadFromString</code>, followed by <code>LoadFile</code>. Bundled asset names may be listed at [[StreamingAssets]]. | ||
=== | === Import implementation === | ||
<code>FileMenu.Import</code> opens a native picker restricted to <code>.pc</code> extensions, verifies read access, attempts <code>DataLoader.LoadFromPath</code>, copies the file into the save directory using <code>SaveUtility.GetNewPath</code>, destroys existing list rows, and rebuilds the list from disk. Parse failures surface a localized error referencing minimum supported save versions. | |||
=== | === Ancillary topics === | ||
* | * In-game suspension of menu visibility is related to the [[Pause menu]]. | ||
* | * Visual documentation: [[Gallery]]. | ||
* | * Personnel and services context: [[Cheng Yi-Ming]], [[Yiming Connect]], [[VerdiX]]. | ||
* | * Editorial policy: [[PC Simulator Unofficial Wiki:Rules]]. | ||
=== | === Control flow reference === | ||
{| style="border-collapse:collapse; width:100%; border:1px solid #c8ccd1;" | {| style="border-collapse:collapse; width:100%; border:1px solid #c8ccd1;" | ||
|- style="background:#eaecf0;" | |- style="background:#eaecf0;" | ||
! style="border:1px solid #c8ccd1; padding:8px; text-align:left; width:28%;" | | ! style="border:1px solid #c8ccd1; padding:8px; text-align:left; width:28%;" | Event | ||
! style="border:1px solid #c8ccd1; padding:8px; text-align:left;" | | ! style="border:1px solid #c8ccd1; padding:8px; text-align:left;" | Processing | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | | | style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | Save name activated | ||
| style="border:1px solid #c8ccd1; padding:8px;" | <code>MainMenu.LoadFile</code> | | style="border:1px solid #c8ccd1; padding:8px;" | <code>MainMenu.LoadFile</code>; <code>SaveManager.Loader</code> assignment; asynchronous load of <code>startRoomSceneIndex + room</code> | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | Example | | style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | Example or secret preset | ||
| style="border:1px solid #c8ccd1; padding:8px;" | <code>LoadExample</code> from streaming | | style="border:1px solid #c8ccd1; padding:8px;" | <code>LoadExample</code> from streaming assets; then <code>LoadFile</code> | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | | | style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | Scene transition from menu | ||
| style="border:1px solid #c8ccd1; padding:8px;" | <code>ShowMenu("Loading")</code> | | style="border:1px solid #c8ccd1; padding:8px;" | <code>ShowMenu("Loading")</code>; coroutine until activation allowed | ||
|- | |- | ||
| style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | | | style="border:1px solid #c8ccd1; padding:8px; vertical-align:top;" | Tutorial accepted | ||
| style="border:1px solid #c8ccd1; padding:8px;" | | | style="border:1px solid #c8ccd1; padding:8px;" | <code>TutorialVersion</code> updated; <code>LoadScene("Tutorial")</code> | ||
|} | |} | ||
== See also == | == See also == | ||
* [[PC Simulator]] | * [[PC Simulator]] | ||
* [[Save]] · [[Save Editor]] | * [[Save]] · [[Save Editor]] | ||
* [[Secrets]] · [[Achievements:The Hidden Room]] | * [[Secrets]] · [[Achievements:The Hidden Room]] | ||
* [[Bitcoin]] · [[EZ Mining]] | * [[Bitcoin]] · [[EZ Mining]] | ||
* [[Modding]] · [[Decompile]] | * [[Modding]] · [[Decompile]] | ||
* [[Main Page]] | * [[Main Page]] | ||
Revision as of 18:19, 22 March 2026
The main menu is the primary user interface presented when PC Simulator starts. It is implemented in the Menu scene and provides access to saved games, the Tutorial, configuration options, and application exit. Save data uses the .pc format documented at Save; external editing is described at Save Editor. Discoverable interactions that load preset saves are summarized at Secrets; the hidden-room achievement context appears at Achievements:The Hidden Room.
| Function | Front-end hub for starting play, managing saves, and adjusting session settings |
| Save format | .pc files; see Save
|
| Related economy | Bitcoin and in-game mining (EZ Mining) apply after gameplay begins |
| Presentation | The title text alternates to simulate a blinking cursor |
Purpose and functions
The main menu exposes the following capabilities:
- Game load: Saved games are listed, typically ordered by most recent file modification time. Saves flagged as hardcore may display a dedicated indicator in the user interface.
- Tutorial access: If the stored tutorial revision is older than the value configured in the build, a prompt object is shown. Accepting the tutorial updates the stored revision and loads the Tutorial scene.
- Settings: Frame rate and resolution preferences are restored when the menu initializes so that the initial view matches prior configuration.
- Audio: Master volume is read from
PlayerPrefsand applied to the audio listener before extended playback. - Import: External
.pcfiles may be selected, validated, and copied into the user save directory. Invalid or incompatible files produce an error message. This workflow supports distribution and Modding. - Exit: The application requests termination via
Application.Quit. Behaviour depends on platform; the Unity Editor may show no visible shutdown.
Load sequence (overview)
- The player selects a save entry, or the application loads a preset or example file.
- The active
DataLoaderinstance is registered for the subsequent scene. - The target scene index is derived from saved
GameData.roomrelative to a configured base build index.
Certain Secrets and achievement-related paths load example content from streaming assets rather than the user save folder. The programmatic path parallels normal save loading once the file contents are obtained. See Achievements:The Hidden Room for the documented hidden-room case.
In-depth
The following subsection describes implementation-level behaviour consistent with the decompiled project structure. Asset extraction is discussed at Decompile; extension of behaviour at Modding.
Core components
| Type | Description |
|---|---|
MainMenu
|
MonoBehaviour singleton exposed as MainMenu.Instance. Initializes localization, restores display settings, controls tutorial gating, drives the title animation, performs asynchronous scene loads, loads example files, and invokes quit.
|
MenuManager
|
Maintains a stack of active menu GameObject roots. ShowMenu(string) activates the child whose object name matches the argument (for example Loading). Back removes the current page when the stack depth exceeds one. HideMenu toggles visibility of the top entry without altering stack order. Optional audio feedback may be enabled.
|
FileMenu
|
Enumerates save files, constructs list entries, supports metadata editing through FileInformation, deletion, and import via native file selection.
|
Localization
During Awake, MainMenu invokes Localization.CreateContent(), sets the active language from stored preferences or from Application.systemLanguage, and registers a handler so language changes persist. Further string tables and language codes may be documented at Localization.
Tutorial revision flag
The integer TutorialVersion in PlayerPrefs is compared to the serialized tutorialVersion field. When the stored value is lower, the guide object is enabled. The Tutorial() method writes the current revision and loads the scene named Tutorial.
Asynchronous loading
Scene transitions display a Loading menu page, then execute an asynchronous load. Reported progress is scaled so that the engine’s 0.9 completion point maps to a 100 percent display value. After reaching that threshold, the interface shows 100 percent, delays for a fixed interval, then permits scene activation. A dedicated article may appear at Loading screen.
Save and example loading
LoadFile(DataLoader loader) assigns SaveManager.Loader and loads the build index startRoomSceneIndex + GameData.room. The inspector-configured startRoomSceneIndex aligns logical room identifiers with the editor build order.
LoadExample(string name) reads StreamingAssets/Examples/{name}.pc. On Android and WebGL the implementation uses UnityWebRequest; on other platforms it uses direct file read APIs. The payload is passed to DataLoader.LoadFromString, followed by LoadFile. Bundled asset names may be listed at StreamingAssets.
Import implementation
FileMenu.Import opens a native picker restricted to .pc extensions, verifies read access, attempts DataLoader.LoadFromPath, copies the file into the save directory using SaveUtility.GetNewPath, destroys existing list rows, and rebuilds the list from disk. Parse failures surface a localized error referencing minimum supported save versions.
Ancillary topics
- In-game suspension of menu visibility is related to the Pause menu.
- Visual documentation: Gallery.
- Personnel and services context: Cheng Yi-Ming, Yiming Connect, VerdiX.
- Editorial policy: PC Simulator Unofficial Wiki:Rules.
Control flow reference
| Event | Processing |
|---|---|
| Save name activated | MainMenu.LoadFile; SaveManager.Loader assignment; asynchronous load of startRoomSceneIndex + room
|
| Example or secret preset | LoadExample from streaming assets; then LoadFile
|
| Scene transition from menu | ShowMenu("Loading"); coroutine until activation allowed
|
| Tutorial accepted | TutorialVersion updated; LoadScene("Tutorial")
|