Form Script: Difference between revisions

Jump to navigation Jump to search
56 bytes added ,  2 October 2012
m
Formatting.
imported>JustinOther
m (→‎SKSE Member Functions: Fixed broken link.)
imported>JustinOther
m (Formatting.)
Line 113: Line 113:
*Returns whether this form has a keyword with the specified string.
*Returns whether this form has a keyword with the specified string.


'''Function [[RegisterForKey - Form|RegisterForKey]](int keyCode)
'''Function [[RegisterForKey - Form|RegisterForKey]](int keyCode)'''
*Registers for OnKeyDown and OnKeyUp events for the given [[Input_Script#DXScanCodes|DXScanCode]].
*Registers for OnKeyDown and OnKeyUp events for the given [[Input_Script#DXScanCodes|DXScanCode]].


'''Function [[UnregisterForKey - Form|UnregisterForKey]](int keyCode)
'''Function [[UnregisterForKey - Form|UnregisterForKey]](int keyCode)'''
*Unregisters for OnKeyDown and OnKeyUp events for the given [[Input_Script#DXScanCodes|DXScanCode]].
*Unregisters for OnKeyDown and OnKeyUp events for the given [[Input_Script#DXScanCodes|DXScanCode]].


'''Function [[UnregisterForAllKeys - Form|UnregisterForAllKeys]]()
'''Function [[UnregisterForAllKeys - Form|UnregisterForAllKeys]]()'''
*Unegisters all registered [[Input_Script#DXScanCodes|DXScanCodes]].
*Unegisters all registered [[Input_Script#DXScanCodes|DXScanCodes]].


'''Function [[RegisterForMenu - Form|RegisterForMenu]](string menuName)
'''Function [[RegisterForMenu - Form|RegisterForMenu]](string menuName)'''
*Registers for OnMenuOpen and OnMenuClose events for the given menu.
*Registers for OnMenuOpen and OnMenuClose events for the given menu.


'''Function [[UnregisterForMenu - Form|UnregisterForMenu]](string menuName)
'''Function [[UnregisterForMenu - Form|UnregisterForMenu]](string menuName)'''
*Unregisters for OnMenuOpen and OnMenuClose events for the given menu.
*Unregisters for OnMenuOpen and OnMenuClose events for the given menu.


'''Function [[UnregisterForAllMenu - Form|UnregisterForAllMenus]]()
'''Function [[UnregisterForAllMenu - Form|UnregisterForAllMenus]]()'''
*Unregisters all registered menus.
*Unregisters all registered menus.


'''Function [[RegisterForModEvent - Form|RegisterForModEvent]](string eventName, string callbackName)
'''Function [[RegisterForModEvent - Form|RegisterForModEvent]](string eventName, string callbackName)'''
*Registers a custom event callback for given event name.
*Registers a custom event callback for given event name.


'''Function [[SendModEvent - Form|SendModEvent]](string eventName, string strArg = "", float numArg = 0.0)
'''Function [[SendModEvent - Form|SendModEvent]](string eventName, string strArg = "", float numArg = 0.0)'''
*Sends a custom event with given generic parameters.
*Sends a custom event with given generic parameters.


'''Function [[UnregisterForModEvent - Form|UnregisterForModEvent]](string eventName)
'''Function [[UnregisterForModEvent - Form|UnregisterForModEvent]](string eventName)'''
*Unregisters a custom event callback for given event name.
*Unregisters a custom event callback for given event name.


'''Function [[UnregisterForAllModEvents - Form|UnregisterForAllModEvents]]()
'''Function [[UnregisterForAllModEvents - Form|UnregisterForAllModEvents]]()'''
*Unregisters all registered custom events.
*Unregisters all registered custom events.


'''Form Function [[TempClone - Form|TempClone]]()
'''Form Function [[TempClone - Form|TempClone]]()'''
*Returns a temporary clone of this form
*Returns a temporary clone of this form


Line 151: Line 151:


'''Event [[OnAnimationEventUnregistered - Form|OnAnimationEventUnregistered]](ObjectReference akSource, string asEventName)'''
'''Event [[OnAnimationEventUnregistered - Form|OnAnimationEventUnregistered]](ObjectReference akSource, string asEventName)'''
*Received when one of the animation events we are listening for has been automatically unregistered by the game due to the target animation graph unloading.
*Received when one of the animation events we are listening for has been automatically unregistered by the game due to the target animation graph unloading.


Line 177: Line 176:
== SKSE Events ==
== SKSE Events ==


Event [[OnKeyDown - Form|OnKeyDown]](int keyCode)
'''Event [[OnKeyDown - Form|OnKeyDown]](int keyCode)'''
*Received when key(s) registered via [[RegisterForKey - Form|RegisterForKey]] are pressed.
*Received when key(s) registered via [[RegisterForKey - Form|RegisterForKey]] are pressed.


Event [[OnKeyUp - Form|OnKeyUp]](int keyCode, float holdTime)
'''Event [[OnKeyUp - Form|OnKeyUp]](int keyCode, float holdTime)'''
*Received when key(s) registered via [[RegisterForKey - Form|RegisterForKey]] are released.
*Received when key(s) registered via [[RegisterForKey - Form|RegisterForKey]] are released.


Event [[OnMenuOpen - Form|OnMenuOpen]](string menuName)
'''Event [[OnMenuOpen - Form|OnMenuOpen]](string menuName)'''
*Received when menu(s) registered via [[RegisterForMenu - Form|RegisterForMenu]] are opened.
*Received when menu(s) registered via [[RegisterForMenu - Form|RegisterForMenu]] are opened.


Event [[OnMenuClose - Form|OnMenuClose]](string menuName)
'''Event [[OnMenuClose - Form|OnMenuClose]](string menuName)'''
*Received when menu(s) registered via [[RegisterForMenu - Form|RegisterForMenu]] are closed.
*Received when menu(s) registered via [[RegisterForMenu - Form|RegisterForMenu]] are closed.
Anonymous user

Navigation menu