Menu namespace
Menu implementation.
Namespaces
Classes
- class AboutSection
- About menu section.
- struct AnimatedValue
- Self-advancing animated scalar.
- class BeginSection
- Main menu root section.
- class CanvasWidget
- Row drawn entirely by a caller-provided callback.
- class ChoiceItem
- Setting row that cycles through values.
- class ControlsOptionsSection
- Controls options menu section.
- class CreateLocalGameOptionsSection
- Local splitscreen game options menu section.
- class CreateServerOptionsSection
- Create server options menu section.
- class CustomLevelSelectSection
- Custom level selection menu section.
- class CustomValueItem
- Setting row with a custom-drawn value.
- class EpisodeSelectSection
- Episode selection menu section.
- class FirstRunSection
- First run menu section.
- class GameplayEnhancementsSection
- Gameplay enhancements menu section.
- class GameplayOptionsSection
- Gameplay options menu section.
- class GraphicsOptionsSection
- Graphics options menu section.
- class HighscoresSection
- Highscores menu section.
- class IMenuContainer
- Base interface of a menu container.
- class ImportSection
- Import Episodes menu section (Emscripten only).
- class InGameMenu
- In-game menu.
- class InputDiagnosticsSection
- Input diagnostics menu section.
- class LanguageSelectSection
- Language selection menu section.
- class ListContainer
- Base of vertical lists of selectable children.
- class ListItem
- Selectable text item.
- class MainMenu
- Main menu.
- class MenuContainerBase
- Shared base of the menu containers.
- class MenuSection
- Base class of a menu section.
- struct MenuStyle
- Centralized look-and-feel of the menu.
- class MenuTransition
- Drives an animated transition between two menu sections.
- class MultiplayerGameModeSelectSection
- Multiplayer game mode selection menu section.
- class OptionsSection
- Options menu section.
- class PauseSection
- In-game menu root section.
- class PlayMultiplayerSection
- Play multiplayer menu section.
- class RefreshCacheSection
- Refresh cache menu section.
- class RemapControlsSection
- Remap controls menu section.
- class RescaleModeSection
- Rescale mode selection menu section.
- class ScoreboardSection
- In-game multiplayer scoreboard.
- class ScrollView
- Vertical list that scrolls when its children overflow the available area.
- class ServerSelectSection
- Server selection menu section.
- class SimpleMessageSection
- Section showing a simple message.
- class Slider
- Setting row with a value bar adjusted left/right.
- class SoundsOptionsSection
- Sounds options menu section.
- class StackLayout
- Vertical list that centers its children within its bounds.
- class StartGameOptionsSection
- Start game options menu section.
- class TextInput
- Editable text row.
- class TextInputBuffer
- Helper class that manages text editing state for text input fields.
- class TouchControlsOptionsSection
- Touch controls options menu section.
- struct TransitionInfo
- Parameters of a section transition.
- class UserProfileOptionsSection
- User profile options menu section.
- class Widget
- Base class of a menu widget.
- struct WidgetInput
- Snapshot of navigation actions newly pressed this frame.
- class WidgetSection
- Base class of a declarative menu section.
Enums
- enum class EpisodeSelectMode { Singleplayer, LocalMultiplayer, OnlineMultiplayer }
- How the episode selected in EpisodeSelectSection should be started.
- enum class ChangedPreferencesType { None = 0x00, Audio = 0x01, Graphics = 0x02, Gameplay = 0x04, Language = 0x08, ControlScheme = 0x10, TouchButtons = 0x20, MainMenu = 0x40 }
- Changed preferences.
- enum class TransitionStyle { None, Fade, SlideHorizontal, SlideVertical, Scale }
- Style of an animated transition between two menu sections.
Enum documentation
enum class Jazz2:: UI:: Menu:: EpisodeSelectMode
How the episode selected in EpisodeSelectSection should be started.
| Enumerators | |
|---|---|
| Singleplayer |
Plain single-player story game |
| LocalMultiplayer |
Local splitscreen multiplayer match |
| OnlineMultiplayer |
Hosted online multiplayer server |
enum class Jazz2:: UI:: Menu:: ChangedPreferencesType
#include <Jazz2/UI/Menu/IMenuContainer.h>
Changed preferences.
Identifies which categories of settings were modified in a menu section, so that the owning container can apply or persist only the affected groups such as audio, graphics, gameplay, language, control scheme or touch button layout. Supports a bitwise combination of its member values.
| Enumerators | |
|---|---|
| None |
None |
| Audio |
Audio |
| Graphics |
Graphics |
| Gameplay |
Gameplay |
| Language |
Language |
| ControlScheme |
Control Scheme |
| TouchButtons |
Touch Buttons layout |
| MainMenu |
Main Menu |
enum class Jazz2:: UI:: Menu:: TransitionStyle
#include <Jazz2/UI/Menu/MenuStyle.h>
Style of an animated transition between two menu sections.
Selects how the outgoing and incoming sections are composited while a transition plays. All styles are implemented purely as a per-layer draw transform (offset/scale/tint) applied by the container, so they require no render targets and add no draw calls.
| Enumerators | |
|---|---|
| None |
No animation, the switch is instant |
| Fade |
Cross-fade by alpha |
| SlideHorizontal |
Slide left when going forward, right when going back |
| SlideVertical |
Slide down when going forward, up when going back |
| Scale |
Scale combined with a cross-fade |