OnPlayerWaitStop - ScriptObject

From Creation Kit
Jump to: navigation, search

Member of: ScriptObject

Event called when the player stops waiting - if this active magic effect/alias/form is registered for it.

This event will only be sent to the specific script that registered for it. Other scripts attached to the same form/alias/active magic effect will not receive the event unless they also register.

Syntax

Event OnPlayerWaitStop(bool abInterrupted)

Parameters

  • abInterrupted: Whether wait was interrupted or not.

Example

Function SomeFunction()
  RegisterForPlayerWait() ; Before we can use OnPlayerWait we must register.
EndFunction
 
Event OnPlayerWaitStop(bool abInterrupted)
  if abInterrupted
    Debug.Trace("Player was interrupted by something!")
  else
    Debug.Trace("Player stopped waiting")
  endIf
endEvent

Notes

  • Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.

See Also