Slices

Benannte Rechtecke, z. B. für Exportbereiche oder Hitboxen. Ein Slice kann auch ein 9-Slice (ein mittleres Rechteck) sein und einen Pivotpunkt tragen; beide beziehen sich wie in Aseprite auf die obere linke Ecke des Slices und wandern mit, wenn die Leinwand skaliert, zugeschnitten oder gedreht wird. (5 Funktionen)

app.addSlice(name, x, y, width, height, opts?) — ändert, rückgängig machbar

Fügt einen neuen benannten rechteckigen Slice hinzu, optional als 9-Slice (center) und/oder mit einem Pivot.

  • name (string)
  • x (number)
  • y (number)
  • width (number)
  • height (number)
  • opts (table, optional)
    • center ({ x, y, width, height }) — Die Mitte des 9-Slice { x, y, width, height }, relativ zum Ursprung des Slices: innerhalb des Slices, positive Größe.
    • pivot ({ x, y }) — Der Pivotpunkt { x, y }, relativ zum Ursprung des Slices (darf außerhalb des Slices liegen).

Gibt zurück (string): Die ID des neuen Slices.

app.getSlices(frameId?) — liest

Jeder Slice als { id, name, x, y, width, height, center = { x, y, width, height } (9-Slice-Slices), pivot = { x, y } (Slices mit Pivot), keyFrameIds (Frames, in denen der Slice einen eigenen Key hat, nur Slices mit Keys pro Frame) }. center und pivot sind relativ zum Ursprung des Slices. Übergib eine Frame-ID für die Geometrie, die in diesem Frame gilt.

  • frameId (string, optional) — Frame, in dem die Slices gelesen werden (ein Slice kann Grenzen, Mitte und Pivot pro Frame ändern); ohne Angabe gilt der erste Frame.

Gibt zurück (table): Array von Slice-Tabellen.

app.removeSlice(sliceId) — ändert, rückgängig machbar

Entfernt einen Slice.

  • sliceId (string)

Gibt nichts zurück.

app.removeSliceKey(sliceId, frameId) — ändert, rückgängig machbar

Entfernt den Key eines Slices an einem Frame (nicht den ersten Frame, der die eigene Geometrie des Slices enthält): Ab diesem Frame gilt wieder die Geometrie des vorherigen Keys. Löst einen Fehler aus, wenn der Slice in diesem Frame keinen Key hat.

  • sliceId (string)
  • frameId (string)

Gibt nichts zurück.

app.updateSlice(sliceId, props, frameId?) — ändert, rückgängig machbar

Aktualisiert eine oder mehrere Eigenschaften eines Slices. Beim Ändern der Größe eines 9-Slice bleibt seine Mitte nur erhalten, wenn sie noch hineinpasst; sonst übergib auch eine neue center (oder false). Mit einer frameId nach dem ersten Frame bearbeiten x, y, width, height, center und pivot den Key des Slices in diesem Frame (und legen einen an: Die neue Geometrie gilt ab diesem Frame bis zum nächsten Key); name gilt immer für den ganzen Slice.

  • sliceId (string)
  • props (table) — Weggelassene Schlüssel bleiben unverändert.
    • name (string) — Der Name des Slices.
    • x (integer) — Linke Kante, in Sprite-Pixeln.
    • y (integer) — Obere Kante, in Sprite-Pixeln.
    • width (integer ≥ 1) — Breite in Pixeln.
    • height (integer ≥ 1) — Höhe in Pixeln.
    • center ({ x, y, width, height } or false) — Die Mitte des 9-Slice { x, y, width, height }, relativ zum Ursprung des Slices: innerhalb des Slices, positive Größe. false löscht sie.
    • pivot ({ x, y } or false) — Der Pivotpunkt { x, y }, relativ zum Ursprung des Slices (darf außerhalb des Slices liegen). false löscht ihn.
  • frameId (string, optional) — Der Frame, für den die Geometrie gilt; ohne Angabe oder beim ersten Frame wird die eigene Geometrie des Slices bearbeitet.

Gibt nichts zurück.

Als Markdown: slices.md.