Asset Type Filtering

Overview

When loading rooms with RoomLoader.Load() or using Screenshotting methods, you might want to filter target room data by asset type, so that only assets of the specified types are loaded or screenshotted.

This section explains how to achieve this using the ROOMLOADER_FLAG Enum.

ROOMLOADER_FLAG Enum

ROOMLOADER_FLAG.INSTANCES

Asset type flags are stored in the ROOMLOADER_FLAG enum. In most cases, you'll use these:

• Individually to target a single asset type.
• Combined using the bitwise OR | operator to target multiple asset types.

STATE HANDLING

If you're not a fan of bitwise operations, see the alternative way to filter by asset type via State.Flags, and the State examples below.

Member	Description
NONE	Doesn't load anything
INSTANCES	Loads Instances from Instance layers
TILEMAPS	Loads Tilemaps from Tile layers
SPRITES	Loads Sprites from Asset layers
SEQUENCES	Loads Sequences from Asset layers
PARTICLES	Loads Particle Systems from Asset layers
TEXTS	Loads Texts from Asset layers
BACKGROUNDS	Loads Backgrounds from Background layers
EFFECTS	Loads Effect layers and on-layer Effects
CORE	Includes INSTANCES, SPRITES and TILEMAPS
EXTENDED	Includes SEQUENCES, TEXTS, BACKGROUNDS and EFFECTS
ALL	Includes all asset types (CORE + EXTENDED). Used by default via the ROOMLOADER_DEFAULT_FLAGS config macro

Regular

// Loads rmLevelCastle01's Tilemaps centered:
RoomLoader.Load(rmLevelCastle01, x, y, 0.5, 0.5, ROOMLOADER_FLAG.TILEMAPS); 

// Loads rmLevelMaze11's Instances and Sprites: 
var _flags = ROOMLOADER_FLAG.INSTANCES | ROOMLOADER_FLAG.TILEMAPS; 
RoomLoader.Load(rmMaze11, x, y, 0, 0, _flags);

// Loads rmLevelRoof with flags set to All BUT Sequences:
var _flags = ROOMLOADER_FLAG.ALL & ~ROOMLOADER_FLAG.SEQUENCES; 
RoomLoader.Load(rmLevelRoof, x, y, 0, 0, _flags);

State

// Loads rmLevelCastle01's Tilemaps centered:
RoomLoader.MiddleCenter().Tilemaps().Load(rmLevelCastle01, x, y); 

// Loads rmLevelMaze11's Instances and Sprites: 
RoomLoader.Instances().Tilemaps().Load(rmMaze11, x, y); 

// Loads rmLevelRoof with flags set to All BUT Sequences:
var _flags = ROOMLOADER_FLAG.ALL & ~ROOMLOADER_FLAG.SEQUENCES;
RoomLoader.Flags(_flags).Load(rmLevelRoof, x, y);