Mission Speaker (DarkLibHUD)

Description

This is a 1:1 recreation of the mission speaker HUD (The pop-up on the right of the screen at the start of missions) complete with transitions, effects, the full roster of mission-givers and a fully typed API. I also added a 'flipped' mode so the element can display correctly on the left side of the screen and a subtitle that can optionally appear below the speaker, since this HUD doesn't fire any audio.

This is something I wanted to include in my larger WIP mod but found it didn't fit as a feature, so I made it a self-contained injectable module that you can drop into any mod and make work with one line of code. Maybe you can do something more fun with it, or cannibalise it for something else entirely!

Why not just hook and modify the existing UI? Because that approach is far more restrictive, less extendible, harder to follow, and less fun.

Once set up, you will have access to these main function calls (and a few more) on the mod.use_mission_speaker field:

Also, the panel will hide itself by default when a real mission speaker is currently active. This is exposed via the manager.

Installation instructions

1. Drop the mission_speaker folder anywhere at or below the lowest folder level in your mod

2. Call the mission_speaker/mission_speaker.lua file with mod:io_dofile, passing your mod instance and the path to the mission_speaker file, relative to your my_mod.lua file

That's it! 

Assuming you have this structure:

└── scripts

├── my_mod.lua              <---- This is where we call the module

├── my_mod_data.lua

├── my_mod_localisation.lua

└── mission_speaker         <--- This is the module folder

├── mission_speaker.lua

Obviously there's some settings you can tweak, along with a constants.lua file with more variables. I've included an example mod that has the settings in the data file. When settings aren't present, the settings_manager.lua file has all the default values.

How to get intellisense (type + function name 

suggestions)

:

To get suggestions on available methods, properties, etc. declare your mod instance as a class with LuaLS