OnMenuOpen - Form

From the CreationKit Wiki
Jump to navigation Jump to search

SKSE Member of: Form Script

Minimum required SKSE Version: 1.06.00

Listens for opening of given menu(s) previously registered via RegisterForMenu. (This function requires SKSE)

Syntax[edit | edit source]

Event OnMenuOpen(String MenuName)

Parameters[edit | edit source]

  • MenuName: The menu(s) listened for.

Return Value[edit | edit source]

None

Examples[edit | edit source]

Event OnInit()
	RegisterForMenu("ContainerMenu")
EndEvent
 
Event OnMenuOpen(String MenuName)
	Debug.Trace("A registered menu has opened.")
	If MenuName == "ContainerMenu"
		Debug.Trace("ContainerMenu has been registered and has opened.")
	EndIf
EndEvent

Notes[edit | edit source]

  • If multiple menus are registered, you'll want to differentiate in the corresponding event body as shown in the example. If only one menu is to be registered, no such differentiation is necessary.

See Also[edit | edit source]