Scripting API

Scripting API

WindowId

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

One of the engine's windows: the primary one, or one opened beside it.

public readonly record struct WindowId

Remarks

A number rather than a handle to anything, the way every other id the engine hands out is. It means something only in the world that issued it and only while that window is open, and it is never written to a file.

Constructors

WindowId

public WindowId(ulong Value)

One of the engine's windows: the primary one, or one opened beside it.

Parameters

  • Value: The engine's number for it. Zero is the primary window.

A number rather than a handle to anything, the way every other id the engine hands out is. It means something only in the world that issued it and only while that window is open, and it is never written to a file.

Properties

Value

public ulong Value { get; init; }

The engine's number for it. Zero is the primary window.

Primary

public static WindowId Primary { get; }

The window the engine opened first, which the frame loop belongs to.

IsPrimary

public bool IsPrimary { get; }

Whether this is the primary window.