RegisterForModEvent - Form

SKSE Member of: ActiveMagicEffect Script, Alias Script, and Form Script

Registers a custom event callback for given event name. Registrations have to be refreshed after each game load.

Syntax

Function RegisterForModEvent(string eventName, string callbackName) native

;The event:
Event callbackName(string eventName, string strArg, float numArg, Form sender)
EndEvent

Parameters

• eventName: The name of the event sent by SendModEvent.

• callbackName: The name by which you can catch the event.

Examples

; Register to receive the ModEvent:
; named HectorHitMe with the callback of OnHectorHitMe
RegisterForModEvent("HectorHitMe", "OnHectorHitMe")

Event OnHectorHitMe(string eventName, string strArg, float numArg, Form sender)
;Do something
EndEvent

Notes

• Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.
• You must register for ModEvents after every game load!
• A script is deregistered for a ModEvent after that event occurs.

See Also

• ActiveMagicEffect Script
• Alias Script
• Form Script
• SendModEvent