OnPlayerWaitStart - ScriptObject

From Creation Kit
Jump to: navigation, search

Member of: ScriptObject

Event called when the player starts 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 OnPlayerWaitStart(float afWaitStartTime, float afDesiredWaitEndTime)

Parameters

  • afWaitStartTime: The time the player started sleeping, in game days passed.
  • afDesiredWaitEndTime: The time the player wants to stop waiting at, in game days passed.

Example

Function SomeFunction()
  RegisterForPlayerWait() ; Before we can use OnPlayerWaitStart we must register.
EndFunction
 
Event OnPlayerWaitStart(float afWaitStartTime, float afDesiredWaitEndTime)
  Debug.Trace("Player started waiting at: " + Utility.GameTimeToString(afWaitStartTime))
  Debug.Trace("Player wants to stop waiting at: " + Utility.GameTimeToString(afDesiredWaitEndTime))
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