Built-In Events

From EventGhost
Jump to: navigation, search

This is a complete list of the events that are built into EventGhost as of version 0.5.

List of Events

Items with no description still need their details clarified (for payload and enduring, as well as description).

Event Payload? Enduring? Description
Event.pngMain.OnInit N N Triggered after EventGhost has loaded all your plugins.
Event.pngMain.OnInitAfterBoot N N If you have EventGhost set to automatically start at login, this event will be fired.
Event.pngMain.OnClose N N Triggered when EventGhost is exiting. You will not be able to act on this event.
Event.pngSystem.Idle N N Your computer is inactive (no keyboard/mouse activity) for 1 minute.
Event.pngSystem.UnIdle N N Your system has been idle, and then detects keyboard/mouse activity.
Event.pngSystem.DriveMounted.N N N A new disk drive has just been mounted as N:.
Event.pngSystem.DriveRemoved.N N N The disk drive called N: has been removed.
Event.pngSystem.DeviceAttached Y N A new USB device, such as a mouse, has been attached. The payload is a list holding a string with the device identifier of the new device.
Event.pngSystem.DeviceRemoved Y N A USB device has been removed. The payload is a list holding a string with the device identifier of the removed device.
Event.pngSystem.ClipboardChanged N N Something has been cut or copied to the clipboard. (This is triggered even if the new item is identical to what was already in the clipboard.)
Event.pngSystem.Mute Y N Sound output has been muted. The payload is a string containing the unmuted volume, ranging from 0.00 to 100.00.
Event.pngSystem.UnMute Y N Sound output has been unmuted. The payload is a string containing the unmuted volume, ranging from 0.00 to 100.00.
Event.pngSystem.Volume Y N Sound output volume level has changed. The payload is a string containing the new volume, ranging from 0.00 to 100.00.
Event.pngSystem.Monitor.Off N N All monitors have turned off.
Event.pngSystem.Monitor.On N N All monitors have turned on.
Event.pngSystem.Monitor.Dim N N All montiors have dimmed. Typically seen in laptops when switching from external power to battery power.
Event.pngSystem.AwayMode.Exiting N N The system has exited the "user not present" state.
Event.pngSystem.AwayMode.Entering N N The system has entered the "user not present" state.
Event.pngSystem.PowerSource.Line N N The system has switched its power source to external (line) power.
Event.pngSystem.PowerSource.Battery N N The system has switched its power source to internal battery power.
Event.pngSystem.PowerSource.UPS N N The system has switched its power source to UPS (external battery) power.
Event.pngSystem.BatteryLevel.N N N Triggered when your internal or UPS battery is at N% remaining.
Event.pngSystem.PowerSaving.Off N N Power saving features have turned off. This will be triggered if you have configured your computer to use power-saving features when on battery power but not on AC power.
Event.pngSystem.PowerSaving.On N N Power saving features have turned on. This will be triggered if you have configured your computer to use power-saving features when on battery power but not on AC power.
Event.pngSystem.PowerProfile.PowerSaver N N Your computer's power consumption profile has changed to a power-saving mode.
Event.pngSystem.PowerProfile.HighPerformance N N Your computer's power consumption profile has changed to a high-performance mode. (You may see this appear when starting a game or other CPU-heavy program.)
Event.pngSystem.PowerProfile.Balanced N N Your computer's power consumption profile has changed to a balanced mode. (You may see this appear when exiting a game or other CPU-heavy program.)
Event.pngSystem.ResumeAutomatic N N Your computer has just been awakened from Suspended mode. (This is triggered before Event.pngSystem.Resume.)
Event.pngSystem.Resume N N You have awakened your computer from Suspended mode by pressing a key or other input. (Implies Event.pngSystem.ResumeAutomatic.)
Event.pngSystem.Suspend N N Your computer is about to go into Suspended mode.
Event.pngSystem.ConsoleConnect Y N A console or remote FX session (remote desktop) has started. The payload is a list holding a string with the name of the user who's console session connected.
Event.pngSystem.ConsoleDisconnect Y N A console or remote FX session (remote desktop) has exited. The payload is a list holding a string with the name of the user who's console session disconnected.
Event.pngSystem.RemoteConnect Y N A remote desktop session has started. The payload is a list holding a string with the name of the user who's remote session connected.
Event.pngSystem.RemoteDisconnect Y N A remote desktop session has exited. The payload is a list holding a string with the name of the user who's remote session disconnected.
Event.pngSystem.SessionLogon Y N User logged into a desktop session. This is triggered for both local and remote desktop sessions. The payload is a list holding a string with the name of the user who logged on.
Event.pngSystem.SessionLogoff Y N User exited a desktop session. This is triggered for both local and remote desktop sessions. The payload is a list holding a string with the name of the user who logged off.
Event.pngSystem.SessionLock Y N The desktop session has been locked. The payload is a list holding a string with the name of the user whose session is locked.
Event.pngSystem.SessionUnlock Y N The desktop session has been unlocked. The payload is a list holding a string with the name of the user whose session is unlocked.
Event.pngSystem.SessionRemoteControl Y N Triggered when a remote desktop session changes state between controlled and uncontrolled. This happens when a remote desktop session is closed and not logged off. The payload is a list holding a string with the name of the user.

Windows XP

The following events are specific to Windows XP:

Event Payload? Enduring? Description
Event.pngSystem.BatteryLevel.Low N N
Event.pngSystem.OemEvent N N
Event.pngSystem.QuerySuspendFailed N N
Event.pngSystem.ResumeCritical N N
Event.pngSystem.QuerySuspend N N

Notes

About Main.OnInit

If you have a macro that needs any setup done before it can properly react (particularly by adding something to eg.globals), you may be tempted to do this setup in a macro that is triggered by Event.pngMain.OnInit. However, this event is triggered after all plugins have been loaded. This means that it is possible for plugins to trigger their own events -- and any macros youve set up to listen to them -- before OnInit is triggered. This can cause trouble if your macros depend on your initial setup.

The solution is to add a Action.pngTrigger Event action to your Autostart.pngAutostart, before your first plugin, to generate a custom event for yourself (you might call it Event.pngMain.OnBeforeInit), and do your setup in a macro that is triggered by this new event instead.

See Also