HUDFramework Wrapper - kinggath/WorkshopFramework GitHub Wiki

HUDFramework Wrapper

The goal of the HUDFramework wrapper is to add some simple, common functions.

It also provides an API function through the main WSFW_API quest and a conditional variable on WSFW_HUDFrameworkManager so you can easily check if it is installed before sending requests to it.

Finally, it tracks the registered widgets and auto scrubs any that are removed on start-up, this way the manager can intercept bad traffic from ever going to HUDFramework as it will pre-screen to ensure the calling widget is actually registered.

See the API and HUDFrameworkManager scripts for the new functions you can use.

This will likely be expanded upon massively in the future, as I have major plans for revamping all of the HUD Modules I've released so far and will be sure to include any useful code I come up to Workshop Framework.

Progress Meter System

Version 1.2.0 introduces a new Progress Meter System. This allows you to create and update progress meters with single lines of code, no need for any Flash work.

You have 4 primary functions for this system:

CreateProgressBar - Which handles creating the progress bar. CompleteProgressBar - Which will close the progress bar when you are finished with it. UpdateProgressBarPercentage - Which updates the percentage towards completion. UpdateProgressBarData - Which allows for updating the icon and text on a progress bar after it's been created.

For full function definitions, check out the HUDFrameWorkManager script.

For an example of implementation, check out the SettlementLayoutManager script which makes use of this system.