Difference between revisions of "ScriptObject Script"
Re-order F4SE Member functions and events, fix DXScanCode link
imported>ShadeMe (Add missing F4SE member functions and events) |
imported>ShadeMe (Re-order F4SE Member functions and events, fix DXScanCode link) |
||
| Line 138: | Line 138: | ||
== F4SE Member Functions == | == F4SE Member Functions == | ||
*[[ | *[[RegisterForCameraState - ScriptObject|RegisterForCameraState]]() | ||
**Registers | **Registers for a camera state change. | ||
*[[RegisterForControl - ScriptObject|RegisterForControl]](string control) | *[[RegisterForControl - ScriptObject|RegisterForControl]](string control) | ||
**Registers the given control for OnControlDown and OnControlUp events. | **Registers the given control for OnControlDown and OnControlUp events. | ||
*[[RegisterForExternalEvent - ScriptObject|RegisterForExternalEvent]](string eventName, string callback) | *[[RegisterForExternalEvent - ScriptObject|RegisterForExternalEvent]](string eventName, string callback) | ||
**Registers the given callback for the given event name. | **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 for | **Registers the given [[DirectX_Scan_Codes|DXScanCode]] for OnKeyDown and OnKeyUp events. | ||
*[[UnregisterForCameraState - ScriptObject|UnregisterForCameraState]]() | *[[UnregisterForCameraState - ScriptObject|UnregisterForCameraState]]() | ||
**Unregisters for a camera state change. | **Unregisters for a camera state change. | ||
*[[ | *[[UnregisterForControl - ScriptObject|UnregisterForControl]](string control) | ||
** | **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) | *[[UnregisterForFurnitureEvent - ScriptObject|UnregisterForFurnitureEvent]](var filter = None) | ||
**Unregisters for a filtered furniture event. | **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 217: | Line 217: | ||
== F4SE Events == | == F4SE Events == | ||
*[[OnControlDown - ScriptObject|OnControlDown]](string control) | |||
**Received when control(s) registered via [[RegisterForControl - ScriptObject|RegisterForControl]] are pressed. | |||
*[[OnControlUp - ScriptObject|OnControlUp]](string control, float holdTime) | |||
**Received when control(s) registered via [[RegisterForControl - ScriptObject|RegisterForControl]] are released. | |||
*[[OnFurnitureEvent - ScriptObject|OnFurnitureEvent]](Actor akActor, ObjectReference akFurniture, bool isGettingUp) | |||
**Received when a furniture event is registered via [[RegisterForFurnitureEvent - ScriptObject|RegisterForFurnitureEvent]]. | |||
*[[OnKeyDown - ScriptObject|OnKeyDown]](int keyCode) | *[[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. | ||
| Line 222: | Line 231: | ||
*[[OnKeyUp - ScriptObject|OnKeyUp]](int keyCode, float holdTime) | *[[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. | ||
*[[OnPlayerCameraState - ScriptObject|OnPlayerCameraState]](int oldState, int newState) | *[[OnPlayerCameraState - ScriptObject|OnPlayerCameraState]](int oldState, int newState) | ||
**Received when a camera state is changed while registered via [[RegisterForCameraState - ScriptObject|RegisterForCameraState]]. | **Received when a camera state is changed while registered via [[RegisterForCameraState - ScriptObject|RegisterForCameraState]]. | ||