TiltFive.GameBoard Class Reference

Represents the game board. More...

Inheritance diagram for TiltFive.GameBoard:

Classes
struct	GameboardDimensions

Static Public Member Functions
static bool	TryGetGameboardType (out GameboardType gameboardType)
	Attempts to check the latest glasses pose for the current gameboard type, such as LE, XE, or none.
static bool	TryGetGameboardType (PlayerIndex playerIndex, out GameboardType gameboardType)
static bool	TryGetGameboardDimensions (GameboardType gameboardType, out GameboardDimensions gameboardDimensions)
	Attempts to obtain the physical dimensions for a particular gameboard type.

Public Attributes
bool	ShowGizmo
	Shows the game board gizmo in the editor.
bool	ShowGrid
float	GridHeightOffset = 0f
bool	StickyHeightOffset = true
float	GizmoOpacity = 0.75f
	Sets the opacity of the game board gizmo in the editor.
GameboardType	GameboardType
	The gameboard configuration, such as LE, XE, or folded XE.

Static Private Attributes
static Dictionary< PlayerIndex, GameboardType >	playerGameboards = new Dictionary<PlayerIndex, GameboardType>()

Additional Inherited Members
Public Member Functions inherited from TiltFive.UniformScaleTransform
void	Awake ()
Protected Member Functions inherited from TiltFive.UniformScaleTransform
void	UnifyScale ()
	Synchronizes the component values of the game object's local scale vector (e.g. [1,2,3] becomes [3,3,3]).
Properties inherited from TiltFive.UniformScaleTransform
float	localScale [get, set]
	The size of the object as a single float value, rather than a scale vector.
Vector3	position [get, set]
	The position vector for the associated transform.
Quaternion	rotation [get, set]
	The rotation vector for the associated transform.

Detailed Description

Represents the game board.

Definition at line 28 of file GameBoard.cs.

Member Function Documentation

TryGetGameboardDimensions()

static bool TiltFive.GameBoard.TryGetGameboardDimensions ( GameboardType  gameboardType, out GameboardDimensions  gameboardDimensions  )

static

Attempts to obtain the physical dimensions for a particular gameboard type.

Parameters

gameboardType
gameboardDimensions

Returns

Returns dimensions for GameboardType.GameboardType_LE if it fails.

Definition at line 155 of file GameBoard.cs.

        {
            if(gameboardType == GameboardType.GameboardType_None)
            {
                gameboardDimensions = new GameboardDimensions();
                return false;
            }
 
            // Default to the LE gameboard dimensions in meters.
            T5_GameboardSize gameboardSize = new T5_GameboardSize(0.7f, 0.7f, 0.05f);
            int result = 1;
 
            try
            {
                result = NativePlugin.GetGameboardDimensions(gameboardType, ref gameboardSize);
            }
            catch (Exception e)
            {
                Log.Error(e.Message);
            }
 
            gameboardDimensions = new GameboardDimensions(gameboardSize);
 
            return result == 0;
        }

References TiltFive.Logging.Log.Error(), and TiltFive.NativePlugin.GetGameboardDimensions().

TryGetGameboardType() [1/2]

static bool TiltFive.GameBoard.TryGetGameboardType ( out GameboardType  gameboardType )

static

Attempts to check the latest glasses pose for the current gameboard type, such as LE, XE, or none.

Parameters

gameboardType

Output gameboard type. Contains GameboardType.GameboardType_None if no pose was provided, which can happen if the user looks away and the head tracking camera loses sight of the gameboard.

Returns

Returns true on successful pose retrieval, false otherwise.

Definition at line 130 of file GameBoard.cs.

        {
            return TryGetGameboardType(PlayerIndex.One, out gameboardType);
        }

References TiltFive.GameBoard.TryGetGameboardType().

Referenced by TiltFive.GameBoard.TryGetGameboardType().

TryGetGameboardType() [2/2]

static bool TiltFive.GameBoard.TryGetGameboardType ( PlayerIndex  playerIndex, out GameboardType  gameboardType  )

static

Definition at line 135 of file GameBoard.cs.

        {
            // Return false and a default gameboard if the player is nonexistent or disconnected.
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle)
                || !playerGameboards.TryGetValue(playerIndex, out var currentGameboardType))
            {
                gameboardType = GameboardType.GameboardType_None;
                return false;
            }
 
            gameboardType = currentGameboardType;
            return true;
        }

References TiltFive.GameBoard.playerGameboards.

Member Data Documentation

GameboardType

GameboardType TiltFive.GameBoard.GameboardType

The gameboard configuration, such as LE, XE, or folded XE.

Definition at line 57 of file GameBoard.cs.

GizmoOpacity

float TiltFive.GameBoard.GizmoOpacity = 0.75f

Sets the opacity of the game board gizmo in the editor.

Definition at line 50 of file GameBoard.cs.

GridHeightOffset

float TiltFive.GameBoard.GridHeightOffset = 0f

Definition at line 41 of file GameBoard.cs.

playerGameboards

Dictionary<PlayerIndex, GameboardType> TiltFive.GameBoard.playerGameboards = new Dictionary<PlayerIndex, GameboardType>()

staticprivate

Definition at line 95 of file GameBoard.cs.

Referenced by TiltFive.GameBoard.TryGetGameboardType().

ShowGizmo

bool TiltFive.GameBoard.ShowGizmo

Shows the game board gizmo in the editor.

Definition at line 36 of file GameBoard.cs.

ShowGrid

bool TiltFive.GameBoard.ShowGrid

Definition at line 39 of file GameBoard.cs.

StickyHeightOffset

bool TiltFive.GameBoard.StickyHeightOffset = true

Definition at line 42 of file GameBoard.cs.

---

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

• GameBoard.cs