Events

This page describes the process of registering an event to execute, as well as provide a full list of all available events.

An event is in this case simply an in-game event. This can range from logging in, to an incoming tell, to losing or gaining HP during battle. There are various events all of which can be reacted to.

All events are registered with windower.register_event(name, fn), where name is the event to register and fn is the function to execute.

Examples

functionprint_values(new, old)
print(new, old)
endwindower.register_event('status change', print_values)

This can usually be simplified by just dropping the function into the definition:

windower.register_event('status change', function(new, old)
print(new, old)
end)

Sometimes (such as in this case) this can be further shortened to the following:

windower.register_event('status change', print)

This will have the same effect since print takes an arbitrary number of arguments, so it will simply print out all arguments the event provides.

---

Event list

The following is a list of all available events, as well as the arguments they provide. Some of them will take return values to modify their content.

Name	Arguments	Return	Description
action	See details	None	⚠️ Deprecated! Use incoming chunk with ID 0x028. General Action Event
action message	See details	None	⚠️ Deprecated! Use incoming chunk with ID 0x029. General Action Message Event
load	None	None	Triggers on addon load.
unload	None	None	Triggers on addon unload.
login	stringname	None	Triggers on login.
logout	stringname	None	Triggers on logout.
gain focus	None	None	Triggers on receiving focus.
lose focus	None	None	Triggers on losing focus.
gain buff	numberbuff_id	None	Triggers on receiving a buff or debuff.
lose buff	numberbuff_id	None	Triggers on losing a buff or debuff.
gain experience	numberamount numberchain_number boollimit	None	Triggers on gaining any experience. limit is true, if the EXP gained were limit points.
lose experience	numberamount	None	Triggers on losing any experience.
level up	numberlevel	None	Triggers on gaining a level.
level down	numberlevel	None	Triggers on losing a level.
job change	numbermain_job_id numbermain_job_level numbersub_job_id numbersub_job_level	None	Triggers on job change. This will trigger on both main and sub job change.
target change	numberindex	None	Triggers on target change.
weather change	numberweather_id	None	Triggers on weather change.
status change	numbernew_status_id numberold_status_id	None	Triggers on player status change. This only triggers for the following statuses: Idle, Engaged, Resting, Dead, Zoning
hp change	numbernew_hp numberold_hp	None	Triggers on HP change.
mp change	numbernew_mp numberold_mp	None	Triggers on MP change.
tp change	numbernew_tp numberold_tp	None	Triggers on TP change.
hpp change	numbernew_hpp numberold_hpp	None	Triggers on HP% change.
mpp change	numbernew_mpp numberold_mpp	None	Triggers on MP% change.
hpmax change	numbernew_hp_max numberold_hp_max	None	Triggers on maximum HP change.
mpmax change	numbernew_mp_max numberold_mp_max	None	Triggers on maximum MP change.
chat message	stringmessage stringsender numbermode boolgm	None	Triggers on any chat message. This only includes FFXI chat messages and will therefor not work with Windower-based chat events, like FFOChat.
emote	numberemote_id numbersender_id numbertarget_id boolmotion	None	Triggers on any player doing an emote. motion is true if it's only motioned without text.
party invite	stringsender numbersender_id	None	Triggers on receiving a party or alliance invite.
examined	stringname numbersender_index	None	Triggers on being examined. name is the name of the person to examine you.
time change	numbernew numberold	None	Triggers on time change. This only triggers when the displayed in-game time actually changes. Both arguments are the number of minutes since the beginning of the in-game day.
day change	numbernew_day numberold_day	None	Triggers on day change.
moon change	stringnew_moon stringold_moon	None	Triggers on moon type change. This means Full Moon, Waning Gibbous, etc.
linkshell change	stringnew_ls stringold_ls	None	Triggers on changing linkshells.
zone change	numbernew_id numberold_id	None	Fires whenever the player is zoning. This includes logging in and logging out.
add item	numberbag numberindex numberid numbercount	None	Triggers whenever an item enters a bag (through trade, dropping from the treasure pool, NPC reward, moving it from another bag, etc.).
remove item	numberbag numberindex numberid numbercount	None	Triggers whenever an item leaves a bag (through trade, dropping it, usage, etc.).
incoming text	stringoriginal stringmodified numberoriginal_mode numbermodified_mode boolblocked	string number	bool
incoming chunk	numberid stringoriginal stringmodified boolinjected boolblocked	string	bool
outgoing text	stringoriginal stringmodified boolblocked	string	bool
outgoing chunk	numberid stringoriginal stringmodified boolinjected boolblocked	string	bool
mouse	numbertype numberx numbery numberdelta numberblocked	bool	Triggers on any mouse action, including movement. Optionally returns a bool indicating whether or not the mouse action has been caught. If true, it will not be passed on to the next stage, so the mouse action would never reach the game. The most common values for the type parameter are the following: Left click down 1 Left click up 2 Left double click 3 Right click down 4 Right click up 5 Right double click 6 Middle click down 7 Middle click up 8 Middle double click 9 Wheel scroll 10 A full list can be found here. The value displayed there needs be bit masked to the low 8 bits, so 0x0201 would be just 1.
keyboard	numberdik boolpressed numberflags boolblocked	bool	Triggers on any keyboard action, including release of a button. Optionally returns a bool indicating whether or not the keyboard action has been caught. If true, it will not be passed on to the next stage, so the keyboard action would never reach the game.
ipc message	stringmessage	None	Triggers on an incoming IPC message.
addon command	string* ...	None	Triggers on passing an addon command, which is any command of the form lua c <name>, where name is the addon name. (Everything after the command is passed to the function, not the command itself.)
unhandled command	string* ...	None	Triggers on Windower commands that weren't processed by any other plugin. (The entire line is passed to the function, including the command.)
pipe message	string* message	None	Triggers upon receiving a message from the named pipe reader \\.\pipe\luaReader.
prerender	None	None	Triggers before every rendering tick.
postrender	None	None	Triggers after every rendering tick.