Scripting API

Scripting API

ComponentGiven

Record in Abyss.Core, from Abyss.Core.

What a load would give one component by itself, as Given answers it.

public record ComponentGiven

Constructors

ComponentGiven

public ComponentGiven(bool Brought, IReadOnlySet<string> Same, IReadOnlyDictionary<string, string> Differences)

What a load would give one component by itself, as Given answers it.

Parameters

  • Brought: Whether the load brings the component at all.
  • Same: The fields, by the names its layout gives them, and the enums, by their paths, in which the entity holds exactly what that load gives: what a scene need not write down.
  • Differences: Of the enums that differ, by path, what a scene writes of each: its variant, with only the fields that load does not give as they are — {"Perspective":{"fov":0.5}}. One not here is written whole.

Properties

Brought

public bool Brought { get; init; }

Whether the load brings the component at all.

Same

public IReadOnlySet<string> Same { get; init; }

The fields, by the names its layout gives them, and the enums, by their paths, in which the entity holds exactly what that load gives: what a scene need not write down.

Differences

public IReadOnlyDictionary<string, string> Differences { get; init; }

Of the enums that differ, by path, what a scene writes of each: its variant, with only the fields that load does not give as they are — {"Perspective":{"fov":0.5}}. One not here is written whole.