Actionbar¶
EEex_Actionbar_AddListener¶
Summary
Registers a function as an actionbar listener. Actionbar listeners are called whenever the actionbar changes state. See EEex_Actionbar_GetState for more details.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
listener |
function |
The listener to register. |
The listener function¶
Parameters:
Name |
Type |
Description |
|---|---|---|
config |
number |
Certain actionbar states map to the same button configuration, albeit with different |
state |
number |
The following shows what actionbar states each config encompases:
Config |
Matching States |
|---|---|
0 |
1 |
1 |
2 |
2 |
3 |
3 |
4 |
4 |
5 |
5 |
6 |
6 |
7 |
7 |
8 |
8 |
9 |
9 |
10 |
10 |
11 |
11 |
12 |
12 |
13 |
13 |
14 |
14 |
15 |
15 |
16 |
16 |
17 |
17 |
18 |
18 |
20 |
19 |
21 |
20 |
101 |
21 |
102, 103 |
22 |
104, 105 |
23 |
106 |
24 |
107 |
25 |
108 |
26 |
109 |
27 |
110 |
28 |
111 |
29 |
112 |
30 |
113, 114 |
EEex_Actionbar_GetArray¶
Summary
Returns the actionbar button array. This structure holds the current state of the actionbar.
Return Values:
Type |
Description |
|---|---|
CInfButtonArray |
See summary. |
EEex_Actionbar_GetLastState¶
Summary
Returns the previous actionbar state. See EEex_Actionbar_GetState for more details.
Return Values:
Type |
Description |
|---|---|
number |
See summary. |
EEex_Actionbar_GetState¶
Summary
Returns the current actionbar state, which is a number that represents what the actionbar is displaying.
Return Values:
Type |
Description |
|---|---|
number |
See summary. |
Actionbar State Ordinals¶
State |
Description |
|---|---|
1 |
Mage / Sorcerer |
2 |
Fighter |
3 |
Cleric |
4 |
Thief |
5 |
Bard |
6 |
Paladin |
7 |
Fighter Mage |
8 |
Fighter Cleric |
9 |
Fighter Thief |
10 |
Fighter Mage Thief |
11 |
Druid |
12 |
Ranger |
13 |
Mage Thief |
14 |
Cleric Mage |
15 |
Cleric Thief |
16 |
Fighter Druid |
17 |
Fighter Mage Cleric |
18 |
Cleric Ranger |
20 |
Monk |
21 |
Shaman |
101 |
Select Weapon Ability |
102 |
Spells (Select Quick Spell) |
103 |
Spells (Cast) |
104 |
Select Quick Item Ability |
105 |
Use Item |
106 |
Special Abilities |
107 |
Select Quick Formation |
108 |
Defunct Select Quick Formation (Not used) |
109 |
Group Selected |
110 |
Unknown (No buttons defined; not used?) |
111 |
Internal List (Opcode #214) |
112 |
Controlled (Class doesn’t have a dedicated state) |
113 |
Cleric / Mage Spells (Cast) |
114 |
Cleric / Mage Spells (Select Quick Spell) |
EEex_Actionbar_IsThievingHotkeyOpeningSpecialAbilities¶
Summary
Returns true if the thieving hotkey is currently in the middle of opening the special abilities menu.
It does this if the thieving button is not a part of the character’s main actionbar state.
This function allows actionbar listeners to differentiate between a user opening the special abilities menu,
and the hotkey automatically doing so.
Return Values:
Type |
Description |
|---|---|
boolean |
See summary. |
EEex_Actionbar_RestoreLastState¶
Summary
Restores the previous actionbar state. This is useful for exiting sub-states, such as the spell list.
EEex_Actionbar_RunWithListenersSuppressed¶
Warning
This function is currently undocumented.
EEex_Actionbar_SetState¶
Summary
Sets the current actionbar state. See EEex_Actionbar_GetState for more details.
Parameters:
Name |
Type |
Default Value |
Description |
|---|---|---|---|
state |
number |
The state to set. |
EEex_Actionbar_SuppressListeners¶
Warning
This function is currently undocumented.