Scripting API

Scripting API

PrefabId

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

A prefab a game loaded to make instances of: a hand-made .prefab or a model's, by the path it was loaded by. See World.LoadPrefab.

public readonly record struct PrefabId

Remarks

A number, as a mesh's id is, so a component or a resource can keep it: its kind in the top byte, its number among prefabs below, and zero for none. Loading the same prefab again gives the same id, held once more; each load is given back with World.Release.

Constructors

PrefabId

public PrefabId(ulong Value)

A prefab a game loaded to make instances of: a hand-made .prefab or a model's, by the path it was loaded by. See World.LoadPrefab.

Parameters

  • Value: The id: its kind in the top byte, its number among prefabs below.

A number, as a mesh's id is, so a component or a resource can keep it: its kind in the top byte, its number among prefabs below, and zero for none. Loading the same prefab again gives the same id, held once more; each load is given back with World.Release.

Properties

Value

public ulong Value { get; init; }

The id: its kind in the top byte, its number among prefabs below.

None

public static PrefabId None { get; }

No prefab.

IsNone

public bool IsNone { get; }

Whether this names no prefab.

Methods

ToString

public override string ToString()

The id as a person reads it: prefab 3.