Components
EEex
The main component of EEex. This includes most functionality required by mods that depend on EEex. There are no user-side effects of this component.
Enable attack info module
This component enables the attack information popup, which opens and displays various attack information when hovering an attack cursor over a creature.
This information includes:
The to-hit probabilities each selected party member has against the target.
And optionally, whether the target is immune to the weapon of each selected party member.
The attack direction can be reversed by holding a keybind, (by default 'Left Alt'). Reversing the attack direction causes the popup to display attack information for the creature under the cursor, as if it was attacking each selected party member.
Enable effect menu module
This component enables the effect menu. A menu displaying all the spells currently affecting a creature can be invoked by holding L-Shift and hovering over said creature.
Note that this menu is dynamically generated - it does the best it can, though there are holes in what it can detect, and it may show internal spells at times.
Enable empty container module
This component changes the highlight color of empty containers to gray (replacing the normal cyan).
Enable hotkey module
This component enables the override/B3Hotkey.lua file, which can be edited to create spell casting hotkeys that support
multi-key sequences and modifier keys. The top of the file includes examples which demonstrate how the keybindings are defined.
Enable scale module
This component enables an option in the "EEex Options" menu that sets the engine's UI scaling factor to a custom value.
Enable time step module
This component enables a keybind, (by default 'D'), that when the game is paused, advances time by the minimum amount. The keybind essentially causes the game to unpause and then pause again extremely quickly. Holding the keybind for half a second makes time flow until it is released.
Also pictured: Bubb's Spell Menu - Overlay Mode
Enable timer module
This component enables visual indicators next to party member portraits that display various timer information.
A red bar indicates the interval of modal actions: find traps, turn undead, etc.
A green bar indicates the interval at which contingency conditions are checked.
Note that some mods add contingency effects behind-the-scenes to implement certain behaviors - this may cause the contingency indicator to appear unexpectedly.
A cyan bar indicates the cooldown for using spells / items.
Experimental - Use LuaJIT
This component replaces the Lua version used by the engine with LuaJIT.
LuaJIT is a faster implementation of Lua; replacing the engine's Lua version with LuaJIT can help alleviate performance issues.
Warning
The engine was not designed to use LuaJIT. This component is currently experimental, and may introduce crashes / errors in mod-introduced Lua code that otherwise works under the engine's normal Lua version.