Scripting API

Scripting API

ActionName

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

An input action as code names it: Actions.Player.Jump, which the build writes from settings/input.json; its path, "Player/Jump" or "Jump" where one map alone has an action so called; or the InputAction itself.

public readonly record struct ActionName

Remarks

One the build wrote, or an InputAction, finds its action by its identity first, so it is found renamed in the editor as the game plays; a path is looked for as it is written.

Constructors

ActionName

public ActionName(string Path, ulong Id = 0)

An input action as code names it: Actions.Player.Jump, which the build writes from settings/input.json; its path, "Player/Jump" or "Jump" where one map alone has an action so called; or the InputAction itself.

Parameters

  • Path: Its map's name and its, or its own where one map alone has an action so called.
  • Id: Its identity, or zero to find it by its path alone.

One the build wrote, or an InputAction, finds its action by its identity first, so it is found renamed in the editor as the game plays; a path is looked for as it is written.

Properties

Path

public string Path { get; init; }

Its map's name and its, or its own where one map alone has an action so called.

Id

public ulong Id { get; init; }

Its identity, or zero to find it by its path alone.

Methods

ToString

public override string ToString()

Operators

implicit operator ActionName

public static implicit operator ActionName(string path)

The action path names.

Parameters

  • path

implicit operator ActionName

public static implicit operator ActionName(InputAction action)

The action itself.

Parameters

  • action