Skip to content

Component

The Local Player Manager component can be added to any GameObject to manage Local Players in your scene. It handles player spawning, camera management, UI canvas setup, and split-screen configurations.

Local Player Manager component interface in Unity

Required Component

The Local Player Manager is required for nearly all Local Multiplayer features, including visual scripting instructions, triggers, and conditions.

Joining

Configure multiple aspects of the join behavior:

Join Behavior

Choose how players can join the game:

  • Join Players When Button Is Pressed: Add a new player when any button is pressed
  • Join Players When Join Action Is Triggered: Add a new player when the referenced input action is called
  • Join Players Manually: Add a new player using the Add Player instruction

Additional Settings

  • Join Action: Specify which input action triggers player joining (when using Join Action Is Triggered mode)
  • Max Player Count: Set the maximum number of allowed players (-1 for unlimited)
  • Allow Joining: Enable/disable player joining using the current Join Behavior. Joining is automatically disabled when Max Player Count is reached

Unlimited Players

Set Max Player Count to -1 to remove the limit on the number of players that can join.

Player

Configure the Local Player prefab settings:

  • Local Player Prefab: Reference to your Local Player prefab that spawns for new players. This typically requires both Character and Local Player components.

Runtime Prefab Override

You can override the Local Player Prefab at runtime using either:

  • The Set Player Prefab instruction
  • The Add Player instruction with a custom prefab override

Camera

Set up camera configurations:

  • Shared Camera: Specify which Camera (with Shared Camera component) will be shared by all players when split-screen is inactive
  • Player Shot Prefab: Define the shot camera that will be instantiated and automatically assigned to each new player

Shot Input Bridge Required

The Player Shot Prefab must have a Shot Input Bridge component attached.

Split Screen

Configure default split-screen settings:

Split Screen Mode

  • None: Disables all split-screen functionality
  • Fixed: Screen is always split based on direction settings
  • Dynamic: Automatically switches between Shared Camera and Split Screen based on player visibility

Split Screen Direction

  • Horizontal: Divides the screen horizontally (landscape style)
  • Vertical: Divides the screen vertically (portrait style)

Dynamic Split Screen

Configure player visibility settings for Dynamic split-screen mode directly on the Shared Camera component.