SpriteSource

Type

struct

Properties

filename

• Type: FileName
• Optional: false

The path to the sprite file to use.

size

• Type: SpriteSizeType | Tuple<SpriteSizeType, SpriteSizeType>
• Optional: true

The width and height of the sprite. If this is a tuple, the first member of the tuple is the width and the second is the height. Otherwise the size is both width and height. Width and height may only be in the range of 0-4096.

width

• Type: SpriteSizeType
• Optional: true

Mandatory if size is not defined.

Width of the picture in pixels, from 0-4096.

height

• Type: SpriteSizeType
• Optional: true

Mandatory if size is not defined.

Height of the picture in pixels, from 0-4096.

x

• Type: SpriteSizeType
• Optional: true

Horizontal position of the sprite in the source file in pixels.

y

• Type: SpriteSizeType
• Optional: true

Vertical position of the sprite in the source file in pixels.

position

• Type: Tuple<SpriteSizeType, SpriteSizeType>
• Optional: true

Loaded only when x and y are both 0. The first member of the tuple is x and the second is y.

load_in_minimal_mode

• Type: boolean
• Optional: true

Minimal mode is entered when mod loading fails. You are in it when you see the gray box after (part of) the loading screen that tells you a mod error. Modders can ignore this property.

premul_alpha

• Type: boolean
• Optional: true

Whether alpha should be pre-multiplied.

allow_forced_downscale

• Type: boolean
• Optional: true

If true, the sprite may be downsampled to half its size on load even when 'Sprite quality' graphics setting is set to 'High'. Whether downsampling happens depends on detected hardware and other graphics settings.