GameBase.GameScene Class Reference

Root Component that acts as central point between the GameEntities, their components and the GameSystems. More...

Inheritance diagram for GameBase.GameScene:

Public Member Functions
bool	IsRegistered (GameSceneSystem system)
	Determines if the given system is already registered. More...
void	Register (GameSceneSystem system)
	Registers the GameSceneSystem. More...
void	Unregister (GameSceneSystem system)
	Unregisters the GameSceneSystem. More...
T	Get< T > ()
	Search from all the registered GameSceneSystem, which one is of type T, and returns it already casted. More...
GameSceneSystem	GetSceneSystem (Type sceneSystemType)
bool	IsSystemRegistered (Type requestedType)
void	CreateDefaultSystem (Type systemType, UnityEngine.Object context=null)
bool	IsRegistered (Player player)
	Determines if the given Player is already registered. More...
void	Register (Player player)
	Registers the Player. More...
void	Unregister (Player player)
	Unregisters the Player. More...

Static Public Member Functions
static GameScene	FindInHierarchy (Transform startingAt)
	Find the GameScene component jumping from parent to parent until its found and starting at the given transform More...
static bool	ValidateExistsInHierarchy (Transform startingAt)
static bool	ValidateExists (UnityEngine.Object context=null)

Static Public Attributes
static string	systemsContainerName = "GameSystems"
static string	entitiesContainerName = "GameEntities"
static string	playersContainerName = "GamePlayers"

Properties
static Transform	EntitiesParent [get]
static Transform	SystemsParent [get]
static Transform	PlayersParent [get]
Transform	SystemsContainer [get]
Transform	EntitiesContainer [get]
Transform	PlayersContainer [get]
IEnumerable< Player >	Players [get]
	Enumerates the registered players More...
int	PlayersCount [get]
	Returns the count of already registered players. More...
int	Version [get]

Detailed Description

Root Component that acts as central point between the GameEntities, their components and the GameSystems.

Member Function Documentation

CreateDefaultSystem()

void GameBase.GameScene.CreateDefaultSystem	(	Type	systemType,
		UnityEngine.Object	context = null
	)

FindInHierarchy()

static GameScene GameBase.GameScene.FindInHierarchy ( Transform  startingAt )

static

Find the GameScene component jumping from parent to parent until its found and starting at the given transform

Parameters

startingAt

Transform where to start the search.

Returns

Returns the current GameScene of null if not found.

Get< T >()

T GameBase.GameScene.Get< T >

(

)

Search from all the registered GameSceneSystem, which one is of type T, and returns it already casted.

Template Parameters

T	Must inherit from GameSceneSystem

Returns

The already casted scene system found. default value on fail.

Type Constraints

T

:

GameSceneSystem

GetSceneSystem()

GameSceneSystem GameBase.GameScene.GetSceneSystem

(

Type

sceneSystemType

)

IsRegistered() [1/2]

bool GameBase.GameScene.IsRegistered

(

GameSceneSystem

system

)

Determines if the given system is already registered.

Parameters

system

The GameSceneSystem to be checked.

Returns

True if it's registered or false on fail.

IsRegistered() [2/2]

bool GameBase.GameScene.IsRegistered

(

Player

player

)

Determines if the given Player is already registered.

Parameters

player

The Player to be checked.

Returns

True if it's registered or false in otherwise.

IsSystemRegistered()

bool GameBase.GameScene.IsSystemRegistered

(

Type

requestedType

)

Register() [1/2]

void GameBase.GameScene.Register

(

GameSceneSystem

system

)

Registers the GameSceneSystem.

Parameters

system

the scene system to be registered.

Register() [2/2]

void GameBase.GameScene.Register

(

Player

player

)

Registers the Player.

Parameters

player

the player to be registered.

Unregister() [1/2]

void GameBase.GameScene.Unregister

(

GameSceneSystem

system

)

Unregisters the GameSceneSystem.

Parameters

system

the scene system to be unregistered.

Unregister() [2/2]

void GameBase.GameScene.Unregister

(

Player

player

)

Unregisters the Player.

Parameters

player

the player to be unregistered.

ValidateExists()

static bool GameBase.GameScene.ValidateExists ( UnityEngine.Object  context = null )

static

ValidateExistsInHierarchy()

static bool GameBase.GameScene.ValidateExistsInHierarchy ( Transform  startingAt )

static

Member Data Documentation

entitiesContainerName

string GameBase.GameScene.entitiesContainerName = "GameEntities"

static

playersContainerName

string GameBase.GameScene.playersContainerName = "GamePlayers"

static

systemsContainerName

string GameBase.GameScene.systemsContainerName = "GameSystems"

static

Property Documentation

EntitiesContainer

Transform GameBase.GameScene.EntitiesContainer

get

EntitiesParent

Transform GameBase.GameScene.EntitiesParent

staticget

Players

IEnumerable<Player> GameBase.GameScene.Players

get

Enumerates the registered players

PlayersContainer

Transform GameBase.GameScene.PlayersContainer

get

PlayersCount

int GameBase.GameScene.PlayersCount

get

Returns the count of already registered players.

PlayersParent

Transform GameBase.GameScene.PlayersParent

staticget

SystemsContainer

Transform GameBase.GameScene.SystemsContainer

get

SystemsParent

Transform GameBase.GameScene.SystemsParent

staticget

Version

int GameBase.GameScene.Version

get