Scripting API

Scripting API

GameCursor

Class in Abyss.Core, from Abyss.Core.

The cursor as a game asks for it: GameCursor.Lock holds it still for a camera turned by the mouse — whose motion still arrives — and GameCursor.Hide hides it.

public sealed class GameCursor

Remarks

A game on its own has it on its window. In the editor it is held in the Game panel while the panel has focus; Escape lets it go there, and a click into the panel takes it again. Play starts with it free and shown.

Properties

IsLocked

public bool IsLocked { get; }

Whether the game has asked for it held.

IsHidden

public bool IsHidden { get; }

Whether the game has asked for it hidden.

Methods

Lock

public void Lock()

Holds it where it is, from the next frame.

Unlock

public void Unlock()

Lets it go.

Hide

public void Hide()

Hides it over the game, from the next frame.

Show

public void Show()

Shows it again.