WaitMenuMode - Utility

Member of: Utility Script

Pauses the script for at least the specified amount of time. This function is latent. Time will be counted while the player is in a menu.

Syntax

Function WaitMenuMode(float afSeconds) native global

Parameters

• afSeconds: How long to wait, in real-time seconds.

Return Value

None

Examples

; Pause our currently running stack for 5 seconds - and count the time spent in a menu
Utility.WaitMenuMode(5.0)

Notes

• The name of this utility script may be misleading: it provides a method for waiting *during* menu mode. To wait for the beginning or end of menu mode, see IsInMenuMode or Wait respectively.
• Wait time isn't precise, based on framerate and general Papyrus system workload.
• A wait time of 0 won't actually wait, and will just return immediately.

See Also

• Utility Script
• Wait - Utility