Class Hud

Methods to manipulate the HUD (heads-up-display) of the game.

Inheritance

Object

Hud

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: GTA.UI

Assembly: ScriptHookVDotNet3.dll

Syntax

public static class Hud

Properties

CursorSprite

Gets or sets the sprite the cursor should used when drawn

Declaration

public static CursorSprite CursorSprite { get; set; }

Property Value

Type	Description
CursorSprite

IsRadarVisible

Gets or sets a value indicating whether the radar is visible.

Declaration

public static bool IsRadarVisible { get; set; }

Property Value

Type	Description
Boolean

IsVisible

Gets or sets a value indicating whether any HUD components should be rendered.

Declaration

public static bool IsVisible { get; set; }

Property Value

Type	Description
Boolean

RadarZoom

Sets how far the minimap should be zoomed in.

Declaration

public static int RadarZoom { set; }

Property Value

Type	Description
Int32	The radar zoom; accepts values from 0 to 200.

Methods

HideComponentThisFrame(HudComponent)

Hides the specified HudComponent this frame.

Declaration

public static void HideComponentThisFrame(HudComponent component)

Parameters

Type	Name	Description
HudComponent	component	The HudComponent to hide.

IsComponentActive(HudComponent)

Determines whether a given HudComponent is active.

Declaration

public static bool IsComponentActive(HudComponent component)

Parameters

Type	Name	Description
HudComponent	component	The HudComponent to check

Returns

Type	Description
Boolean	true if the HudComponent is active; otherwise, false

ShowComponentThisFrame(HudComponent)

Draws the specified HudComponent this frame.

Declaration

public static void ShowComponentThisFrame(HudComponent component)

Parameters

Type	Name	Description
HudComponent	component	The HudComponent

Remarks

This will only draw the HudComponent if the HudComponent can be drawn

ShowCursorThisFrame()

Shows the mouse cursor this frame.

Declaration

public static void ShowCursorThisFrame()