Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

This function allows the window to flash in the Windows taskbar.

Syntax

bool setWindowFlashing ( bool shouldFlash, [ int count = 10 ] )

Required Arguments

• shouldFlash: whether the window should flash

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• count (default: 10): the number of times the window should flash, defaults to 10 times

Returns

• bool: value

Returns false if:

Code Examples

Example 1 Example 2

shared

A command that allows the player to flash their window three times after one second.

addCommandHandler("flash",
  function()
    setTimer(setWindowFlashing, 1000, 1, true, 3)
  end
)

shared

A command that allows the player to flash their window after a certain period of time for a certain count.

addCommandHandler("flash",
  function(_, wait, count)
    wait = tonumber(wait) -- makes "wait" a number, this will be false if it can't be converted
    shouldFlash = type(wait) == "number" -- if wait is given, we should flash, otherwise we shouldn't
    wait = wait or 5-- make wait default to 1 second if it isn't a number
    count = tonumber(count) or 5 -- makes "count" a number, 5 if it can't be converted

    setTimer(setWindowFlashing, wait*1000, 1, shouldFlash, count)
  end
)

See Also

Utility Functions

• addDebugHook
• bitAnd
• bitArShift
• bitExtract
• bitLRotate
• bitLShift
• bitNot
• bitOr
• bitReplace
• bitRRotate
• bitRShift
• bitTest
• bitXor
• createTrayNotification
• debugSleep
• decodeString
• deref
• downloadFile
• encodeString
• fromJSON
• generateKeyPair
• getColorFromString
• getDevelopmentMode
• getDistanceBetweenPoints2D
• getDistanceBetweenPoints3D
• getEasingValue
• getFPSLimit
• getKeyboardLayout
• getLocalization
• getNetworkStats
• getNetworkUsageData
• getPerformanceStats
• getProcessMemoryStats
• getRealTime
• getServerIp
• getTickCount
• getTimerDetails
• getTimers
• gettok
• getUserdataType
• getVersion
• hash
• inspect
• interpolateBetween
• iprint
• isOOPEnabled
• isShowCollisionsEnabled
• isShowSoundEnabled
• isTimer
• isTimerPaused
• isTransferBoxAlwaysVisible
• isTransferBoxVisible
• isTrayNotificationEnabled
• killTimer
• md5
• passwordHash
• passwordVerify
• pregFind
• pregMatch
• pregReplace
• ref
• removeDebugHook
• resetTimer
• setClipboard
• setDevelopmentMode
• setFPSLimit
• setTimer
• setTimerPaused
• setTransferBoxVisible
• setWindowFlashing
• sha256
• showCol
• showSound
• split
• teaDecode
• teaEncode
• tocolor
• toJSON
• utfChar
• utfCode
• utfLen
• utfSeek
• utfSub

Reference

• Scripting Functions