Setup Local Multiplayer

Every Local Multiplayer session starts with the Initialize Local Multiplayer instruction.

Initialize Local Multiplayer

To start a Local Multiplayer session, you must first use the Initialize Local Multiplayer instruction.

1. Add a Game Creator 2 Trigger component to a GameObject in your scene
2. Click "Add Instruction" and choose Initialize Local Multiplayer

Joining

Joining Behavior

Defines how players are able to join the game.

• Join Players When Button Is Pressed: Listens for any button press on any of the unassigned devices.
• Join Players When Join Action Is Triggered: Listens for the assigned Join Action to be pressed.
• Join Manually: Add players using the Add Player instruction.

Player Prefab

A reference to the Player Prefab you would like instantiated when a local player joins. See Player Prefab Configuration.

Tip

You can change which player prefab is instantiated at any time by using the Set Player Prefab instruction.

Joining Enabled By Default

Determines if players are allowed to join immediately after Local Multiplayer has been initialized.

Tip

You can disable or enable joining later by using the Allow Joining instruction.

Limit Number Of Players

Sets a limit on the number of local players that can join the session.

Tip

While the module is designed for up to four local players, you can support as many local players as your game design and hardware allow, with no inherent restrictions from the input system itself.

Split-Screen

Split-Screen Config

The Split-Screen Config allows you to define if and how the screen is divided during a session. See SplitScreen Config.

Persistence

Survive Scene Loads

Determines whether the local multiplayer session is carried between scenes.

Tip

In most scenarios, you will want to have the session persist. See more in the Transitioning Scenes.