Scripting API

Scripting API

SceneMarker

Struct in Abyss.Core, from Abyss.Core.

One light or camera, as the editor's Scene panel marks it: where it is, which way it faces, and what it is.

public readonly struct SceneMarker

Remarks

Laid out as abyss_core::gizmo::SceneMarker is, 120 bytes.

Properties

Entity

public ulong Entity { get; init; }

The entity, packed as the engine packs one.

Kind

public MarkerKind Kind { get; init; }

What it is.

Projection

public MarkerProjection Projection { get; init; }

How a camera projects.

Color

public Vector4 Color { get; init; }

A light's color, in sRGB, as a person picks it: red, green, blue and alpha.

Position

public Vector3 Position { get; init; }

Where it is, in world space.

Range

public float Range { get; init; }

How far a point or spot light reaches, in world units.

Rotation

public Quaternion Rotation { get; init; }

Which way it is turned. A light shines, and a camera looks, along its -Z.

Angle

public float Angle { get; init; }

A spot light's outer angle, from its middle to its edge, or a perspective camera's field of view, from the top of what it sees to the bottom; in radians.

Aspect

public float Aspect { get; init; }

A perspective camera's width over its height.

Near

public float Near { get; init; }

How far in front of a camera its near plane is, in world units; how near an Audio Source is heard whole.

Far

public float Far { get; init; }

How far in front of a camera its far plane is, in world units; how far an Audio Source falls off to.

Area

public Vector4 Area { get; init; }

What an orthographic camera sees, in its own space, in world units: left, bottom, right and top, as X, Y, Z and W; a Particle Emitter's shape's numbers, as MarkerShape says.

Scale

public Vector3 Scale { get; init; }

How big it is along its own X, Y and Z, as its entity's scale says in the world.

Shape

public MarkerShape Shape { get; init; }

A Particle Emitter's shape.

Flat

public bool Flat { get; init; }

Whether a Particle Emitter is drawn flat, its shape in its XY plane.