Log inGet started
Package

sprites.module

README.md

sprites

Draws a flat pixel-art picture showing one cell of a sprite sheet on any entity, without a component: pick the cell, mirror it, flash it white, dither-fade it, tint it, and keep it snapped to the art's pixel grid so it never shimmers. It is the shared drawing code behind twoDKit.Sprite2D, the level's gems, flags and moving-platform planks, and the kit's effects.

attach spawns a temporary child entity under the host (so every peer draws its own and nothing is saved) holding a quad pivoted at the bottom-centre of the frame, one world unit per 16 art pixels (Sprites.PPU). The material must use the kit's twoDKit.sprite shader; the cell, flip, flash, fade and tint are written to the child's per-entity shader data lanes, so one material serves every sprite on the same sheet.

API

  • Sprites.attach(hostId, opts) -> View: opts: material (required), frameWidth, frameHeight (pixels, default 16), columns, rows (default 1), z (depth offset), snap (default true), pivotX, pivotY (0..1, default 0.5, 0), name, scale.
  • Sprites.setCell(view, col, row, flip?): show cell (col, row) counted from the top-left; flip mirrors horizontally.
  • Sprites.setFlash(view, 0..1): mix toward white (hit flash).
  • Sprites.setFade(view, 0..1): ordered-dither transparency (blink, ghost).
  • Sprites.setTint(view, r, g, b, amount): mix toward a colour.
  • Sprites.setVisible(view, bool): show or hide.
  • Sprites.setMaterial(view, material, opts?): swap the sheet; with opts also change frame size and grid (the quad is rebuilt).
  • Sprites.snapTo(view, worldX, worldY): offset the picture so it lands on the 1/16 pixel grid for a host at that position (no-op when snap is off).
  • Sprites.alive(view), Sprites.detach(view).
  • Sprites.quad(w, h, pivotX?, pivotY?): the cached quad mesh used for sprites and parallax bands.
local Sprites = require("pixelSprites.sprites")
local mat = asset.resolve("twoDKit.art.fx.fx", "material")
local v = Sprites.attach(e.id, { material = mat, frameWidth = 16, frameHeight = 16, columns = 8, rows = 8 })
Sprites.setCell(v, 0, 5)          -- first frame of the gem row
Sprites.snapTo(v, e.position.x, e.position.y)
Sprites.detach(v)

For an animated, network-synced sprite with named animations use pixelSprites.SpriteSheet (or twoDKit's Sprite2D for the kit's characters).