kts.DispelMagic

Name

kts.DispelMagic – trigger Dispel Magic effect

Synopsis

kts.DispelMagic(message)

Description

This function instantly removes most magical effects from all knights currently in the dungeon.

Specifically, the following effects are all cancelled:

The message is also displayed for the current actor (cxt.actor), if any, as if kts.FlashMessage(message) had been called. Note that the message must be a localized message (either a string key, or a table with parameters, as described in Localization).

Return Value

None.

Notes

Note that magic is dispelled for all knights, not just the current actor!

Examples

In the standard Knights data files, this is one of the possible scroll effects: see magic.lua.

See Also

The cxt table

kts.FlashMessage

kts.Invisibility

kts.Invulnerability

kts.Paralyzation

kts.PoisonImmunity

kts.Quickness

kts.Regeneration

kts.RevealLocation

kts.SenseKnight

kts.Strength

kts.Super