All Classes Namespaces Functions Variables Enumerations Enumerator Properties
plyGame.Player Class Reference

Shortcut to some common player related object references More...

Static Public Attributes

static CharacterControllerBase Instance = null
 The active player character. It can be either set in Awake or Start of the Player controller so you should not depend on it being ready in Start. More...
 
static Camera Camera = null
 The active player camera. It can be either set in Awake or Start of the camera controller so you should not depend on it being ready in Start. More...
 

Properties

static bool IsReady [get, set]
 This can be used to check if the player is actually ready. This will not only return false while the Instance is null but also while the player is not in a 'ready' state. The Player character is considered ready when the Awake, Start, and Loading (if persistence is on) is done and the Update loop was entered. More...
 

Detailed Description

Shortcut to some common player related object references

Member Data Documentation

Camera plyGame.Player.Camera = null
static

The active player camera. It can be either set in Awake or Start of the camera controller so you should not depend on it being ready in Start.

CharacterControllerBase plyGame.Player.Instance = null
static

The active player character. It can be either set in Awake or Start of the Player controller so you should not depend on it being ready in Start.

Property Documentation

bool plyGame.Player.IsReady
staticgetset

This can be used to check if the player is actually ready. This will not only return false while the Instance is null but also while the player is not in a 'ready' state. The Player character is considered ready when the Awake, Start, and Loading (if persistence is on) is done and the Update loop was entered.