Scripting API

Scripting API

CommandOutcome

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

What applying a command buffer did.

public readonly record struct CommandOutcome

Remarks

Every count is of entities the command actually reached. Ids that no longer named a live entity are skipped rather than failing the buffer, so the difference between what was asked for and what is reported here is how much the world moved on underneath the request.

Constructors

CommandOutcome

public CommandOutcome(int Spawned, int Despawned, int Added, int Removed)

What applying a command buffer did.

Parameters

  • Spawned: Entities created.
  • Despawned: Entities removed. Excludes ids that were already gone.
  • Added: Live entities an add reached. Components they already carried were overwritten.
  • Removed: Live entities a remove reached. Counts the entity, not the components taken from it: one that carried none of them is still reached, it simply had nothing to lose.

Every count is of entities the command actually reached. Ids that no longer named a live entity are skipped rather than failing the buffer, so the difference between what was asked for and what is reported here is how much the world moved on underneath the request.

Properties

Spawned

public int Spawned { get; init; }

Entities created.

Despawned

public int Despawned { get; init; }

Entities removed. Excludes ids that were already gone.

Added

public int Added { get; init; }

Live entities an add reached. Components they already carried were overwritten.

Removed

public int Removed { get; init; }

Live entities a remove reached. Counts the entity, not the components taken from it: one that carried none of them is still reached, it simply had nothing to lose.