Elevator UI

The elevator panel is the React-based NUI interface that players see when they use an elevator. It is fully immersive, themed per elevator, and adapts to any screen resolution. This page documents every element, state, and interaction available in the panel.

Opening the UI

When a player enters the interaction zone of an elevator floor (either a Volumetric Box or an Entity Target) and presses the configured interact key (default: E), the elevator panel opens.

Before the panel becomes visible, the themed background image is preloaded silently. The UI only appears once the image is fully downloaded, preventing any visual flash or blank frame.

Themed Background

Each elevator has an Animation Style (set in the Dashboard → General tab) that determines the full-screen background rendered behind the panel:

The background is resolution-aware and automatically selects the correct artwork variant based on the player's screen resolution:

The entire panel UI also scales proportionally to the background using a cover-scale algorithm, so it always appears correctly positioned and sized relative to the cabin artwork regardless of resolution.

Panel Layout

The elevator panel is rendered as an in-world control interface, slightly rotated (0.7deg) to give a natural tilted-panel feel. It consists of four main zones stacked vertically:

┌─────────────────────────┐
│  [Watermark logo]       │
│  ┌───────────────────┐  │
│  │  ▼  [0][7]  ▲    │  │  ← HUD Display
│  └───────────────────┘  │
│  ┌───────────────────┐  │
│  │  [0] [1] [2] [3]  │  │  ← Floor Buttons
│  │  [4] [5] [6] [7]  │  │
│  └───────────────────┘  │
│  ::::::::::::::::::::   │  ← Speaker grille (decorative)
│  ┌───────────────────┐  │
│  │  [◁❘▷]  [+]  [☏] │  │  ← Controls Row
│  └───────────────────┘  │
└─────────────────────────┘

HUD Display

The segmented display at the top of the panel shows the current floor number in real-time as the elevator moves between floors.

During the ride, the displayed floor number counts up or down one step at a time, synchronized with the Speed setting in config.lua (each step = one interval of Speed ms).

Floor Buttons

The panel displays one button for every floor configured in the Dashboard. Buttons are ordered numerically and rendered in a grid.

Button States

Each button can be in one of the following visual states:

Button Content

• Floor number — always shown (e.g., 0, 1, 10).
• Floor label — shown as a secondary line below the number only if the label is longer than 3 characters (configured via the Dashboard → Floors tab → Registry Label). Short labels (≤ 3 characters) are omitted to avoid clutter.

Click Behavior

When a valid floor is clicked:

1. The target floor is set and the button becomes active.
2. The door closing animation begins (1 second delay).
3. The ride starts (see Ride Lifecycle).

Clicking an already active floor or the current floor plays the error sound and does nothing.

Controls Row

Three buttons are always shown at the bottom of the panel.

Open Doors (◁❘▷)

• Available only after arriving at a destination (state: PRESS TO OPEN).
• Clicking starts the door-opening animation (opening state) and plays the ding sound.
• After 1.5 seconds, the server is notified, the teleport is finalized, and the UI auto-closes after 2 seconds.
• Disabled during motion (inMotion = true).

Invite (+)

• Visible only to the Host (the player who opened the elevator).
• Clicking fetches the list of nearby players from the server and toggles the Invite Panel.
• Button appears active (highlighted) while the invite panel is open.

Alarm (☏)

• Available to all players in the elevator (Host and Guests).
• Clicking plays the elevator alarm sound effect (elevator_alarm.mp3).
• Purely cosmetic / roleplay feature.

Invite Panel

When the Host clicks the + button, an overlay panel slides in over the floor buttons showing nearby players.

┌───────────────────────┐
│  NEARBY PLAYERS   [x] │
│  ─────────────────── │
│  PlayerName       [+] │
│  AnotherPlayer    [+] │
│  (No players nearby)  │
└───────────────────────┘

Invite Button States

The invite button for each player cycles through states as the interaction progresses:

Once an invite is sent, the button for that player is disabled (clicking again has no effect) until the status updates from the server.

Ride Lifecycle

A complete elevator ride goes through the following phases:

1. [IDLE]        → Player clicks a floor button
2. [CLOSING]     → Door animation plays (1 second)
3. [IN MOTION]   → Floor counter ticks, trip audio plays
                   ESC is blocked during this phase
4. [ARRIVED]     → Counter stops, "PRESS TO OPEN" appears
                   Trip audio stops, ESC still blocked
5. [OPENING]     → Player clicks Open Doors, ding plays
6. [CLOSED]      → Server teleports player, UI auto-closes after 2s

Loading States

While the elevator is in motion or arrived, a centered overlay is shown:

Co-op Ride Sync

When a guest accepts an invite:

1. The server notifies the guest's client to open the elevator UI.
2. The guest's UI enters Guest mode — all floor buttons receive the noClick class, preventing any interaction.
3. When the host selects a floor and departs, a startSharedTrip event is sent to the guest.
4. The guest's UI starts the same ride animation independently, synchronized by floor target.
5. The server handles the actual teleportation for both players simultaneously.

Audio

The elevator UI uses four independent audio tracks:

All audio is client-side only (Web Audio API via the browser NUI context).

Watermark

If MBT.ElevatorSettings.Watermark = true in config.lua, the MalibuTech logo is rendered above the panel. Set to false to remove it.

Localization

All text strings shown in the elevator UI are pulled from MBT.Locale in config.lua and sent to the NUI on resource start:

Edit these values in config.lua to translate or customize the panel text without touching any UI files.