HUD Library State

HUD library state can be reset to default using HudResetState.

2D drawing

These settings apply to 2D drawing only.

2D position

The current 2D point in the HUD coordinate system to draw the message at.

Default: 0.0, 0.0

Manipulated by HudSetPoint.

General appearance

These settings affect *all* messages drawn through HUD Library.

2D/3D mode

Whether to draw in 2D or 3D mode.

Default: 2D mode.

Manipulated by:

HudSetPoint (switches to 2D mode)

HudSetPoint3D (switches to 3D mode)

Scale

Current X and Y scale of the message to draw.

Default: 1.0, 1.0

Manipulated by:

HudSetScale

HudSetScaleXY

HudSetInvScale

HudSetInvScaleXY

Show to everyone

Whether to use HudMessage or HudMessageBold.

Default: false (use HudMessage)

Manipulated by HudSetShowToEveryone.

Appearance time

Duration of fade-in animation. 0 disables fade-in animation and makes the message appear instantly.

Default: 0.0

Manipulated by HudSetAppearTime.

Stay time

For how long the message stays after the end of fade-in and before the beginning fade-out.

Default: HUD_STAYTIME_FOREVER.

Manipulated by HudSetStayTime.

Disappearance time

Duration of fade-out animation. 0 disables fade-out animation and makes the message disappear instantly.

Default: 0.0

Manipulated by HudSetDisappearTime.

Blend style

Which blend style to use for the message. Can be one of the following:

HUD_BLENDSTYLE_NORMAL – normal translucency

HUD_BLENDSTYLE_ADDITIVE – additive translucency

Default: HUD_BLENDSTYLE_NORMAL (makes messages with alpha = 1.0 opaque).

Manipulated by HudSetBlendStyle.

Alpha

The alpha (opaqueness) of the message.

Default: 1.0

Manipulated by HudSetAlpha.

Text drawing

These settings apply only to HudDrawText, not to HudDrawImage.

Word wrap

Whether to enable word wrap when the message goes off the right edge of the screen.

Default: false

Manipulated by HudSetWordWrap.

3D drawing

These settings apply to 3D drawing only.

3D position

The current 3D point to draw the message at.

Default: 0.0, 0.0, 0.0

Manipulated by HudSetPoint3D.

Camera position

The 3D position of the camera that views the 3D points.

Default: 0.0, 0.0, 0.0

Manipulated by:

HudSetCameraPosition

HudSetCameraActor

HudSetCameraActorAdvanced

Camera direction

The direction of the camera that views the 3D points.

Default: along the world X axis.

Manipulated by:

HudSetCameraAngles

HudSetCameraActor

HudSetCameraActorAdvanced

2D offset

A 2D offset to shift the message on screen by.

Default: 0.0, 0.0

Manipulated by HudSet2DOffset.

Projection mode

3D projection mode to convert 3D coordinates to 2D. Can be one of the following:

HUD_PROJECTION_AUTO – use true 3D projection if IsOpenGL returns true and Y-shearing projection otherwise.

HUD_PROJECTION_3D – true 3D projection.

HUD_PROJECTION_YSHEARING – a 3D projection with Y-shearing like in software renderer.

Default: HUD_PROJECTION_AUTO

Manipulated by HudSetProjectionMode.

Auto distance scale

Whether to multiply the scale of the message by a factor to make it change size with distance.

Default: true

Manipulated by HudSetAutoDistanceScale.