ShowOff:OnQueueCornerMessage
An event handler added by the ShowOff NVSE Plugin version 1.50.
Description
This event runs whenever a corner message is queued for display. It may have to wait in queue until other messages are displayed before being displayed.
Unlike with SetShowOffOnCornerMessageEventHandler, this event will ignore redundant queues that will be ignored by the game, such as queuing 2 of the exact same message twice. For example, if you have a Karma loss message currently displayed, then the game won't queue another one unless something else is in the queue.
It can also be filtered more thoroughly.
Dispatched Args
The args dispatched to handlers are:
- String: the message text.
Keywords such as "&sUActnVats" may be present; the text is not fully formatted. - String: the sound path.
- String: the icon path
- Float: the message's display time.
Syntax
Use SetEventHandler / SetEventHandlerAlt with the event name "ShowOff:OnQueueCornerMessage".
Handler Script
A skeleton handler script for this event:
scn OnQueueCornerMessageUDF begin Function { string_var sMsgTxt, string_var sSoundPath, string_var sIconPath, float fDisplayTime } ; do code end
Example
SetEventHandler "ShowOff:OnQueueCornerMessage" OnQueueCornerMessageUDF
Will register OnQueueCornerMessage as an event handler for the event.