Variables
	ShaderMaterial

	SpriteAnimationRect

	file
	Load one sprite pack manifest from a project JSON path.

	data

	String
	Load one sprite pack manifest from an already-parsed data dictionary.

	pack_id

	set_definition

	warm_profile

	sprite = {}
	Load and return a Texture2D for one sprite id, or null when unavailable.

	next_data
	Return a copy of manifest data with all required placeholder sprite entries inserted.

	next_sprites = {}

	id = "%s_%s" % [id, direction]

	texture = frames[0] if not frames.is_empty() else null
	Load the first available texture from a preferred/fallback sprite id list.

	frames

	path

	int
	Load and return a scaled Texture2D for UI controls that need smaller icons.

	cache_key

	image

	scaled

	Dictionary
	Resolve a texture from game data that may name a `sprite_id` or legacy path.

	sprite_key

	path_key

	fallback_sprite_id

	sprite_id = sprite_id.strip_edges()

	single

	animation

	frame_definition

	request_metadata

	node

	animation_options

	stretch_mode

	expand_mode

	mouse_filter

	request

	ids = sprites.keys()

	Array
	Preload textures and animation frames for a game, level, or scene.

	bool

	existing_sprite
	Invalidate cached outputs for one changed sprite id without discarding shared source textures.

	existing_path

	prefix
	Build required placeholder sprite rows from a reusable state/direction contract.

	states

	directions

	directional_states

	tags

	category

	state_id

	state_directions

	sprite_tags

	has_all = false

	values

	scaled_values

	scaled_sizes

	flip_h

	flip_v

	material

	shader

	code

	greyscale_material_cache = material

	_ :

	display

	sheet

	cell

	cell_width

	cell_height

	row

	column

	source_image = _image_from_texture_or_path(source_texture, path)

	source_texture

	region

	range_definition

	from_column

	to_column

	step

	resource

	texture_image

	import_file_path

	config

	dest_files

Variable Documentation

◆ _

sprite_manager._ :

protected

Definition at line 689 of file sprite_manager.gd.

◆ animation

sprite_manager.animation

Definition at line 220 of file sprite_manager.gd.

◆ animation_options

sprite_manager.animation_options

Definition at line 262 of file sprite_manager.gd.

◆ Array

sprite_manager.Array

Preload textures and animation frames for a game, level, or scene.

Return missing or placeholder assignments for selected ids, or every required sprite.

Trim final/generated caches to a small set of sprite ids.

Pass explicit ids for scene-local warming, or omit ids to warm every mapped sprite currently loaded in this manager.

This is useful when changing sub-screens inside one game: pass the next screen's warm-list ids, then call warm_texture_cache() or a warm profile.

Definition at line 345 of file sprite_manager.gd.

◆ bool

sprite_manager.bool

Definition at line 429 of file sprite_manager.gd.

◆ cache_key

sprite_manager.cache_key

Definition at line 132 of file sprite_manager.gd.

◆ category

sprite_manager.category

Definition at line 535 of file sprite_manager.gd.

◆ cell

sprite_manager.cell

Definition at line 720 of file sprite_manager.gd.

◆ cell_height

sprite_manager.cell_height

Definition at line 724 of file sprite_manager.gd.

◆ cell_width

sprite_manager.cell_width

Definition at line 723 of file sprite_manager.gd.

◆ code

sprite_manager.code

Definition at line 666 of file sprite_manager.gd.

◆ column

sprite_manager.column

Definition at line 726 of file sprite_manager.gd.

◆ config

sprite_manager.config

Definition at line 869 of file sprite_manager.gd.

◆ data

sprite_manager.data

Definition at line 33 of file sprite_manager.gd.

◆ dest_files

sprite_manager.dest_files

Definition at line 872 of file sprite_manager.gd.

◆ Dictionary

sprite_manager.Dictionary

Resolve a texture from game data that may name a sprite_id or legacy path.

Clear cached textures, cropped sheet cells, scaled UI textures, and frames.

Record a stable sprite id requested by rendering code.

Create a TextureRect-like node for one sprite id.

Static sprites return a normal TextureRect. Animated sprite definitions return a SpriteAnimationRect configured with extracted frames and FPS metadata.

This lets renderers emit the art contract they actually used during development/playtests. The recorded ids can later be merged into a game's sprites.json with manifest_with_requested_sprites().

Clear scene-local/generated cache layers while optionally preserving decoded sources.

Use this when leaving a game scene, editor tool, or large menu. By default it drops final textures, scaled UI textures, animation frame arrays, and cropped sheet-cell textures while keeping decoded source images available for the next scene warmup.

Definition at line 166 of file sprite_manager.gd.

◆ directional_states

sprite_manager.directional_states

Definition at line 533 of file sprite_manager.gd.

◆ directions

sprite_manager.directions

Definition at line 532 of file sprite_manager.gd.

◆ display

sprite_manager.display

Definition at line 697 of file sprite_manager.gd.

◆ existing_path

sprite_manager.existing_path

Definition at line 484 of file sprite_manager.gd.

◆ existing_sprite

sprite_manager.existing_sprite

Invalidate cached outputs for one changed sprite id without discarding shared source textures.

Definition at line 482 of file sprite_manager.gd.

◆ expand_mode

sprite_manager.expand_mode

Definition at line 270 of file sprite_manager.gd.

◆ fallback_sprite_id

sprite_manager.fallback_sprite_id

Definition at line 169 of file sprite_manager.gd.

◆ file

sprite_manager.file

Load one sprite pack manifest from a project JSON path.

Definition at line 30 of file sprite_manager.gd.

◆ flip_h

sprite_manager.flip_h

Definition at line 656 of file sprite_manager.gd.

◆ flip_v

sprite_manager.flip_v

Definition at line 657 of file sprite_manager.gd.

◆ frame_definition

sprite_manager.frame_definition

Definition at line 222 of file sprite_manager.gd.

◆ frames

sprite_manager.frames

Definition at line 116 of file sprite_manager.gd.

◆ from_column

sprite_manager.from_column

Definition at line 828 of file sprite_manager.gd.

◆ greyscale_material_cache

sprite_manager.greyscale_material_cache = material

Definition at line 669 of file sprite_manager.gd.

◆ has_all

sprite_manager.has_all = false

Definition at line 575 of file sprite_manager.gd.

◆ id

str sprite_manager.id = "%s_%s" % [id, direction]

Definition at line 76 of file sprite_manager.gd.

◆ ids

sprite_manager.ids = sprites.keys()

Definition at line 314 of file sprite_manager.gd.

◆ image

sprite_manager.image

Definition at line 140 of file sprite_manager.gd.

◆ import_file_path

sprite_manager.import_file_path

Definition at line 866 of file sprite_manager.gd.

◆ int

sprite_manager.int

Load and return a scaled Texture2D for UI controls that need smaller icons.

Resolve a scaled texture from game data that may name a sprite_id or path.

Definition at line 131 of file sprite_manager.gd.

◆ material

sprite_manager.material

Definition at line 659 of file sprite_manager.gd.

◆ mouse_filter

sprite_manager.mouse_filter

Definition at line 271 of file sprite_manager.gd.

◆ next_data

sprite_manager.next_data

Return a copy of manifest data with all required placeholder sprite entries inserted.

Clear recorded renderer sprite requests.

Return a manifest copy with runtime-requested ids added as placeholders.

Definition at line 68 of file sprite_manager.gd.

◆ next_sprites

dict sprite_manager.next_sprites = {}

Definition at line 69 of file sprite_manager.gd.

◆ node

sprite_manager.node

Definition at line 261 of file sprite_manager.gd.

◆ pack_id

sprite_manager.pack_id

Definition at line 41 of file sprite_manager.gd.

◆ path

sprite_manager.path

Definition at line 121 of file sprite_manager.gd.

◆ path_key

sprite_manager.path_key

Definition at line 168 of file sprite_manager.gd.

◆ prefix

sprite_manager.prefix

Build required placeholder sprite rows from a reusable state/direction contract.

Definition at line 527 of file sprite_manager.gd.

◆ range_definition

sprite_manager.range_definition

Definition at line 825 of file sprite_manager.gd.

◆ region

sprite_manager.region

Definition at line 738 of file sprite_manager.gd.

◆ request

sprite_manager.request

Definition at line 297 of file sprite_manager.gd.

◆ request_metadata

sprite_manager.request_metadata

Definition at line 251 of file sprite_manager.gd.

◆ resource

sprite_manager.resource

Definition at line 844 of file sprite_manager.gd.

◆ row

sprite_manager.row

Definition at line 725 of file sprite_manager.gd.

◆ scaled

sprite_manager.scaled

Definition at line 144 of file sprite_manager.gd.

◆ scaled_sizes

sprite_manager.scaled_sizes

Definition at line 648 of file sprite_manager.gd.

◆ scaled_values

sprite_manager.scaled_values

Definition at line 641 of file sprite_manager.gd.

◆ set_definition

sprite_manager.set_definition

Definition at line 46 of file sprite_manager.gd.

◆ shader

sprite_manager.shader

Definition at line 665 of file sprite_manager.gd.

◆ ShaderMaterial

sprite_manager.ShaderMaterial

Definition at line 23 of file sprite_manager.gd.

◆ sheet

sprite_manager.sheet

Definition at line 716 of file sprite_manager.gd.

◆ single

sprite_manager.single

Definition at line 216 of file sprite_manager.gd.

◆ source_image

sprite_manager.source_image = _image_from_texture_or_path(source_texture, path)

Definition at line 730 of file sprite_manager.gd.

◆ source_texture

sprite_manager.source_texture

Definition at line 732 of file sprite_manager.gd.

◆ sprite

dict sprite_manager.sprite = {}

Load and return a Texture2D for one sprite id, or null when unavailable.

Clear cropped sheet/animation products when sheet metadata changes.

Return animation metadata including configured frames-per-second.

Return Texture2D frames for a sprite definition with animation metadata.

Definition at line 59 of file sprite_manager.gd.

◆ sprite_id

sprite_manager.sprite_id = sprite_id.strip_edges()

Definition at line 170 of file sprite_manager.gd.

◆ sprite_key

sprite_manager.sprite_key

Definition at line 167 of file sprite_manager.gd.

◆ sprite_tags

sprite_manager.sprite_tags

Definition at line 571 of file sprite_manager.gd.

◆ SpriteAnimationRect

sprite_manager.SpriteAnimationRect

Definition at line 25 of file sprite_manager.gd.

◆ state_directions

sprite_manager.state_directions

Definition at line 538 of file sprite_manager.gd.

◆ state_id

sprite_manager.state_id

Definition at line 537 of file sprite_manager.gd.

◆ states

sprite_manager.states

Definition at line 528 of file sprite_manager.gd.

◆ step

sprite_manager.step

Definition at line 830 of file sprite_manager.gd.

◆ stretch_mode

sprite_manager.stretch_mode

Definition at line 269 of file sprite_manager.gd.

◆ String

sprite_manager.String

Load one sprite pack manifest from an already-parsed data dictionary.

Return radians to rotate a canonical-facing sprite toward a movement vector.

Load several sprite pack manifests.

Return one sprite metadata dictionary.

Return one reusable spritesheet or sprite-set metadata dictionary.

Return the res:// texture path for one sprite id.

Definition at line 40 of file sprite_manager.gd.

◆ tags

sprite_manager.tags

Definition at line 534 of file sprite_manager.gd.

◆ texture

sprite_manager.texture = frames[0] if not frames.is_empty() else null

Load the first available texture from a preferred/fallback sprite id list.

Definition at line 114 of file sprite_manager.gd.

◆ texture_image

sprite_manager.texture_image

Definition at line 846 of file sprite_manager.gd.

◆ to_column

sprite_manager.to_column

Definition at line 829 of file sprite_manager.gd.

◆ values

sprite_manager.values

Definition at line 616 of file sprite_manager.gd.

◆ warm_profile

sprite_manager.warm_profile

Definition at line 51 of file sprite_manager.gd.

Variables