diff --git a/data/core/macros/special-notes.cfg b/data/core/macros/special-notes.cfg index c6d993c0e7e..397879e373b 100644 --- a/data/core/macros/special-notes.cfg +++ b/data/core/macros/special-notes.cfg @@ -6,175 +6,142 @@ "+_"Special Notes:"#enddef # SPECIAL_NOTES_* are the deprecated versions that provide the strings. +# INTERNAL:SPECIAL_NOTES_* contain the strings shared by deprecated and non-deprecated macros. Do not use them directly. # NOTE_* are the new versions that provide an entire tag. # For now, the new are defined in terms of the old, but when adding new special notes, # only a NOTE_* form should be added. -#define SPECIAL_NOTES_SPIRIT -#deprecated 1 Use {NOTE_SPIRIT} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_SPIRIT _"Spirits have very unusual resistances to damage, and move quite slowly over open water."#enddef -#define SPECIAL_NOTES_ARCANE -#deprecated 1 Use {NOTE_ARCANE} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_ARCANE _"This unit’s arcane attack deals tremendous damage to magical creatures, and even some to mundane creatures."#enddef -#define SPECIAL_NOTES_HEALS -#deprecated 1 Use {NOTE_HEALS} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_HEALS _"This unit is capable of basic healing."#enddef -#define SPECIAL_NOTES_EXTRA_HEAL -#deprecated 1 Use {NOTE_EXTRA_HEAL} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_EXTRA_HEAL _"This unit is capable of rapid healing."#enddef -#define SPECIAL_NOTES_CURES -#deprecated 1 Use {NOTE_CURES} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_CURES _"This unit is capable of healing those around it, and curing them of poison."#enddef -#define SPECIAL_NOTES_UNPOISON -#deprecated 1 Use {NOTE_UNPOISON} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_UNPOISON _"This unit is capable of neutralizing the effects of poison in units around it."#enddef -#define SPECIAL_NOTES_REGENERATES -#deprecated 1 Use {NOTE_REGENERATES} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_REGENERATES _"This unit regenerates, which allows it to heal as though always stationed in a village."#enddef -#define SPECIAL_NOTES_STEADFAST -#deprecated 1 Use {NOTE_STEADFAST} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_STEADFAST _"The steadiness of this unit reduces damage from some attacks, but only while defending."#enddef -#define SPECIAL_NOTES_LEADERSHIP -#deprecated 1 Use {NOTE_LEADERSHIP} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_LEADERSHIP _"The leadership of this unit enables adjacent units of the same side to deal more damage in combat, though this only applies to units of lower level."#enddef -#define SPECIAL_NOTES_SKIRMISHER -#deprecated 1 Use {NOTE_SKIRMISHER} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_SKIRMISHER _"This unit’s skill at skirmishing allows it to ignore enemies’ zones of control and thus move unhindered around them."#enddef -#define SPECIAL_NOTES_ILLUMINATES -#deprecated 1 Use {NOTE_ILLUMINATES} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_ILLUMINATES _"Illumination increases the lighting level in adjacent areas."#enddef -#define SPECIAL_NOTES_TELEPORT -#deprecated 1 Use {NOTE_TELEPORT} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_TELEPORT _"This unit can use one move to teleport between any two empty villages controlled by its side."#enddef -#define SPECIAL_NOTES_AMBUSH -#deprecated 1 Use {NOTE_AMBUSH} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_AMBUSH _"In woodlands, this unit’s ambush skill renders it invisible to enemies unless it is immediately adjacent or has revealed itself by attacking."#enddef -#define SPECIAL_NOTES_NIGHTSTALK -#deprecated 1 Use {NOTE_NIGHTSTALK} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_NIGHTSTALK _"This unit is able to hide at night, leaving no trace of its presence."#enddef -#define SPECIAL_NOTES_CONCEALMENT -#deprecated 1 Use {NOTE_CONCEALMENT} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_CONCEALMENT _"This unit can hide in villages (with the exception of water villages), and remain undetected by its enemies, except by those standing next to it."#enddef -#define SPECIAL_NOTES_SUBMERGE -#deprecated 1 Use {NOTE_SUBMERGE} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_SUBMERGE _"This unit can move unseen in deep water, requiring no air from the surface."#enddef -#define SPECIAL_NOTES_FEEDING -#deprecated 1 Use {NOTE_FEEDING} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_FEEDING _"This unit gains 1 hitpoint added to its maximum whenever it kills a living unit."#enddef -#define SPECIAL_NOTES_BERSERK -#deprecated 1 Use {NOTE_BERSERK} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_BERSERK _"Whenever its berserk attack is used, this unit continues to push the attack until either it or its enemy lies dead."#enddef -#define SPECIAL_NOTES_BACKSTAB -#deprecated 1 Use {NOTE_BACKSTAB} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_BACKSTAB _"If there is an enemy of the target on the opposite side of the target while attacking it, this unit may backstab, inflicting double damage by creeping around behind that enemy."#enddef -#define SPECIAL_NOTES_PLAGUE -#deprecated 1 Use {NOTE_PLAGUE} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_PLAGUE _"Foes who lose their life to the plague will rise again in unlife, unless they are standing on a village."#enddef -#define SPECIAL_NOTES_SLOW -#deprecated 1 Use {NOTE_SLOW} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_SLOW _"This unit is able to slow its enemies, halving their movement speed and attack damage until they end a turn."#enddef -#define SPECIAL_NOTES_PETRIFY -#deprecated 1 Use {NOTE_PETRIFY} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_PETRIFY _"The ability to turn the living to stone makes this unit extremely dangerous."#enddef -#define SPECIAL_NOTES_STONE -#deprecated 1 Use {NOTE_PETRIFY} instead (note the singular), which generates a [special_note] tag. -{SPECIAL_NOTES_PETRIFY}#enddef - -#define SPECIAL_NOTES_MARKSMAN -#deprecated 1 Use {NOTE_MARKSMAN} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_MARKSMAN _"This unit’s marksmanship gives it a high chance of hitting targeted enemies, but only on the attack."#enddef -#define SPECIAL_NOTES_MAGICAL -#deprecated 1 Use {NOTE_MAGICAL} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_MAGICAL _"This unit has magical attacks, which always have a high chance of hitting an opponent."#enddef -#define SPECIAL_NOTES_SWARM -#deprecated 1 Use {NOTE_SWARM} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_SWARM _"The swarming attacks of this unit become less deadly whenever its members are wounded."#enddef -#define SPECIAL_NOTES_CHARGE -#deprecated 1 Use {NOTE_CHARGE} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_CHARGE _"Using a charging attack doubles both damage dealt and received; this does not affect defensive retaliation."#enddef -#define SPECIAL_NOTES_DRAIN -#deprecated 1 Use {NOTE_DRAIN} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_DRAIN _"During battle, this unit can drain life from victims to renew its own health."#enddef -#define SPECIAL_NOTES_FIRSTSTRIKE -#deprecated 1 Use {NOTE_FIRSTRIKE} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_FIRSTSTRIKE _"The length of this unit’s weapon allows it to strike first in melee, even in defense."#enddef -#define SPECIAL_NOTES_POISON -#deprecated 1 Use {NOTE_POISON} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_POISON _"The victims of this unit’s poison will continually take damage until they can be cured in town or by a unit which cures."#enddef -#define SPECIAL_NOTES_DEFENSE_CAP -#deprecated 1 Use {NOTE_DEFENSE_CAP} instead (note the singular), which generates a [special_note] tag. +#define INTERNAL:SPECIAL_NOTES_DEFENSE_CAP _"This unit has a defense cap on certain terrain types — it cannot achieve a higher defense rating on mixed terrains with such terrain types."#enddef # New versions start here! #define NOTE_SPIRIT [special_note] - note={SPECIAL_NOTES_SPIRIT} + note={INTERNAL:SPECIAL_NOTES_SPIRIT} [/special_note] #enddef #define NOTE_ARCANE [special_note] - note={SPECIAL_NOTES_ARCANE} + note={INTERNAL:SPECIAL_NOTES_ARCANE} [/special_note] #enddef #define NOTE_HEALS [special_note] - note={SPECIAL_NOTES_HEALS} + note={INTERNAL:SPECIAL_NOTES_HEALS} [/special_note] #enddef #define NOTE_EXTRA_HEAL [special_note] - note={SPECIAL_NOTES_EXTRA_HEAL} + note={INTERNAL:SPECIAL_NOTES_EXTRA_HEAL} [/special_note] #enddef #define NOTE_CURES [special_note] - note={SPECIAL_NOTES_CURES} + note={INTERNAL:SPECIAL_NOTES_CURES} [/special_note] #enddef #define NOTE_UNPOISON [special_note] - note={SPECIAL_NOTES_UNPOISON} + note={INTERNAL:SPECIAL_NOTES_UNPOISON} [/special_note] #enddef #define NOTE_REGENERATES [special_note] - note={SPECIAL_NOTES_REGENERATES} + note={INTERNAL:SPECIAL_NOTES_REGENERATES} [/special_note] #enddef @@ -186,138 +153,264 @@ _"This unit has a defense cap on certain terrain types — it cannot achieve a h #define NOTE_STEADFAST [special_note] - note={SPECIAL_NOTES_STEADFAST} + note={INTERNAL:SPECIAL_NOTES_STEADFAST} [/special_note] #enddef #define NOTE_LEADERSHIP [special_note] - note={SPECIAL_NOTES_LEADERSHIP} + note={INTERNAL:SPECIAL_NOTES_LEADERSHIP} [/special_note] #enddef #define NOTE_SKIRMISHER [special_note] - note={SPECIAL_NOTES_SKIRMISHER} + note={INTERNAL:SPECIAL_NOTES_SKIRMISHER} [/special_note] #enddef #define NOTE_ILLUMINATES [special_note] - note={SPECIAL_NOTES_ILLUMINATES} + note={INTERNAL:SPECIAL_NOTES_ILLUMINATES} [/special_note] #enddef #define NOTE_TELEPORT [special_note] - note={SPECIAL_NOTES_TELEPORT} + note={INTERNAL:SPECIAL_NOTES_TELEPORT} [/special_note] #enddef #define NOTE_AMBUSH [special_note] - note={SPECIAL_NOTES_AMBUSH} + note={INTERNAL:SPECIAL_NOTES_AMBUSH} [/special_note] #enddef #define NOTE_NIGHTSTALK [special_note] - note={SPECIAL_NOTES_NIGHTSTALK} + note={INTERNAL:SPECIAL_NOTES_NIGHTSTALK} [/special_note] #enddef #define NOTE_CONCEALMENT [special_note] - note={SPECIAL_NOTES_CONCEALMENT} + note={INTERNAL:SPECIAL_NOTES_CONCEALMENT} [/special_note] #enddef #define NOTE_SUBMERGE [special_note] - note={SPECIAL_NOTES_SUBMERGE} + note={INTERNAL:SPECIAL_NOTES_SUBMERGE} [/special_note] #enddef #define NOTE_FEEDING [special_note] - note={SPECIAL_NOTES_FEEDING} + note={INTERNAL:SPECIAL_NOTES_FEEDING} [/special_note] #enddef #define NOTE_BERSERK [special_note] - note={SPECIAL_NOTES_BERSERK} + note={INTERNAL:SPECIAL_NOTES_BERSERK} [/special_note] #enddef #define NOTE_BACKSTAB [special_note] - note={SPECIAL_NOTES_BACKSTAB} + note={INTERNAL:SPECIAL_NOTES_BACKSTAB} [/special_note] #enddef #define NOTE_PLAGUE [special_note] - note={SPECIAL_NOTES_PLAGUE} + note={INTERNAL:SPECIAL_NOTES_PLAGUE} [/special_note] #enddef #define NOTE_SLOW [special_note] - note={SPECIAL_NOTES_SLOW} + note={INTERNAL:SPECIAL_NOTES_SLOW} [/special_note] #enddef #define NOTE_PETRIFY [special_note] - note={SPECIAL_NOTES_PETRIFY} + note={INTERNAL:SPECIAL_NOTES_PETRIFY} [/special_note] #enddef #define NOTE_MARKSMAN [special_note] - note={SPECIAL_NOTES_MARKSMAN} + note={INTERNAL:SPECIAL_NOTES_MARKSMAN} [/special_note] #enddef #define NOTE_MAGICAL [special_note] - note={SPECIAL_NOTES_MAGICAL} + note={INTERNAL:SPECIAL_NOTES_MAGICAL} [/special_note] #enddef #define NOTE_SWARM [special_note] - note={SPECIAL_NOTES_SWARM} + note={INTERNAL:SPECIAL_NOTES_SWARM} [/special_note] #enddef #define NOTE_CHARGE [special_note] - note={SPECIAL_NOTES_CHARGE} + note={INTERNAL:SPECIAL_NOTES_CHARGE} [/special_note] #enddef #define NOTE_DRAIN [special_note] - note={SPECIAL_NOTES_DRAIN} + note={INTERNAL:SPECIAL_NOTES_DRAIN} [/special_note] #enddef #define NOTE_FIRSTSTRIKE [special_note] - note={SPECIAL_NOTES_FIRSTSTRIKE} + note={INTERNAL:SPECIAL_NOTES_FIRSTSTRIKE} [/special_note] #enddef #define NOTE_POISON [special_note] - note={SPECIAL_NOTES_POISON} + note={INTERNAL:SPECIAL_NOTES_POISON} [/special_note] #enddef #define NOTE_DEFENSE_CAP [special_note] - note={SPECIAL_NOTES_DEFENSE_CAP} + note={INTERNAL:SPECIAL_NOTES_DEFENSE_CAP} [/special_note] #enddef + +# Deprecated versions here + +#define SPECIAL_NOTES_SPIRIT +#deprecated 1 Use {NOTE_SPIRIT} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_SPIRIT}#enddef + +#define SPECIAL_NOTES_ARCANE +#deprecated 1 Use {NOTE_ARCANE} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_ARCANE}#enddef + +#define SPECIAL_NOTES_HEALS +#deprecated 1 Use {NOTE_HEALS} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_HEALS}#enddef + +#define SPECIAL_NOTES_EXTRA_HEAL +#deprecated 1 Use {NOTE_EXTRA_HEAL} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_EXTRA_HEAL}#enddef + +#define SPECIAL_NOTES_CURES +#deprecated 1 Use {NOTE_CURES} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_CURES}#enddef + +#define SPECIAL_NOTES_UNPOISON +#deprecated 1 Use {NOTE_UNPOISON} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_UNPOISON}#enddef + +#define SPECIAL_NOTES_REGENERATES +#deprecated 1 Use {NOTE_REGENERATES} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_REGENERATES}#enddef + +#define SPECIAL_NOTES_STEADFAST +#deprecated 1 Use {NOTE_STEADFAST} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_STEADFAST}#enddef + +#define SPECIAL_NOTES_LEADERSHIP +#deprecated 1 Use {NOTE_LEADERSHIP} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_LEADERSHIP}#enddef + +#define SPECIAL_NOTES_SKIRMISHER +#deprecated 1 Use {NOTE_SKIRMISHER} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_SKIRMISHER}#enddef + +#define SPECIAL_NOTES_ILLUMINATES +#deprecated 1 Use {NOTE_ILLUMINATES} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_ILLUMINATES}#enddef + +#define SPECIAL_NOTES_TELEPORT +#deprecated 1 Use {NOTE_TELEPORT} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_TELEPORT}#enddef + +#define SPECIAL_NOTES_AMBUSH +#deprecated 1 Use {NOTE_AMBUSH} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_AMBUSH}#enddef + +#define SPECIAL_NOTES_NIGHTSTALK +#deprecated 1 Use {NOTE_NIGHTSTALK} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_NIGHTSTALK}#enddef + +#define SPECIAL_NOTES_CONCEALMENT +#deprecated 1 Use {NOTE_CONCEALMENT} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_CONCEALMENT}#enddef + +#define SPECIAL_NOTES_SUBMERGE +#deprecated 1 Use {NOTE_SUBMERGE} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_SUBMERGE}#enddef + +#define SPECIAL_NOTES_FEEDING +#deprecated 1 Use {NOTE_FEEDING} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_FEEDING}#enddef + +#define SPECIAL_NOTES_BERSERK +#deprecated 1 Use {NOTE_BERSERK} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_BERSERK}#enddef + +#define SPECIAL_NOTES_BACKSTAB +#deprecated 1 Use {NOTE_BACKSTAB} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_BACKSTAB}#enddef + +#define SPECIAL_NOTES_PLAGUE +#deprecated 1 Use {NOTE_PLAGUE} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_PLAGUE}#enddef + +#define SPECIAL_NOTES_SLOW +#deprecated 1 Use {NOTE_SLOW} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_SLOW}#enddef + +#define SPECIAL_NOTES_PETRIFY +#deprecated 1 Use {NOTE_PETRIFY} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_PETRIFY}#enddef + +#define SPECIAL_NOTES_STONE +#deprecated 1 Use {NOTE_PETRIFY} instead (note the singular), which generates a [special_note] tag. +{SPECIAL_NOTES_PETRIFY}#enddef + +#define SPECIAL_NOTES_MARKSMAN +#deprecated 1 Use {NOTE_MARKSMAN} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_MARKSMAN}#enddef + +#define SPECIAL_NOTES_MAGICAL +#deprecated 1 Use {NOTE_MAGICAL} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_MAGICAL}#enddef + +#define SPECIAL_NOTES_SWARM +#deprecated 1 Use {NOTE_SWARM} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_SWARM}#enddef + +#define SPECIAL_NOTES_CHARGE +#deprecated 1 Use {NOTE_CHARGE} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_CHARGE}#enddef + +#define SPECIAL_NOTES_DRAIN +#deprecated 1 Use {NOTE_DRAIN} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_DRAIN}#enddef + +#define SPECIAL_NOTES_FIRSTSTRIKE +#deprecated 1 Use {NOTE_FIRSTRIKE} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_FIRSTSTRIKE}#enddef + +#define SPECIAL_NOTES_POISON +#deprecated 1 Use {NOTE_POISON} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_POISON}#enddef + +#define SPECIAL_NOTES_DEFENSE_CAP +#deprecated 1 Use {NOTE_DEFENSE_CAP} instead (note the singular), which generates a [special_note] tag. +{INTERNAL:SPECIAL_NOTES_DEFENSE_CAP}#enddef