Plush

Sprite#

plupy · Type index

Module: plupy

A sprite datablock (plupy.data.sprites[...]): an image for material maps and Sprite Renderer 2D, with its import settings.

Inherits DataBlock. The settings are also plain props (sprite.maxSize, sprite.pixelsPerUnit, sprite.filter, sprite.mips, sprite.srgb, sprite.wrap, sprite.compression, sprite.borderLeft …).

class Sprite(DataBlock)

Inherits DataBlock: its members are documented there.

Members: import_settings · set_import

import_settings#

import_settings -> dict   # read-only

The stored import settings as a dictionary of importSettings keys (maxSize, pixelsPerUnit, filter, …); a key absent from the dictionary is at its default.

set_import#

set_import(*, max_size: int | None=None, pixels_per_unit: float | None=None, filter: str | None=None, mips: bool | str | None=None, srgb: bool | str | None=None, wrap: str | None=None, compression: str | None=None, border: int | tuple[int, int, int, int] | None=None)

Changes the given import settings (the arguments of SpriteCollection.import_file); omitted ones stay. Every use of the sprite sees the change; each setting is one Undo step unless grouped in plupy.edit.

plupy.data.sprites["Panel"].set_import(pixels_per_unit=64, border=(24, 24, 24, 24), compression="none")

DataBlock · SpriteCollection · edit

Source#