Game Class

Game Class

Provides convenient access to various parts of the game that are often needed by mods.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          spaar.ModLoaderSingleInstanceGame
            spaar.ModLoaderGame

Namespace: spaar.ModLoader
Assembly: SpaarModLoader (in SpaarModLoader.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public class Game : SingleInstance<Game>

The Game type exposes the following members.

Constructors

	Name	Description
	Game	Initializes a new instance of the Game class

Properties

	Name	Description
	AddPiece	Reference to the AddPiece instance of the current scene. Null if there is no AddPiece in the current scene.
	BlockInfoController	Reference to the BlockInfoController instance of the current scene. Null if there is no BlockInfoController in the current scene.
	CompletedLevels	Array specifying whether each level is completed or not.
	IsSimulating	Whether the game is currently simulating.
	MachineObjectTracker	Reference to the MachineObjectTracker instance of the current scene. Null if there is no MachineObjectTracker in the current scene.
	Name	(Overrides SingleInstanceTName.)

Methods

	Name	Description
	GetCurrentZone	Gets a Zone object representing the current zone. Returns null if the current level is not a zone.
	GetZone	Gets a Zone object representing the specified zone. The Sandbox is Zone 0, all other zones are numbered as shown in the level select screens.

Events

	Name	Description
	OnKeymapperOpen	This event is fired whenever the keymapper is opened.
	OnLevelWon	This event is fired whenever the user completes a level.
	OnSimulationToggle	This event is fired whenever the simulation started or stopped.