Background for Fallout 4
Member of the ScriptObject script
eventOnPlayerWaitStop(boolabInterrupted)

Description

Wiki Description

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.

Documentation Comment

Received when the player stops waiting - whether naturally or interrupted (after registering)


Caveats

CK Wiki - Notes

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

Parameters

  1. boolabInterrupted

    CK Wiki Description

    Whether wait was interrupted or not.


Examples

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

Auto-Generated Example

Scriptname MyCoolScript extends ScriptObject

event OnPlayerWaitStop(bool abInterrupted)
    Debug.trace("Event received - OnPlayerWaitStop: abInterrupted = " + abInterrupted)
endEvent

Related Pages


Additional References

View this event’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.