Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Runtime Docs Version 2.0.77

# SpritePath - Runtime Docs

## SpritePath :: string

It can be either the name of a SpritePrototype defined in the data stage, or a path in form "type/name" or "type.name".

The validity of a SpritePath can be verified at runtime using LuaHelpers::is_valid_sprite_path.

The supported types are: `"item"` - for example "item/iron-plate" is the icon sprite of iron plate `"entity"` - for example "entity/small-biter" is the icon sprite of the small biter `"technology"` `"recipe"` `"fluid"` `"tile"` `"item-group"` `"virtual-signal"` `"shortcut"` `"achievement"` `"equipment"` `"ammo-category"` `"decorative"` `"space-connection"` `"space-location"` `"surface"` `"airborne-pollutant"` `"asteroid-chunk"` `"quality"` `"file"` - path to an image file located inside the current scenario. This file is not preloaded so it will be slower; for frequently used sprites, it is better to define sprite prototype and use it instead. `"utility"` - sprite defined in the utility-sprites object, these are the pictures used by the game internally for the UI.

Concept used in

- LuaGuiElement::add()
- LuaGuiElement::sprite
- LuaGuiElement::hovered_sprite
- LuaGuiElement::clicked_sprite
- LuaHelpers::is_valid_sprite_path()
- LuaRenderObject::sprite
- LuaRendering::draw_sprite()
- LuaRendering::draw_light()