Scripting API

Scripting API

InputBinding

Record in Abyss.Core, from Abyss.Core.

One way of driving an action, and what is done to its value; see Bind for making one.

public record InputBinding

Properties

Id

public ulong Id { get; init; }

Its identity, which stays with it as the file is edited; given when it is bound where it is zero.

Source

public BindingSource? Source { get; init; }

What it reads, or null for a composite.

Parts

public IReadOnlyList<CompositePart> Parts { get; init; }

A composite's parts — negative and positive, or up, down, left and right — or none.

Deadzone

public float? Deadzone { get; init; }

How far from zero it must go before it reads anything, zero to below one, past which the rest is scaled back up to one; null for the engine's own, 0.2 for a stick or axis and zero for the rest.

Scale

public float Scale { get; init; }

What the value is multiplied by, last.

InvertX

public bool InvertX { get; init; }

Whether one number, or a vector's x, is turned the other way.

InvertY

public bool InvertY { get; init; }

Whether a vector's y is turned the other way.

IsComposite

public bool IsComposite { get; }

Whether it is a composite of several pressed things rather than one source.

Methods

Problem

public string? Problem(ActionType type)

What is wrong with it for an action of type, as the engine says it; null for nothing.

Parameters

  • type

Constants

StickDeadzone

public const float StickDeadzone = 0.2

The engine's dead zone for a stick or axis whose binding says none.