MrxGuiHudFactionBuffer
Module: mrxguihudfactionbuffer.lua
Overview
The MrxGuiHudFactionBuffer module is a manager for up to two on-screen faction gauges. It handles the lifecycle of these gauges, including adding, updating, and removing them based on faction activity. The module also manages the visibility of the “Objective Tray” HUD element, temporarily hiding it when a gauge occupies the bottom slot.
Inheritance
- Inherits from:
none(base/utility module) - Imports:
MrxGui
Instance pattern
This is a stateless manager/utility module with no per-instance tables. It tracks the following key fields:
_knNumSlots: The number of slots available for faction gauges (set to 2).tData.tSlotLife: An array tracking the remaining life time of each slot.tData.tSlotPointData: An array storing animation point data for each slot.tData.tSlotOccupants: An array mapping slots to currently occupied faction gauges.tData.tFactionGauges: A table mapping faction names to their respective gauge widgets.
Functions
Initialize(oWidget)
Initializes the faction buffer manager. Sets up the template gauge, calculates slot positions, and initializes various data structures. Adds event handlers for GUI updates and defines additional methods on the widget (AddFactionGauge, SetInsideFactionZone, etc.).
AddFactionGauge(oWidget, sFactionName, sTexture)
Adds a new faction gauge for the specified faction name with an optional texture. Duplicates the template gauge, sets its icon, and adds it to the widget’s children.
SetInsideFactionZone(oWidget, sFactionName, bInside, bInitialize)
Sets whether the specified faction is inside their zone. This function is currently a placeholder and does not perform any actions.
SetValue(oWidget, sFactionName, nLevel, bInitialize)
Updates the value of the gauge for the specified faction. Handles animations and slot management to ensure smooth transitions between different states.
StartTimer(oWidget, sFactionName, nTime, fFunction, tCallbackData)
Starts a timer for the specified faction’s gauge. This function is used to manage timed events associated with the faction gauge.
StartPursuit(oWidget, sFactionName, nTime, fFunction, tCallbackData)
Starts a pursuit event for the specified faction’s gauge. Similar to StartTimer, but specifically for pursuit-related actions.
HideGauge(oWidget, sFactionName)
Hides the gauge for the specified faction by animating it out and clearing its slot occupation.
ModifyFactionMood(oWidget, sFactionName, nLevel, bInitialize)
Modifies the mood of the specified faction. This function is currently a placeholder and does not perform any actions.
ShowAll(oWidget, nDuration)
Shows all faction gauges for a specified duration. This function is currently a placeholder and does not perform any actions.
_Update(oWidget, nDeltaTime)
Per-frame update function that manages the lifecycle of faction gauges. Updates slot lifetimes, handles animations, and manages the visibility of the “Objective Tray” HUD element.
_FindSlot(oWidget, sFactionName)
Finds an available slot for the specified faction gauge. Returns the slot index and whether it is currently active.
_IsBufferEmpty(oWidget)
Checks if all slots are empty. Returns true if no gauges are present, otherwise returns false.
Events
- Listens for per-frame updates via
GuiUpdateto call_Update. - Manages custom events related to faction gauge lifecycle and state changes.
Notes for modders
- Ensure that the widget passed to
Initializeis properly set up with a template gauge. - Use
AddFactionGauge,SetValue,StartTimer, andStartPursuitto manage faction gauges dynamically. - Be aware that the “Objective Tray” HUD element may be temporarily hidden when a gauge occupies the bottom slot.
- The module currently has placeholder functions for
SetInsideFactionZone,ModifyFactionMood, andShowAll. Implementing these functions will require additional logic.