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.
• ModEvent registrations are persistent and are stored in the MCBR record of the SKSE co-save. If you mod relies on these registrations being persistent it is strongly recommended that you register for the event again after each game load, if the user deletes this file for any reason it could break your mod.^[1]

See Also

• ActiveMagicEffect Script
• Alias Script
• Form Script
• SendModEvent