Scripting API

Scripting API

HeardInput

Record struct in Abyss.Core, from Abyss.Core.

What World.ListenForInput heard first: a key, mouse button, gamepad button or stick's direction.

public readonly record struct HeardInput

Constructors

HeardInput

public HeardInput(HeardKind Kind, uint Number, int Sign)

What World.ListenForInput heard first: a key, mouse button, gamepad button or stick's direction.

Parameters

  • Kind: Which of them.
  • Number: The key's, button's or axis's number; a mouse button's bit.
  • Sign: For a stick, which way it was pushed: one or negative one.

Properties

Kind

public HeardKind Kind { get; init; }

Which of them.

Number

public uint Number { get; init; }

The key's, button's or axis's number; a mouse button's bit.

Sign

public int Sign { get; init; }

For a stick, which way it was pushed: one or negative one.

Methods

ToSource

public BindingSource ToSource(ActionType type)

What a binding of an action of type reads for it: the key or button; a stick pushed, for a vector, as the whole stick, and otherwise as its one axis.

Parameters

  • type