ShowOff:OnShowCornerMessage

From GECK
Jump to: navigation, search

An event handler added by the ShowOff NVSE Plugin version 1.50.

Description

This event runs whenever a corner message first appears on screen.

Dispatched Args

The args dispatched to handlers are:

  1. String: the message text.
    Keywords such as "&sUActnVats" may be present; the text is not fully formatted.
  2. String: the sound path.
  3. String: the icon path
  4. Float: the message's display time.

Syntax

Use SetEventHandler / SetEventHandlerAlt with the event name "ShowOff:OnShowCornerMessage".

Handler Script

A skeleton handler script for this event:

scn OnShowCornerMessageUDF

begin Function { string_var sMsgTxt, string_var sSoundPath, string_var sIconPath, float fDisplayTime }
   ; do code
end

Example

SetEventHandler "ShowOff:OnShowCornerMessage" OnShowCornerMessageUDF

Will register OnShowCornerMessage as an event handler for the event.

See Also