eventOnPlayerWaitStart(floatafWaitStartTime, floatafDesiredWaitEndTime)
Description
Wiki Description
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.
Documentation Comment
Received when the player waits. Start and desired end time are in game time days (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
floatafWaitStartTime
CK Wiki Description
The time the player started sleeping, in game days passed.
floatafDesiredWaitEndTime
CK Wiki Description
The time the player wants to stop waiting at, in game days passed.
Examples
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))
endEventAuto-Generated Example
Scriptname MyCoolScript extends ScriptObject
event OnPlayerWaitStart(float afWaitStartTime, float afDesiredWaitEndTime)
Debug.trace("Event received - OnPlayerWaitStart: afWaitStartTime = " + afWaitStartTime + " afDesiredWaitEndTime = " + afDesiredWaitEndTime)
endEvent