kts.FlashMessage

Name

kts.FlashMessage – flash a message on-screen for the current actor

Synopsis

kts.FlashMessage(message)

kts.FlashMessage(message, number_of_times)

Description

If the current actor (as given by cxt.actor) is a knight, then the given message is flashed on-screen above the knight (for that player only). By default the message flashes 4 times, but this can be overridden by setting the number_of_times parameter.

Return Value

None.

Examples

This will show the message "Locked" twice:

kts.FlashMessage("Locked", 2)

This example comes from the standard Knights files, in the scenario where a knight is trying to open a locked door or chest tile. See tiles.lua.

See Also

The cxt table

kts.FlashScreen