Engine Types

Collaboration diagram for Engine Types:

Macros
#define	ENGINE_TABLE(f)   f( 0, NONE, title ) f( 1, TOPDOWN, topdown ) f( 2, POV, pov )
#define	engines_active(state)   (0 == window_modal() && DSEKAI_FLAG_INPUT_BLOCKED != (DSEKAI_FLAG_INPUT_BLOCKED & (state)->flags) && 0 > (state)->menu.menu_id)
#define	ENGINES_SETUP_PROTOTYPES(idx, eng, prefix)   int16_t prefix ## _setup( struct DSEKAI_STATE* state ) SECTION_SETUP;
#define	ENGINES_INPUT_PROTOTYPES(idx, eng, prefix)   int16_t prefix ## _input( INPUT_VAL in_char, int16_t click_x, int16_t click_y, struct DSEKAI_STATE* state );
#define	ENGINES_ANIMATE_PROTOTYPES(idx, eng, prefix)   void prefix ## _animate( struct DSEKAI_STATE* state );
#define	ENGINES_DRAW_PROTOTYPES(idx, eng, prefix)   void prefix ## _draw( struct DSEKAI_STATE* state );
#define	ENGINES_SHUTDOWN_PROTOTYPES(idx, eng, prefix)   void prefix ## _shutdown( struct DSEKAI_STATE* state ) SECTION_SETUP;

Typedefs
typedef int16_t(*	ENGINES_SETUP) (struct DSEKAI_STATE *state)
	Sets up the current engine (allocates specific state, etc).
typedef int16_t(*	ENGINES_INPUT) (INPUT_VAL in_char, int16_t click_x, int16_t click_y, struct DSEKAI_STATE *state)
	Handles polled input according to the rules of the current engine.
typedef void(*	ENGINES_ANIMATE) (struct DSEKAI_STATE *state)
	Cycles animations and executes scripts relevant to the current engine.
typedef void(*	ENGINES_DRAW) (struct DSEKAI_STATE *state)
	Draws the engine sceen on-screen according to current state.

Variables
RES_CONST char *	gc_engines_tokens []
RES_CONST ENGINES_SETUP	gc_engines_setup []
RES_CONST ENGINES_INPUT	gc_engines_input []
RES_CONST ENGINES_ANIMATE	gc_engines_animate []
RES_CONST ENGINES_DRAW	gc_engines_draw []

Detailed Description

Typedef Documentation

ENGINES_ANIMATE

typedef void(* ENGINES_ANIMATE) (struct DSEKAI_STATE *state)

Cycles animations and executes scripts relevant to the current engine.

Parameters

state

Locked MEMORY_PTR for current DSEKAI_STATE.

ENGINES_DRAW

typedef void(* ENGINES_DRAW) (struct DSEKAI_STATE *state)

Draws the engine sceen on-screen according to current state.

Parameters

state

Locked MEMORY_PTR for current DSEKAI_STATE.

ENGINES_INPUT

typedef int16_t(* ENGINES_INPUT) (INPUT_VAL in_char, int16_t click_x, int16_t click_y, struct DSEKAI_STATE *state)

Handles polled input according to the rules of the current engine.

Parameters

in_char	Last char polled from user input.
state	Locked MEMORY_PTR for current DSEKAI_STATE.

Returns

1 if engine should continue running or 0 to quit.

ENGINES_SETUP

typedef int16_t(* ENGINES_SETUP) (struct DSEKAI_STATE *state)

Sets up the current engine (allocates specific state, etc).

Parameters

state

Locked MEMORY_PTR for current DSEKAI_STATE.

Returns

1 if engine should continue running or 0 on failure.