Scripting API

Scripting API

SceneEdit

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

One thing a person did to a component's handles in the Scene view, for its plugin to make of it.

public readonly record struct SceneEdit

Constructors

SceneEdit

public SceneEdit(SceneEditKind Kind, int Index, Vector2 At, bool Shift, bool Alt)

One thing a person did to a component's handles in the Scene view, for its plugin to make of it.

Parameters

  • Kind: A dot dragged, added or deleted, or a point moved.
  • Index: The dot dragged or deleted, the line a dot is added on, or the point moved.
  • At: Where the dot is to be, dragged or added, in the entity's own units on its XY plane.
  • Shift: Whether Shift is held: by the Rect tool's rule, the shape kept as it grows.
  • Alt: Whether Alt is held: by the Rect tool's rule, the far side moved with it, the middle staying.

Properties

Kind

public SceneEditKind Kind { get; init; }

A dot dragged, added or deleted, or a point moved.

Index

public int Index { get; init; }

The dot dragged or deleted, the line a dot is added on, or the point moved.

At

public Vector2 At { get; init; }

Where the dot is to be, dragged or added, in the entity's own units on its XY plane.

Shift

public bool Shift { get; init; }

Whether Shift is held: by the Rect tool's rule, the shape kept as it grows.

Alt

public bool Alt { get; init; }

Whether Alt is held: by the Rect tool's rule, the far side moved with it, the middle staying.

Point

public Vector3 Point { get; init; }

Where a point moved or added is to be, in the entity's own units; nothing for a dot.