cl_hud.h File Reference

HUD related routines. More...

Go to the source code of this file.

Macros
#define	ACTOR_HAND_CHAR_RIGHT   (char)'r'
#define	ACTOR_HAND_CHAR_LEFT   (char)'l'
#define	ACTOR_GET_HAND_CHAR(hand)   ((hand) == ACTOR_HAND_LEFT ? ACTOR_HAND_CHAR_LEFT : ACTOR_HAND_CHAR_RIGHT)
#define	ACTOR_GET_HAND_INDEX(hand)   ((hand) == ACTOR_HAND_CHAR_LEFT ? ACTOR_HAND_LEFT : ACTOR_HAND_RIGHT)

Functions
void	HUD_InitStartup (void)
void	HUD_InitUI (const char *optionWindowName)
	Display the user interface. More...
void	HUD_DisplayMessage (const char *text)
	Displays a message on the hud. More...
void	HUD_Update (void)
	Updates console vars for an actor. More...
void	HUD_UpdateActorStats (const struct le_s *le)
void	HUD_UpdateCursor (void)
	Updates the cursor texts when in battlescape. More...
int	HUD_ReactionFireGetTUs (const struct le_s *actor)

Variables
cvar_t *	cl_worldlevel

Detailed Description

HUD related routines.

Definition in file cl_hud.h.

Macro Definition Documentation

#define ACTOR_GET_HAND_CHAR

(

hand

)

((hand) == ACTOR_HAND_LEFT ? ACTOR_HAND_CHAR_LEFT : ACTOR_HAND_CHAR_RIGHT)

Parameters

[in]

hand

Hand index (ACTOR_HAND_RIGHT, ACTOR_HAND_LEFT)

Definition at line 32 of file cl_hud.h.

Referenced by HUD_DisplayFiremodeEntry().

#define ACTOR_GET_HAND_INDEX

(

hand

)

((hand) == ACTOR_HAND_CHAR_LEFT ? ACTOR_HAND_LEFT : ACTOR_HAND_RIGHT)

Parameters

[in]

hand

Hand index (ACTOR_HAND_CHAR_RIGHT, ACTOR_HAND_CHAR_LEFT)

Definition at line 34 of file cl_hud.h.

Referenced by HUD_DisplayFiremodes_f(), HUD_FireWeapon_f(), and HUD_SelectReactionFiremode_f().

#define ACTOR_HAND_CHAR_LEFT   (char)'l'

Definition at line 29 of file cl_hud.h.

#define ACTOR_HAND_CHAR_RIGHT   (char)'r'

Definition at line 28 of file cl_hud.h.

Function Documentation

void HUD_DisplayMessage

(

const char *

text

)

Displays a message on the hud.

See also

UI_DisplayNotice

Parameters

[in]

text

text is already translated here

Definition at line 138 of file cl_hud.cpp.

References cvar_s::integer, cvar_s::string, and UI_DisplayNotice().

Referenced by CL_ActorAppear(), CL_ActorCheckAction(), CL_ActorDie(), CL_ActorReload(), CL_ActorRevitalised(), CL_ActorStateChange(), CL_ActorWound(), CL_DoEndRound(), CL_NextRound_f(), CL_ParseServerMessage(), GAME_GetImportData(), HUD_CheckReload(), HUD_CheckShooting(), HUD_FireWeapon_f(), HUD_ReloadLeft_f(), HUD_ReloadRight_f(), HUD_ToggleCrouchReservation_f(), HUD_ToggleReaction_f(), and HUD_UpdateActorFireMode().

void HUD_InitStartup

(

void

)

Note

We can't check the value at startup cause scripts are not yet loaded

Definition at line 1597 of file cl_hud.cpp.

References CL_CvarWorldLevel(), Cmd_AddCommand(), CVAR_ARCHIVE, Cvar_Get(), CVAR_LATCH, Cvar_RegisterChangeListener(), Cvar_SetCheckFunction(), HUD_ActorSelectionChangeListener(), HUD_ActorWoundData_f(), HUD_CvarCheckMNHud(), HUD_DisplayActions_f(), HUD_DisplayFiremodes_f(), HUD_InitCallbacks(), HUD_LeftHandChangeListener(), HUD_PopupFiremodeReservation_f(), HUD_RemainingTUs_f(), HUD_RightHandChangeListener(), HUD_SelectReactionFiremode_f(), HUD_ShotReserve_f(), HUD_TUChangeListener(), HUD_UpdateActorLoad_f(), and cvar_s::modified.

Referenced by CL_InitLocal().

void HUD_InitUI

(

const char *

optionWindowName

)

Display the user interface.

Parameters

optionWindowName

Name of the window used to display options, else nullptr if nothing

Definition at line 1572 of file cl_hud.cpp.

References Cvar_Set(), HUD_CheckCLHud(), OBJZERO, cvar_s::string, UI_ExecuteConfunc(), and UI_InitStack().

Referenced by GAME_GetImportData(), and GAME_StartBattlescape().

int HUD_ReactionFireGetTUs

(

const struct le_s *

actor

)

void HUD_Update

(

void

)

Updates console vars for an actor.

This function updates the cvars for the hud (battlefield) unlike CL_ActorCvars and CL_UGVCvars which updates them for displaying the data in the menu system

See also

CL_ActorCvars

CL_UGVCvars

Definition at line 1428 of file cl_hud.cpp.

References ca_active, cl, cls, Cvar_Set(), Cvar_SetValue(), HUD_UpdateActor(), i, cvar_s::integer, clientBattleScape_s::mapMaxLevel, cvar_s::modified, clientBattleScape_s::numTeamList, PATHFINDING_HEIGHT, selActor, client_static_s::state, and UI_ExecuteConfunc().

Referenced by CL_SlowFrame().

void HUD_UpdateActorStats

(

const struct le_s *

le

)

void HUD_UpdateCursor

(

void

)

Updates the cursor texts when in battlescape.

Definition at line 976 of file cl_hud.cpp.

References cl_map_debug, image_s::height, HUD_DrawMouseCursorText(), cvar_s::integer, it_pic, LE_IsCrouched, LONGLINES_WRAP, MAPDEBUG_TEXT, mousePosX, mousePosY, R_DrawImage(), R_FindImage(), R_FontTextSize(), selActor, le_s::state, STATE_REACTION, TEXT_MOUSECURSOR_BOTTOM, TEXT_MOUSECURSOR_LEFT, TEXT_MOUSECURSOR_PLAYERNAMES, TEXT_MOUSECURSOR_RIGHT, TEXT_MOUSECURSOR_TOP, UI_GetText(), UI_ResetData(), viddef, viddef_t::virtualWidth, and image_s::width.

Referenced by SCR_DrawCursor().

Variable Documentation

cvar_t* cl_worldlevel

Definition at line 46 of file cl_hud.cpp.

Referenced by CL_ActorMouseTrace(), CL_ActorMoveMouse(), CL_ActorVis(), CL_AddActorPathing(), CL_AddPathing(), CL_AddTargeting(), CL_CameraMove(), CL_GetWorldCoordsUnderMouse(), CL_LevelDown_f(), CL_LevelUp_f(), CL_ParticleRun2(), CL_StartGame(), CL_ViewUpdateRenderData(), uiRadarNode::draw(), LE_AddToScene(), LE_BrushModelAction(), LE_PlayFootStepSound(), LM_AddToSceneOrder(), and UI_RadarNodeGetActorColor().