Pathfinding

Files
file	pathfind.h

Data Structures
struct	PATHFIND_NODE

Macros
#define	PATHFIND_LIST_MAX   20
	Maximum number of nodes in the pathfinding lists.
#define	PATHFIND_ERROR_FARTHER   -2
#define	PATHFIND_ERROR_CLOSED   -3
#define	PATHFIND_FLAGS_TGT_OCCUPIED   0x01
	Flag for pathfind_start() indicating the target tile is occupied (e.g. we're following another mobile), so don't try to land on it.
#define	pathfind_trace_printf(...)
	Alias for debug_printf() enabled when PATHFIND_TRACE is defined.
#define	pathfind_cmp_eq(a, b)
#define	pathfind_test_dir(x, y, dir_move, state, t)
	Check for blocking terrain or other MOBILE objects preventing movement in dir_move.

Functions
int8_t	pathfind_start (struct MOBILE *mover, uint8_t tgt_x, uint8_t tgt_y, uint8_t steps, uint8_t flags, struct DSEKAI_STATE *state)

Detailed Description

Macro Definition Documentation

pathfind_cmp_eq

#define pathfind_cmp_eq	(		a,
			b )

Value:

(((a)->coords.x == (b)->coords.x) && (((a)->coords.y == (b)->coords.y)))

PATHFIND_LIST_MAX

#define PATHFIND_LIST_MAX   20

Maximum number of nodes in the pathfinding lists.

Warning

This must not exceed 127!

pathfind_test_dir

#define pathfind_test_dir	(		x,
			y,
			dir_move,
			state,
			t )

Value:

(TILEMAP_ERROR_BLOCKED != tilemap_collide( x, y, dir_move, t ) && (NULL == mobile_get_facing( x, y, dir_move, state )) ? 1 : MOBILE_ERROR_BLOCKED)

Check for blocking terrain or other MOBILE objects preventing movement in dir_move.

Parameters

mover	Locked MEMORY_PTR to MOBILE performing the movement.
dir_move	Cardinal Directions to attempt to move in.
state	Locked MEMORY_PTR for current DSEKAI_STATE.
force	0 if movement should not be attempted if input is blocked globally, or 1 if it should.
t	Locked MEMORY_PTR for DSEKAI_STATE::map_handle.

Returns

1 if successful, or MOBILE_ERROR_BLOCKED if movement is blocked.

Todo

TODO: Determine terrain movement speed.

pathfind_trace_printf

#define pathfind_trace_printf

(

...

)

Alias for debug_printf() enabled when PATHFIND_TRACE is defined.

This was made its own alias since pathfinding can get rather chatty when it's enabled!