UI and Menus

Source: Assembly-CSharp/ (decompiled, global namespace).
Base: T17MonoBehaviour : MonoBehaviour (wraps common T17 lifecycle).
Input: Rewired + Team17UIInputModule with per-gamer T17EventSystem.
Localization: T17Text.SetLocalisedTextCatchAll() with tags like "Text.UI.ShadowsOff".
Persistence: GlobalSave with string keys (e.g. "Settings:VSync", "Audio:MusicVol").

1. Architecture Overview

GlobalStart
 ├─ BootFlow
 ├─ LoadingFlow
 ├─ FrontEndFlow (BaseFlowBehaviour)
 │   ├─ FrontendRootMenu (RootMenu)
 │   └─ EditorRootMenu (RootMenu)
 ├─ LevelFlow
 ├─ InGameMenuFlow (BaseFlowBehaviour)
 │   └─ InGameRootMenu (RootMenu) × N players
 ├─ HUDMenuFlow (BaseFlowBehaviour)
 │   └─ HUDRootMenu (RootMenu) × N players
 └─ ResultsFlow (BaseFlowBehaviour)
      └─ ResultsRootMenu (RootMenu)

Each RootMenu owns a T17TabPanel + a Dictionary<enum, MenuList_Container>. Switching the active type (e.g. FrontendMenuTypeToOpen.Campaign) repopulates the tab panel's bodies and shows the default tab.

2. Flow System

BaseFlowBehaviour : T17MonoBehaviour

• Assembly-CSharp/BaseFlowBehaviour.cs
• m_FlowType (FlowType enum): NotSet, Boot, Loading, Frontend, Level, HUD, InGameMenu, Results
• Registers with GlobalStart via HookUpFlow(); signals completion via SignalDoneWithFlow().

FrontEndFlow : BaseFlowBehaviour

• Assembly-CSharp/FrontEndFlow.cs
• Enum MenuType: GameFrontend, LevelEditor, Unassigned
• Private MODE: MODE_INIT → MODE_SHOW_MENUS/MODE_SHOW_LEVEL_EDITOR → MODE_RUNNING
• Singleton Instance
• Owns FrontendRootMenu m_MainMenu, EditorRootMenu m_EditorMenu
• Manages background video drone (VideoDrone), slide-in/out animations, frontend music
• Key methods: StartFrontEnd(), StartEditorFrontEnd(), SwitchToFrontEndMenuType(), ShowMenus(), HideMenus(), ToggleBackgroundVideo()
• Routes: restores previous FrontendUserPath (versus lobby return, etc.)

InGameMenuFlow : BaseFlowBehaviour

• Assembly-CSharp/InGameMenuFlow.cs
• Singleton Instance
• List<PlayerIGMData> m_PlayersIGMData — one per camera/splitscreen slot
• PlayerIGMData nested class holds per-player references:
  • Canvas m_ParentObject, InGameRootMenu m_PlayerRootMenu
  • MainMapMenu m_Map, CalendarMenu m_Calendar, JobBoardMenu m_JobBoard
  • PayphoneMenu m_Payphone, PlayerSelectMenu m_PlayerSelect
  • PauseMenu m_PauseMenu, GuardBoard m_GuardBoardMenu
  • InformationBoard m_InformationBoardMenu, SignPost m_SignPostMenu
  • BedSaveMenu m_BedSaveMenu, JobTutorialMenu m_JobTutorialMenu
  • PlayerInventoryMenu PlayerInventory (lazy getter)
  • OpenMenuCount tracks stacked menus; AnyMenusOpen / ClickOffCloseContainer()
  • HideActiveMenus() hides all child menus
• Dynamically instantiates IGM canvases for splitscreen (3-4 players)
• Resizes/positions each per-player canvas from HUDItemsLayout data
• Input categories: InputCateogryStates.InGame, InGameMenu, InGamePaused, InGameMainMap
• Open/hide methods: OpenMenu(), HideMenu(), OpenMap/HideMap, OpenCalendar/HideCalendar, OpenJobsBoard/HideJobsBoard, OpenGuardBoard/HideGuardBoard, OpenInformationBoard/HideInformationBoard, OpenPayphone/HidePayphone, OpenPauseMenu/HidePauseMenu, OpenPlayerSelect/HidePlayerSelect, OpenSignPost/HideSignPost, OpenBedSave/HideBedSave, OpenJobTutorialBoard/HideJobTutorialBoard

HUDMenuFlow : BaseFlowBehaviour

• Assembly-CSharp/HUDMenuFlow.cs
• Singleton Instance
• List<PlayerHUDData> m_PlayersHUDData — one per player
• PlayerHUDData nested class holds per-player HUD refs:
  • Canvas m_ParentObject, Canvas m_WorldSpace_ParentObject
  • HUDRootMenu m_PlayerRootMenu, UIAnimatedEffectController m_FadeEffects
  • RoutineAndTimeTrackerHUD m_MiniMapParent, FloorIndicatorHUD m_FloodIndicator
  • PlayerInventoryHUD PlayerInventory (lazy), PlayerSolitaryHUD PlayerSolitaryHUD (lazy)
  • ObjectiveTrackerHUD m_PlayerObjectiveTrackedHUD, TutorialSpeechHUD m_TutorialSpeechHUD
  • ChatFeedHUD m_ChatFeedHUD, PerPlayerTrackedUIElements PerPlayerTrackedItems
  • Camera m_PlayerCamera, T17RawImage m_PIPImage
  • Tutorial popup state: ActivePopupInstance, PopupTimer
• Creates world-space canvases per floor (WorldCanvasTrackedUIElements)
• Manages split-screen HUD layout via SplitscreenHUDHandler + HUDItemLayoutGroup/HUDItemsLayout
• Speech-bubble facade-shift test (DoShiftTestForSpeechBubble) for multi-floor visibility
• Methods: OpenPlayerHUD(), HideMenu(), HideAllHUDs/ShowAllHUDs, Add/RemoveMouseHUDItem(), ShowPopupDialogue(), PlayGlobalEffect()

ResultsFlow : BaseFlowBehaviour

• Assembly-CSharp/ResultsFlow.cs
• Singleton Instance
• Owns ResultsRootMenu m_MainMenu
• MODE: MODE_INIT → MODE_SHOW_MENUS → MODE_RUNNING
• Picks CoopResults vs VersusResults based on ConfigManager.gameType
• ReturnToMainMenu() / ReturnToLobby() set exit flag + frontend route

3. Root Menu Hierarchy

RootMenu : BaseMenuBehaviour

• Assembly-CSharp/RootMenu.cs
• RootMenuType: FrontEnd, InGame, HUD, Results, LevelEditor
• T17TabPanel m_MainTabPanel — drives body switching
• LegendButtonsManager m_LegendButtonsManager
• MenuList_Container — groups of BaseMenuBehaviour per tab, with m_DefaultTab
• EditorHack_BaseMenuBehaviour[] m_EditorTabAbleMenuTypes — serialised tab-mapping from editor
• TextFontTypes m_FontTypesForRootMenu — applies fonts to all T17Text children
• PlayerInventoryMenu m_PlayerInventoryOnThisRoot
• InitializeData() collects all child BaseMenuBehaviour/IT17EventHelper, applies fonts, calls DoSingleTimeInitialize() on each
• Show() sets IT17EventHelper gamers, shows player inventory, updates legends
• SetGamePlayerForMenus() propagates Player to all child menus

FrontendRootMenu : RootMenu

• Assembly-CSharp/FrontendRootMenu.cs
• FrontendMenuTypeToOpen: MainMenu, Campaign, Versus, BrowseGamesMenu, PrisonSetupMenu, Customization, Collectables, Leaderboards, Settings, Credits, Shop, Editor
• Dictionary<FrontendMenuTypeToOpen, MenuList_Container> m_FrontEndTabableMenuTypes
• m_PCBackButton — shown/hidden based on last active controller type
• SetFrontEndMenuTypeToOpen() handles online-area exit for non-online menus
• OpenFrontendChildOfCurrent() opens sub-menus (index > 0)
• PromptGameExit() shows T17DialogBox quit confirmation

EditorRootMenu : RootMenu

• Assembly-CSharp/EditorRootMenu.cs
• EditorMenuTypeToOpen: EditorHomepageMenu, MyPrisonsMenu, BrowseGamesMenu, SubscribedMenu, PrisonSetupMenu
• Singleton m_Instance
• ReturnToNormalFrontend() delegates to FrontEndFlow.Instance.StartFrontEndFromLevelEditor()

InGameRootMenu : RootMenu

• Assembly-CSharp/InGameRootMenu.cs
• InGameMenuTypeToOpen: MainSelf, Inmate, DownedInmate, FavourInmate, ShopInmate, Guard, DownedGuard, Desk, Toilet, SwagBag, Cutlrey, RobinsonFavour, RobinsonContinueFavour
• Dictionary<InGameMenuTypeToOpen, MenuList_Container> m_InGameTabableMenuTypes
• m_EnabledMenuTypeMask — bitmask of InGameMenuTypes flags
• CheckMenuEnabled() / SetMenuEnabled() control per-menu visibility
• HasPanelsToShow() checks if any panel in a type set is enabled
• Shows/hides TabLeft/TabRight based on panel count

HUDRootMenu : RootMenu

• Assembly-CSharp/HUDRootMenu.cs
• HUDMenuTypeToOpen: PlayerInfo, PlayerInfoTutorial
• Dictionary<HUDMenuTypeToOpen, MenuList_Container> m_HUDMenuTypes
• Show() — if no m_MainTabPanel, shows all menus in the set simultaneously

ResultsRootMenu : RootMenu

• Assembly-CSharp/ResultsRootMenu.cs
• ResultsMenuTypeToOpen: CoopResults, VersusResults
• Dictionary<ResultsMenuTypeToOpen, MenuList_Container> m_ResultMenuTypes

4. Base Menu Classes

BaseMenuBehaviour : T17MonoBehaviour, IMenuEventDelegate

• Assembly-CSharp/BaseMenuBehaviour.cs
• InGameMenuTypes flags enum: UnSet = -1, SelfCharacterInfo = 1, CraftingMenu = 2, JournalFavours = 4, JournalTips = 8, ControlsMenu = 16, SettingsMenu = 32, InmateCharacterInfo = 64, InmateGifting = 128, InmateShop = 256, InmateFavour = 512, InmateLooting = 1024, DeskInventory = 2048, ToiletInventory = 4096, SwagBagInventory = 8192, CutlreyInventory = 16384, MAX = 16385
• Player CurrentGamePlayer, Gamer CurrentGamer, Rewired.Player CurrentRewiredPlayer — derived from current gamer
• T17EventSystem CachedEventSystem — per-gamer event system
• Selectable m_Top/Bottom/Left/RightSelectable — navigation anchors for tab-panel linking
• Sprite m_TabIcon / m_TabIconDisabled
• NavigateOnUICancel m_NavigateOnUICancel — invoked on UI_Cancel input
• Animator m_TransitionAnimator — forward/back transition triggers
• m_bShouldBlockParentCancelHandler — when true, parent's cancel handling is suppressed while child is open
• AllowedCancelHandlers — static counter
• m_LegendTextItem / m_LegendLocalisationTag / m_LegendIconData — legend/button-hint system
• Show() sets gamer, manages cancel-blocking, shows game object, fires MenuChangedEvent
• Hide() restores invoker state, cleans up children, fires OnHide
• Child menu tracking: AddChildMenu(), OnChildHide(), GetChildMenus()
• Transition: PlayForwardTransition(), PlayBackTransition(), IsTransitionInProgress()

BaseIngameMenu : BaseMenuBehaviour

• Base class for overlay menus shown on top of gameplay
• Subclasses: CraftingMenu, LootingMenu, PlayerInventoryMenu, DeskMenu, ToiletMenu, SwagBagMenu, ControlsMenu, SettingsMenu, etc.

BaseIngamePassiveUI : BaseMenuBehaviour

• Base class for HUD passive UI elements
• Init(Player player) called during HUD setup
• Subclasses: PlayerStatsHUD, ProgressBarHUD, RoutineAndTimeTrackerHUD, etc.

GameMenuBehaviour : BaseIngameMenu

• Base class for inventory-interactive menus
• GameMenuInformation struct: m_MenuRepresentative, m_MenuRepresentativeContainer, m_Player, m_PlayerItemContainer, m_PlayerInventoryBehaviour, m_PlayerInventoryMenu
• SetGameMenuInformation() receives container/player data

FrontendMenuBehaviour : BaseMenuBehaviour

• Base class for frontend menu panels
• InvokeNavigateOnUICancel() — called when UI_Cancel is pressed in a frontend context

BaseOptionItem : BaseMenuBehaviour

• Assembly-CSharp/BaseOptionItem.cs
• Persistent option with dirty tracking: SetOptionDirty(), ApplyOption(), ResetOption()
• Saves/loads via GlobalSave with string keys
• Subclasses: ToggleOptionItem, ResolutionOptionItem, BlurOptionItem, ShadowDetailOptionItem, VSyncOptionItem, VibrationOptionItem, MusicOptionItem, SFXOptionItem, ProfanityFilterOptionItem, InfluencersOptionItem, PCControlOptionItem, PhotonRegionOptionItem

BaseTooltip : BaseMenuBehaviour

• Base class for tooltip popups

BaseResultsScreen : BaseMenuBehaviour

• Base for results screens (Results_CoopMenu, Results_VersusMenu, Results_CharacterProfile)

BaseContextMenu : BaseMenuBehaviour

• Base for context menus (e.g. FriendsContextMenu)

BaseComponentSetup

• Non-MonoBehaviour utility for component lookup and configuration

5. T17 Widget Library

Core Widgets

Layout & Containers

Overlays & Dialogs

UI Helpers

Event System

Input Categories (InputCateogryStates)

• Frontend
• InGame
• InGameMenu
• InGamePaused
• InGameMainMap
• InGameMouseOnHUD
• Loading

6. Frontend Menus

All frontend menu classes extend FrontendMenuBehaviour : BaseMenuBehaviour.

7. In-Game (Overlay) Menus

8. HUD Widgets

HUD Layout Data

HUDItemsLayout (in Assembly-CSharp/HUDItemsLayout.cs) contains Vector2 fields for every positioned HUD element:

• m_MiniMapPosition/Scale
• m_StatsPosition/Scale
• m_QuestPosition/Scale
• m_EmotePosition/Scale
• m_BottomRightPosition/Scale
• m_VoiceChatFeedPosition/Scale
• m_ChatFeedPosition/Scale
• m_CentreCanvasPosition/Scale
• m_IGMPosition/Scale
• m_MaskContainerSize/Position
• m_CalendarPosition
• m_JobsBoardPosition/Scale
• m_PayphonePosition/Scale
• m_BedSaveMenuPosition/Scale
• m_FullScreenMapKeyOffset/Scale
• m_FullScreenMapFloorsOffset/Scale
• m_FullScreenMapLegendOffset/Scale
• m_InformationMenuPosition/Scale
• m_TutorialPopupPosition/Scale
• m_FadingCanvasPosition/Scale

9. World-Space UI & Tracked Elements

WorldCanvasTrackedUIElements

• Per-floor world-space canvas with object pooling (m_PoolSize)
• Contains T17TrackedUIElement instances for nameplates, speech bubbles, icons
• GetUsedAlwaysVisibleElements() returns active speech bubbles for facade shifting

PerPlayerTrackedUIElements

• Per-player world-space HUD elements (health bars, oven indicators)
• SetTrackingCamera() / SetLayer() for per-player culling
• m_OvenHudContainer reference

T17TrackedUIElement

• Base tracked element attaching to world objects via Transform AttachedTo
• m_SpeechBubble reference for facade offset management

TrackableUIElementsReporter

• Update controller that reports tracked element positions

WorldSpaceHudScalePODO

• Plain-old-data object for world HUD scaling

10. UI Effects & Animation

11. UI Carousels & Friend Activity

12. Settings Options

All options extend BaseOptionItem.

13. Controllers & Remapping

ControlsRemapEntry

• Individual control remapping entry (action → key/button binding)

ControllerSupportLegend

• Legend images for controller bindings

LegendButtonsManager

• Manages legend/button-hint display per root menu; RequestButtonUptate()

T17ControlMapper

• Rewired ControlMapper integration for in-game rebinding UI

AlternateButtonMasher

• Masher for alternate input detection

Input Map Data

• InputMapData.cs — serialised input mapping configuration

SwitchControllerType

• Enum for controller type switching

ControlSetting

• Enum of control setting categories

ControlOption

• Enum of control scheme options (e.g. SchemeA, SchemeB)

14. Navigation Helpers

15. Tutorial & Hint System

16. Guide Arrows

17. Utility Enums & Data Classes

ShadowLevel

Off, Low, High

ControlSetting

LeftStick, RightStick, DPad, FaceButtons, LeftShoulder, RightShoulder,
LeftTrigger, RightTrigger, Start, Back, ActionBottom, ActionRight,
ActionLeft, ActionTop, LeftStickClick, RightStickClick

ControlOption

SchemeA, SchemeB

SwitchControllerType

ProController, JoyCons

PCPlatform

• Platform abstraction for PC-specific UI

PerPlatformActivator

• Activates/deactivates game objects per platform

18. Key Patterns

Tab-Panel Menu Switching

Each RootMenu subclass has a dictionary mapping a menu-type enum → MenuList_Container (list of BaseMenuBehaviour + default index). When the flow calls SetXxxMenuTypeToOpen(), the RootMenu.Show() repopulates T17TabPanel.SetMenuBodies() and selects the default tab.

Single-Player Menu Hierarchy

FrontendRootMenu, EditorRootMenu, ResultsRootMenu operate on a single gamer. InGameRootMenu and HUDRootMenu have per-player instances cloned from a template canvas.

Cancel Handling Stack

BaseMenuBehaviour.m_bShouldBlockParentCancelHandler + static AllowedCancelHandlers form a stack. When a child opens with blocking enabled, the parent's cancel handler is temporarily disabled. On child hide, the parent's handler is restored.

Legend Text System

T17Text supports inline icons via TextPic. BaseMenuBehaviour.UpdateLegendText() converts localisation tags with icon size/offset data into formatted text. Legend data persists across show/hide cycles.

Options Dirty-Track Pattern

BaseOptionItem → SetOptionDirty() marks pending; ApplyOption() writes to GlobalSave and applies; ResetOption() restores saved value. Used by all settings toggles/sliders.

Input Category Management

T17EventSystem.ApplyCategories() switches Rewired action categories based on UI state (e.g. InGame → InGameMenu → InGamePaused). This enables/disables relevant input bindings per context.

HUD Splitscreen Scaling

HUDMenuFlow.CheckMenuInstances() clones the HUD canvas for each player, then applies position/scale from HUDItemsLayout (selected by SplitscreenHUDHandler based on camera count + player index). World-space HUD scale adjusts for 3/4-player splitscreen via m_MasterWorldHUDScale and per-platform multipliers.

T17EventSystem Per-Gamer

Each gamer gets their own T17EventSystem with a dedicated T17RewiredStandaloneInputModule. T17EventSystemsManager maps gamer → event system. All UI interactions use the gamer-specific event system to support split-screen input isolation.

19. File Index

(Key files by functional area)