kts.RevealStop

Name

kts.RevealStop – stop revealing the actor's location to all players

Synopsis

kts.RevealStop()

Description

If the current actor (cxt.actor) is a knight, the effect of a previous kts.RevealStart call is cancelled, and the knight's location is no longer revealed to other players (unless there is some other reason why it should still be revealed, e.g. a previous call to kts.RevealLocation is still in effect).

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

Return Value

None.

Notes

This function works completely independently of kts.RevealLocation.

Multiple calls to kts.RevealStart "stack", i.e. if kts.RevealStart() is called multiple times, then kts.RevealStop() must be called the same number of times to cancel the effect.

Examples

This is used as part of the Ancient Book of Knowledge effect: see items.lua.

See Also

The cxt table

kts.RevealLocation

kts.RevealStart