diff --git a/Custom HUD Class - BP_ShipHUD.-.md b/Custom HUD Class - BP_ShipHUD.-.md index 5d08b7b..243e89b 100644 --- a/Custom HUD Class - BP_ShipHUD.-.md +++ b/Custom HUD Class - BP_ShipHUD.-.md @@ -1 +1,22 @@ -Welcome to the Wiki. \ No newline at end of file +This custom HUD class can easily be replace with your own, new or existing, HUD class. The functionality in here is meant to organize all the various widgets and UI elements used by the kit. + +This class implements the following Blueprint Interfaces and functions: + +1. ***BPI_ShopUI*** + *DisplayDockingPrompt* + *HideDockingPrompt* + *HideUndockPrompt* + *DisplayUndockPrompt* + *CloseShopUI* + *OpenOutfittingUI* + *CloseOutfittingUI* + *OpenShopUI* + +## BeginPlay + +![](https://git.crabinteractive.com/crabdev/MSSS-Documentation/raw/branch/main/Images/BP_ShipHUD/BeginPlay.png) + +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. + + +