Difference between revisions of "ScriptObject Script"

1,280 bytes added ,  02:10, 28 October 2017
m
category
imported>Kyllagdrgn
imported>Qazaaq
m (category)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
'''Extends:''' None
'''Extends:''' None


Line 139: Line 135:


== F4SE Member Functions ==
== F4SE Member Functions ==
*[[RegisterForKey - ScriptObject|RegisterForKey]](Int ''key'')'''
*[[RegisterForCameraState - ScriptObject|RegisterForCameraState]]()
**Registers the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events.
**Registers for a camera state change.
*[[UnregisterForKey - ScriptObject|UnregisterForKey]](Int ''key'')'''
 
**Unregisters the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events.
*[[RegisterForControl - ScriptObject|RegisterForControl]](string control)
*[[RegisterForControl - Form|RegisterForControl]](String ''control'')'''
**Registers the given control for OnControlDown and OnControlUp events.
**Registers the given control for OnControlDown and OnControlUp events.
*[[UnregisterForControl - Form|UnregisterForControl]](String ''control'')'''
 
*[[RegisterForExternalEvent - ScriptObject|RegisterForExternalEvent]](string eventName, string callback)
**Registers the given callback for the given event name.
 
*[[RegisterForFurnitureEvent - ScriptObject|RegisterForFurnitureEvent]](var filter = None)
**Registers for a filtered furniture event.
 
*[[RegisterForKey - ScriptObject|RegisterForKey]](int key)
**Registers the given [[DirectX_Scan_Codes|DXScanCode]] for OnKeyDown and OnKeyUp events.
 
*[[UnregisterForCameraState - ScriptObject|UnregisterForCameraState]]()
**Unregisters for a camera state change.
 
*[[UnregisterForControl - ScriptObject|UnregisterForControl]](string control)
**Unregisters the given control for OnControlDown and OnControlUp events.
**Unregisters the given control for OnControlDown and OnControlUp events.
*[[UnregisterForExternalEvent - ScriptObject|UnregisterForExternalEvent]](string eventName)
**Unregisters any callbacks for the given event name.
*[[UnregisterForFurnitureEvent - ScriptObject|UnregisterForFurnitureEvent]](var filter = None)
**Unregisters for a filtered furniture event.
*[[UnregisterForKey - ScriptObject|UnregisterForKey]](int key)
**Unregisters the given [[DirectX_Scan_Codes|DXScanCode]] for OnKeyDown and OnKeyUp events.


== Events ==
== Events ==
Line 197: Line 214:


== F4SE Events ==
== F4SE Events ==
*[[OnKeyDown - Form|OnKeyDown]](Int ''keyCode'')'''
*[[OnControlDown - ScriptObject|OnControlDown]](string control)
**Received when key(s) registered via [[RegisterForKey - Form|RegisterForKey]] are pressed.
**Received when control(s) registered via [[RegisterForControl - ScriptObject|RegisterForControl]] are pressed.
*[[OnKeyUp - Form|OnKeyUp]](Int ''keyCode'', Float ''holdTime'')'''
 
**Received when key(s) registered via [[RegisterForKey - Form|RegisterForKey]] are released.
*[[OnControlUp - ScriptObject|OnControlUp]](string control, float holdTime)
*[[OnControlDown - Form|OnControlDown]](String ''control'')'''
**Received when control(s) registered via [[RegisterForControl - ScriptObject|RegisterForControl]] are released.
**Received when control(s) registered via [[RegisterForControl - Form|RegisterForControl]] are pressed.
 
*[[OnControlUp - Form|OnControlUp]](String ''control'', Float ''holdTime'')'''
*[[OnFurnitureEvent - ScriptObject|OnFurnitureEvent]](Actor akActor, ObjectReference akFurniture, bool isGettingUp)
**Received when control(s) registered via [[RegisterForControl - Form|RegisterForControl]] are released.
**Received when a furniture event is registered via [[RegisterForFurnitureEvent - ScriptObject|RegisterForFurnitureEvent]].
 
*[[OnKeyDown - ScriptObject|OnKeyDown]](int keyCode)
**Received when key(s) registered via [[RegisterForKey - ScriptObject|RegisterForKey]] are pressed.
 
*[[OnKeyUp - ScriptObject|OnKeyUp]](int keyCode, float holdTime)
**Received when key(s) registered via [[RegisterForKey - ScriptObject|RegisterForKey]] are released.
 
*[[OnPlayerCameraState - ScriptObject|OnPlayerCameraState]](int oldState, int newState)
**Received when a camera state is changed while registered via [[RegisterForCameraState - ScriptObject|RegisterForCameraState]].
 
 
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
Anonymous user