Difference between revisions of "ScriptObject Script"
Add missing F4SE member functions and events
imported>Qazaaq m (removed whitespace from top of document) |
imported>ShadeMe (Add missing F4SE member functions and events) |
||
| Line 138: | Line 138: | ||
== F4SE Member Functions == | == F4SE Member Functions == | ||
*[[RegisterForKey - ScriptObject|RegisterForKey]](int | *[[RegisterForKey - ScriptObject|RegisterForKey]](int key) | ||
**Registers the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events. | **Registers the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events. | ||
*[[UnregisterForKey - ScriptObject|UnregisterForKey]](int | |||
*[[UnregisterForKey - ScriptObject|UnregisterForKey]](int key) | |||
**Unregisters the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events. | **Unregisters the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events. | ||
*[[RegisterForControl - ScriptObject|RegisterForControl]](string | |||
*[[RegisterForControl - ScriptObject|RegisterForControl]](string control) | |||
**Registers the given control for OnControlDown and OnControlUp events. | **Registers the given control for OnControlDown and OnControlUp events. | ||
*[[UnregisterForControl - ScriptObject|UnregisterForControl]](string | |||
*[[UnregisterForControl - ScriptObject|UnregisterForControl]](string control) | |||
**Unregisters the given control for OnControlDown and OnControlUp events. | **Unregisters the given control for OnControlDown and OnControlUp events. | ||
*[[RegisterForExternalEvent - ScriptObject|RegisterForExternalEvent]](string eventName, string callback) | |||
**Registers the given callback for the given event name. | |||
*[[UnregisterForExternalEvent - ScriptObject|UnregisterForExternalEvent]](string eventName) | |||
**Unregisters any callbacks for the given event name. | |||
*[[RegisterForCameraState - ScriptObject|RegisterForCameraState]]() | |||
**Registers for a camera state change. | |||
*[[UnregisterForCameraState - ScriptObject|UnregisterForCameraState]]() | |||
**Unregisters for a camera state change. | |||
*[[RegisterForFurnitureEvent - ScriptObject|RegisterForFurnitureEvent]](var filter = None) | |||
**Registers for a filtered furniture event. | |||
*[[UnregisterForFurnitureEvent - ScriptObject|UnregisterForFurnitureEvent]](var filter = None) | |||
**Unregisters for a filtered furniture event. | |||
== Events == | == Events == | ||
| Line 196: | Line 217: | ||
== F4SE Events == | == F4SE Events == | ||
*[[OnKeyDown - ScriptObject|OnKeyDown]](int | *[[OnKeyDown - ScriptObject|OnKeyDown]](int keyCode) | ||
**Received when key(s) registered via [[RegisterForKey - ScriptObject|RegisterForKey]] are pressed. | **Received when key(s) registered via [[RegisterForKey - ScriptObject|RegisterForKey]] are pressed. | ||
*[[OnKeyUp - ScriptObject|OnKeyUp]](int | |||
*[[OnKeyUp - ScriptObject|OnKeyUp]](int keyCode, float holdTime) | |||
**Received when key(s) registered via [[RegisterForKey - ScriptObject|RegisterForKey]] are released. | **Received when key(s) registered via [[RegisterForKey - ScriptObject|RegisterForKey]] are released. | ||
*[[OnControlDown - ScriptObject|OnControlDown]](string | |||
*[[OnControlDown - ScriptObject|OnControlDown]](string control) | |||
**Received when control(s) registered via [[RegisterForControl - ScriptObject|RegisterForControl]] are pressed. | **Received when control(s) registered via [[RegisterForControl - ScriptObject|RegisterForControl]] are pressed. | ||
*[[OnControlUp - ScriptObject|OnControlUp]](string | |||
*[[OnControlUp - ScriptObject|OnControlUp]](string control, float holdTime) | |||
**Received when control(s) registered via [[RegisterForControl - ScriptObject|RegisterForControl]] are released. | **Received when control(s) registered via [[RegisterForControl - ScriptObject|RegisterForControl]] are released. | ||
*[[OnPlayerCameraState - ScriptObject|OnPlayerCameraState]](int oldState, int newState) | |||
**Received when a camera state is changed while registered via [[RegisterForCameraState - ScriptObject|RegisterForCameraState]]. | |||
*[[OnFurnitureEvent - ScriptObject|OnFurnitureEvent]](Actor akActor, ObjectReference akFurniture, bool isGettingUp) | |||
**Received when a furniture event is registered via [[RegisterForFurnitureEvent - ScriptObject|RegisterForFurnitureEvent]]. | |||