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

Inheritance diagram for TiltFive.Player:

Classes
class	PlayerCore

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

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

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 15 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 32 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 44 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.

Member Data Documentation

◆ players

Dictionary<PlayerIndex, PlayerCore> TiltFive.Player.players = new Dictionary<PlayerIndex, PlayerCore>()

private

Definition at line 19 of file Player.cs.

The documentation for this class was generated from the following file:

Player.cs

Classes

Static Public Member Functions