Manages joining and leaving of players.
Inheritance
System.Object
PlayerInputManager
public class PlayerInputManager : MonoBehaviour
Fields
Declaration
public const string PlayerJoinedMessage = "OnPlayerJoined"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string PlayerJoinFailedMessage = "OnPlayerJoinFailed"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string PlayerLeftMessage = "OnPlayerLeft"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string SplitScreenSetupChanged = "OnSplitScreenSetupChanged"
Field Value
| Type |
Description |
| System.String |
|
Properties
Declaration
public int fixedNumberOfSplitScreens { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
Declaration
public static PlayerInputManager instance { get; }
Property Value
Declaration
public InputActionProperty joinAction { get; set; }
Property Value
Declaration
public PlayerJoinBehavior joinBehavior { get; set; }
Property Value
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
Maximum number of players allowed concurrently in the game.
Declaration
public int maxPlayerCount { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
Declaration
public PlayerNotifications notificationBehavior { get; set; }
Property Value
Optional delegate that creates players.
Declaration
public Func<PlayerInput> onCreatePlayer { get; set; }
Property Value
Declaration
public Func<PlayerInput> onDestroyPlayer { get; set; }
Property Value
Declaration
public int playerCount { get; }
Property Value
| Type |
Description |
| System.Int32 |
|
Declaration
public PlayerInputManager.PlayerJoinedEvent playerJoinedEvent { get; }
Property Value
Declaration
public PlayerInputManager.PlayerLeftEvent playerLeftEvent { get; }
Property Value
Declaration
public GameObject playerPrefab { get; set; }
Property Value
| Type |
Description |
| GameObject |
|
If enabled, each player will automatically be assigned
Declaration
public bool splitScreen { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
The normalized screen rectangle available for allocating player split-screens into.
Declaration
public Rect splitScreenArea { get; set; }
Property Value
If this is non-zero, split-screen areas will be
Declaration
public float splitScreenBorderWidth { get; set; }
Property Value
| Type |
Description |
| System.Single |
|
Methods
Declaration
public void DisableJoining()
Declaration
public void EnableJoining()
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 |
|
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
JoinPlayerFromActionIfNotAlreadyJoined(InputAction.CallbackContext)
Declaration
public void JoinPlayerFromActionIfNotAlreadyJoined(InputAction.CallbackContext context)
Parameters
Join a new player based on input on a UI element.
Declaration
public void JoinPlayerFromUI()
Events
Declaration
public event Action<PlayerInput> onPlayerJoined
Event Type
Declaration
public event Action<PlayerInput> onPlayerLeft
Event Type
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.