Class PlayerInputManager

Manages joining and leaving of players.

Inheritance

System.Object

PlayerInputManager

Namespace: UnityEngine.InputSystem.Plugins.PlayerInput

Syntax

public class PlayerInputManager : MonoBehaviour

Remarks

This is a singleton component. Only one instance is meant to be active in a game at any one time. To retrieve the current instance, use instance.

Fields

PlayerJoinedMessage

Declaration

public const string PlayerJoinedMessage = "OnPlayerJoined"

Field Value

Type	Description
System.String

PlayerJoinFailedMessage

Declaration

public const string PlayerJoinFailedMessage = "OnPlayerJoinFailed"

Field Value

Type	Description
System.String

PlayerLeftMessage

Declaration

public const string PlayerLeftMessage = "OnPlayerLeft"

Field Value

Type	Description
System.String

SplitScreenSetupChanged

Declaration

public const string SplitScreenSetupChanged = "OnSplitScreenSetupChanged"

Field Value

Type	Description
System.String

Properties

fixedNumberOfSplitScreens

This property

Declaration

public int fixedNumberOfSplitScreens { get; set; }

Property Value

Type	Description
System.Int32

instance

Declaration

public static PlayerInputManager instance { get; }

Property Value

Type	Description
PlayerInputManager

joinAction

Declaration

public InputActionProperty joinAction { get; set; }

Property Value

Type	Description
InputActionProperty

joinBehavior

Declaration

public PlayerJoinBehavior joinBehavior { get; set; }

Property Value

Type	Description
PlayerJoinBehavior

joiningEnabled

Declaration

public bool joiningEnabled { get; }

Property Value

Type	Description
System.Boolean

maintainAspectRatioInSplitScreen

If splitScreen is enabled, this property determines whether subdividing the screen is allowed to produce screen areas that have an aspect ratio different from the screen resolution.

Declaration

public bool maintainAspectRatioInSplitScreen { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

By default, when splitScreen is enabled, the manager will add or remove screen subdivisions in steps of two. This means that when, for example, the second player is added, the screen will be subdivided into a left and a right screen area; the left one allocated to the first player and the right one allocated to the second player.

This behavior makes optimal use of screen real estate but will result in screen areas that have aspect ratios different from the screen resolution. If this is not acceptable, this property can be set to true to enforce split-screen to only create screen areas that have the same aspect ratio of the screen.

This results in the screen being subdivided more aggressively. When, for example, a second player is added, the screen will immediately be divided into a four-way split-screen setup with the lower two screen areas not being used.

This property is irrelevant if fixedNumberOfSplitScreens is used.

maxPlayerCount

Maximum number of players allowed concurrently in the game.

Declaration

public int maxPlayerCount { get; set; }

Property Value

Type	Description
System.Int32

Remarks

If this limit is reached, joining is turned off automatically.

By default this is set to -1. Any negative value deactivates the player limit and allows arbitrary many players to join.

notificationBehavior

Declaration

public PlayerNotifications notificationBehavior { get; set; }

Property Value

Type	Description
PlayerNotifications

onCreatePlayer

Optional delegate that creates players.

Declaration

public Func<PlayerInput> onCreatePlayer { get; set; }

Property Value

Type	Description
System.Func<PlayerInput>

Remarks

This can be used in place of playerPrefab to take control over how player objects are created. If this property is not null, playerPrefab will be ignored (and can be left at null) and the delegate will be invoked to create new players.

onDestroyPlayer

Declaration

public Func<PlayerInput> onDestroyPlayer { get; set; }

Property Value

Type	Description
System.Func<PlayerInput>

playerCount

Declaration

public int playerCount { get; }

Property Value

Type	Description
System.Int32

playerJoinedEvent

Declaration

public PlayerInputManager.PlayerJoinedEvent playerJoinedEvent { get; }

Property Value

Type	Description
PlayerInputManager.PlayerJoinedEvent

playerLeftEvent

Declaration

public PlayerInputManager.PlayerLeftEvent playerLeftEvent { get; }

Property Value

Type	Description
PlayerInputManager.PlayerLeftEvent

playerPrefab

Declaration

public GameObject playerPrefab { get; set; }

Property Value

Type	Description
GameObject

splitScreen

If enabled, each player will automatically be assigned

Declaration

public bool splitScreen { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

For this to work, the associated with each PlayerInput component must have a component either directly on the GameObject or on a child.

Note that as player join, the screen may be increasingly subdivided and players may see their previous screen area getting resized.

splitScreenArea

The normalized screen rectangle available for allocating player split-screens into.

Declaration

public Rect splitScreenArea { get; set; }

Property Value

Type	Description
Rect

Remarks

This is only used if splitScreen is true.

By default it is set to (0,0,1,1), i.e. the entire screen area will be used for player screens. If, for example, part of the screen should display a UI/information shared by all players, this property can be used to cut off the area and not have it used by PlayerInputManager.

splitScreenBorderWidth

If this is non-zero, split-screen areas will be

Declaration

public float splitScreenBorderWidth { get; set; }

Property Value

Type	Description
System.Single

Methods

DisableJoining()

Declaration

public void DisableJoining()

EnableJoining()

Declaration

public void EnableJoining()

JoinPlayer(Int32, Int32, String, InputDevice)

Declaration

public void JoinPlayer(int playerIndex = -1, int splitScreenIndex = -1, string controlScheme = null, InputDevice pairWithDevice = null)

Parameters

Type	Name	Description
System.Int32	playerIndex
System.Int32	splitScreenIndex
System.String	controlScheme
InputDevice	pairWithDevice

JoinPlayer(Int32, Int32, String, InputDevice[])

Declaration

public void JoinPlayer(int playerIndex = -1, int splitScreenIndex = -1, string controlScheme = null, params InputDevice[] pairWithDevices)

Parameters

Type	Name	Description
System.Int32	playerIndex
System.Int32	splitScreenIndex
System.String	controlScheme
InputDevice[]	pairWithDevices

JoinPlayerFromAction(InputAction.CallbackContext)

Join a new player based on input received through an InputAction.

Declaration

public void JoinPlayerFromAction(InputAction.CallbackContext context)

Parameters

Type	Name	Description
InputAction.CallbackContext	context

JoinPlayerFromActionIfNotAlreadyJoined(InputAction.CallbackContext)

Declaration

public void JoinPlayerFromActionIfNotAlreadyJoined(InputAction.CallbackContext context)

Parameters

Type	Name	Description
InputAction.CallbackContext	context

JoinPlayerFromUI()

Join a new player based on input on a UI element.

Declaration

public void JoinPlayerFromUI()

Remarks

This should be called directly from a UI callback such as . The device that the player joins with is taken from the device that was used to interact with the UI element.

Events

onPlayerJoined

Declaration

public event Action<PlayerInput> onPlayerJoined

Event Type

Type	Description
System.Action<PlayerInput>

onPlayerLeft

Declaration

public event Action<PlayerInput> onPlayerLeft

Event Type

Type	Description
System.Action<PlayerInput>