Class ControlsHint

Namespace

TinyLife.Uis

Assembly

TinyLife.dll

A controls hint is a set of information that is displayed in the bottom-right corner of the game that is supposed to help the player with the game's controls. Each controls hint has a condition as well as a set of bindings and a string that it should display.

public class ControlsHint

Inheritance

object

ControlsHint

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Extensions.JsonCopy<T>(T)

Constructors

ControlsHint(string, Func<Options, bool, object>, Func<GameImpl, bool>)

Creates a new controls hint with the given settings.

public ControlsHint(string name, Func<Options, bool, object> keybind, Func<GameImpl, bool> shouldDisplay = null)

Parameters

name string

The name of this controls hint.

keybind Func<Options, bool, object>

A function that returns the keybind that should be displayed, based on the current Options instance, and whether MLEM.Ui.UiControls.IsAutoNavMode is true. Returned bindings can be of type Microsoft.Xna.Framework.Input.Keys, MLEM.Input.MouseButton, Microsoft.Xna.Framework.Input.Buttons, MLEM.Input.GenericInput, MLEM.Input.ModifierKey or Keybind.

shouldDisplay Func<GameImpl, bool>

Whether this controls hint should currently be displayed, based on the current Options instance.

Fields

GlobalHints

A set of hints that are registered to be displayed in the bottom-right corner of the game window automatically. Register new hints using RegisterGlobal(ControlsHint).

public static readonly ReadOnlyCollection<ControlsHint> GlobalHints

Field Value

ReadOnlyCollection<ControlsHint>

Keybind

A function that returns the keybind that should be displayed, based on the current Options instance, and whether MLEM.Ui.UiControls.IsAutoNavMode is true. Returned bindings can be of type Microsoft.Xna.Framework.Input.Keys, MLEM.Input.MouseButton, Microsoft.Xna.Framework.Input.Buttons, MLEM.Input.GenericInput, MLEM.Input.ModifierKey or Keybind.

public readonly Func<Options, bool, object> Keybind

Field Value

Func<Options, bool, object>

Name

The name of this controls hint.

public readonly string Name

Field Value

string

ShouldDisplay

Whether this controls hint should currently be displayed, based on the current Options instance.

public readonly Func<GameImpl, bool> ShouldDisplay

Field Value

Func<GameImpl, bool>

Methods

CreatePanel(Anchor, IEnumerable<ControlsHint>)

public static Panel CreatePanel(Anchor anchor, IEnumerable<ControlsHint> hints)

Parameters

anchor Anchor

hints IEnumerable<ControlsHint>

Returns

Panel

RegisterGlobal(ControlsHint)

Registers the given controls hint to the GlobalHints registry, which causes the hint to be displayed in the bottom-right corner of the game window automatically.

public static ControlsHint RegisterGlobal(ControlsHint hint)

Parameters

hint ControlsHint

The hint to register.

Returns

ControlsHint

The passed hint, for chaining.