Class UnityPlayerJoinOverlayComponent

On-screen panel that lists the players currently joined via the Input System — each slot's player index, control scheme, and devices — so a designer can see local-multiplayer joins happen while testing, instead of guessing from the Console.

Inheritance

object

UnityPlayerJoinOverlayComponent

Namespace: Serenity.InputGateway.Infrastructure.Components

Assembly: Serenity.UnityPlayerInput.Infrastructure.dll

Syntax

public class UnityPlayerJoinOverlayComponent : MonoBehaviour

Remarks

Self-contained: it only reads UnityEngine.InputSystem.PlayerInput.all, so it needs no services and works in any scene that uses PlayerInputManager / PlayerInput. Toggle it from the inspector, with the Serenity.InputGateway.Infrastructure.Components.UnityPlayerJoinOverlayComponent.toggleKey (default F4, so it sits alongside the F3 Diagnostics Overlay), or no-code by wiring Toggle()/Show()/Hide() to a UnityEvent or input action. It hides itself in non-development player builds unless Serenity.InputGateway.Infrastructure.Components.UnityPlayerJoinOverlayComponent.showInBuilds is enabled.

Constructors

UnityPlayerJoinOverlayComponent()

Declaration

public UnityPlayerJoinOverlayComponent()

Methods

Hide()

Hides the panel.

Declaration

public void Hide()

Show()

Shows the panel.

Declaration

public void Show()

Toggle()

Toggles the panel's visibility.

Declaration

public void Toggle()