kts.FlashScreen

Name

kts.FlashScreen – cause the screen to flash

Synopsis

kts.FlashScreen()

kts.FlashScreen(delay)

Description

If the current actor (determined by cxt.actor) is a knight, then the screen will briefly flash for all players who are currently able to see that knight.

If delay is specified, then the screen flash will happen delay milliseconds from now; otherwise it will happen immediately.

If the current actor is not a knight, then nothing happens.

Return Value

None.

Notes

This is used for things like wands (which flash the screen when used) or pentagrams (which flash the screen when walked over).

Bugs

The rule that kts.FlashScreen does nothing when the actor is not a knight was originally designed to prevent screen flashes from being accidentally triggered by monsters. E.g. if a zombie triggered a screen flash every time it walked over a pentagram, then that would be quite distracting. However, if the Lua code actually wants to trigger a screen flash from something that a monster does, then currently there is no way to do that.

See Also

The cxt table

kts.FlashMessage