kts.RevealLocation

Name

kts.RevealLocation – reveal the current actor's location to other players for a limited time

Synopsis

kts.RevealLocation(duration)

Description

If the current actor (cxt.actor) is a knight, their location will become visible on the mini-map of all players, for the next duration milliseconds.

If the current actor already has a timed "reveal location" effect in place, then the timer is restarted (from the current time) with the new duration.

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

Return Value

None.

Notes

This function works completely independently of kts.RevealStart and kts.RevealStop.

Players are not told that their location is now being broadcast to other knights. This makes for more interesting gameplay because players might think they are walking around the dungeon in secret, but actually everyone else is able to see where they are!

Examples

When using the standard Knights data files, there is a one in six chance that reading a scroll will call kts.RevealLocation; see magic.lua.

See Also

The cxt table

kts.DispelMagic

kts.SenseKnight

kts.RevealStart

kts.RevealStop