Skip to content
Shadowed edited this page Sep 13, 2010 · 6 revisions

Details on the module events that are included in SUF, see Fader module for an example on how to use some of the events. All module events are fired in the order the module is registered, this means that all of the modules included in SUF by default will get their events first, then custom modules.

OnInitialize

The database has been loaded for SUF, but all the units and such have not been initialized.
Arg Type Description
No arguments sent.

OnProfileChange

Works the same as OnInitialize, but it fires after a profile change has occured but before units have all been reloaded.
Arg Type Description
No arguments sent.

OnEnable

The module has been enabled for a frame, either for the first time or because it was disabled before. Make sure you check that any frames you create were not created already in a previous call.
Keep in mind, you must define both OnEnable and OnDisable, if you do not you will not get either event.
Arg Type Description
frame table The frame that has enabled this module.

OnDisable

The module has been disabled for this frame, make sure you unregister all event and updates (see Unit frame functions and fields) as well as hide any frames you might have created
Keep in mind, you must define both OnEnable and OnDisable, if you do not you will not get either event.
Arg Type Description
frame table The frame that has disabled this module.

OnPreLayoutApplied

Called right before a layout is updated, no layout updates were applied yet, but they will be immediately after.
Arg Type Description
frame table The frame that is being modified

OnLayoutApplied

Called right after a layout has been applied to a frame.
Arg Type Description
frame table The frame that is being modified

OnConfigurationLoad

Called right after the configuration tables have been created, but the interface hasn’t been shown yet.
Arg Type Description
No arguments sent.