JugiMap Framework
Static Public Member Functions | Static Public Attributes | List of all members
JugiMapBinaryLoader Class Reference
MapLoaders

The JugiMapBinaryLoader class loads data from jugimap binary files (.jmb). More...

#include <jmMapBinaryLoader.h>

Static Public Member Functions

static bool LoadSourceGraphics (std::string _filePath, SourceGraphics *_sourceGraphics)
 Loads source data from a jugimap binary file (.jmb) at the given **_filePath** into an empty **_SourceGraphics**. Returns true if loading succeeds, otherwise returns false. More...
 
static bool LoadMap (std::string _filePath, jugimap::Map *_map, SourceGraphics *_sourceGraphics)
 Loads map data from a jugimap binary file (.jmb) at the given **_filePath** using the associated **_SourceGraphics**. Returns true if loading succeeds, otherwise returns false. More...
 

Static Public Attributes

static std::string pathPrefix = ""
 An optional string attached to the filePath parameter in the loading functions. It must end with slash '/'! More...
 
static std::string error = ""
 Error message if loading fails. More...
 
static std::vector< std::string > messages
 Messages about skipped chunks of data during the loading. More...
 
static int zOrderCounterStart = 1000
 Starting z-order for loaded layers (for engines which manages drawing order of sprites via z-order parameter). More...
 
static int zOrderCounter = 1000
 Z-order counter for loaded layers. More...
 

Detailed Description

The JugiMapBinaryLoader class loads data from jugimap binary files (.jmb).

Member Function Documentation

◆ LoadSourceGraphics()

bool LoadSourceGraphics ( std::string  _filePath,
SourceGraphics *  _sourceGraphics 
)
static

Loads source data from a jugimap binary file (.jmb) at the given **_filePath** into an empty **_SourceGraphics**. Returns true if loading succeeds, otherwise returns false.

◆ LoadMap()

bool LoadMap ( std::string  _filePath,
jugimap::Map *  _map,
SourceGraphics *  _sourceGraphics 
)
static

Loads map data from a jugimap binary file (.jmb) at the given **_filePath** using the associated **_SourceGraphics**. Returns true if loading succeeds, otherwise returns false.

Member Data Documentation

◆ pathPrefix

std::string pathPrefix = ""
static

An optional string attached to the filePath parameter in the loading functions. It must end with slash '/'!

◆ error

std::string error = ""
static

Error message if loading fails.

◆ messages

std::vector< std::string > messages
static

Messages about skipped chunks of data during the loading.

◆ zOrderCounterStart

int zOrderCounterStart = 1000
static

Starting z-order for loaded layers (for engines which manages drawing order of sprites via z-order parameter).

◆ zOrderCounter

int zOrderCounter = 1000
static

Z-order counter for loaded layers.

The documentation for this class was generated from the following files: