Class ControlHintUI

Hint for active buttons displays at botton-left corner of the screen during gameplay

Implements

Constructors

ControlHintUI()

Declaration
public ControlHintUI()

Properties

Instance

Single instance of this entity

Declaration
public static ControlHintUI Instance { get; }

OffsetX

Position offset X in global space

Declaration
public int OffsetX { get; set; }

OffsetY

Position offset Y in global space

Declaration
public int OffsetY { get; set; }

UseControlHint

True if show the control hint UI

Declaration
public static bool UseControlHint { get; set; }

UseGamePadHint

True if show the gamepad UI indicator

Declaration
public static bool UseGamePadHint { get; set; }

Methods

AddHint(Gamekey, Gamekey, string, int)

Require hint for given game-key for the current frame

Declaration
public static void AddHint(Gamekey keyA, Gamekey keyB, string label, int priority = -2147483648)
int priority

Require with large priority will override the one with small priority

AddHint(Gamekey, string, int)

Require hint for given game-key for the current frame

Declaration
public static void AddHint(Gamekey key, string label, int priority = -2147483648)
int priority

Require with large priority will override the one with small priority

AddHint(KeyboardKey, KeyboardKey, string)

Require hint for given keyboard-key for the current frame

Declaration
public static void AddHint(KeyboardKey keyA, KeyboardKey keyB, string label)

AddHint(KeyboardKey, string)

Require hint for given keyboard-key for the current frame

Declaration
public static void AddHint(KeyboardKey key, string label)

DrawGlobalHint(int, int, Gamekey, Gamekey, string, bool)

Draw a control hint UI on the given position

Declaration
public static void DrawGlobalHint(int globalX, int globalY, Gamekey keyA, Gamekey keyB, string label, bool background = false)
Parameters
Type Name Description
int globalX

Position X in global space
int globalY

Position Y in global space
string label

Hint content
bool background

True if the hint renders with a black background

DrawGlobalHint(int, int, Gamekey, string, bool)

Draw a control hint UI on the given position

Declaration
public static void DrawGlobalHint(int globalX, int globalY, Gamekey key, string label, bool background = false)
Parameters
Type Name Description
int globalX

Position X in global space
int globalY

Position Y in global space
Gamekey key

Target key
string label

Hint content
bool background

True if the hint renders with a black background

DrawGlobalHint(int, int, GamepadKey, GamepadKey, string, bool)

Draw a control hint UI on the given position

Declaration
public static void DrawGlobalHint(int globalX, int globalY, GamepadKey keyA, GamepadKey keyB, string label, bool background = false)
Parameters
Type Name Description
int globalX

Position X in global space
int globalY

Position Y in global space
string label

Hint content
bool background

True if the hint renders with a black background

DrawGlobalHint(int, int, GamepadKey, string, bool)

Draw a control hint UI on the given position

Declaration
public static void DrawGlobalHint(int globalX, int globalY, GamepadKey key, string label, bool background = false)
Parameters
Type Name Description
int globalX

Position X in global space
int globalY

Position Y in global space
GamepadKey key

Target key
string label

Hint content
bool background

True if the hint renders with a black background

DrawGlobalHint(int, int, KeyboardKey, KeyboardKey, string, bool)

Draw a control hint UI on the given position

Declaration
public static void DrawGlobalHint(int globalX, int globalY, KeyboardKey keyA, KeyboardKey keyB, string label, bool background = false)
Parameters
Type Name Description
int globalX

Position X in global space
int globalY

Position Y in global space
string label

Hint content
bool background

True if the hint renders with a black background

DrawGlobalHint(int, int, KeyboardKey, string, bool)

Draw a control hint UI on the given position

Declaration
public static void DrawGlobalHint(int globalX, int globalY, KeyboardKey key, string label, bool background = false)
Parameters
Type Name Description
int globalX

Position X in global space
int globalY

Position Y in global space
KeyboardKey key

Target key
string label

Hint content
bool background

True if the hint renders with a black background

ForceHideGamepad(int)

Hide gamepad indicator even user have turn it on in setting menu

Declaration
public static void ForceHideGamepad(int duration = 1)

ForceHideGlobalHint(int)

Hide all global hints for given frames

Declaration
public static void ForceHideGlobalHint(int duration = 1)

ForceOffset(int, int, int)

Override global position offset for given frames

Declaration
public static void ForceOffset(int x, int y, int duration = 1)

ForceShowHint(int)

Show control hint even user have turn it off in setting menu

Declaration
public static void ForceShowHint(int duration = 1)

OnActivated()

This function is called when entity enter the stage

Declaration
public override void OnActivated()
Overrides