Scripting API

Scripting API

Tile

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

What a cell of a Tilemap holds: a slice of its tile set, by the slice's identity, flipped across or up; Tile.None for nothing.

public readonly record struct Tile

Remarks

A slice is found by its name with WorldTilemaps.TileNamed. Its identity stays with it as the image is cut again and its slices renamed or put in another order, so a tile a game keeps stays the slice it was.

Constructors

Tile

public Tile(ulong Slice, bool FlipX = false, bool FlipY = false)

What a cell of a Tilemap holds: a slice of its tile set, by the slice's identity, flipped across or up; Tile.None for nothing.

Parameters

  • Slice: The slice's identity, zero for none.
  • FlipX: Whether it is flipped across, its left on the right.
  • FlipY: Whether it is flipped up, its top at the bottom.

A slice is found by its name with WorldTilemaps.TileNamed. Its identity stays with it as the image is cut again and its slices renamed or put in another order, so a tile a game keeps stays the slice it was.

Properties

Slice

public ulong Slice { get; init; }

The slice's identity, zero for none.

FlipX

public bool FlipX { get; init; }

Whether it is flipped across, its left on the right.

FlipY

public bool FlipY { get; init; }

Whether it is flipped up, its top at the bottom.

None

public static Tile None { get; }

Nothing: what an empty cell holds, and what empties one.

IsNone

public bool IsNone { get; }

Whether it is nothing.

Methods

Flipped

public Tile Flipped(bool flipX, bool flipY)

The same slice, flipped across as flipX and up as flipY say.

Parameters

  • flipX
  • flipY