1. Pods
  2. FantomMappy 1.0.6
  3. API
  4. MapHeader

classafFantomMappy::MapHeader

sys::Obj
  afFantomMappy::MapHeader

@Js

Represents the data held within the MPHD chunk.

blockGap

Source

Size? blockGap

Since FMP 0.5

blockSize

Source

Int blockSize

blockSizeInPixels

Source

Size blockSizeInPixels := Size.defVal

blockStagger

Source

Size? blockStagger

Since FMP 0.5

chromeKey

Source

Color? chromeKey

For colour depths 16 and 24 this returns the Colour that is rendered transparent.

Since FMP 0.4

chromeKeyIndex

Source

Int? chromeKeyIndex

For a colour depths of 8, this returns the colour index into MappyMap.colours that is rendered transparent.

Since FMP 0.4

clickMask

Source

Int? clickMask

Since FMP 0.5

colourDepth

Source

Int colourDepth

endian

Source

Endian endian := Endian.big

isIsometric

Source

Bool isIsometric()

Returns true is this map is isometric (has a non-default blockStagger).

mapSizeInBlocks

Source

Size mapSizeInBlocks := Size.defVal

mapSizeInPixels

Source

Size mapSizeInPixels()

This takes into account the staggered block layout of an isometric map.

mapType

Source

MapType mapType := MapType.FMP05

mapVersion

Source

Version mapVersion := Version.defVal

noOfBlocks

Source

Int noOfBlocks

noOfImages

Source

Int noOfImages

reserved1

Source

Int reserved1

reserved2

Source

Int reserved2

risingPillarMode

Source

Bool? risingPillarMode

Since FMP 0.5

textStringUserDataIndex

Source

Int? textStringUserDataIndex

Used by the Block Chunk Loader. A value of null means text strings have not been set. This is defined in the TSTR chunk, but here seemed like a good place to stick it for now