HUD

Hook Documentation for HUD Module.

Functions

MODULE:AdjustBlurAmount(blurGoal)

Adjusts the amount of blur applied to the screen.

Parameters

  • blurGoal Integer

    The current target blur amount.

Returns

  • number

    The adjusted blur amount to be applied.

MODULE:DrawAmmo(weapon)

Draws the ammo display for the given weapon.

Parameters

  • weapon Entity

    The weapon for which the ammo display is being drawn.

MODULE:DrawBlur()

Draws the blur effect.

MODULE:DrawBranchWarning()

Draws a warning about a branching path.

MODULE:DrawCrosshair()

Draws the crosshair.

MODULE:DrawEntityInfo(entity, alpha)

Draws information about the given entity.

Parameters

  • entity

    The entity for which information is being drawn.

  • alpha

    The alpha value to use for drawing the entity information.

MODULE:DrawLiliaModelView(panel, entity)

Called to draw additional content within the model view panel.

Parameters

  • panel Panel

    The panel containing the model view

  • entity Entity

    The entity being drawn.

MODULE:DrawVignette()

Draws the vignette effect.

MODULE:ItemShowEntityMenu(entity)

Displays the context menu for interacting with an item entity.

Parameters

  • entity Entity

    The item entity for which the context menu is displayed.

MODULE:SetupQuickMenu(panel)

Sets up the quick menu by adding buttons, sliders, spacers, etc. This function is called during the initialization of the quick menu panel.

Parameters

  • panel Panel

    The panel representing the quick menu.

MODULE:ShouldBarDraw(bar)

Determines whether a bar should be drawn.

Parameters

  • bar Table

    The bar object.

Returns

  • bool

    True if the bar should be drawn, false otherwise.

MODULE:ShouldDrawAmmo(weapon)

Determines whether the ammo display should be drawn for the given weapon.

Parameters

  • weapon Entity

    The weapon for which the ammo display is being considered.

Returns

  • bool

    True if the ammo display should be drawn, false otherwise.

MODULE:ShouldDrawAmmoHUD(weapon)

Whether or not the ammo HUD should be drawn.

Parameters

  • weapon Entity

    Weapon the player currently is holding

Returns

  • bool

    Whether or not to draw the ammo hud

MODULE:ShouldDrawBlur()

Determines whether the blur effect should be drawn.

Returns

  • bool

    True if the blur effect should be drawn, false otherwise.

MODULE:ShouldDrawBranchWarning()

Determines whether a warning about a branching path should be drawn.

Returns

  • bool

    True if the branching path warning should be drawn, false otherwise.

MODULE:ShouldDrawCharInfo(entity, character, charInfo)

Determines whet character information should be drawn for the given entity and character.

Parameters

  • entity Entity

    The entity associated with the character.

  • character Character

    The character for which information is being considered.

  • charInfo Table

    Additional information about the character.

Returns

  • bool

    True if character information should be drawn, false otherwise.

MODULE:ShouldDrawCrosshair()

Determines whether the crosshair should be drawn.

Returns

  • bool

    True if the crosshair should be drawn, false otherwise.

MODULE:ShouldDrawCrosshair(client, weapon)

Determines whether the crosshair should be drawn for a specific client and weapon.

Parameters

  • client Player

    The player entity.

  • weapon String

    The weapon entity.

Returns

  • bool

    True if the crosshair should be drawn, false otherwise.

MODULE:ShouldDrawEntityInfo(entity)

Determines whether entity information should be drawn for the given entity.

Parameters

  • entity Entity

    The entity for which information is being considered.

Returns

  • bool

    True if entity information should be drawn, false otherwise.

MODULE:ShouldDrawPlayerInfo()

Determines whether player information should be drawn.

Returns

  • bool

    True if player information should be drawn, false otherwise.

MODULE:ShouldDrawVignette()

Determines whether the vignette effect should be drawn.

Returns

  • bool

    True if the vignette effect should be drawn, false otherwise.

MODULE:ShouldHideBars()

Determines whether bars should be hidden.

Returns

  • bool

    True if bars should be hidden, false otherwise.

MODULE:ShouldHideBars()

Determines whether bars should be hidden.

Returns

  • bool

    True if bars should be hidden, false otherwise.

MODULE:TooltipInitialize(panel, targetPanel)

Initializes the tooltip before it is displayed.

Parameters

  • panel Panel

    The tooltip panel.

  • targetPanel Panel

    The panel for which the tooltip is being displayed.

MODULE:TooltipLayout(panel)

Handles the layout of the tooltip.

Parameters

  • panel Panel

    The tooltip panel.

MODULE:TooltipPaint(panel, w, h)

Handles the painting of the tooltip.

Parameters

  • panel Panel

    The tooltip panel.

  • w Integer

    The width of the tooltip.

  • h Integer

    The height of the tooltip.