SCRIPTING API / Scripts and entities / Game

Game

Controls the running game itself. Available in shipped games; in the editor's Play mode IsStandalone is false and the rest do nothing.

Kindclass

NamespaceKroys.EngineScripting

Members6

SourceGame.cs

DECLARATION

Declaration

Namespace Kroys.EngineScripting.

Declaration

public static class Game

REFERENCE

Members

Properties

#public static bool IsStandalone { get; }

True in a shipped game, where scripts own menus and the mouse.

propertystatic

Methods

#public static void Quit()

Closes the shipped game.

methodstatic

#public static void SetCursorCaptured(bool captured)

Locks the mouse for play, or frees it for menus. The first call hands the mouse to scripts for good.

methodstatic

#public static void SetFullscreen(bool fullscreen)

Switches between desktop-resolution fullscreen and a window.

methodstatic

#public static void SetInvertLook(bool horizontal, bool vertical)

Inverts mouse look horizontally and/or vertically for the built-in character cameras.

methodstatic

#public static void SetMovementKeys(KeyCode forward, KeyCode back, KeyCode left, KeyCode right, KeyCode jump)

Keys the native character controller reads for walking and jumping.

methodstatic

Signatures

public static bool IsStandalone { get; }
public static void Quit()
public static void SetCursorCaptured(bool captured)
public static void SetFullscreen(bool fullscreen)
public static void SetInvertLook(bool horizontal, bool vertical)
public static void SetMovementKeys(KeyCode forward, KeyCode back, KeyCode left, KeyCode right, KeyCode jump)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.