Scripting API

Scripting API

PrefabDifferences

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

What of an entity a prefab supplied differs from what the prefab says; see SceneFile.Differences.

public record PrefabDifferences

Constructors

PrefabDifferences

public PrefabDifferences(AssetGuid Prefab, IReadOnlyList<SceneComponent> Changed, IReadOnlyList<string> Added, IReadOnlyList<string> Removed)

What of an entity a prefab supplied differs from what the prefab says; see SceneFile.Differences.

Parameters

  • Prefab: The prefab of the instance it is the top of, or is in.
  • Changed: Each of the prefab's components it holds otherwise, with the fields that differ, at its own values.
  • Added: Each component it carries that the prefab does not give it, by name: the instance's own.
  • Removed: Each component the prefab gives it that it no longer carries, by name, as a scene says it took it off; see SceneOverride.Removed.

Properties

Prefab

public AssetGuid Prefab { get; init; }

The prefab of the instance it is the top of, or is in.

Changed

public IReadOnlyList<SceneComponent> Changed { get; init; }

Each of the prefab's components it holds otherwise, with the fields that differ, at its own values.

Added

public IReadOnlyList<string> Added { get; init; }

Each component it carries that the prefab does not give it, by name: the instance's own.

Removed

public IReadOnlyList<string> Removed { get; init; }

Each component the prefab gives it that it no longer carries, by name, as a scene says it took it off; see SceneOverride.Removed.