Difference between revisions of "ScriptObject Script"
m
category
imported>Plplecuyer (→Events) |
imported>Qazaaq m (category) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
'''Extends:''' None | '''Extends:''' None | ||
| Line 137: | Line 133: | ||
*Function [[UnregisterForTutorialEvent - ScriptObject|UnregisterForTutorialEvent]](string asEventName) | *Function [[UnregisterForTutorialEvent - ScriptObject|UnregisterForTutorialEvent]](string asEventName) | ||
**Unregisters this script from tutorial events. | **Unregisters this script from tutorial events. | ||
== F4SE Member Functions == | |||
*[[RegisterForCameraState - ScriptObject|RegisterForCameraState]]() | |||
**Registers for a camera state change. | |||
*[[RegisterForControl - ScriptObject|RegisterForControl]](string control) | |||
**Registers the given control for OnControlDown and OnControlUp events. | |||
*[[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. | |||
*[[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 185: | Line 212: | ||
*Event [[OnTutorialEvent - ScriptObject|OnTutorialEvent]](String asEventName, Message aMessage) | *Event [[OnTutorialEvent - ScriptObject|OnTutorialEvent]](String asEventName, Message aMessage) | ||
**Event called whenever a tutorial-related event occurs | **Event called whenever a tutorial-related event occurs | ||
== 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) | |||
**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]] | |||