Skip to content

RitnProtoSprite

Data-stage manipulator for data.raw["sprite"][<name>]. Inherits from RitnPrototype. Provides shortcuts to inject a sprite into the utility-sprites and to declare new sprites.

Warning — Factorio 1.x API: this class hasn't been revised since Factorio 2.0. Usable but not validated for 2.0 — see Factorio 2.0 migration.
Source classes/prototypes/Sprite.lua
Stage data
Access require(ritnlib.defines.class.prototype.sprite)
Inherits from RitnPrototype
object_name "RitnProtoSprite"

Constructor

RitnProtoSprite(sprite_name) → RitnProtoSprite

Deep-copies data.raw["sprite"][sprite_name] into prototype if it exists.

Parameters - sprite_name :: string — sprite name.

Methods

:createUtility(priority?, flags?) → RitnProtoSprite

Copies the sprite into data.raw["utility-sprites"].default[<name>] so it becomes available as a utility-sprite. Defaults: priority = "medium", flags = {"icon"}.

Parameters: priority :: string? · flags :: string[]?.

:extend(name, file_name, size?)

Declares a new sprite via data:extend({...}). size accepts a number (square) or a {w, h} table (default 32×32).

Parameters: name :: string · file_name :: string (path) · size :: number|number[]?.

local RitnSprite = require(ritnlib.defines.class.prototype.sprite)
RitnSprite():extend("ritn-logo", "__MyMod__/graphics/logo.png", 64)

The generic mutators are inherited from RitnPrototype.

See also