com.alienfactory.javamappy
Class MapHeader

java.lang.Object
  extended by com.alienfactory.javamappy.MapHeader

public class MapHeader
extends java.lang.Object

MapHeader :: This class represents the data held within the MPHD chunk.

Author:
Steve Eynon

Constructor Summary
MapHeader()
           
 
Method Summary
 int getBlockGapX()
           
 int getBlockGapY()
           
 int getBlockHeight()
          Returns the height of a Block in pixels.
 int getBlockSize()
           
 int getBlockStaggerX()
           
 int getBlockStaggerY()
           
 int getBlockWidth()
          Returns the width of a Block in pixels.
 int getChromeKey()
          For colour depths 16 and 24 this returns the Colour that is rendered transparent.
 int getChromeKeyIndex()
          For a colour depths of 8, this returns the colour index into Map.getColours() that is rendered transparent.
 int getClickMask()
           
 int getColourDepth()
          Returns the colour depth of the block images.
 int getMapBlockHeight()
          Returns the height of the Map in Blocks.
 int getMapBlockWidth()
          Returns the width of the Map in Blocks.
 int getMapPixelHeight()
          Returns the height of the Map in pixels.
 int getMapPixelWidth()
          Returns the width of the Map in pixels.
 int getMapType()
          I'm not really sure what this is, but from my own observations I've noticed the following:
0 = FMP 0.5 1 = FMP 1.0 2 = FMP 1.0 RLE (Run Length Encoding)
 int getMapVersionMajor()
          Returns the major part of the FMP version.
 int getMapVersionMinor()
          Returns the minor part of the FMP version.
 int getNoOfBlocks()
           
 int getNoOfImages()
           
 int getTextStringUserDataIndex()
          Used by the Block Chunk Loader.
 boolean isLsb()
           
 boolean isRisingPillarMode()
          Rising Pillar Mode is essentially Isometric Mode.
 void setBlockGapX(int blockGapX)
           
 void setBlockGapY(int blockGapY)
           
 void setBlockHeight(int blockHeight)
           
 void setBlockSize(int blockSize)
           
 void setBlockStaggerX(int blockStaggerX)
           
 void setBlockStaggerY(int blockStaggerY)
           
 void setBlockWidth(int blockWidth)
           
 void setChromeKey(int chromeKey)
           
 void setChromeKeyIndex(int chromeKeyIndex)
           
 void setClickMask(int clickMask)
           
 void setColourDepth(int colourDepth)
           
 void setLsb(boolean lsb)
           
 void setMapBlockHeight(int mapHeight)
           
 void setMapBlockWidth(int mapWidth)
           
 void setMapType(int mapType)
           
 void setMapVersionMajor(int mapVersionMajor)
           
 void setMapVersionMinor(int mapVersionMinor)
           
 void setNoOfBlocks(int noOfBlocks)
           
 void setNoOfImages(int noOfImages)
           
 void setRisingPillarMode(boolean risingPillarMode)
           
 void setTextStringUserDataIndex(int textStringUserDataIndex)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MapHeader

public MapHeader()
Method Detail

isLsb

public boolean isLsb()

getBlockGapX

public int getBlockGapX()

getBlockGapY

public int getBlockGapY()

getBlockHeight

public int getBlockHeight()
Returns the height of a Block in pixels.


getBlockSize

public int getBlockSize()

getBlockStaggerX

public int getBlockStaggerX()

getBlockStaggerY

public int getBlockStaggerY()

getBlockWidth

public int getBlockWidth()
Returns the width of a Block in pixels.


getChromeKey

public int getChromeKey()
For colour depths 16 and 24 this returns the Colour that is rendered transparent. The colour is in 0xAARRGGBB format where an alpha of 0xFF is fully opaque.


getChromeKeyIndex

public int getChromeKeyIndex()
For a colour depths of 8, this returns the colour index into Map.getColours() that is rendered transparent.
rendered transparent.


getClickMask

public int getClickMask()

getColourDepth

public int getColourDepth()
Returns the colour depth of the block images. Should be one of either 8, 16, 24 or 32.


getMapBlockHeight

public int getMapBlockHeight()
Returns the height of the Map in Blocks.


getMapPixelHeight

public int getMapPixelHeight()
Returns the height of the Map in pixels. This takes into account the staggered block layout of an isometric map.


getMapType

public int getMapType()
I'm not really sure what this is, but from my own observations I've noticed the following:


getMapVersionMajor

public int getMapVersionMajor()
Returns the major part of the FMP version.


getMapVersionMinor

public int getMapVersionMinor()
Returns the minor part of the FMP version.


getMapBlockWidth

public int getMapBlockWidth()
Returns the width of the Map in Blocks.


getMapPixelWidth

public int getMapPixelWidth()
Returns the width of the Map in pixels. This takes into account the staggered block layout of an isometric map.


getNoOfBlocks

public int getNoOfBlocks()

getNoOfImages

public int getNoOfImages()

isRisingPillarMode

public boolean isRisingPillarMode()
Rising Pillar Mode is essentially Isometric Mode.


getTextStringUserDataIndex

public int getTextStringUserDataIndex()
Used by the Block Chunk Loader. A value of -1 means text strings have not been set.


setLsb

public void setLsb(boolean lsb)

setBlockGapX

public void setBlockGapX(int blockGapX)

setBlockGapY

public void setBlockGapY(int blockGapY)

setBlockHeight

public void setBlockHeight(int blockHeight)

setBlockSize

public void setBlockSize(int blockSize)

setBlockStaggerX

public void setBlockStaggerX(int blockStaggerX)

setBlockStaggerY

public void setBlockStaggerY(int blockStaggerY)

setBlockWidth

public void setBlockWidth(int blockWidth)

setChromeKey

public void setChromeKey(int chromeKey)

setChromeKeyIndex

public void setChromeKeyIndex(int chromeKeyIndex)

setClickMask

public void setClickMask(int clickMask)

setColourDepth

public void setColourDepth(int colourDepth)

setMapBlockHeight

public void setMapBlockHeight(int mapHeight)

setMapType

public void setMapType(int mapType)

setMapVersionMajor

public void setMapVersionMajor(int mapVersionMajor)

setMapVersionMinor

public void setMapVersionMinor(int mapVersionMinor)

setMapBlockWidth

public void setMapBlockWidth(int mapWidth)

setNoOfBlocks

public void setNoOfBlocks(int noOfBlocks)

setNoOfImages

public void setNoOfImages(int noOfImages)

setRisingPillarMode

public void setRisingPillarMode(boolean risingPillarMode)

setTextStringUserDataIndex

public void setTextStringUserDataIndex(int textStringUserDataIndex)


Copyright © 2001-2009 Alien-Factory Ltd. All Rights Reserved.