Difference between revisions of "Interaction token"

The following [[token]]s can be used to define and use interactions.

| {{text anchor|EXPERIMENT_ONLY}}{{version|0.47.01}}

| This disallows use of the interaction in play, and also encourages usage specifically to create experimental populations. [http://www.bay12forums.com/smf/index.php?topic=169696.msg8083872#msg8083872]

| Defines what things are capable of triggering this interaction. Multiple sources may be specified. Valid values:

* '''CREATURE_ACTION''' - Allows the interaction to be used in conjunction with [[Creature_token#CAN_DO_INTERACTION|[CAN_DO_INTERACTION]]] and [[Syndrome#Special_Effects|[CE_CAN_DO_INTERACTION]]].

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

* '''INGESTION''' - Allows the interaction to be used in conjunction with [[Syndrome#Special_Effects|[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. See also [[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]]].

* '''UNDERGROUND_SPECIAL''' - Allows the interaction to take place spontaneously in [[Demonic fortress|curious underground structures]].

* '''EXPERIMENT''' - Allows the interaction to be used when experimenting on creatures. [http://www.bay12forums.com/smf/index.php?topic=175437.msg8083510#msg8083510]

 

| Describes what the interaction did to a historical figure; this is displayed in legends mode after the name of the historical figure that performed the interaction.

| Describes what the interaction did to a historical figure; this is displayed in legends mode after the name of the historical figure that was targeted by the interaction.

| {{text anchor|IS_TRIGGER_STRING}}{{version|0.47.01}}

| {{text anchor|IS_TRIGGER_STRING_SECOND}}{{version|0.47.01}}

[IS_TRIGGER_STRING_THIRD: have]

| {{text anchor|IS_TRIGGER_STRING_THIRD}}{{version|0.47.01}}

| [[Sphere]]

| Indicates the sphere to which this secret pertains. Only one sphere can be defined for each [I_SOURCE:SECRET] token, thus, several [I_SOURCE:SECRET] tokens are required to create a valid custom secret which belongs to several different spheres.

However, currently only IMMORTALITY will result in a secret being pursued during world-gen.

* '''SUPERNATURAL_LEARNING_POSSIBLE''' - the secret can be gifted by gods to their worshippers. Secrets with [[Interaction_token#IS_SPHERE|[IS_SPHERE]]] specified may only be granted by gods who have at least one matching sphere.

* '''MUNDANE_RESEARCH_POSSIBLE''' - the secret can be researched by mundane means

* '''MUNDANE_RECORDING_POSSIBLE:objects/text/(book_title).txt:objects/text/(book_topic).txt''' - the secret can be written in books with the specified title. 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'''{{version|0.47.01}}, '''MEDIUM_BLESSING'''{{version|0.47.01}}, '''MINOR_CURSE'''{{version|0.47.01}}, '''MEDIUM_CURSE'''{{version|0.47.01}}, and '''MAJOR_CURSE''' are the only values that make sense.

| Indicates what types of regions are capable of performing this interaction. Multiple regions may be specified. Valid values:

* '''ANY'''

* '''ANY_TERRAIN'''

* Region type - '''SWAMP''', '''DESERT''', '''FOREST''', '''MOUNTAINS''', '''OCEAN''', '''LAKE''', '''GLACIER''', '''TUNDRA''', '''GRASSLAND''', '''HILLS'''

* '''RANDOM_NEARBY_LOCATION'''{{version|0.47.01}} - 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.

* '''FLOW''':Breath attack token - Specifies an attack not made of any material.

* '''MATERIAL''':[[Material token]]:Breath attack token - Specifies an attack made of a specific material.

* '''CONTEXT_MATERIAL''' - Use material from [[Interaction_token#MATERIAL|[CDI:MATERIAL]]] token.

* '''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 [SYNDROME] 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 [[Interaction_token#IE_GRIME_LEVEL|[IE_GRIME_LEVEL]]] and [[Interaction_token#IE_SYNDROME_TAG|[IE_SYNDROME_TAG]]].

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

* '''CREATE_ITEM'''{{version|0.47.01}} - Creates an item as described by [[Interaction_token#IE_ITEM|[IE_ITEM]]] and [[Interaction_token#IE_ITEM_QUALITY|[IE_ITEM_QUALITY]]].

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

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

* '''PROPEL_UNIT'''{{version|0.47.01}} - Applies a force specified using [[Interaction_token#IE_PROPEL_FORCE|[IE_PROPEL_FORCE]]] to a unit to knock it back.

* '''CHANGE_WEATHER'''{{version|0.47.01}} - Changes the weather as specified by [[Interaction_token#IE_ADD_WEATHER|[IE_ADD_WEATHER]]] and/or [[Interaction_token#IE_REMOVE_WEATHER|[IE_REMOVE_WEATHER]]].

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

| Currently only appears to work with [I_SOURCE:REGION] interactions. Indicates that the effect happens intermittently and specifies roughly how often. Valid values:

note:

DAILY, MONTHLY and YEARLY also exist in the string dump but aren't currently supported.

| Indicates where the effect can take place. Valid values:

A depth of 1/7 appears to be sufficient for IN_WATER and IN_MAGMA.

|-

| Allows the interaction to be applied to newly spawned creatures in Arena mode.

| {{text anchor|IE_ADD_WEATHER}}{{version|0.47.01}}

| {{text anchor|IE_REMOVE_WEATHER}}{{version|0.47.01}}

| Syndrome flag

| Indicates that cleaning off materials will activate their syndromes if they have this flag.

| {{text anchor|IE_PROPEL_FORCE}}{{version|0.47.01}}

| {{text anchor|IE_ITEM}}{{version|0.47.01}}

| {{text anchor|IE_ITEM_QUALITY}}{{version|0.47.01}}

| {{text anchor|IE_SET_QUALITY}}{{version|0.47.01}}

| {{text anchor|IE_CHANGE_QUALITY}}{{version|0.47.01}}

| {{text anchor|CREATURE}}{{version|0.47.01}}

| {{text anchor|IE_CREATURE_FLAG}}{{version|0.47.01}}

| Any creature with the specified [[Interaction_token#Creature_and_Caste_Flags|creature flag]] may be summoned. This token may be used multiple times per interaction effect; it appears that any creature with at least one of the indicated flags will be counted as a valid option.

| {{text anchor|IE_FORBIDDEN_CREATURE_FLAG}}{{version|0.47.01}}

| Any creature with the specified [[Interaction_token#Creature_and_Caste_Flags|creature flag]] will not be summoned. This token may be used multiple times per interaction effect; any creature with at least one of the indicated flags is forbidden.

| {{text anchor|IE_CREATURE_CASTE_FLAG}}{{version|0.47.01}}

| Any creature with the specified [[Interaction_token#Creature_and_Caste_Flags|caste flag]] may be summoned. This token may be used multiple times per interaction effect; it appears that any creature with at least one of the indicated flags will be counted as a valid option.

| {{text anchor|IE_FORBIDDEN_CREATURE_CASTE_FLAG}}{{version|0.47.01}}

| Any creature with the specified [[Interaction_token#Creature_and_Caste_Flags|caste flag]] will not be summoned. This token may be used multiple times per interaction effect; any creature with at least one of the indicated flags is forbidden.

| {{text anchor|IE_HAVE_FAST_EFFORTLESS_GAIT_SPEED}}{{version|0.47.01}}

|  

| Exists in the string dump; presumably narrows the random summoning choices to creatures whose normal/slow/slower gait is relatively fast, though this has yet to be tested.

| {{text anchor|IE_ALL_SLOW_EFFORTLESS_GAIT_SPEED}}{{version|0.47.01}}

|  

| Exists in the string dump; presumably narrows the random summoning choices to creatures whose normal gait is relatively slow, though this has yet to be tested.

| {{text anchor|IE_TIME_RANGE}}{{version|0.47.01}}

| {{text anchor|IE_MAKE_PET_IF_POSSIBLE}}{{version|0.47.01}}

In order to actually use an interaction, the [[creature token]] [CAN_DO_INTERACTION:NAME] should be added, followed by a series of [CDI:...] tokens. Interactions can also be granted through [[syndrome]]s using the token [CE_CAN_DO_INTERACTION] (plus the same series of CDI tokens).

The following CDI tokens can be specified:

| id

| Specifies which interaction can be performed. Only to be used with syndromes, since CE_CAN_DO_INTERACTION does not allow specifying the interaction ID directly.

* '''DISTURBER_ONLY''' - the target must be whoever disturbed the source

| Specifies how far away the target can be, in tiles. For SOLID_GLOB, LIQUID_GLOB and FIREBALL breath attacks, also determines how far the projectiles will fly before falling to the ground.

| Location Hint (see above)

| ?

| Indicates when and how CPU-controlled creatures will use the interaction. If no hint is specified, the interaction will be used whenever a valid target is available. Valid values:

* '''DEFEND'''{{version|0.47.01}} - Used in combat. Creature will target itself.

* '''NEGATIVE_SOCIAL_RESPONSE''' - Used when a creature is expressing contempt (for example, to a murderer). Used for spitting by civilised races.

* '''TORMENT'''

| {{text anchor|ADV_NAME}}

| text

| Specifies the interaction's name when used in Adventurer mode.

| {{text anchor|MAX_TARGET_NUMBER}}

| ID, number

| Specifies the maximum number of things that can be selected for a particular I_TARGET.

| {{text anchor|WAIT_PERIOD}}

| number

| Controls how often the interaction can be used.

| Only creatures that can speak will be able to use the interaction.  Might also be needed for VERBAL_SPEECH.

| filename

| Specifies what the creature says when they perform the interaction. Filename path is relative to /data/speech.

| Presumably, allows two creatures with the same interaction to use it on each other simultaneously, for example, cats cleaning each other.

 

| Indicates that performing the interaction doesn't take any time.

| When a creature uses the interaction, a message will display, describing the source as doing this.

 

| Indicates that a particular body part must be present in order to perform the interaction. Criteria are BY_CATEGORY:category, BY_TYPE:type, or BY_TOKEN:token.

| Causes the interaction to create an effect not made of any material. Only makes sense for '''FIREBALL''', '''FIREJET''', or '''DRAGONFIRE'''.

| [[Material token]]:Breath attack token

| Causes the interaction to create an effect made of a specific material. Doesn't make sense for FIREBALL, FIREJET, or DRAGONFIRE.

LINE_OF_SIGHT refers to where the target C may be; others include SELF_ALLOWED (presumably like LINE_OF_SIGHT, but with the creature allowed to target itself), SELF_ONLY (preferable for undirected attacks and TOUCHABLE (for up-close attacks, as trailing flows tend to be).

When using types of MATERIAL the format would be: [CDI:MATERIAL:material:sub-material:action-type] action-type being like SOLID_GLOB or UNDIRECTED_VAPOR

| TRAILING_DUST_FLOW

| Lets out a cloud of solid dust. Appears to use cave-in dust physics, causing this to fling around anything it comes in contact with, making it capable of smashing creatures into the ground and flinging them over walls. Creature will attack as normal.

| TRAILING_VAPOR_FLOW

| Shoots a trail of liquid mist at the target which can condense and trigger contact syndromes. Creature will attack as normal.

| TRAILING_GAS_FLOW

| Shoots a trail of gas substance at the target which can be inhaled. Creature will attack as normal.

| 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 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". Creature will attack as normal.

| SHARP_ROCK{{version|0.47.01}}

| Shoots a sharpened solid chunk of spinning substance at the creature, leaving symbols similar to broken arrows, essentially, a projectile weapon. If the cooldown rate is short enough, some creatures with this breath attack will not move, preferring instead to hold position and shoot shards at you, even when you are literally right next to them.

| SOLID_GLOB

| Shoots a solid glob of spinning substance at the creature, leaving symbols similar to broken arrows, essentially, a projectile weapon. If the cooldown rate is short enough, some creatures with this breath attack will not move, preferring instead to hold position and shoot globs at you, even when you are literally right next to them.

| LIQUID_GLOB

| Shoots a liquid glob of substance at the target. Contact syndromes will take effect if the glob hits the target's exposed skin.

| SPATTER_POWDER

| Creates a pile of powder at the specified location.

| SPATTER_LIQUID

| Creates a pool of liquid at the specified location.

| UNDIRECTED_GAS

| Creature occasionally releases a cloud of gas substance. Similar to TRAILING_GAS_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.

| UNDIRECTED_VAPOR

| Creature occasionally releases a cloud of liquid mist. Similar to TRAILING_VAPOR_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.

| UNDIRECTED_DUST

| Creature occasionally releases a cloud of solid dust, which will spread and dissipate. Similar to 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.

| UNDIRECTED_ITEM_CLOUD:[[item token]]

| Creature occasionally releases a "cloud" of items at the target, leaving piles of this item on the floor. The same comments apply as TRAILING_ITEM_FLOW. Creature will attack as normal.

| WEB_SPRAY