map.h File Reference

Jo Engine MAP file (sprite map). More...

Go to the source code of this file.

Macros
#define	JO_MAP_NO_COLLISION
	Value returned by jo_map_hitbox_detection_custom_boundaries();.

Functions
int	jo_map_per_pixel_vertical_collision (const unsigned int layer, int x, int y, unsigned char *attribute)
	Method to get vertical distance between our point (x, y) and the surface of the map (example: hill).
int	jo_map_hitbox_detection_custom_boundaries (const unsigned int layer, const int x, const int y, const int w, const int h)
	Fast method to get if a square intersects with the map (HitBox processing) based on screen coord.
bool	jo_map_load_from_file (const unsigned int layer, const short depth, const char *const sub_dir, const char *const filename)
	Load a sprite map on a specific layer using MAP file format.
bool	jo_map_create (const unsigned int layer, const unsigned short max_tile_count, const short depth)
	Create a new sprite map.
void	jo_map_add_tile (const unsigned int layer, const short x, const short y, const unsigned char sprite_id, const unsigned char attribute)
	Add a tile on the specific layer.
void	jo_map_add_animated_tile (const unsigned int layer, const short x, const short y, const unsigned char anim_id, const unsigned char attribute)
	Add an animated tile on the specific layer.
void	jo_map_free (const unsigned int layer)
	Destroy the specific layer.
void	jo_map_draw (const unsigned int layer, const short screen_x, const short screen_y)
	Display the specific layer.
void	jo_map_draw_background (const unsigned int layer, const short x, const short y)
	Draw the specific layer on the background (NBG1).
static __jo_force_inline void	jo_vdp2_map_draw_nbg1 (const unsigned int layer, const short x, const short y)
	Draw the specific layer on the background (NBG1).
void	jo_map_scroll_background (const unsigned int layer, const short x, const short y, const jo_color clear_color)
	Draw the specific layer on the background (NBG1) using the hardware scroll (no flickering).
static __jo_force_inline void	jo_vdp2_map_scroll_nbg1 (const unsigned int layer, const short x, const short y, const jo_color clear_color)
	Draw the specific layer on the background (NBG1) using the hardware scroll (no flickering).
void	jo_map_move_tiles_by_attribute (const unsigned int layer, const unsigned char attribute_filter, const short incr_x, const short incr_y)
	Move specific tiles by their attributes.
void	jo_map_3d_draw (const unsigned int layer, const int x, const int y, const int z)

Detailed Description

Jo Engine MAP file (sprite map).

Author

Johannes Fetz

Bug

No known bugs.

Macro Definition Documentation

JO_MAP_NO_COLLISION

#define JO_MAP_NO_COLLISION

Value returned by jo_map_hitbox_detection_custom_boundaries();.

Warning

Don't change this value

Function Documentation

jo_map_3d_draw()

void jo_map_3d_draw	(	const unsigned int	layer,
		const int	x,
		const int	y,
		const int	z )

jo_map_add_animated_tile()

void jo_map_add_animated_tile	(	const unsigned int	layer,
		const short	x,
		const short	y,
		const unsigned char	anim_id,
		const unsigned char	attribute )

Add an animated tile on the specific layer.

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
x	horizontal position on the map
y	vertical position on the map
anim_id	Animation ID
attribute	User attribute (it's for you)

jo_map_add_tile()

void jo_map_add_tile	(	const unsigned int	layer,
		const short	x,
		const short	y,
		const unsigned char	sprite_id,
		const unsigned char	attribute )

Add a tile on the specific layer.

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
x	horizontal position on the map
y	vertical position on the map
sprite_id	Sprite ID
attribute	User attribute (it's for you)

jo_map_create()

bool jo_map_create	(	const unsigned int	layer,
		const unsigned short	max_tile_count,
		const short	depth )

Create a new sprite map.

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
max_tile_count	Maximum tile count in the entire map
depth	Z index (ex 500)

Returns

true if successful otherwise false (use jo_get_last_error())

jo_map_draw()

void jo_map_draw	(	const unsigned int	layer,
		const short	screen_x,
		const short	screen_y )

Display the specific layer.

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
screen_x	relative horizontal position between the screen and the map
screen_y	relative vertical position between the screen and the map

jo_map_draw_background()

void jo_map_draw_background	(	const unsigned int	layer,
		const short	x,
		const short	y )

Draw the specific layer on the background (NBG1).

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
x	relative horizontal position between the background image and the map
y	relative vertical position between the background image and the map

Warning

Only works with full color images (not 8 bits)

Todo

Handle NBG1 Zoom

jo_map_free()

void jo_map_free

(

const unsigned int

layer

)

Destroy the specific layer.

Parameters

layer

layer level (between 0 and JO_MAP_MAX_LAYER)

jo_map_hitbox_detection_custom_boundaries()

int jo_map_hitbox_detection_custom_boundaries	(	const unsigned int	layer,
		const int	x,
		const int	y,
		const int	w,
		const int	h )

Fast method to get if a square intersects with the map (HitBox processing) based on screen coord.

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
x	Horizontal position of square (based on the screen !, so 0 is the left the screen)
y	Vertical position of square (based on the screen !, so 0 is the top the screen)
w	Width of the square
h	Height of the square

Returns

The attribute of the tile if square collides otherwise JO_MAP_NO_COLLISION

jo_map_load_from_file()

bool jo_map_load_from_file	(	const unsigned int	layer,
		const short	depth,
		const char *const	sub_dir,
		const char *const	filename )

Load a sprite map on a specific layer using MAP file format.

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
depth	Z-index
sub_dir	Sub directory name (use JO_ROOT_DIR if the file is on the root directory)
filename	Filename (upper case and shorter as possible like "A.MAP")

Remarks

Sample file with 4 blocks. Each tile has his own texture:

IMAGE_FILENAME X Y ATTRIBUTE(optional)

1.TGA 0 0

2.TGA 160 0

3.TGA 0 120

4.TGA 160 120

use JoMapEditor to create map file

Returns

true if successful otherwise false (use jo_get_last_error())

jo_map_move_tiles_by_attribute()

void jo_map_move_tiles_by_attribute	(	const unsigned int	layer,
		const unsigned char	attribute_filter,
		const short	incr_x,
		const short	incr_y )

Move specific tiles by their attributes.

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
attribute_filter	Tile attribute value (filtering)
incr_x	Horizontal position incrementation
incr_y	Vertical position incrementation

jo_map_per_pixel_vertical_collision()

int jo_map_per_pixel_vertical_collision	(	const unsigned int	layer,
		int	x,
		int	y,
		unsigned char *	attribute )

Method to get vertical distance between our point (x, y) and the surface of the map (example: hill).

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
x	Horizontal position of the point (based on the screen !, so 0 is the left the screen)
y	Vertical position of the point (based on the screen !, so 0 is the top the screen)
attribute	Tile attribute

Remarks

(x,y)

# | #

### | ##

##### v ##

####### ####

##############

Returns

distance from the surface of the map otherwise JO_MAP_NO_COLLISION

Warning

if distance > 0 then you don't touch the ground but your are on the sprite

if distance <= 0 then you are under the surface of the sprite

Don't use this method if you don't have transparent pixel or if the surface is concave

jo_map_scroll_background()

void jo_map_scroll_background	(	const unsigned int	layer,
		const short	x,
		const short	y,
		const jo_color	clear_color )

Draw the specific layer on the background (NBG1) using the hardware scroll (no flickering).

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
x	relative horizontal position between the screen and the map (like jo_map_draw_background())
y	relative vertical position between the screen and the map (like jo_map_draw_background())
clear_color	Color of the pixels without tile (JO_COLOR_Transparent to see the screens behind)

Remarks

Call it every frame: only the columns and lines that will appear on the screen are drawn, outside of the visible area

The NBG1 scroll position is changed by this function (jo_vdp2_move_nbg1())

Don't clear the NBG1 bitmap between 2 calls

Warning

Only works with full color images (not 8 bits). Animated tiles are not updated while they stay on the screen

jo_vdp2_map_draw_nbg1()

__jo_force_inline void jo_vdp2_map_draw_nbg1 ( const unsigned int layer, const short x, const short y )

static

Draw the specific layer on the background (NBG1).

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
x	relative horizontal position between the background image and the map
y	relative vertical position between the background image and the map

Warning

Only works with full color images (not 8 bits)

Todo

Handle NBG1 Zoom

jo_vdp2_map_scroll_nbg1()

__jo_force_inline void jo_vdp2_map_scroll_nbg1 ( const unsigned int layer, const short x, const short y, const jo_color clear_color )

static

Draw the specific layer on the background (NBG1) using the hardware scroll (no flickering).

Parameters

layer	layer level (between 0 and JO_MAP_MAX_LAYER)
x	relative horizontal position between the screen and the map
y	relative vertical position between the screen and the map
clear_color	Color of the pixels without tile (JO_COLOR_Transparent to see the screens behind)

Remarks

See jo_map_scroll_background()