TiltFive.Player Class Reference

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

Inheritance diagram for TiltFive.Player:

Classes
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.
static bool	TryGetFriendlyName (PlayerIndex playerIndex, out string friendlyName)
	Attempts to get the friendly name assigned to the specified player's glasses.
static bool	TryGetSettings (PlayerIndex playerIndex, out PlayerSettings playerSettings)
	Obtains the PlayerSettings corresponding to the specified player.

Additional Inherited Members
Protected Member Functions inherited from TiltFive.Singleton< T >
	Singleton ()
Properties inherited from TiltFive.Singleton< T >
static T	Instance [get]

Detailed Description

Provides access to player settings and functionality.

Member Function Documentation

IsConnected()

bool TiltFive.Player.IsConnected ( PlayerIndex playerIndex )

inlinestatic

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

Parameters

playerIndex

Returns

TryGetFriendlyName()

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

inlinestatic

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

Parameters

playerIndex
friendlyName

Returns

TryGetSettings()

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

inlinestatic

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.

---

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

• Runtime/Player/Player.cs