Provides access to player settings and functionality. More...

Inheritance diagram for TiltFive.Player:

Classes
class	PlayerCore

class	WaitUntilPlayerConnected
	Suspends coroutine execution until the provided player has connected. More...

Static Public Member Functions
static bool	IsConnected (PlayerIndex playerIndex)
	Determines whether the specified player has an associated pair of glasses connected. More...

static bool	TryGetFriendlyName (PlayerIndex playerIndex, out string friendlyName)
	Attempts to get the friendly name assigned to the specified player's glasses. More...

static bool	TryGetSettings (PlayerIndex playerIndex, out PlayerSettings playerSettings)
	Obtains the PlayerSettings corresponding to the specified player. More...

Private Attributes
Dictionary< PlayerIndex, PlayerCore >	players = new Dictionary<PlayerIndex, PlayerCore>()

Additional Inherited Members
Protected Member Functions inherited from TiltFive.Singleton< Player >
	Singleton ()

Properties inherited from TiltFive.Singleton< Player >
static T	Instance `[get]`

Detailed Description

Provides access to player settings and functionality.

Definition at line 30 of file Player.cs.

Member Function Documentation

◆ IsConnected()

static bool TiltFive.Player.IsConnected ( PlayerIndex playerIndex )

static

Determines whether the specified player has an associated pair of glasses connected.

Parameters

playerIndex

Returns

Definition at line 48 of file Player.cs.

         {
             return playerIndex != PlayerIndex.None && Instance.players.TryGetValue(playerIndex, out var playerCore);
         }

References TiltFive.Singleton< Player >.Instance.

Referenced by TiltFive.Display.GetGlassesAvailability(), TiltFive.SplitStereoCamera.OnRenderImage(), and TiltFive.Glasses.GlassesCore.Update().

◆ TryGetFriendlyName()

static bool TiltFive.Player.TryGetFriendlyName	(	PlayerIndex	playerIndex,
		out string	friendlyName
	)

static

Attempts to get the friendly name assigned to the specified player's glasses.

Parameters

playerIndex
friendlyName

Returns

Definition at line 60 of file Player.cs.

         {
             if (playerIndex == PlayerIndex.None || !Instance.players.TryGetValue(playerIndex, out var playerCore))
             {
                 friendlyName = "";
                 return false;
             }
  
             friendlyName = playerCore.FriendlyName;
             return true;
         }

References TiltFive.Singleton< Player >.Instance.

◆ TryGetSettings()

static bool TiltFive.Player.TryGetSettings	(	PlayerIndex	playerIndex,
		out PlayerSettings	playerSettings
	)

static

Obtains the PlayerSettings corresponding to the specified player.

Parameters

playerIndex
playerSettings

Returns: Returns false and sets playerSettings to null if the provided player index is invalid, or if there are no player settings defined in the scene due to the absence of a TiltFiveManager2 or TiltFiveManager.

Definition at line 79 of file Player.cs.

         {
             // We need to obtain a TiltFiveManager2 or TiltFiveManager to query for player settings.
             // Since we don't know which (if either) is available, we'll use TiltFiveSingletonHelper.
             if (playerIndex == PlayerIndex.None || !TiltFiveSingletonHelper.TryGetISceneInfo(out var sceneInfo))
             {
                 playerSettings = null;
                 return false;
             }
  
             if (sceneInfo is TiltFiveManager2 tiltFiveManager2
                 && tiltFiveManager2.TryGetPlayerSettings(playerIndex, out var resultingPlayerSettings))
             {
                 playerSettings = resultingPlayerSettings;
                 return true;
             }
  
             // If we are dealing with a TiltFiveManager, the scene is singleplayer-only; reject other player indices.
             if (sceneInfo is TiltFiveManager tiltFiveManager && playerIndex == PlayerIndex.One)
             {
                 playerSettings = tiltFiveManager.playerSettings;
                 return true;
             }
  
             playerSettings = null;
             return false;
         }