Editing Interaction token

The following [[token]]s can be used to define and use interactions. (''It appears that, at least in order to make the big list make a little more sense, [[Necromancer#Modding|some]]  [[Interaction_examples|examples]] of those may be necessary.'')

 

| {{text anchor|EXPERIMENT_ONLY}}

| Disallows use of the interaction in play, but if the interaction animates or resurrects corpses, or has an I_SOURCE:EXPERIMENT tag, it can be used in worldgen. Animation and resurrection interactions do not need I_SOURCE:EXPERIMENT to work in worldgen.

* '''CREATURE_ACTION''' - Specifies that the interaction may be used in conjunction with [[Creature_token#CAN_DO_INTERACTION|[CAN_DO_INTERACTION]]] and [[Syndrome#CE_CAN_DO_INTERACTION|[CE_CAN_DO_INTERACTION]]], but it isn't actually necessary for this. It might exist simply to allow for the inclusion of IS_ tokens (detailed below) to be applied when the interaction is used in this context.

* '''ATTACK''' - Allows the interaction to be used in conjunction with [[Creature_token#SPECIALATTACK_INTERACTION|[SPECIALATTACK_INTERACTION]]] and [[Syndrome#CE_SPECIAL_ATTACK_INTERACTION|[CE_SPECIAL_ATTACK_INTERACTION]]].

* '''INGESTION''' - Allows the interaction to be used in conjunction with [[Syndrome#CE_BODY_MAT_INTERACTION|[CE_BODY_MAT_INTERACTION]]].

* '''SECRET''' - Allows the interaction to act as a secret which can be learnt and passed on to others, as specified via [[Interaction_token#IS_SECRET|[IS_SECRET]]]. Appropriate [[Interaction_token#I_EFFECT|interaction effects]] with a [[Interaction_token#IE_TARGET|creature target]] will be applied to individuals who learn the secret. It is possible to set restrictions on who may learn the secret by using creature target tokens as described below. Also see [[Interaction_token#IS_SECRET_GOAL|[IS_SECRET_GOAL]]] and [[Interaction_token#IS_SPHERE|[IS_SPHERE]]].

* '''REGION''' - Allows the interaction to take place spontaneously in regions specified using [[Interaction_token#IS_REGION|[IS_REGION]]]. Also see [[Interaction_token#IS_FREQUENCY|[IS_FREQUENCY]]] and [[Interaction_token#IE_INTERMITTENT|[IE_INTERMITTENT]]].

* '''UNDERGROUND_SPECIAL''' - Allows the interaction to take place spontaneously in [[Demonic fortress|curious underground structures]] (which no longer generate); generated interactions with this token used to be used to produce [[undead|zombies]] when creating the structure's inhabitants.

* '''EXPERIMENT''' - This can be used by NIGHT_CREATURE_EXPERIMENTERs while "performing horrible experiments" in worldgen. Only seems relevant for interactions that target living creatures. Note that all NIGHT_CREATURE_EXPERIMENTERs have access to generated experiments, and due to the large number of generated experiments available custom experiment interactions will tend to show up very rarely.

| {{text anchor|IS_TRIGGER_STRING}}

| {{text anchor|IS_TRIGGER_STRING_SECOND}}

[IS_TRIGGER_STRING_SECOND: have]

| {{text anchor|IS_TRIGGER_STRING_THIRD}}

| [[Sphere#Available_spheres|sphere]]

| Indicates the [[sphere]] to which this secret pertains. Only one sphere can be defined for each [I_SOURCE:SECRET] token, so several [I_SOURCE:SECRET] tokens are required to make a secret belong to multiple spheres.

However, currently only IMMORTALITY will result in a secret being pursued during worldgen.

* '''MUNDANE_RESEARCH_POSSIBLE''' - the secret can be researched by mundane means. This doesn't do anything at present. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8243222#msg8243222].

* '''MUNDANE_RECORDING_POSSIBLE:TITLE_SET:NAME_SET''' - the secret can be written in books whose title and name are taken from the specified text sets. If this tag is present, a slab will be created upon learning the secret by supernatural means.

| Indicates why a deity would choose to perform this interaction. See [[Interaction_token#USAGE_HINT|CDI:USAGE_HINT]] below for valid values - in this context, '''MINOR_BLESSING''', '''MEDIUM_BLESSING''', '''MINOR_CURSE''', '''MEDIUM_CURSE''', and '''MAJOR_CURSE''' are the only values that make sense.

| Indicates what types of regions are capable of performing this interaction. This token may be specified several times per I_SOURCE to permit multiple terrain/alignment types. Valid values:

 

* '''ANY''' permits the interaction to occur in all regions, regardless of terrain or alignment

 

 

* '''TUNDRA'''

* '''ANY_TERRAIN''' permits the interaction to occur in all regions which meet alignment specifications

 

 

 

|-

| When used with [[Interaction_token#I_SOURCE|[I_SOURCE:REGION]]], determines how likely it is for the region(s) specified via [[Interaction_token#IS_REGION|[IS_REGION]]] to possess this interaction.

 

Note: it appears that regions aren't allowed to possess more than a single regional interaction at present.

* '''RANDOM_NEARBY_LOCATION''' - Used with LOCATION. Targets a location from somewhere random within a number of squares from another LOCATION target specified by its target ID. For example, [I_TARGET:B:LOCATION] with [IT_LOCATION:RANDOM_NEARBY_LOCATION:A:5] will randomly select a tile lying somewhere within a radius of 5 tiles from [I_TARGET:A:LOCATION]. A walkable path between the two locations must exist.

 

* '''ADD_SYNDROME''' - Adds one or more syndromes to a valid creature target.  You must specify the syndrome details just below this interaction effect using the <code>[[Syndrome#SYNDROME|[SYNDROME]]]</code> tag followed by the relevant syndrome tokens. See [[syndrome#The anatomy of a syndrome|here]] for more information.

 

 

* '''CLEAN''' - Removes [[Contaminant|contaminants]] from a valid creature target. See {{token|IE_GRIME_LEVEL|in}}  and {{token|IE_SYNDROME_TAG|in}}.

 

 

* '''HIDE''' - Allows the creature to [[Ambusher|hide]] even if another creature can see it.

 

* '''CREATE_ITEM''' - Creates an item as described by {{token|IE_ITEM|in}} and {{token|IE_ITEM_QUALITY|in}}.

 

* '''CHANGE_ITEM_QUALITY''' - Alters an item's quality level as indicated by either {{token|IE_CHANGE_QUALITY|in}} or {{token|IE_SET_QUALITY|in}}. When targeting a unit, all items equipped by that unit will be affected.

 

* '''SUMMON_UNIT''' - Creates a new unit at the target. The type of unit can either be specified using the {{token|CREATURE|in}} token, or made to be randomly selected as indicated by a variety of flag-based tokens: {{token|IE_CREATURE_FLAG|in}}, {{token|IE_FORBIDDEN_CREATURE_FLAG|in}}, {{token|IE_CREATURE_CASTE_FLAG|in}}, {{token|IE_FORBIDDEN_CREATURE_CASTE_FLAG|in}}, {{token|IE_HAVE_FAST_EFFORTLESS_GAIT_SPEED|in}} and/or {{token|IE_ALL_SLOW_EFFORTLESS_GAIT_SPEED|in}}. See also {{token|IE_TIME_RANGE|in}} and {{token|IE_MAKE_PET_IF_POSSIBLE|in}}.

 

* '''PROPEL_UNIT''' - Applies a force specified using {{token|IE_PROPEL_FORCE|in}} to a unit to knock it back.

 

* '''CHANGE_WEATHER''' - Changes the weather as specified by {{token|IE_ADD_WEATHER|in}} and/or {{token|IE_REMOVE_WEATHER|in}}.

 

* '''RAISE_GHOST''' - Present in version 0.47.01 and accepted as a valid I_EFFECT token, but does not have an effect currently.

 

| Allows the interaction effect to be applied directly to newly spawned creatures in [[object testing arena|arena mode]]. The specified name is used to represent it within the creature creation [[Object_testing_arena#Effects|effects list]].

| Only appears to work with [I_SOURCE:REGION] interactions. Indicates that the effect happens intermittently and specifies roughly how often. Regional interactions aren't able to use effects which lack this token. Valid values:

 

Note: DAILY, MONTHLY and YEARLY also exist in the string dump but don't appear to work at present.

 

| Prevents the interaction effect from manifesting unless the target is in a location which meets the specified criteria.  

Valid values:

A [[Water#Depth|depth]] of 1/7 is sufficient for IN_WATER and IN_MAGMA.

Note: NO_THICK_FOG and OUTSIDE are accepted as valid location hints when specified with IE_LOCATION, but don't appear to work. It's possible that they're currently only implemented for use with <code>[[Interaction_token#LOCATION_HINT|[CDI:LOCATION_HINT]]]</code>.

| {{text anchor|IE_ADD_WEATHER}}

* '''FRONT_WARM'''

| {{text anchor|IE_REMOVE_WEATHER}}

| syndrome trigger flag

| When a creature cleans off a [[contaminant]] which is associated with a [[syndrome]], the syndrome will be contracted if it has a matching [[Syndrome#The_anatomy_of_a_syndrome|trigger flag]]. This is what enables [[cat]]s to become slightly inebriated when licking off [[alcohol]]. '''SYN_INGESTED''' appears to be the only syndrome trigger flag that works in this context.

| {{text anchor|IE_PROPEL_FORCE}}

| {{text anchor|IE_ITEM}}

| {{text anchor|IE_ITEM_QUALITY}}

| {{text anchor|IE_SET_QUALITY}}

| {{text anchor|IE_CHANGE_QUALITY}}

| {{text anchor|CREATURE}}

| {{text anchor|IE_CREATURE_FLAG}}

| When this token is added to a random creature summoning effect, it narrows down the selection to creatures which have the specified [[Interaction_token#Creature_and_Caste_Flags|creature flag]]. This token may be used multiple times per interaction effect; creatures which lack any of the indicated flags will never be summoned.

| {{text anchor|IE_FORBIDDEN_CREATURE_FLAG}}

| When this token is added to a random creature summoning effect, any creature with the specified [[Interaction_token#Creature_and_Caste_Flags|creature flag]] will be excluded from the selection. This token may be used multiple times per interaction effect; creatures which possess any of the indicated flags will never be summoned.

| {{text anchor|IE_CREATURE_CASTE_FLAG}}

| When this token is added to a random creature summoning effect, it narrows down the selection to creatures which have the specified [[Interaction_token#Creature_and_Caste_Flags|caste flag]]. This token may be used multiple times per interaction effect; creatures which lack any of the indicated flags will never be summoned.

| {{text anchor|IE_FORBIDDEN_CREATURE_CASTE_FLAG}}

| When this token is added to a random creature summoning effect, it excludes any creature with the specified [[Interaction_token#Creature_and_Caste_Flags|caste flag]]. This token may be used multiple times per interaction effect; creatures which possess any of the indicated flags will never be summoned.

| {{text anchor|IE_HAVE_FAST_EFFORTLESS_GAIT_SPEED}}

| <minimum [[Gait#Speed|gait speed]]>

| When this token is added to a random creature summoning effect, it narrows down the selection to creatures which have at least one [[gait]] with an [[Creature_token#GAIT|<energy expenditure>]] of 0 and a [[Creature_token#GAIT|<max speed>]] less than or equal to the specified <minimum gait speed> ("less than" because lower is faster in the scale used for [[Gait#Speed|gait speed]]). [http://www.bay12forums.com/smf/index.php?topic=169696.msg8243222#msg8243222]

| {{text anchor|IE_ALL_SLOW_EFFORTLESS_GAIT_SPEED}}

| <maximum [[Gait#Speed|gait speed]]>

| When this token is added to a random creature summoning effect, it excludes any creatures which have at least one [[gait]] with an [[Creature_token#GAIT|<energy expenditure>]] of 0 and a [[Creature_token#GAIT|<max speed>]] value less than or equal to the specified <maximum gait speed> (note that larger values are slower in the scale used for [[Gait#Speed|gait speed]]). [http://www.bay12forums.com/smf/index.php?topic=169696.msg8243222#msg8243222]

| {{text anchor|IE_TIME_RANGE}}

| {{text anchor|IE_MAKE_PET_IF_POSSIBLE}}

To enable a particular type of creature to use an interaction directly, the [[creature token]] <code>[[Creature_token#CAN_DO_INTERACTION|[CAN_DO_INTERACTION:<interaction name>]]]</code> should be added to its creature raws (replacing '<interaction name>' with the ID of the desired interaction; for an interaction called <code>[INTERACTION:CLEANING]</code> in the raws, the ID would be "CLEANING"), followed by a series of [CDI:...] tokens as detailed below.

 

The following is a list of valid CDI tokens. Precede them with "CDI:" in the style of <code>[CDI:ADV_NAME:Clean]</code>, for example.

| Specifies the name of the interaction as it will appear on the [[Adventurer_mode|adventure mode]] 'powers/abilities' menu.

| Determines the maximum distance from the interaction user (in [[tile]]s) at which something can be considered a valid target. For [[Interaction_token#SOLID_GLOB|SOLID_GLOB]], [[Interaction_token#SHARP_ROCK|SHARP_ROCK]], [[Interaction_token#LIQUID_GLOB|LIQUID_GLOB]] and [[Interaction_token#FIREBALL|FIREBALL]] breath attacks, also determines how far the projectiles can fly before falling to the ground.

| Prevents CPU-controlled creatures from using the interaction unless they are in a location which meets the specified criteria. See [[Interaction_token#IE_LOCATION|above]] for a list of valid location hint values.

| Indicates when and how CPU-controlled creatures will use the interaction. If no hint is specified in fortress mode, the interaction will be performed at the every opportunity in combat. Multiple usage hints may be specified. Valid values:

* '''DEFEND''' - Used in combat. Creature will target itself.

* '''NEGATIVE_SOCIAL_RESPONSE''' - Used when a creature is expressing contempt (for example, to a murderer). This is used in the default spitting interaction, for example.

* '''TORMENT''' - This is also used in the default spitting interaction, and is presumably used in a similar context.

Note: A WAIT_PERIOD of 10 is 10 ticks long in [[fortress mode]], but only 1 tick long in [[adventurer mode]].

| When a creature uses the interaction, a combat report message will be displayed in the form:

 

 

The 'self' text is presented when describing the interaction in the second person (that is, when the interaction is carried out by the player character in [[adventure mode]]), the 'other' text is presented when describing it in the third person, and the 'mutual' text is presented when the interaction is carried out in a [[Interaction_token#CAN_BE_MUTUAL|mutual]] fashion.

 

 

* '''[[Interaction_token#FIREBALL|FIREBALL]]'''

* '''[[Interaction_token#FIREJET|FIREJET]]'''

* '''[[Interaction_token#DRAGONFIRE|DRAGONFIRE]]'''.

    '''[CDI:MATERIAL:<[[material token]]>:<material emission type>]'''

 

Is used to emit a specific material in a specific manner. A list of valid emission types can be found below.

 

Examples:

 

    [CDI:MATERIAL:INORGANIC:GABBRO:[[Interaction_token#SHARP_ROCK|SHARP_ROCK]]]

creates a pool of [[dwarf|dwarven]] tears

 

 

    '''[CDI:FLOW:<flow emission type>]'''

 

Is used to emit one of the special hardcoded flow types ([[Interaction_token#FIREBALL|FIREBALL]], [[Interaction_token#FIREJET|FIREJET]]  or [[Interaction_token#DRAGONFIRE|DRAGONFIRE]]).

 

 

| {{text anchor|TRAILING_DUST_FLOW}}

| Shoots a trail of solid dust at the target. Appears to use [[cave-in]] dust physics, as the dust cloud will fling around anything it comes in contact with (including the creature who emitted it), making it capable of smashing creatures into the ground and flinging them over walls. Creatures caught in the dust cloud will be [[contaminant|covered]] with dust; this will trigger any associated [[Syndrome#SYN_CONTACT|contact syndromes]].

| {{text anchor|TRAILING_VAPOR_FLOW}}

| Shoots a trail of liquid mist at the target. Creatures caught in the vapor will be [[contaminant|covered]] with the condensed liquid; this will trigger any associated [[Syndrome#SYN_CONTACT|contact syndromes]].

| {{text anchor|TRAILING_GAS_FLOW}}

| Shoots a trail of gaseous substance at the target. This can be inhaled, triggering any associated [[Syndrome#SYN_INHALED|inhalation syndromes]].

| {{text anchor|TRAILING_ITEM_FLOW}}:[[item token]]

| Shoots a "cloud" of items at the target, leaving piles of this item on the floor.  Note that this does ''not'' create the actual items or use falling item mechanics (meaning no flying daggers or Touhou-style barrages, unfortunately).  Instead, this token acts as [[Interaction_token#TRAILING_GAS_FLOW|TRAILING_GAS_FLOW]], except that the material will use its ''normal'' temperature - for example, a breath attack of steel anvils will envelop the target in a "burst of steel".

| {{text anchor|UNDIRECTED_DUST}}

| The creature releases a cloud of solid dust which spreads and dissipates. Similar to [[Interaction_token#TRAILING_DUST_FLOW|TRAILING_DUST_FLOW]], but undirected, thus affecting a larger area but losing the distance - range is roughly the same as that of a cave-in. Creature will attack as normal. <s>DO NOT USE THIS TAG UNLESS YOU WANT TO KILL THE CREATURE AND EVERYTHING NEAR IT AND SEND PEOPLE FLYING.</s> You know you want to.

| {{text anchor|UNDIRECTED_VAPOR}}

| The creature releases a cloud of liquid mist which spreads and dissipates. Similar to [[Interaction_token#TRAILING_VAPOR_FLOW|TRAILING_VAPOR_FLOW]], but undirected, thus affecting a larger area but losing the distance.

| {{text anchor|UNDIRECTED_GAS}}

| The creature releases a cloud of gaseous material which spreads and dissipates. Similar to [[Interaction_token#TRAILING_GAS_FLOW|TRAILING_GAS_FLOW]], but undirected, thus affecting a larger area but losing the distance.

| {{text anchor|UNDIRECTED_ITEM_CLOUD}}:[[item token]]

| The creature releases a "cloud" of items at the target, leaving piles of this item on the floor.  The same comments apply as [[Interaction_token#TRAILING_ITEM_FLOW|TRAILING_ITEM_FLOW]].

| {{text anchor|WEATHER_CREEPING_DUST}}

| Creates a cloud of creeping dust. Not usable by creatures.

| {{text anchor|WEATHER_CREEPING_VAPOR}}

| Creates a cloud of creeping vapor. Not usable by creatures.

| {{text anchor|WEATHER_CREEPING_GAS}}

| Creates a cloud of gas that appears at the edge of the map and slowly creeps across the map. Not usable by creatures.

| {{text anchor|WEATHER_FALLING_MATERIAL}}

| Causes it to start raining a particular material. If the material is solid at the outdoor temperatures, it will snow the material instead. Can transfer [[Syndrome#SYN_CONTACT|contact syndromes]]. Regardless of the nature of the material, being caught in it will give dwarves the negative [[thought]] of being 'caught in freakish weather lately'. Not usable by creatures.

| {{text anchor|SOLID_GLOB}}

| Shoots a [[Item_token#GLOB|solid glob]] of spinning substance at the target, leaving a symbol similar to broken arrows, if it misses. Essentially a projectile weapon. If the [[Interaction_token#WAIT_PERIOD|cooldown rate]] is short enough, some creatures with this breath attack will not move, preferring instead to hold position and shoot globs at their enemies, even when they are right next to them.

| {{text anchor|SHARP_ROCK}}

| Just like [[Interaction_token#SOLID_GLOB|SOLID_GLOB]], but more harmful, as it shoots a sharpened [[Item_token#ROCK|solid chunk]] of material instead.

| {{text anchor|LIQUID_GLOB}}

| Shoots a [[Item_token#LIQUID_MISC|liquid glob]] of substance at the target.  [[Syndrome#SYN_CONTACT|Contact syndromes]] will take effect if the glob hits the target's exposed skin.

| {{text anchor|SPATTER_POWDER}}

| Creates a [[contaminant|pile of powder]] at the specified location.

| {{text anchor|SPATTER_LIQUID}}

| Creates a [[contaminant|pool of liquid]] at the specified location.

| {{text anchor|WEB_SPRAY}}

| Emits a burst of [[web]]s that entangle target creatures.

| Emits a wide cone of [[dragon]] [[fire]] that burns target creatures at a scorching {{ct|50000}}.

| Emits a narrow cone of [[fire]] that burns target creatures at {{ct|11000}}.

| Emits a fireball that burns the target creature.

Keep in mind that you can give a creature multiple breath attacks, which appears to make the creature choose between them at random.  Creatures cannot use the WEATHER effects, these being reserved for regional interactions.

Certain interaction and syndrome effects (currently limited to [[Interaction_token#I_EFFECT|[IE_SUMMON_UNIT]]] and [[Syndrome#CE_BODY_TRANSFORMATION|[CE_BODY_TRANSFORMATION]]]) permit modders to specify the required/forbidden creature and caste flags of the desired creature(s). These are a collection of internal flags which are derived from [[Creature_token|creature tokens]] but are not necessarily identical to them. The following lists contain creature and caste flag names as provided by Toady One in a FotF reply [http://www.bay12forums.com/smf//index.php?topic=169696.msg8099138#msg8099138] (valid as of 0.47.04).

HAS_ANY_CAN_SWIM

MUNDANE