//////////////////////////////////////////////////////////////////////
/* bj_ui.sch														*/
/* Author: DJ Jones													*/
/* UI definitions for base jump activity.							*/
//////////////////////////////////////////////////////////////////////


// Keep track of UI status.
ENUM BJ_UI_FLAG
	BJUIFLAG_SHOW_OBJECTIVE,
	BJUIFLAG_SHOW_FALL_HELP,
	BJUIFLAG_SHOW_PARA_HELP,
	BJUIFLAG_CLEAR_PARA_HELP,
	BJUIFLAG_INIT_SCORECARD,
	BJUIFLAG_POPULATE_SCORECARD,
	BJUIFLAG_PREPARED_SCORECARD,
	BJUIFLAG_PROCESS_SCORE,
	BJUIFLAG_DRAW_SCORECARD,
	BJUIFLAG_INIT_FAIL_MESSAGE,
	BJUIFLAG_PLAY_PASS_AUDIO,
	BJUIFLAG_MUSIC_PREP_OJBJ_START,
	BJUIFLAG_MUSIC_PREP_OJBJ_JUMPED,
	BJUIFLAG_MUSIC_PREP_OJBJ_LANDED,
	BJUIFLAG_MUSIC_PREP_OJBJ_STOP,
	BJUIFLAG_MUSIC_TRIG_OJBJ_START,
	BJUIFLAG_MUSIC_TRIG_OJBJ_JUMPED,
	BJUIFLAG_MUSIC_TRIG_OJBJ_LANDED,
	BJUIFLAG_MUSIC_TRIG_OJBJ_STOP,
	BJUIFLAG_AUDIO_SCENE_TRIG_OJBJ_CUTSCENE,
	BJUIFLAG_AUDIO_SCENE_TRIG_OJBJ_START,
	BJUIFLAG_AUDIO_SCENE_TRIG_OJBJ_JUMPED,
	BJUIFLAG_AUDIO_SCENE_TRIG_OJBJ_DEPLOYED,
	BJUIFLAG_AUDIO_SCENE_TRIG_OJBJ_STOP,
	BJUIFLAG_STARTED_FAIL_EFFECTS,
	BJUIFLAG_FINISHED_FAIL_EFFECTS,
	BJUIFLAG_FINISHED_WRITING_TO_LB,
	BJUIFLAG_SHOWING_OFFLINE_LB_BUTTON,
	BJUIFLAG_SHOWING_VIEW_PROF_BUTTON
	
ENDENUM

ENUM BJ_SCORECARD_RETURN_VALUE
	BJSCORECARD_RETRY,
	BJSCORECARD_EXIT,
	BJSCORECARD_NONE
ENDENUM


// All data needed by the UI.
STRUCT BJ_UI
	SCRIPT_SCALEFORM_UI uiControls
	END_SCREEN_DATASET bjEndScreen
	INT uiFlags
ENDSTRUCT


// Set a UI flag.
PROC BJ_SET_UI_FLAG(BJ_UI& bjUI, BJ_UI_FLAG uiFlag, BOOL bSet)
	IF bSet
		SET_BIT(bjUI.uiFlags, ENUM_TO_INT(uiFlag))
	ELSE
		CLEAR_BIT(bjUI.uiFlags, ENUM_TO_INT(uiFlag))
	ENDIF
ENDPROC

// Checks to see if a flag is set.
FUNC BOOL BJ_GET_UI_FLAG(BJ_UI& bjUI, BJ_UI_FLAG uiFlag)
	RETURN IS_BIT_SET(bjUI.uiFlags, ENUM_TO_INT(uiFlag))
ENDFUNC

// Reset all UI flags (turn off).
PROC BJ_CLEAR_UI_FLAGS(BJ_UI& bjUI)
	bjUI.uiFlags = 0
ENDPROC