class TL_Class

TileLib Game Library

Public Methods
TL_Class(char *name): Creates a new TileLib map object and loads the mapfile
TL_Class(): Creates a new TileLib map object.
~TL_Class(): Destructor, frees up memory allocated
void update(BITMAP *buffer): Draws a map to the specified buffer.
int scroll(int xAmt, int yAmt): Scrolls the screen in whole tile increments, may be negative
int smoothScroll(int xAmt, int yAmt): Scrolls the screen in single pixel increments, may be negative
int tileInfo(unsigned int x, unsigned int y, BaseStruct *base): given PIXEL coordinates, retrieves the data on that particular tile and stores it in the structure passed in
int tileInfo(unsigned int x, unsigned int y, FringeStruct *fringe): given PIXEL coordinates, retrieves the data on that particular tile and stores it in the structure passed in
int tileInfo(unsigned int x, unsigned int y, ObjectStruct *obj): given PIXEL coordinates, retrieves the data on that particular tile and stores it in the structure passed in
int tileInfo(unsigned int x, unsigned int y, RoofStruct *roof): given PIXEL coordinates, retrieves the data on that particular tile and stores it in the structure passed in
int modifyTile(unsigned int x, unsigned int y, BaseStruct bs): This function lets you modify the tile attributes of the base layer at a given pixel coordinate
int modifyTile(unsigned int x, unsigned int y, FringeStruct fs): This function lets you modify the tile attributes of the fringe layer at a given pixel coordinate
int modifyTile(unsigned int x, unsigned int y, ObjectStruct os): This function lets you modify the tile attributes of the object layer at a given pixel coordinate
int modifyTile(unsigned int x, unsigned int y, RoofStruct rs): This function lets you modify the tile attributes of the roof layer at a given pixel coordinate
int loadMap(char *name): Loads a map into memory.
void setPalette(void): Changes the color palette to that defined in the resource datafile
int removeRoofVisibleWindow(unsigned int group_no): Removes all tiles from screen (actually just hides them) belonging to the specified group number, and ONLY on the visible portion of the screen
int removeRoofBoundedWindow(unsigned int group_no, unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2): This function removes all tiles belonging to group number group_no from a given boundary (ie.
int removeRoofEntireMap(unsigned int group_no): This function removes every tile in group_no from the ENTIRE map, so this might be slow if you have a huge map.
int replaceRoofVisibleWindow(unsigned int group_no): Makes the roof layer in the specified group visible ONLY on the visible screen portion
int replaceRoofBoundedWindow(unsigned int group_no, unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2): Makes visible all tiles belonging to group number group_no from a given boundary (ie.
int replaceRoofEntireMap(unsigned int group_no): Makes visible all tiles in the specified group number in the ENTIRE map world This may be time consuming for large maps
void setBorderX1(unsigned int x): Creates a border of the specified pixel amount around the map
void setBorderX2(unsigned int x): Creates a border of the specified pixel amount around the map
void setBorderY1(unsigned int y): Creates a border of the specified pixel amount around the map
void setBorderY2(unsigned int y): Creates a border of the specified pixel amount around the map
unsigned int getBorderX1(void): Returns the upper left amount of the border width
unsigned int getBorderX2(void): Returns the lower right amount of the border width
unsigned int getBorderY1(void): Returns the upper left amount of the border width
unsigned int getBorderY2(void): Returns the lower right amount of the border width
int getVideoMode(void): Returns the current video mode as a standard Allegro GFX_ define
unsigned int getResX(void): Returns the current screen width in pixels
unsigned int getResY(void): Returns the current screen height in pixels
unsigned int getTileW(void): Returns the width in pixels of the tiles in the world
unsigned int getTileH(void): Returns the height in pixels of the tiles in the world

Protected Fields
MapStruct** map
DATAFILE* data: a 2D array holding the map data
unsigned int resX: holds the graphics/sounds/etc
unsigned int tileW: screen resolution, in pixels
unsigned int mapW: pixel size of the tiles
byte numLayers: dimension of the map, in tiles
int palNo: number of map layers
char dataFile[80]: palette number
unsigned int borderX1: data file name (holds graphics, etc)
unsigned int borderY1: border, if any, from the
unsigned int borderX2: top left corner of the screen
unsigned int borderY2
unsigned int mapXStart: border from bottom right of screen, if any
unsigned int mapYStart
int videoMode: which tiles to start at in the map array
byte bl
int xOff: set to 1 if the base, fringe, object or roof layers are used (or all)

Protected Methods
int freeMem(void): Free up all the memory in the map array
void clearAll(void): zero out the entire map array

Documentation

TileLib Game Library

TL_Class(char *name)

Creates a new TileLib map object and loads the mapfile


Parameters:: name - a char* that is the FULL path name of the map to load

TL_Class()

Creates a new TileLib map object. You must later call loadMap() to load a map into memory.

~TL_Class()

Destructor, frees up memory allocated

void update(BITMAP *buffer)

Draws a map to the specified buffer. Pass in "screen" to draw directly to screen.


Parameters:: buffer - a BITMAP* to draw to, most likely you will want this to be your double buffer.

int scroll(int xAmt, int yAmt)

Scrolls the screen in whole tile increments, may be negative


Parameters:: xAmt - the number of tiles to scroll in the X direction
yAmt - the number of tiles to scroll in the Y direction
Returns:: 0 if error or couldn't scroll entire amount requested, otherwise 1

int smoothScroll(int xAmt, int yAmt)

Scrolls the screen in single pixel increments, may be negative


Parameters:: xAmt - the number of pixels to scroll in the X direction
yAmt - the number of pixels to scroll in the Y direction
Returns:: 0 if error or couldn't scroll entire amount requested, otherwise 1

int tileInfo(unsigned int x, unsigned int y, BaseStruct *base)

given PIXEL coordinates, retrieves the data on that particular tile and stores it in the structure passed in


Parameters:: x - the x coordinate at which you want to retrieve information
y - the y coordinate at which you want to retrieve information
base - the BaseStruct to store the result in
Returns:: 0 on error, otherwise 1.

int tileInfo(unsigned int x, unsigned int y, FringeStruct *fringe)

given PIXEL coordinates, retrieves the data on that particular tile and stores it in the structure passed in


Parameters:: x - the x coordinate at which you want to retrieve information
y - the y coordinate at which you want to retrieve information
fringe - the FringeStruct to store the result in
Returns:: 0 on error, otherwise 1.

int tileInfo(unsigned int x, unsigned int y, ObjectStruct *obj)

given PIXEL coordinates, retrieves the data on that particular tile and stores it in the structure passed in


Parameters:: x - the x coordinate at which you want to retrieve information
y - the y coordinate at which you want to retrieve information
obj - the ObjectStruct to store the result in
Returns:: 0 on error, otherwise 1.

int tileInfo(unsigned int x, unsigned int y, RoofStruct *roof)

given PIXEL coordinates, retrieves the data on that particular tile and stores it in the structure passed in


Parameters:: x - the x coordinate at which you want to retrieve information
y - the y coordinate at which you want to retrieve information
roof - the RoofStruct to store the result in
Returns:: 0 on error, otherwise 1.

int modifyTile(unsigned int x, unsigned int y, BaseStruct bs)

This function lets you modify the tile attributes of the base layer at a given pixel coordinate


Parameters:: x - the x coordinate at which you want to retrieve information
y - the y coordinate at which you want to retrieve information
bs - the BaseStruct to store the result in
Returns:: 0 on error, otherwise 1.

int modifyTile(unsigned int x, unsigned int y, FringeStruct fs)

This function lets you modify the tile attributes of the fringe layer at a given pixel coordinate


Parameters:: x - the x coordinate at which you want to retrieve information
y - the y coordinate at which you want to retrieve information
fs - the FringeStruct to store the result in
Returns:: 0 on error, otherwise 1.

int modifyTile(unsigned int x, unsigned int y, ObjectStruct os)

This function lets you modify the tile attributes of the object layer at a given pixel coordinate


Parameters:: x - the x coordinate at which you want to retrieve information
y - the y coordinate at which you want to retrieve information
os - the ObjectStruct to store the result in
Returns:: 0 on error, otherwise 1.

int modifyTile(unsigned int x, unsigned int y, RoofStruct rs)

This function lets you modify the tile attributes of the roof layer at a given pixel coordinate


Parameters:: x - the x coordinate at which you want to retrieve information
y - the y coordinate at which you want to retrieve information
rs - the RoofStruct to store the result in
Returns:: 0 on error, otherwise 1.

int loadMap(char *name)

Loads a map into memory. WARNING: This must __ONLY__ be called after Allegro has been placed into a graphics mode or you will get a core dump!


Parameters:: name - the char* thta is the full path name of the map to load.

void setPalette(void)

Changes the color palette to that defined in the resource datafile

int removeRoofVisibleWindow(unsigned int group_no)

Removes all tiles from screen (actually just hides them) belonging to the specified group number, and ONLY on the visible portion of the screen


Parameters:: group_no - the group number of the roof tiles to hide.
Returns:: 0 on error, otherwise non-zero.

int removeRoofBoundedWindow(unsigned int group_no, unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2)

This function removes all tiles belonging to group number group_no from a given boundary (ie. can encompass more than just the visible screen). NOTE: COORDINATES ARE IN TILE UNITS, NOT PIXELS!! So basically, think of your world as starting at tile location (0, 0). The bottom most corner is (x2, y2) of your world. You could have a variable that keeps track of the current tile x,y that the user is on, in addition to what you probably already have, that being the x,y of the user in pixels. See the examples for ideas on how to implement this, or read the documentation


Parameters:: group_no - the group number of the roof tiles to hide.
x1 - the upper left x coordinate in tiles to begin removing roof tiles from
y1 - the upper left y coordinate in tiles to begin removing roof tiles from
x2 - the lower right x coordinate in tiles to begin removing roof tiles from
y2 - the lower right y coordinate in tiles to begin removing roof tiles from
Returns:: 0 on error, otherwise 1.

int removeRoofEntireMap(unsigned int group_no)

This function removes every tile in group_no from the ENTIRE map, so this might be slow if you have a huge map.


Parameters:: group_no - the group number of the roof tiles to hide.
Returns:: 0 on error, otherwise 1.

int replaceRoofVisibleWindow(unsigned int group_no)

Makes the roof layer in the specified group visible ONLY on the visible screen portion


Parameters:: group_no - the group number of the roof tiles to hide.
Returns:: 0 on error, otherwise 1

int replaceRoofBoundedWindow(unsigned int group_no, unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2)

Makes visible all tiles belonging to group number group_no from a given boundary (ie. can encompass more than just the visible screen). NOTE: COORDINATES ARE IN TILE UNITS, NOT PIXELS!! So basically, think of your world as starting at tile location (0, 0). The bottom most corner is (x2, y2) of your world. You could have a variable that keeps track of the current tile x,y that the user is on, in addition to what you probably already have, that being the x,y of the user in pixels. See the examples for ideas on how to implement this, or read the documentation


Parameters:: group_no - the group number of the roof tiles to hide.
x1 - the upper left x coordinate in tiles
y1 - the upper left y coordinate in tiles
x2 - the lower right x coordinate in tiles
y2 - the lower right y coordinate in tiles
Returns:: 0 on error, otherwise 1.

int replaceRoofEntireMap(unsigned int group_no)

Makes visible all tiles in the specified group number in the ENTIRE map world This may be time consuming for large maps


Parameters:: group_no - the group number of the roof tiles to hide.
Returns:: 0 on error, otherwise 1.

void setBorderX1(unsigned int x)

Creates a border of the specified pixel amount around the map


Parameters:: x - the border in pixels to set in the x direction of the upper left corner

void setBorderX2(unsigned int x)

Creates a border of the specified pixel amount around the map


Parameters:: x - the border in pixels to set in the x direction of the lower right corner

void setBorderY1(unsigned int y)

Creates a border of the specified pixel amount around the map


Parameters:: y - the border in pixels to set in the y direction of the upper left corner

void setBorderY2(unsigned int y)

Creates a border of the specified pixel amount around the map


Parameters:: y - the border in pixels to set in the y direction of the lower right corner

unsigned int getBorderX1(void)

Returns the upper left amount of the border width

unsigned int getBorderX2(void)

Returns the lower right amount of the border width

unsigned int getBorderY1(void)

Returns the upper left amount of the border width

unsigned int getBorderY2(void)

Returns the lower right amount of the border width

int getVideoMode(void)

Returns the current video mode as a standard Allegro GFX_ define

unsigned int getResX(void)

Returns the current screen width in pixels

unsigned int getResY(void)

Returns the current screen height in pixels

unsigned int getTileW(void)

Returns the width in pixels of the tiles in the world

unsigned int getTileH(void)

Returns the height in pixels of the tiles in the world

int freeMem(void)

Free up all the memory in the map array

void clearAll(void)

zero out the entire map array

MapStruct** map

DATAFILE* data

a 2D array holding the map data

unsigned int resX

holds the graphics/sounds/etc

unsigned int tileW

screen resolution, in pixels

unsigned int mapW

pixel size of the tiles

byte numLayers

dimension of the map, in tiles

int palNo

number of map layers

char dataFile[80]

palette number

unsigned int borderX1

data file name (holds graphics, etc)

unsigned int borderY1

border, if any, from the

unsigned int borderX2

top left corner of the screen

unsigned int borderY2

unsigned int mapXStart

border from bottom right of screen, if any

unsigned int mapYStart

int videoMode

which tiles to start at in the map array

byte bl

int xOff

set to 1 if the base, fringe, object or roof layers are used (or all)

This class has no child classes.


Author:: Jeff Weinstein, jeffw@ucsd.edu, http://coredump.cc Main (and in fact only) TileLib class. All programs wishing to use a TileLib object must create a new TL_Class variable. It is highly recommended that you make this dynamic, for reasons explained in the manual. If you don't know how to do this, here is an example: TL_Class map; map = new TL_Class(); simple. Make sure you clean up the memory when done with a: delete map; Accessing works the same way, only use a "->" instead of a "."
Version:: 0.4

Alphabetic index HTML hierarchy of classes or Java

This page was generated with the help of DOC++.

class TL_Class

Public Methods

Protected Fields

Protected Methods

Documentation