Scripting API

Scripting API

PrefabOverride

Record in Abyss.Core.Scenes, from Abyss.Core.

One thing an instance did of its prefab: a line of its Overrides list, and what Revert and Apply are asked of.

public record PrefabOverride

Constructors

PrefabOverride

public PrefabOverride(OverrideKind Kind, ulong Entity, string Name, string? Component = null, string? Field = null, IReadOnlyList<string>? With = null)

One thing an instance did of its prefab: a line of its Overrides list, and what Revert and Apply are asked of.

Parameters

  • Kind: What it is.
  • Entity: The entity it is about: whose component it is, or the entity added.
  • Name: What that entity is called.
  • Component: The component's name; null for an entity added.
  • Field: For a change, the one field it is narrowed to, or what the names of several begin with — a row's, translation — or null for every field of the component it changed.
  • With: For a component taken off, the others taken off with it, put back and applied with it: what one section of the Inspector holds, as a mesh's section holds whether it casts shadows. Null for none.

Properties

Kind

public OverrideKind Kind { get; init; }

What it is.

Entity

public ulong Entity { get; init; }

The entity it is about: whose component it is, or the entity added.

Name

public string Name { get; init; }

What that entity is called.

Component

public string? Component { get; init; }

The component's name; null for an entity added.

Field

public string? Field { get; init; }

For a change, the one field it is narrowed to, or what the names of several begin with — a row's, translation — or null for every field of the component it changed.

With

public IReadOnlyList<string>? With { get; init; }

For a component taken off, the others taken off with it, put back and applied with it: what one section of the Inspector holds, as a mesh's section holds whether it casts shadows. Null for none.

Components

public IReadOnlyList<string> Components { get; }

For a component taken off, it and those taken off with it; for anything else, its component alone, if any.