Update Custom HUD Class - BP_ShipHUD

Kyle Austad 2024-10-07 09:02:43 -06:00
parent 750af73f54
commit 419b602ad4

@ -18,5 +18,14 @@ This class implements the following Blueprint Interfaces and functions/events:
The *Begin Play* event is used here simply to create all the widgets used my the *Modular Spaceship Stat System* and store references to them for future use, as well as set their initial visibility. This should be pretty straightforward to understand and can be dissected to create these widgets more dynamically or eloquently based on your projects needs. The *Begin Play* event is used here simply to create all the widgets used my the *Modular Spaceship Stat System* and store references to them for future use, as well as set their initial visibility. This should be pretty straightforward to understand and can be dissected to create these widgets more dynamically or eloquently based on your projects needs.
## Interface Events
![](https://git.crabinteractive.com/crabdev/MSSS-Documentation/raw/branch/main/Images/BP_ShipHUD/InterfaceEvents.png)
This is simply a collection of the various interface functions. The names should be pretty straightforward as to what they do. An important note is that on opening certain UI elements we also perform the function *SetValues* as we don't use bindings for values to avoid checking every tick. The *SetValues* Function is on most widgets to set their relevant information whenever needed, such as opening the Shop UI.
## OpenShopUI
![](https://git.crabinteractive.com/crabdev/MSSS-Documentation/raw/branch/main/Images/BP_ShipHUD/OpenShopUI.png)
This interface event is a little different since it has an output reference to the Shop Interface Widget, which is used to create a reference elsewhere for hiding and showing the UI. This interface function simply sets a boolean *IsShopOpen?* to true and performs the *SetupShopLists* function on the Shop Interface widget. This function is covered in the Shop UI documenation.