Engine

(NOTE) The GameSession manages all spaces and data for a a game.

Methods	Properties	Base Classes	Derived Classes
CreateNamedSpace	AllSpaces	cog
CreateSpace	Focused
FindAllSpacesByName	FullScreen
FindSpaceByName	Paused
Constructor	Resolution
IsEditorMode
Pause
Quit
RequestQuit
Start

Properties

---

AllSpaces : spacemapvaluerange

read-only

var AllSpaces : SpaceMapValueRange

---

Focused : boolean

read-only

var Focused : Boolean

---

FullScreen : boolean

read-only

var FullScreen : Boolean

---

Paused : boolean

Controls if the game session is paused which prevents updates to all spaces owned by this game.

var Paused : Boolean

---

Resolution : real2

read-only

var Resolution : Real2

---

Methods

---

CreateNamedSpace : space

Create a space from an archetype with the given name. |Name|Type|Description| |---|---|---| |name|string| | |archetype|archetype| |

function CreateNamedSpace(name : String, archetype : Archetype) : Space

---

CreateSpace : space

Create a space in the game. Use the archetype's name. |Name|Type|Description| |---|---|---| |archetype|archetype| |

function CreateSpace(archetype : Archetype) : Space

---

FindAllSpacesByName : spacemapvaluerange

Name	Type	Description
name	string

function FindAllSpacesByName(name : String) : SpaceMapValueRange

---

FindSpaceByName : space

Find a named space. |Name|Type|Description| |---|---|---| |name|string| |

function FindSpaceByName(name : String) : Space

---

GameSession : Void

constructor

Name	Type	Description

function GameSession()

---

IsEditorMode : boolean

Name	Type	Description

function IsEditorMode() : Boolean

---

Pause : Void

Pauses the game session which prevents updates to all spaces owned by this game. |Name|Type|Description| |---|---|---|

function Pause()

---

Quit : Void

Quit the game and exit the engine if not in editor. |Name|Type|Description| |---|---|---|

function Quit()

---

RequestQuit : Void

Request to quit sending out the GameRequestQuit event. |Name|Type|Description| |---|---|---|

function RequestQuit()

---

Start : Void

Start the game. |Name|Type|Description| |---|---|---|

function Start()

---