Scripting API

Scripting API

ComponentField

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

One field of a component, at the offset the engine reported rather than one C# assumed.

public readonly record struct ComponentField

Constructors

ComponentField

public ComponentField(ComponentId Component, string Name, int Offset, FieldKind Kind, int Count)

One field of a component, at the offset the engine reported rather than one C# assumed.

Parameters

  • Component: The component it belongs to, so it cannot be applied to another.
  • Name: The field's name in Rust.
  • Offset: Byte offset from the start of the component.
  • Kind: What kind of value it holds.
  • Count: How many: 1 for a scalar, N for an array.

Properties

Component

public ComponentId Component { get; init; }

The component it belongs to, so it cannot be applied to another.

Name

public string Name { get; init; }

The field's name in Rust.

Offset

public int Offset { get; init; }

Byte offset from the start of the component.

Kind

public FieldKind Kind { get; init; }

What kind of value it holds.

Count

public int Count { get; init; }

How many: 1 for a scalar, N for an array.

Size

public int Size { get; }

Total size of the field in bytes.