A B C D E F G H I J L M N P R S T U V W

A

addBlockX(int) - Method in class com.alienfactory.javamappy.viewer.MapViewer
 
addBlockX(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Increments the X coordinate by the given block amount.
addBlockY(int) - Method in class com.alienfactory.javamappy.viewer.MapViewer
 
addBlockY(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Increments the Y coordinate by the given block amount.
addPixelX(int) - Method in class com.alienfactory.javamappy.viewer.MapViewer
 
addPixelX(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Increments the X coordinate by the given pixel amount.
addPixelY(int) - Method in class com.alienfactory.javamappy.viewer.MapViewer
 
addPixelY(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Increments the Y coordinate by the given pixel amount.
AN_LOOPF - Static variable in class com.alienfactory.javamappy.AnimBlock
Loop Forward.
AN_LOOPR - Static variable in class com.alienfactory.javamappy.AnimBlock
Loop Reverse.
AN_NONE - Static variable in class com.alienfactory.javamappy.AnimBlock
Do Not Animate.
AN_ONCE - Static variable in class com.alienfactory.javamappy.AnimBlock
Animate Once.
AN_ONCEH - Static variable in class com.alienfactory.javamappy.AnimBlock
Animate Once & Halt.
AN_ONCES - Static variable in class com.alienfactory.javamappy.AnimBlock
Animate Once Finished.
AN_PPFF - Static variable in class com.alienfactory.javamappy.AnimBlock
Ping Ping Forward - Outward Leg.
AN_PPFR - Static variable in class com.alienfactory.javamappy.AnimBlock
Ping Ping Forward - Return Leg.
AN_PPRF - Static variable in class com.alienfactory.javamappy.AnimBlock
Ping Ping Reverse - Outward Leg.
AN_PPRR - Static variable in class com.alienfactory.javamappy.AnimBlock
Ping Ping Reverse - Return Leg.
animateLayer() - Method in class com.alienfactory.javamappy.viewer.TiledLayerWrapper
Applies the current state of the AnimBlocks to the TiledLayer.
AnimBlock - Class in com.alienfactory.javamappy
AnimBlock represents a sequence of frames (images) that will be played out according to the animation type and a speed dictated by the frame delay.
AnimBlock() - Constructor for class com.alienfactory.javamappy.AnimBlock
 
ATTACH_NEXT - Static variable in class com.alienfactory.javamappy.Block
Used in Pillar Riser Mode to flag that the next Block should continue the pillar.

B

BACKGROUND - Static variable in class com.alienfactory.javamappy.Block
A Block image layer used to get / set its image index.
BACKGROUND - Static variable in class com.alienfactory.javamappy.MapObject
A MapObject image layer used to get / set its image index.
Block - Class in com.alienfactory.javamappy
A simple bean class which represents a Block as used by Mappy.
Block() - Constructor for class com.alienfactory.javamappy.Block
 
BOTTOM - Static variable in class com.alienfactory.javamappy.Block
In conjunction with LEFT or RIGHT this specifies a corner of the Block.

C

calculateTallestPillar() - Method in class com.alienfactory.javamappy.viewer.LayerViewer
Calculates the height of the tallest pillar - used when drawing Isometric maps with Pillar Riser Mode turned on.
checkMax(int, String, int) - Static method in class com.alienfactory.javamappy.util.ParameterChecker
 
checkMin(int, String, int) - Static method in class com.alienfactory.javamappy.util.ParameterChecker
 
checkMinMax(int, String, int, int) - Static method in class com.alienfactory.javamappy.util.ParameterChecker
 
checkNotNull(Object, String) - Static method in class com.alienfactory.javamappy.util.ParameterChecker
 
ChunkLoader - Class in com.alienfactory.javamappy.loader
This is the base class for all ChunkLoaders.
ChunkLoader() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoader
 
ChunkLoaderANDT - Class in com.alienfactory.javamappy.loader
Chunk ANDT :: Contains ANISTR structures.
ChunkLoaderANDT() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderANDT
 
ChunkLoaderATHR - Class in com.alienfactory.javamappy.loader
Chunk ATHR :: Up to 4 ASCII strings of author information.
ChunkLoaderATHR() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderATHR
 
ChunkLoaderBGFX - Class in com.alienfactory.javamappy.loader
Chunk BGFX :: The raw image data.
ChunkLoaderBGFX() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderBGFX
 
ChunkLoaderBKDT - Class in com.alienfactory.javamappy.loader
Chunk BKDT :: Contains BLKSTR structures.
ChunkLoaderBKDT() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderBKDT
 
ChunkLoaderBODY - Class in com.alienfactory.javamappy.loader
Chunk BODY :: An array of short ints containing positive offsets into BKDT, and negative offsets into ANDT.
ChunkLoaderBODY() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderBODY
 
ChunkLoaderCMAP - Class in com.alienfactory.javamappy.loader
Chunk CMAP :: Colour palette for 8bit maps.
ChunkLoaderCMAP() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderCMAP
 
ChunkLoaderFORM - Class in com.alienfactory.javamappy.loader
Chunk FORM :: Must be present at the start of every map.
ChunkLoaderFORM() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderFORM
 
ChunkLoaderMPHD - Class in com.alienfactory.javamappy.loader
Chunk MPHD :: Map header, see struct in mapfunc.c
ChunkLoaderMPHD() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderMPHD
 
ChunkLoaderOBDT - Class in com.alienfactory.javamappy.loader
Chunk OBDT :: Contains OBJSTR structures.
ChunkLoaderOBDT() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderOBDT
 
ChunkLoaderOBFN - Class in com.alienfactory.javamappy.loader
Chunk OBFN :: Contains OBJ Filenames for OBJSTR.
ChunkLoaderOBFN() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderOBFN
 
chunkLoaders - Variable in class com.alienfactory.javamappy.loader.MapLoader
 
ChunkLoaderTSTR - Class in com.alienfactory.javamappy.loader
Chunk TSTR :: Text Strings.
ChunkLoaderTSTR() - Constructor for class com.alienfactory.javamappy.loader.ChunkLoaderTSTR
 
ChunkLoadException - Exception in com.alienfactory.javamappy.loader
ChunkLoadException
ChunkLoadException(String) - Constructor for exception com.alienfactory.javamappy.loader.ChunkLoadException
Constructs a ChunkLoadException with the given message.
ChunkLoadException(String, Exception) - Constructor for exception com.alienfactory.javamappy.loader.ChunkLoadException
Constructs a ChunkLoadException with a nested exception and an error message.
com.alienfactory.javamappy - package com.alienfactory.javamappy
Contains the core API and objects that mimic the logical structure of a .FMP Map.
com.alienfactory.javamappy.loader - package com.alienfactory.javamappy.loader
These classes are only concerned with loading FMP Chunks.
com.alienfactory.javamappy.util - package com.alienfactory.javamappy.util
Generic utility classes.
com.alienfactory.javamappy.viewer - package com.alienfactory.javamappy.viewer
These classes, when given the relevant Mappy data objects, concern themselves with displaying Maps and Layers.
com.alienfactory.javamappy.viewer.render - package com.alienfactory.javamappy.viewer.render
These classes purely handle the rendering of blocks, allowing you to swap in and out new renderers dependent on your platform; be it an Applet, JDK 1.4, or J2ME.
createChunkLoader(InputStream) - Method in class com.alienfactory.javamappy.loader.MapLoader
Factory method for producing instances of ChunkLoaders.
createLogger(Class) - Static method in class com.alienfactory.javamappy.util.Logger
 
createLogger(String) - Static method in class com.alienfactory.javamappy.util.Logger
 

D

debug(Object) - Method in class com.alienfactory.javamappy.util.Logger
 
doLoadMap(InputStream) - Method in class com.alienfactory.javamappy.loader.MapLoader
Performs the actual FMP map loading.
draw(Object, boolean) - Method in class com.alienfactory.javamappy.viewer.LayerViewer
Renders the Background and Foreground layers of all the visible blocks onto the screen.
draw(Object, boolean, int, int, int, int) - Method in class com.alienfactory.javamappy.viewer.LayerViewer
Renders a partial area of the Layer using the given GFX object.
draw(Object, boolean) - Method in class com.alienfactory.javamappy.viewer.MapViewer
Renders the Map using the given GFX object.
draw(Object, boolean, int, int, int, int) - Method in class com.alienfactory.javamappy.viewer.MapViewer
Renders a partial area of the Map using the given GFX object.
draw(Object, boolean) - Method in class com.alienfactory.javamappy.viewer.Viewer
Draws Mappy data into the viewing area.
draw(Object, boolean, int, int, int, int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Draws but just a section of the viewing area.
DRAW_LEFT_SIDE_ONLY - Static variable in interface com.alienfactory.javamappy.viewer.render.Renderer
When drawing an image this value specifies that only the left hand side of the image should be drawn (used in Pillar Rising Mode).
DRAW_RIGHT_SIDE_ONLY - Static variable in interface com.alienfactory.javamappy.viewer.render.Renderer
When drawing an image this value specifies that only the right hand side of the image should be drawn (used in Pillar Rising Mode).
drawBackground(Object, boolean) - Method in class com.alienfactory.javamappy.viewer.LayerViewer
Renders the background layer of all the visible block onto the screen.
drawBackground(Object, boolean, int, int, int, int) - Method in class com.alienfactory.javamappy.viewer.LayerViewer
 
drawForeground(Object, int) - Method in class com.alienfactory.javamappy.viewer.LayerViewer
Renders a foreground layer of all the visible blocks onto the screen.
drawForeground(Object, int, int, int, int, int) - Method in class com.alienfactory.javamappy.viewer.LayerViewer
 
drawImage(Object, int, int, int, boolean, int) - Method in class com.alienfactory.javamappy.viewer.render.MIDP10Renderer
Renders a tile image at the given coordinates.
drawImage(Object, int, int, int, boolean, int) - Method in class com.alienfactory.javamappy.viewer.render.MIDP10RendererAlt
 
drawImage(Object, int, int, int, boolean, int) - Method in class com.alienfactory.javamappy.viewer.render.MIDP20Renderer
Renders a tile image at the given coordinates.
drawImage(Object, int, int, int, boolean, int) - Method in class com.alienfactory.javamappy.viewer.render.NokiaRenderer
Renders a tile image at the given coordinates.
drawImage(Object, int, int, int, boolean, int) - Method in interface com.alienfactory.javamappy.viewer.render.Renderer
Draws an image as given by imageIndex at the given coordinates.

E

error(Object, Exception) - Method in class com.alienfactory.javamappy.util.Logger
 
error(Exception) - Method in class com.alienfactory.javamappy.util.Logger
 

F

FLAG1 - Static variable in class com.alienfactory.javamappy.MapObject
A User defined flag.
FLAG2 - Static variable in class com.alienfactory.javamappy.MapObject
A User defined flag.
FLAG3 - Static variable in class com.alienfactory.javamappy.MapObject
A User defined flag.
FLAG4 - Static variable in class com.alienfactory.javamappy.MapObject
A User defined flag.
FLAG5 - Static variable in class com.alienfactory.javamappy.MapObject
A User defined flag.
FLAG6 - Static variable in class com.alienfactory.javamappy.MapObject
A User defined flag.
FLAG7 - Static variable in class com.alienfactory.javamappy.MapObject
A User defined flag.
FLAG8 - Static variable in class com.alienfactory.javamappy.MapObject
A User defined flag.
FOREGROUND1 - Static variable in class com.alienfactory.javamappy.Block
A Block image layer used to get / set its image index.
FOREGROUND1 - Static variable in class com.alienfactory.javamappy.MapObject
A MapObject image layer used to get / set its image index.
FOREGROUND2 - Static variable in class com.alienfactory.javamappy.Block
A Block image layer used to get / set its image index.
FOREGROUND2 - Static variable in class com.alienfactory.javamappy.MapObject
A MapObject image layer used to get / set its image index.
FOREGROUND3 - Static variable in class com.alienfactory.javamappy.Block
A Block image layer used to get / set its image index.
FOREGROUND3 - Static variable in class com.alienfactory.javamappy.MapObject
A MapObject image layer used to get / set its image index.

G

getAnimBlock(int, int) - Method in class com.alienfactory.javamappy.Layer
Returns the AnimBlock at the given block coordinates.
getAnimBlocks() - Method in class com.alienfactory.javamappy.Layer
Returns the AnimBlocks used by this Layer, as passed into the constructor.
getAnimBlocks() - Method in class com.alienfactory.javamappy.Map
 
getBlock(int, int) - Method in class com.alienfactory.javamappy.Layer
Returns the Block at the given block coordinates.
getBlockGapX() - Method in class com.alienfactory.javamappy.MapHeader
 
getBlockGapY() - Method in class com.alienfactory.javamappy.MapHeader
 
getBlockHeight() - Method in class com.alienfactory.javamappy.MapHeader
Returns the height of a Block in pixels.
getBlockIndex(int, int) - Method in class com.alienfactory.javamappy.Layer
Returns the Block index at the given coordinates.
getBlocks() - Method in class com.alienfactory.javamappy.Layer
Returns the Blocks used by this Layer, as passed into the constructor.
getBlocks() - Method in class com.alienfactory.javamappy.Map
 
getBlockSize() - Method in class com.alienfactory.javamappy.MapHeader
 
getBlockStaggerX() - Method in class com.alienfactory.javamappy.MapHeader
 
getBlockStaggerY() - Method in class com.alienfactory.javamappy.MapHeader
 
getBlockWidth() - Method in class com.alienfactory.javamappy.MapHeader
Returns the width of a Block in pixels.
getBlockX() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns the X coordinate in blocks of the top left hand corner of the viewing area.
getBlockY() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns the Y coordinate in blocks of the top left hand corner of the viewing area.
getBottomCollisionCoor(int, int, int, int) - Method in class com.alienfactory.javamappy.Layer
Starts at the top of the given rectangle and works its way down, checking the status of the collision flags on the way.
getByte(int) - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Returns the byte at the given index without affecting the 'inputStream'.
getBytesRemaining() - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Returns the number of bytes yet to be read for this chunk.
getChromeKey() - Method in class com.alienfactory.javamappy.MapHeader
For colour depths 16 and 24 this returns the Colour that is rendered transparent.
getChromeKeyIndex() - Method in class com.alienfactory.javamappy.MapHeader
For a colour depths of 8, this returns the colour index into Map.getColours() that is rendered transparent.
getChunkLength() - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Returns the total number of bytes in this chunk.
getChunkName() - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Returns the 4 character name of the chunk.
getClickMask() - Method in class com.alienfactory.javamappy.MapHeader
 
getCmapPixelData() - Method in class com.alienfactory.javamappy.PixelData
Returns image data as indexes into the ColourMap.
getCollisionAt(int, int) - Method in class com.alienfactory.javamappy.Layer
Performs a collision detection test at the given pixel coordinates using the Block's collision flags.
getCollisionFlag(int) - Method in class com.alienfactory.javamappy.Block
Returns the specified collision flag.
getColourDepth() - Method in class com.alienfactory.javamappy.MapHeader
Returns the colour depth of the block images.
getColours() - Method in class com.alienfactory.javamappy.Map
 
getCurrentFrame() - Method in class com.alienfactory.javamappy.AnimBlock
Returns the current frame (image index).
getCurrentFrameIndex() - Method in class com.alienfactory.javamappy.AnimBlock
Returns the current frame index.
getDelay() - Method in class com.alienfactory.javamappy.AnimBlock
The delay is the number of times AnimBlock.updateAnimation() needs to be called before the currentFrameIndex changes.
getDelayCountdown() - Method in class com.alienfactory.javamappy.AnimBlock
Returns the number of times AnimBlock.updateAnimation() has to be called before the current frame is changed to the next in sequence.
getDescription() - Method in class com.alienfactory.javamappy.Map
 
getFlag(int) - Method in class com.alienfactory.javamappy.Block
Returns the specified flag.
getFlag(int) - Method in class com.alienfactory.javamappy.MapObject
Returns the specified flag.
getFrames() - Method in class com.alienfactory.javamappy.AnimBlock
Returns an array of frames (image indexs) that represent the animation sequence.
getGfxId() - Method in class com.alienfactory.javamappy.MapObject
 
getGHandleXOff() - Method in class com.alienfactory.javamappy.MapObject
 
getGHandleYOff() - Method in class com.alienfactory.javamappy.MapObject
 
getGHeight() - Method in class com.alienfactory.javamappy.MapObject
 
getGWidth() - Method in class com.alienfactory.javamappy.MapObject
 
getGXOffset() - Method in class com.alienfactory.javamappy.MapObject
 
getGYOffset() - Method in class com.alienfactory.javamappy.MapObject
 
getHeightInBlocks() - Method in class com.alienfactory.javamappy.Layer
Returns the height of the layer, measured in blocks.
getHeightInPixels() - Method in class com.alienfactory.javamappy.Layer
Returns the height of the layer, measured in pixels.
getImageData() - Method in class com.alienfactory.javamappy.Map
 
getImageIndex(int) - Method in class com.alienfactory.javamappy.Block
Returns the image index of the given Block layer.
getImageIndex(int) - Method in class com.alienfactory.javamappy.MapObject
Returns the image index of the given MapObject layer.
getLayer() - Method in class com.alienfactory.javamappy.viewer.LayerViewer
Returns the Layer associated with this Viewer.
getLayer() - Method in class com.alienfactory.javamappy.viewer.TiledLayerWrapper
Returns the Layer associated with this Viewer.
getLayerData() - Method in class com.alienfactory.javamappy.Layer
Returns the raw layer data as passed into the constructor.
getLayers() - Method in class com.alienfactory.javamappy.Map
 
getLayerViewers() - Method in class com.alienfactory.javamappy.viewer.MapViewer
Returns an array of LayerViewers.
getLeftCollisionCoor(int, int, int, int) - Method in class com.alienfactory.javamappy.Layer
Starts at the right of the given rectangle and works its way to the left, checking the status of the collision flags on the way.
getMap() - Method in class com.alienfactory.javamappy.viewer.MapViewer
Returns the Map associated with this viewer.
getMapBlockHeight() - Method in class com.alienfactory.javamappy.MapHeader
Returns the height of the Map in Blocks.
getMapBlockWidth() - Method in class com.alienfactory.javamappy.MapHeader
Returns the width of the Map in Blocks.
getMapHeader() - Method in class com.alienfactory.javamappy.Layer
Returns the MapHeader associated with this Layer.
getMapHeader() - Method in class com.alienfactory.javamappy.Map
 
getMapHeader() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns the MapHeader associated with this Viewer.
getMapObjectImages() - Method in class com.alienfactory.javamappy.Map
 
getMapObjects() - Method in class com.alienfactory.javamappy.Map
 
getMapPixelHeight() - Method in class com.alienfactory.javamappy.MapHeader
Returns the height of the Map in pixels.
getMapPixelWidth() - Method in class com.alienfactory.javamappy.MapHeader
Returns the width of the Map in pixels.
getMapType() - Method in class com.alienfactory.javamappy.MapHeader
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)
getMapVersionMajor() - Method in class com.alienfactory.javamappy.MapHeader
Returns the major part of the FMP version.
getMapVersionMinor() - Method in class com.alienfactory.javamappy.MapHeader
Returns the minor part of the FMP version.
getMessage() - Method in exception com.alienfactory.javamappy.JavaMappyException
Returns the error message.
getNestedException() - Method in exception com.alienfactory.javamappy.JavaMappyException
Returns the nested exception if one exists.
getNoOfBlocks() - Method in class com.alienfactory.javamappy.MapHeader
 
getNoOfImages() - Method in class com.alienfactory.javamappy.MapHeader
 
getPixelX() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns the X coordinate in pixels of the top left hand corner of the viewing area.
getPixelY() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns the Y coordinate in pixels of the top left hand corner of the viewing area.
getRawPixelData() - Method in class com.alienfactory.javamappy.PixelData
Returns image data in 0xAARRGGBB format.
getRenderer() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns the Renderer associated with this Viewer.
getRightCollisionCoor(int, int, int, int) - Method in class com.alienfactory.javamappy.Layer
Starts at the left of the given rectangle and works its way to the right, checking the status of the collision flags on the way.
getShow() - Method in class com.alienfactory.javamappy.MapObject
 
getTextString() - Method in class com.alienfactory.javamappy.Block
Returns the text string associated with this block.
getTextString() - Method in class com.alienfactory.javamappy.MapObject
Returns the text string associated with this MapObject.
getTextStrings() - Method in class com.alienfactory.javamappy.Map
 
getTextStringUserDataIndex() - Method in class com.alienfactory.javamappy.MapHeader
Used by the Block Chunk Loader.
getTiledLayer() - Method in class com.alienfactory.javamappy.viewer.TiledLayerWrapper
Returns the TiledLayer the class wraps.
getTileId() - Method in class com.alienfactory.javamappy.MapObject
 
getTopCollisionCoor(int, int, int, int) - Method in class com.alienfactory.javamappy.Layer
Starts at the bottom of the given rectangle and works its way up, checking the status of the collision flags on the way.
getType() - Method in class com.alienfactory.javamappy.AnimBlock
The type dictates how the animation sequence will be played out.
getUserData() - Method in class com.alienfactory.javamappy.AnimBlock
Returns any user defined data.
getUserData(int) - Method in class com.alienfactory.javamappy.Block
Returns the specified User Data.
getUserData(int) - Method in class com.alienfactory.javamappy.MapObject
Returns the specified User Data.
getViewHeight() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns the height in pixels of the viewing area.
getViewOffsetX() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns the horizontal offset in pixels of the viewing area from the top left hand corner of the screen.
getViewOffsetY() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns the vertical offset in pixels of the viewing area from the top left hand corner of the screen.
getViewWidth() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns the width in pixels of the viewing area.
getWidthInBlocks() - Method in class com.alienfactory.javamappy.Layer
Returns the width of the layer, measured in blocks.
getWidthInPixels() - Method in class com.alienfactory.javamappy.Layer
Returns the width of the layer, measured in pixels.
getX() - Method in class com.alienfactory.javamappy.MapObject
 
getY() - Method in class com.alienfactory.javamappy.MapObject
 

H

hasTransparentPixels() - Method in class com.alienfactory.javamappy.PixelData
 

I

info(Object) - Method in class com.alienfactory.javamappy.util.Logger
 
isAnimBlock(int, int) - Method in class com.alienfactory.javamappy.Layer
A helper method that checks if the block at the given coordinates is an AnimBlock.
isCollisionAt(int, int) - Method in class com.alienfactory.javamappy.Layer
Performs a collision detection test at the given pixel coordinates using the Block's collision flags.
isLoggingEnabled() - Static method in class com.alienfactory.javamappy.util.Logger
 
isLSB() - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Returns true if shorts and int are stored Least Significant Byte first in the inputStream.
isLsb() - Method in class com.alienfactory.javamappy.MapHeader
 
isPillarRiserMode() - Method in class com.alienfactory.javamappy.viewer.Viewer
Returns true is this viewer is in Pillar Riser Mode, used in isometric maps.
isRisingPillarMode() - Method in class com.alienfactory.javamappy.MapHeader
Rising Pillar Mode is essentially Isometric Mode.

J

J2SE14Renderer - Class in com.alienfactory.javamappy.viewer.render
This Renderer has been optimised for use in Java2 SE 1.4 JVMs or later.
J2SE14Renderer(Map) - Constructor for class com.alienfactory.javamappy.viewer.render.J2SE14Renderer
Uses the raw pixel data and colour map from the given Map to create images in a JDK specific manner.
J2SE14Renderer(Map, InputStream, boolean) - Constructor for class com.alienfactory.javamappy.viewer.render.J2SE14Renderer
Loads the tile sheet image from the given Input Stream (which is not closed).
JavaMappyException - Exception in com.alienfactory.javamappy
A JavaMappyException is thrown when something fishy happens!
JavaMappyException(String) - Constructor for exception com.alienfactory.javamappy.JavaMappyException
Constructs a MapException with the given message.
JavaMappyException(String, Exception) - Constructor for exception com.alienfactory.javamappy.JavaMappyException
Constructs a MapException with a nested exception and an error message.
JDK11Renderer - Class in com.alienfactory.javamappy.viewer.render
This Renderer is for use by JDK 1.1.x JVMs.
JDK11Renderer(Map) - Constructor for class com.alienfactory.javamappy.viewer.render.JDK11Renderer
Uses the raw pixel data and colour map from the given Map to create the solid and transparent images in a JDK specific manner.
JDK12Renderer - Class in com.alienfactory.javamappy.viewer.render
This Renderer has been optimised for use in JDK 1.2 JVMs.
JDK12Renderer(Map) - Constructor for class com.alienfactory.javamappy.viewer.render.JDK12Renderer
Uses the raw pixel data and colour map from the given Map to create the solid and transparent images in a JDK specific manner.

L

Layer - Class in com.alienfactory.javamappy
Represents one of the layers in a Map.
Layer(Map, short[][]) - Constructor for class com.alienfactory.javamappy.Layer
Deprecated. use @link Layer#Layer(MapHeader, short[][], Block[], AnimBlock[]) instead
Layer(MapHeader, short[][], Block[], AnimBlock[]) - Constructor for class com.alienfactory.javamappy.Layer
 
LayerViewer - Class in com.alienfactory.javamappy.viewer
Renders a Layer of a Map onto the screen.
LayerViewer(Layer, MapHeader, Renderer, int, int) - Constructor for class com.alienfactory.javamappy.viewer.LayerViewer
Creates a LayerViewer and places the viewing area at the top left corner.
LayerViewer(Layer, MapHeader, Renderer, int, int, int, int) - Constructor for class com.alienfactory.javamappy.viewer.LayerViewer
Creates a LayerViewer and places the viewing area at the given offset.
LEFT - Static variable in class com.alienfactory.javamappy.Block
In conjunction with TOP or BOTTOM this specifies a corner of the Block.
LEFT_SIDE_PILLAR - Static variable in class com.alienfactory.javamappy.Block
Used in Pillar Riser Mode to flag that only the left hand side of the Block should be rendered.
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoader
The method invoked to load the chunk.
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderANDT
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderATHR
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderBGFX
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderBKDT
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderBODY
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderCMAP
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderFORM
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderMPHD
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderOBDT
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderOBFN
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.ChunkLoaderTSTR
 
loadChunk(Map) - Method in class com.alienfactory.javamappy.loader.MapLoader.DefaultChunkLoader
 
loadMap(InputStream) - Static method in class com.alienfactory.javamappy.loader.MapLoader
Helper method to create a Map from the given input stream of .FMP data.
Logger - Class in com.alienfactory.javamappy.util
This simple Logger logs messages to System.out.

M

Map - Class in com.alienfactory.javamappy
A standard bean class representing a .FMP map.
Map() - Constructor for class com.alienfactory.javamappy.Map
 
MapHeader - Class in com.alienfactory.javamappy
MapHeader :: This class represents the data held within the MPHD chunk.
MapHeader() - Constructor for class com.alienfactory.javamappy.MapHeader
 
mapHeader - Variable in class com.alienfactory.javamappy.viewer.Viewer
 
MapLoader - Class in com.alienfactory.javamappy.loader
MapLoader
MapLoader() - Constructor for class com.alienfactory.javamappy.loader.MapLoader
 
MapLoader.DefaultChunkLoader - Class in com.alienfactory.javamappy.loader
 
MapLoader.DefaultChunkLoader() - Constructor for class com.alienfactory.javamappy.loader.MapLoader.DefaultChunkLoader
 
MapObject - Class in com.alienfactory.javamappy
A simple bean class which represents a MapObject as used by Mappy.
MapObject() - Constructor for class com.alienfactory.javamappy.MapObject
 
MapViewer - Class in com.alienfactory.javamappy.viewer
Renders a Map onto the screen.
MapViewer(Map, Renderer, int, int) - Constructor for class com.alienfactory.javamappy.viewer.MapViewer
Creates a LayerViewer for each of the Layers in the Map.
MapViewer(Map, Renderer, int, int, int, int) - Constructor for class com.alienfactory.javamappy.viewer.MapViewer
Creates a LayerViewer for each of the Layers in the Map and places the viewing area at the given offset.
MAX_NO_OF_LAYERS - Static variable in class com.alienfactory.javamappy.Map
This is the maximum number of Layers that can be contained within a Map.
MAX_USER_DATA - Static variable in class com.alienfactory.javamappy.Block
A minimum index for User Data.
MAX_USER_DATA - Static variable in class com.alienfactory.javamappy.MapObject
A minimum index for User Data.
MIDP10Renderer - Class in com.alienfactory.javamappy.viewer.render
The standard Renderer to use with MIDP v1.0 compatible devices.
MIDP10Renderer(Map) - Constructor for class com.alienfactory.javamappy.viewer.render.MIDP10Renderer
Uses the raw pixel data and colour map from the given Map to create the opaque tilemap image.
MIDP10Renderer(Map, String, boolean) - Constructor for class com.alienfactory.javamappy.viewer.render.MIDP10Renderer
Initialises itself from the given tileset image.
MIDP10RendererAlt - Class in com.alienfactory.javamappy.viewer.render
An alternative J2ME Renderer to use with MIDP v1.0 compatible devices.
MIDP10RendererAlt(Map, String[], boolean) - Constructor for class com.alienfactory.javamappy.viewer.render.MIDP10RendererAlt
Initialises itself from the given array of tile sheet images.
MIDP20Renderer - Class in com.alienfactory.javamappy.viewer.render
A Renderer for MIDP v2.0 compatible devices.
MIDP20Renderer(Map) - Constructor for class com.alienfactory.javamappy.viewer.render.MIDP20Renderer
Uses the raw pixel data and colour map from the given Map to create the tilemap image.
MIDP20Renderer(Map, String, boolean) - Constructor for class com.alienfactory.javamappy.viewer.render.MIDP20Renderer
Initialises itself from the given tileset image.
MIN_USER_DATA - Static variable in class com.alienfactory.javamappy.Block
A minimum index for User Data.
MIN_USER_DATA - Static variable in class com.alienfactory.javamappy.MapObject
A minimum index for User Data.

N

NokiaRenderer - Class in com.alienfactory.javamappy.viewer.render
This Renderer references Nokia's own J2ME API which, unlike the MIDP 1.0 specification, supports full alpha transparency.
NokiaRenderer(Map) - Constructor for class com.alienfactory.javamappy.viewer.render.NokiaRenderer
Uses the raw pixel data and colour map from the given Map to create the tilemap image.
NokiaRenderer(Map, String, boolean) - Constructor for class com.alienfactory.javamappy.viewer.render.NokiaRenderer
Initialises itself from the given tileset image.
NONE - Static variable in interface com.alienfactory.javamappy.viewer.render.Renderer
When drawing an image this value specifies that no modifications should be applied.

P

ParameterChecker - Class in com.alienfactory.javamappy.util
ParameterCheck :: Gives the user helpful, friendly exception messages that imply their code sucks.
pillarRiserMode - Variable in class com.alienfactory.javamappy.viewer.Viewer
 
PixelData - Class in com.alienfactory.javamappy
Holds raw pixel data for an image - used by Renderers.
PixelData(int[], boolean) - Constructor for class com.alienfactory.javamappy.PixelData
 
PixelData(int[], byte[], boolean) - Constructor for class com.alienfactory.javamappy.PixelData
 
pixelX - Variable in class com.alienfactory.javamappy.viewer.Viewer
 
pixelY - Variable in class com.alienfactory.javamappy.viewer.Viewer
 

R

readByte() - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Reads the next byte from the input stream.
readInt() - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Reads the next 4 bytes from the Map input stream and turns them into an int.
readShort() - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Reads the next 2 bytes from the Map input stream and turns them into a short.
readString(int) - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Reads the next n bytes from the Map input stream and turns them into a String.
readString() - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Reads characters until it find a terminating zero and returns the string.
readUByte() - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Reads the next byte from the input stream and returns it as an unsigned int.
registerChunkLoader(String, ChunkLoader) - Method in class com.alienfactory.javamappy.loader.MapLoader
 
registerChunkLoaders() - Method in class com.alienfactory.javamappy.loader.MapLoader
This is where we hard code chunk loader class references to chunk names.
Renderer - Interface in com.alienfactory.javamappy.viewer.render
A Renderer contains API specific drawing routines.
renderer - Variable in class com.alienfactory.javamappy.viewer.Viewer
 
restoreClip(Object) - Method in interface com.alienfactory.javamappy.viewer.render.Renderer
This is called after a Layer is drawn to restore the clipping region to what it used to be.
RIGHT - Static variable in class com.alienfactory.javamappy.Block
In conjunction with TOP or BOTTOM this specifies a corner of the Block.
RIGHT_SIDE_PILLAR - Static variable in class com.alienfactory.javamappy.Block
Used in Pillar Riser Mode to flag that only the right hand side of the Block should be rendered.

S

setAnimBlocks(AnimBlock[]) - Method in class com.alienfactory.javamappy.Map
nulls are allowed.
setBlockGapX(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setBlockGapY(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setBlockHeight(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setBlockIndex(int, int, int) - Method in class com.alienfactory.javamappy.Layer
Replaces the block at the given coordinates.
setBlocks(Block[]) - Method in class com.alienfactory.javamappy.Map
nulls are allowed.
setBlockSize(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setBlockStaggerX(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setBlockStaggerY(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setBlockWidth(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setBlockX(int) - Method in class com.alienfactory.javamappy.viewer.MapViewer
 
setBlockX(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Sets the X coordinate in blocks of the top left hand corner of the viewing area.
setBlockY(int) - Method in class com.alienfactory.javamappy.viewer.MapViewer
 
setBlockY(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Sets the Y coordinate in blocks of the top left hand corner of the viewing area.
setChromeKey(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setChromeKeyIndex(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setClickMask(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setClip(Object, int, int, int, int) - Method in interface com.alienfactory.javamappy.viewer.render.Renderer
This is called just before a Layer is drawn to allow the Renderer to set the desired clipping region.
setCollisionFlag(int, boolean) - Method in class com.alienfactory.javamappy.Block
Sets the specified collision flag.
setColourDepth(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setColours(int[]) - Method in class com.alienfactory.javamappy.Map
nulls are allowed.
setCurrentFrameIndex(int) - Method in class com.alienfactory.javamappy.AnimBlock
Sets the current frame index.
setDelay(int) - Method in class com.alienfactory.javamappy.AnimBlock
The delay is the number of times AnimBlock.updateAnimation() needs to be called before the currentFrameIndex changes.
setDelayCountdown(int) - Method in class com.alienfactory.javamappy.AnimBlock
Sets the number of times AnimBlock.updateAnimation() has to be called before the current frame is changed to the next in sequence.
setDescription(String[]) - Method in class com.alienfactory.javamappy.Map
 
setFlag(int, boolean) - Method in class com.alienfactory.javamappy.Block
Sets the specified flag to the given boolean value.
setFlag(int, boolean) - Method in class com.alienfactory.javamappy.MapObject
Sets the specified flag to the given boolean value.
setFrames(int[]) - Method in class com.alienfactory.javamappy.AnimBlock
Sets the frames (image indexs) that represent the animation sequence.
setGfxId(int) - Method in class com.alienfactory.javamappy.MapObject
 
setGHandleXOff(int) - Method in class com.alienfactory.javamappy.MapObject
 
setGHandleYOff(int) - Method in class com.alienfactory.javamappy.MapObject
 
setGHeight(int) - Method in class com.alienfactory.javamappy.MapObject
 
setGWidth(int) - Method in class com.alienfactory.javamappy.MapObject
 
setGXOffset(int) - Method in class com.alienfactory.javamappy.MapObject
 
setGYOffset(int) - Method in class com.alienfactory.javamappy.MapObject
 
setImageData(PixelData[]) - Method in class com.alienfactory.javamappy.Map
nulls are allowed.
setImageIndex(int, int) - Method in class com.alienfactory.javamappy.Block
Sets the image index of the given Block layer.
setImageIndex(int, int) - Method in class com.alienfactory.javamappy.MapObject
Sets the image index of the given MapObject layer.
setLayers(Layer[]) - Method in class com.alienfactory.javamappy.Map
 
setLoggingEnabled(boolean) - Static method in class com.alienfactory.javamappy.util.Logger
 
setLsb(boolean) - Method in class com.alienfactory.javamappy.MapHeader
 
setMapBlockHeight(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setMapBlockWidth(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setMapObjectImages(String[]) - Method in class com.alienfactory.javamappy.Map
nulls are allowed.
setMapObjects(MapObject[]) - Method in class com.alienfactory.javamappy.Map
nulls are allowed.
setMapType(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setMapVersionMajor(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setMapVersionMinor(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setNoOfBlocks(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setNoOfImages(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setPillarRiserMode(boolean) - Method in class com.alienfactory.javamappy.viewer.MapViewer
 
setPillarRiserMode(boolean) - Method in class com.alienfactory.javamappy.viewer.Viewer
Sets the Pillar Riser Mode, as used in isometric maps.
setPixelX(int) - Method in class com.alienfactory.javamappy.viewer.MapViewer
 
setPixelX(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Sets the X coordinate in pixels of the top left hand corner of the viewing area.
setPixelY(int) - Method in class com.alienfactory.javamappy.viewer.MapViewer
 
setPixelY(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Sets the Y coordinate in pixels of the top left hand corner of the viewing area.
setRisingPillarMode(boolean) - Method in class com.alienfactory.javamappy.MapHeader
 
setShow(int) - Method in class com.alienfactory.javamappy.MapObject
 
setTextString(String) - Method in class com.alienfactory.javamappy.Block
Sets the text string associated with this block.
setTextString(String) - Method in class com.alienfactory.javamappy.MapObject
Sets the text string associated with this MapObject.
setTextStrings(String[]) - Method in class com.alienfactory.javamappy.Map
 
setTextStringUserDataIndex(int) - Method in class com.alienfactory.javamappy.MapHeader
 
setTileId(int) - Method in class com.alienfactory.javamappy.MapObject
 
setType(int) - Method in class com.alienfactory.javamappy.AnimBlock
The type dictates how the animation sequence will be played out.
setUserData(int) - Method in class com.alienfactory.javamappy.AnimBlock
Sets any user defined data.
setUserData(int, int) - Method in class com.alienfactory.javamappy.Block
Sets the specified User Data.
setUserData(int, int) - Method in class com.alienfactory.javamappy.MapObject
Sets the specified User Data.
setViewHeight(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Sets the height in pixels of the viewing area.
setViewOffsetX(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Sets the horizontal offset in pixels of the viewing area from the top left hand corner of the screen.
setViewOffsetY(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Sets the vertical offset in pixels of the viewing area from the top left hand corner of the screen.
setViewWidth(int) - Method in class com.alienfactory.javamappy.viewer.Viewer
Sets the width in pixels of the viewing area.
setX(int) - Method in class com.alienfactory.javamappy.MapObject
 
setY(int) - Method in class com.alienfactory.javamappy.MapObject
 
skip(int) - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Skips the next n bytes from the Map input stream.

T

throwChunkException(Object) - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Throws a ChunkLoadException with a formatted message.
TiledLayerWrapper - Class in com.alienfactory.javamappy.viewer
This class creates and wraps a J2ME MIDP 2.0 TiledLayer representing a given Layer.
TiledLayerWrapper(Layer, int, Image, boolean) - Constructor for class com.alienfactory.javamappy.viewer.TiledLayerWrapper
Creates a TiledLayer to display the given Layer
TOP - Static variable in class com.alienfactory.javamappy.Block
In conjunction with LEFT or RIGHT this specifies a corner of the Block.
toString() - Method in class com.alienfactory.javamappy.loader.ChunkLoader
Pretty print.
trace(Object) - Method in class com.alienfactory.javamappy.util.Logger
 
TRIGGER - Static variable in class com.alienfactory.javamappy.Block
A User defined flag.

U

UNUSED1 - Static variable in class com.alienfactory.javamappy.Block
A User defined flag.
UNUSED2 - Static variable in class com.alienfactory.javamappy.Block
A User defined flag.
UNUSED3 - Static variable in class com.alienfactory.javamappy.Block
A User defined flag.
updateAnimation() - Method in class com.alienfactory.javamappy.AnimBlock
Counts down the delay and updates the current frame to the next in the animation sequence.
updateAnimBlocks() - Method in class com.alienfactory.javamappy.viewer.MapViewer
A helper method that updates the animation of all the AnimBlocks in the Map.

V

Viewer - Class in com.alienfactory.javamappy.viewer
Renders a Map or a Layer (dependent on the concrete implementation) onto the screen.
Viewer(MapHeader, Renderer, int, int, int, int) - Constructor for class com.alienfactory.javamappy.viewer.Viewer
Creates a Viewer and places the viewing area at the given offset.
viewHeight - Variable in class com.alienfactory.javamappy.viewer.Viewer
 
viewOffsetX - Variable in class com.alienfactory.javamappy.viewer.Viewer
 
viewOffsetY - Variable in class com.alienfactory.javamappy.viewer.Viewer
 
viewWidth - Variable in class com.alienfactory.javamappy.viewer.Viewer
 

W

warn(Object) - Method in class com.alienfactory.javamappy.util.Logger
 

A B C D E F G H I J L M N P R S T U V W

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