v50 Steam/Premium information for editors
- v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
- Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.
Editing Interaction token
Jump to navigation
Jump to search
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.
If you are creating a redirect to the current version's page, do not use any namespace. For example: use #REDIRECT [[Cat]], not #REDIRECT [[Main:Cat]] or #REDIRECT [[cv:Cat]]. See DF:Versions for more information.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | |||
{{av}} | {{av}} | ||
− | |||
− | The following [[token]]s can be used to define and use interactions. | + | The following [[token]]s can be used to define and use interactions. |
− | |||
− | |||
− | |||
==Definitions== | ==Definitions== | ||
Line 16: | Line 11: | ||
! Description | ! Description | ||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | {{text anchor|EXPERIMENT_ONLY}} | + | | {{text anchor|EXPERIMENT_ONLY}}{{version|0.47.01}} |
| Global | | Global | ||
| | | | ||
− | | | + | | 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] |
|- | |- | ||
Line 33: | Line 23: | ||
| type | | type | ||
| Defines what things are capable of triggering this interaction - multiple sources may be specified. Valid values: | | Defines what things are capable of triggering this interaction - multiple sources may be specified. Valid values: | ||
− | * '''CREATURE_ACTION''' - Specifies that the interaction may be used in conjunction with [[Creature_token#CAN_DO_INTERACTION|[CAN_DO_INTERACTION]]] and [[Syndrome# | + | * '''CREATURE_ACTION''' - Specifies that the interaction may be used in conjunction with [[Creature_token#CAN_DO_INTERACTION|[CAN_DO_INTERACTION]]] and [[Syndrome#Special_Effects|[CE_CAN_DO_INTERACTION]]], but it isn't actually necessary for this. It might exist simply to allow for the specification 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# | + | * '''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# | + | * '''INGESTION''' - Allows the interaction to be used in conjunction with [[Syndrome#Special_Effects|[CE_BODY_MAT_INTERACTION]]]. |
* '''DEITY''' - Allows the interaction to be inflicted upon mortals by the gods, for reasons dictated by [[Interaction_token#IS_USAGE_HINT|[IS_USAGE_HINT]]]. | * '''DEITY''' - Allows the interaction to be inflicted upon mortals by the gods, for reasons dictated by [[Interaction_token#IS_USAGE_HINT|[IS_USAGE_HINT]]]. | ||
− | * '''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. | + | * '''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 | + | * '''REGION''' - Allows the interaction to take place spontaneously in regions specified using [[Interaction_token#IS_REGION|[IS_REGION]]]. |
* '''DISTURBANCE''' - Allows the interaction to take place spontaneously in disturbed [[tomb|tombs]]; generated interactions with this token are used to create [[mummy|mummies]]. | * '''DISTURBANCE''' - Allows the interaction to take place spontaneously in disturbed [[tomb|tombs]]; generated interactions with this token are used to create [[mummy|mummies]]. | ||
− | * '''UNDERGROUND_SPECIAL''' - Allows the interaction to take place spontaneously in [[Demonic fortress|curious underground structures]] (which | + | * '''UNDERGROUND_SPECIAL''' - Allows the interaction to take place spontaneously in [[Demonic fortress|curious underground structures]] (which have since been removed {{version|0.40.01}}); generated interactions with this token used to be used to produce [[undead|zombies]] when creating the structure's inhabitants. |
− | * '''EXPERIMENT''' - | + | * '''EXPERIMENT''' - Allows the interaction to be used when experimenting on creatures. [http://www.bay12forums.com/smf/index.php?topic=175437.msg8083510#msg8083510] |
|- | |- | ||
Line 60: | Line 50: | ||
|- | |- | ||
− | | {{text anchor|IS_TRIGGER_STRING}} | + | | {{text anchor|IS_TRIGGER_STRING}}{{version|0.47.01}} |
| Within I_SOURCE | | Within I_SOURCE | ||
| text | | text | ||
Line 68: | Line 58: | ||
|- | |- | ||
− | | {{text anchor|IS_TRIGGER_STRING_SECOND}} | + | | {{text anchor|IS_TRIGGER_STRING_SECOND}}{{version|0.47.01}} |
| Within I_SOURCE | | Within I_SOURCE | ||
| text | | text | ||
| Presented before the [[Interaction_token#IS_TRIGGER_STRING|IS_TRIGGER_STRING]] when describing the event in the second person. | | Presented before the [[Interaction_token#IS_TRIGGER_STRING|IS_TRIGGER_STRING]] when describing the event in the second person. | ||
− | [ | + | [IS_TRIGGER_STRING_THIRD: have] |
|- | |- | ||
− | | {{text anchor|IS_TRIGGER_STRING_THIRD}} | + | | {{text anchor|IS_TRIGGER_STRING_THIRD}}{{version|0.47.01}} |
| Within I_SOURCE | | Within I_SOURCE | ||
| text | | text | ||
Line 90: | Line 80: | ||
[IS_NAME:the secrets of life and death] | [IS_NAME:the secrets of life and death] | ||
+ | |||
+ | |- | ||
+ | | {{text anchor|IS_FREQUENCY}} | ||
+ | | Within I_SOURCE | ||
+ | | Number | ||
+ | | When used with [[Interaction_token#I_SOURCE|[I_SOURCE:REGION]]], presumably determines the probability of the biome specified by [[Interaction_token#IS_REGION|[IS_REGION]]] to have this interaction. | ||
|- | |- | ||
| {{text anchor|IS_SPHERE}} | | {{text anchor|IS_SPHERE}} | ||
| Within I_SOURCE:SECRET | | Within I_SOURCE:SECRET | ||
− | | [[Sphere | + | | [[Sphere]] |
− | | Indicates the | + | | 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. |
|- | |- | ||
Line 114: | Line 110: | ||
* '''SEE_THE_GREAT_NATURAL_SITES''' | * '''SEE_THE_GREAT_NATURAL_SITES''' | ||
* '''IMMORTALITY''' | * '''IMMORTALITY''' | ||
− | + | However, currently only IMMORTALITY will result in a secret being pursued during world-gen. | |
− | |||
− | |||
− | However, currently only IMMORTALITY will result in a secret being pursued during | ||
|- | |- | ||
Line 125: | Line 118: | ||
| Indicates how the secret can be learned. Valid values: | | Indicates how the secret can be learned. Valid values: | ||
* '''SUPERNATURAL_LEARNING_POSSIBLE''' - gods may gift the secret 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. | * '''SUPERNATURAL_LEARNING_POSSIBLE''' - gods may gift the secret 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_RESEARCH_POSSIBLE''' - the secret can be researched by mundane means |
* '''MUNDANE_TEACHING_POSSIBLE''' - the secret can be taught to apprentices | * '''MUNDANE_TEACHING_POSSIBLE''' - the secret can be taught to apprentices | ||
− | * '''MUNDANE_RECORDING_POSSIBLE: | + | * '''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. |
|- | |- | ||
Line 133: | Line 126: | ||
| Within I_SOURCE:DEITY | | Within I_SOURCE:DEITY | ||
| Usage Hint token | | Usage Hint token | ||
− | | 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 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. |
|- | |- | ||
Line 139: | Line 132: | ||
| Within I_SOURCE:REGION | | Within I_SOURCE:REGION | ||
| Region type | | Region type | ||
− | | Indicates what types of regions are capable of performing this interaction. | + | | Indicates what types of regions are capable of performing this interaction. Multiple regions may be specified. Valid values: |
− | + | * '''ANY''' | |
− | * '''ANY | + | * '''ANY_TERRAIN''' |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | * '''ANY_TERRAIN''' | ||
− | |||
− | |||
− | |||
* '''NORMAL_ALLOWED''' | * '''NORMAL_ALLOWED''' | ||
* '''EVIL_ALLOWED''' | * '''EVIL_ALLOWED''' | ||
Line 166: | Line 142: | ||
* '''GOOD_ONLY''' | * '''GOOD_ONLY''' | ||
* '''SAVAGE_ONLY''' | * '''SAVAGE_ONLY''' | ||
− | + | * Region type - '''SWAMP''', '''DESERT''', '''FOREST''', '''MOUNTAINS''', '''OCEAN''', '''LAKE''', '''GLACIER''', '''TUNDRA''', '''GRASSLAND''', '''HILLS''' | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
Line 197: | Line 166: | ||
* '''CONTEXT_REGION''' - Can only be used by [[Interaction_token#I_SOURCE|[I_SOURCE:REGION]]] interactions. | * '''CONTEXT_REGION''' - Can only be used by [[Interaction_token#I_SOURCE|[I_SOURCE:REGION]]] interactions. | ||
* '''CONTEXT_MATERIAL''' - Used with MATERIAL if you want an [[Interaction_token#I_EFFECT|[I_EFFECT:MATERIAL_EMISSION]]] to obtain the emission material/flow type from [[Interaction_token#MATERIAL|[CDI:MATERIAL]]] or [[Interaction_token#FLOW|[CDI:FLOW]]]. | * '''CONTEXT_MATERIAL''' - Used with MATERIAL if you want an [[Interaction_token#I_EFFECT|[I_EFFECT:MATERIAL_EMISSION]]] to obtain the emission material/flow type from [[Interaction_token#MATERIAL|[CDI:MATERIAL]]] or [[Interaction_token#FLOW|[CDI:FLOW]]]. | ||
− | * '''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. | + | * '''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. |
|- | |- | ||
Line 274: | Line 243: | ||
| type | | type | ||
| Specifies what the interaction does to the targets. Multiple [I_EFFECT]s may be specified in a single interaction, and the same type may be used more than once. Valid values: | | Specifies what the interaction does to the targets. Multiple [I_EFFECT]s may be specified in a single interaction, and the same type may be used more than once. Valid values: | ||
− | + | * '''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. | |
− | * '''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 | ||
− | |||
* '''ANIMATE''' - Raises the target corpse/bodypart as an [[undead]] unit. The zombie will always be hostile to life and will retain no information about its original personality/loyalties. Syndromes can also be specified within this tag. If a regional interaction contains this effect, affected regions will have undead wildlife. | * '''ANIMATE''' - Raises the target corpse/bodypart as an [[undead]] unit. The zombie will always be hostile to life and will retain no information about its original personality/loyalties. Syndromes can also be specified within this tag. If a regional interaction contains this effect, affected regions will have undead wildlife. | ||
− | |||
* '''RESURRECT''' - Takes a target corpse and returns the creature to life. This can be used on parts that are not FIT_FOR_RESURRECTION, but only the main part (with an UPPERBODY attached) will remain loyal to its original faction. Syndromes can also be specified within this tag. | * '''RESURRECT''' - Takes a target corpse and returns the creature to life. This can be used on parts that are not FIT_FOR_RESURRECTION, but only the main part (with an UPPERBODY attached) will remain loyal to its original faction. Syndromes can also be specified within this tag. | ||
− | + | * '''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]]]. | |
− | * '''CLEAN''' - Removes [[Contaminant|contaminants]] from a valid creature target. See | ||
− | |||
* '''CONTACT''' - Causes the creatures to touch. | * '''CONTACT''' - Causes the creatures to touch. | ||
− | |||
* '''MATERIAL_EMISSION''' - Causes a particular material to be emitted. Used by [[evil weather]] and the MATERIAL_EMISSION interaction. | * '''MATERIAL_EMISSION''' - Causes a particular material to be emitted. Used by [[evil weather]] and the MATERIAL_EMISSION interaction. | ||
− | + | * '''HIDE''' - Allows the creature to hide even if another creature can see it. | |
− | * '''HIDE''' - Allows the creature to | + | * '''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. | |
− | * '''CREATE_ITEM''' - Creates an item as described by | + | * '''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_ITEM_QUALITY''' - Alters an item's quality level as indicated by either | + | * '''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. | |
− | * '''SUMMON_UNIT''' - Creates a new unit at the target. The type of unit can either be specified using the | ||
− | |||
− | * '''PROPEL_UNIT''' - Applies a force specified using | ||
− | |||
− | * '''CHANGE_WEATHER''' - Changes the weather as specified by | ||
− | |||
− | * '''RAISE_GHOST''' - Present in version 0.47.01 and accepted as a valid I_EFFECT token, but does not have an effect currently | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
Line 317: | Line 267: | ||
| Within I_EFFECT | | Within I_EFFECT | ||
| Frequency | | Frequency | ||
− | | | + | | Currently only appears to work with [I_SOURCE:REGION] interactions. Indicates that the effect happens intermittently and specifies roughly how often. Valid values: |
* '''WEEKLY''' | * '''WEEKLY''' | ||
− | + | note: | |
− | + | DAILY, MONTHLY and YEARLY also exist in the string dump but aren't currently supported. | |
− | |||
|- | |- | ||
| {{text anchor|IE_IMMEDIATE}} | | {{text anchor|IE_IMMEDIATE}} | ||
Line 332: | Line 281: | ||
| Within I_EFFECT | | Within I_EFFECT | ||
| Location Hint | | Location Hint | ||
− | | | + | | Indicates where the effect can take place. Valid values: |
− | Valid values: | ||
* '''IN_WATER''' | * '''IN_WATER''' | ||
* '''IN_MAGMA''' | * '''IN_MAGMA''' | ||
Line 340: | Line 288: | ||
* '''NO_THICK_FOG''' | * '''NO_THICK_FOG''' | ||
* '''OUTSIDE''' | * '''OUTSIDE''' | ||
− | A | + | A depth of 1/7 appears to be sufficient for IN_WATER and IN_MAGMA. |
− | + | |- | |
+ | | {{text anchor|IE_ARENA_NAME}} | ||
+ | | Within I_EFFECT | ||
+ | | text | ||
+ | | Allows the interaction effect to be applied to newly spawned creatures in Arena mode. | ||
|- | |- | ||
− | | {{text anchor|IE_ADD_WEATHER}} | + | | {{text anchor|IE_ADD_WEATHER}}{{version|0.47.01}} |
| Within I_EFFECT:CHANGE_WEATHER | | Within I_EFFECT:CHANGE_WEATHER | ||
| type | | type | ||
Line 352: | Line 304: | ||
* '''FOG_NORMAL''' | * '''FOG_NORMAL''' | ||
* '''FOG_THICK''' | * '''FOG_THICK''' | ||
− | * ''' | + | * '''FRONT_OCCLUDED''' |
* '''FRONT_COLD''' | * '''FRONT_COLD''' | ||
− | |||
* '''STRATUS_ALTO''' | * '''STRATUS_ALTO''' | ||
* '''STRATUS_PROPER''' | * '''STRATUS_PROPER''' | ||
Line 364: | Line 315: | ||
|- | |- | ||
− | | {{text anchor|IE_REMOVE_WEATHER}} | + | | {{text anchor|IE_REMOVE_WEATHER}}{{version|0.47.01}} |
| Within I_EFFECT:CHANGE_WEATHER | | Within I_EFFECT:CHANGE_WEATHER | ||
| type | | type | ||
Line 378: | Line 329: | ||
| {{text anchor|IE_SYNDROME_TAG}} | | {{text anchor|IE_SYNDROME_TAG}} | ||
| Within I_EFFECT:CLEAN | | Within I_EFFECT:CLEAN | ||
− | | | + | | Syndrome flag |
− | | | + | | Indicates that cleaning off materials will activate their syndromes if they have this flag. |
|- | |- | ||
− | | {{text anchor|IE_PROPEL_FORCE}} | + | | {{text anchor|IE_PROPEL_FORCE}}{{version|0.47.01}} |
| Within I_EFFECT:PROPEL_UNIT | | Within I_EFFECT:PROPEL_UNIT | ||
| amount | | amount | ||
Line 388: | Line 339: | ||
|- | |- | ||
− | | {{text anchor|IE_ITEM}} | + | | {{text anchor|IE_ITEM}}{{version|0.47.01}} |
| Within I_EFFECT:CREATE_ITEM | | Within I_EFFECT:CREATE_ITEM | ||
| <probability>:<quantity>:[[item token]]:[[material token]] | | <probability>:<quantity>:[[item token]]:[[material token]] | ||
Line 394: | Line 345: | ||
|- | |- | ||
− | | {{text anchor|IE_ITEM_QUALITY}} | + | | {{text anchor|IE_ITEM_QUALITY}}{{version|0.47.01}} |
| Within I_EFFECT:CREATE_ITEM | | Within I_EFFECT:CREATE_ITEM | ||
| <[[Item_quality|quality]]> OR <minimum [[Item_quality|quality]]>:<maximum [[Item_quality|quality]]> | | <[[Item_quality|quality]]> OR <minimum [[Item_quality|quality]]>:<maximum [[Item_quality|quality]]> | ||
Line 407: | Line 358: | ||
|- | |- | ||
− | | {{text anchor|IE_SET_QUALITY}} | + | | {{text anchor|IE_SET_QUALITY}}{{version|0.47.01}} |
| Within I_EFFECT:CHANGE_ITEM_QUALITY | | Within I_EFFECT:CHANGE_ITEM_QUALITY | ||
| [[Interaction_token#IE_ITEM_QUALITY|quality level]] | | [[Interaction_token#IE_ITEM_QUALITY|quality level]] | ||
Line 413: | Line 364: | ||
|- | |- | ||
− | | {{text anchor|IE_CHANGE_QUALITY}} | + | | {{text anchor|IE_CHANGE_QUALITY}}{{version|0.47.01}} |
| Within I_EFFECT:CHANGE_ITEM_QUALITY | | Within I_EFFECT:CHANGE_ITEM_QUALITY | ||
| amount | | amount | ||
Line 419: | Line 370: | ||
|- | |- | ||
− | | {{text anchor|CREATURE}} | + | | {{text anchor|CREATURE}}{{version|0.47.01}} |
| Within I_EFFECT:SUMMON_UNIT | | Within I_EFFECT:SUMMON_UNIT | ||
| <creature token>:<caste token> | | <creature token>:<caste token> | ||
Line 425: | Line 376: | ||
|- | |- | ||
− | | {{text anchor|IE_CREATURE_FLAG}} | + | | {{text anchor|IE_CREATURE_FLAG}}{{version|0.47.01}} |
| Within I_EFFECT:SUMMON_UNIT | | Within I_EFFECT:SUMMON_UNIT | ||
| <[[Interaction_token#Creature_and_Caste_Flags|creature flag]]> | | <[[Interaction_token#Creature_and_Caste_Flags|creature flag]]> | ||
− | | | + | | 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}} | + | | {{text anchor|IE_FORBIDDEN_CREATURE_FLAG}}{{version|0.47.01}} |
| Within I_EFFECT:SUMMON_UNIT | | Within I_EFFECT:SUMMON_UNIT | ||
| <[[Interaction_token#Creature_and_Caste_Flags|creature flag]]> | | <[[Interaction_token#Creature_and_Caste_Flags|creature flag]]> | ||
− | | | + | | 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}} | + | | {{text anchor|IE_CREATURE_CASTE_FLAG}}{{version|0.47.01}} |
| Within I_EFFECT:SUMMON_UNIT | | Within I_EFFECT:SUMMON_UNIT | ||
| <[[Interaction_token#Creature_and_Caste_Flags|caste flag]]> | | <[[Interaction_token#Creature_and_Caste_Flags|caste flag]]> | ||
− | | | + | | 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}} | + | | {{text anchor|IE_FORBIDDEN_CREATURE_CASTE_FLAG}}{{version|0.47.01}} |
| Within I_EFFECT:SUMMON_UNIT | | Within I_EFFECT:SUMMON_UNIT | ||
| <[[Interaction_token#Creature_and_Caste_Flags|caste flag]]> | | <[[Interaction_token#Creature_and_Caste_Flags|caste flag]]> | ||
− | | | + | | 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}} | + | | {{text anchor|IE_HAVE_FAST_EFFORTLESS_GAIT_SPEED}}{{version|0.47.01}} |
| Within I_EFFECT:SUMMON_UNIT | | Within I_EFFECT:SUMMON_UNIT | ||
− | | | + | | |
− | | | + | | 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}} | + | | {{text anchor|IE_ALL_SLOW_EFFORTLESS_GAIT_SPEED}}{{version|0.47.01}} |
| Within I_EFFECT:SUMMON_UNIT | | Within I_EFFECT:SUMMON_UNIT | ||
− | | | + | | |
− | | | + | | 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}} | + | | {{text anchor|IE_TIME_RANGE}}{{version|0.47.01}} |
| Within I_EFFECT:SUMMON_UNIT | | Within I_EFFECT:SUMMON_UNIT | ||
| <minimum [[Time|ticks]]>:<maximum [[Time|ticks]]> | | <minimum [[Time|ticks]]>:<maximum [[Time|ticks]]> | ||
Line 467: | Line 418: | ||
|- | |- | ||
− | | {{text anchor|IE_MAKE_PET_IF_POSSIBLE}} | + | | {{text anchor|IE_MAKE_PET_IF_POSSIBLE}}{{version|0.47.01}} |
| Within I_EFFECT:SUMMON_UNIT | | Within I_EFFECT:SUMMON_UNIT | ||
| | | | ||
Line 482: | Line 433: | ||
==Usage== | ==Usage== | ||
− | To enable a particular type of creature to use an interaction directly, the [[creature token]] | + | To enable a particular type of creature to use an interaction directly, the [[creature token]] [[Creature_token#CAN_DO_INTERACTION|[CAN_DO_INTERACTION:NAME]]] should be added to its creature raws (replacing 'NAME' with the ID of the relevant interaction), followed by a series of [CDI:...] tokens as detailed below. Interactions can also be granted through [[syndrome]]s using the token [[Syndrome#Special_Effects|[CE_CAN_DO_INTERACTION]]] (plus the same series of CDI tokens). |
− | + | The following CDI tokens can be specified: | |
− | |||
− | The following | ||
{| {{prettytable}} | {| {{prettytable}} | ||
|- bgcolor="#C0C0C0" | |- bgcolor="#C0C0C0" | ||
Line 501: | Line 450: | ||
| {{text anchor|ADV_NAME}} | | {{text anchor|ADV_NAME}} | ||
| text | | text | ||
− | | Specifies the name of the interaction as it will | + | | Specifies the name of the interaction as it will be displayed on the [[Adventurer_mode|adventure mode]] powers/abilities menu. |
|- | |- | ||
Line 516: | Line 465: | ||
| {{text anchor|TARGET_RANGE}} | | {{text anchor|TARGET_RANGE}} | ||
| target ID, range | | target ID, range | ||
− | | | + | | 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. |
|- | |- | ||
Line 526: | Line 475: | ||
| {{text anchor|LOCATION_HINT}} | | {{text anchor|LOCATION_HINT}} | ||
| Location Hint | | Location Hint | ||
− | | | + | | Specifies where the creature is permitted to use the interaction. See [[Interaction_token#IE_LOCATION|above]] for valid values. |
|- | |- | ||
| {{text anchor|USAGE_HINT}} | | {{text anchor|USAGE_HINT}} | ||
| Usage hint token | | Usage hint token | ||
− | | Indicates when and how CPU-controlled creatures will use the interaction. If no hint is specified | + | | 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: |
+ | * '''MINOR_BLESSING'''{{version|0.47.01}} - Used in divination dice blessings. Targets the roller. | ||
+ | * '''MINOR_CURSE'''{{version|0.47.01}} - Used in divination dice curses. Targets the roller. | ||
+ | * '''MEDIUM_BLESSING'''{{version|0.47.01}} - Used in divination dice blessings. Targets the roller. | ||
+ | * '''MEDIUM_CURSE'''{{version|0.47.01}} - Used in divination dice curses. Targets the roller. | ||
+ | * '''MAJOR_CURSE''' - Used in disturbance and deity curses. Targets the tomb disturber/temple defiler. | ||
* '''GREETING''' - Creatures will target 'friendly' creatures, usually at random. | * '''GREETING''' - Creatures will target 'friendly' creatures, usually at random. | ||
+ | * '''CLEAN_SELF''' - Creature targets itself when covered in liquids or dust. | ||
+ | * '''CLEAN_FRIEND''' - Same, but targets other friendly units. | ||
* '''ATTACK''' - Targets enemy creatures in combat. If the interaction specifies SELF_ONLY, CPU-controlled creatures will never use it. | * '''ATTACK''' - Targets enemy creatures in combat. If the interaction specifies SELF_ONLY, CPU-controlled creatures will never use it. | ||
− | * '''DEFEND''' - Used in combat. Creature will target itself. | + | * '''DEFEND'''{{version|0.47.01}} - Used in combat. Creature will target itself. |
* '''FLEEING''' - Used when fleeing an enemy. Creature will target itself. | * '''FLEEING''' - Used when fleeing an enemy. 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''' | |
− | * '''NEGATIVE_SOCIAL_RESPONSE''' - Used when a creature is expressing contempt (for example, to a murderer). | ||
− | * '''TORMENT''' | ||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
Line 550: | Line 499: | ||
| number | | number | ||
| The creature must wait the specified number of [[time|ticks]] before being able to use the interaction again. The delay defaults to 20 ticks if this is omitted. Setting it to 0 removes the delay altogether. | | The creature must wait the specified number of [[time|ticks]] before being able to use the interaction again. The delay defaults to 20 ticks if this is omitted. Setting it to 0 removes the delay altogether. | ||
− | Note: | + | Note: due to the [[Time#Basic_mechanics|time difference]] between fortress mode and adventure mode, a WAIT_PERIOD of 10 is actually just 1 tick long in adventure mode. |
|- | |- | ||
Line 580: | Line 529: | ||
| {{text anchor|VERB}} | | {{text anchor|VERB}} | ||
| self:other:mutual | | self:other:mutual | ||
− | | When a creature uses the interaction, a | + | | When a creature uses the interaction, a message will display, describing the source as doing this. The first message specified is presented when describing the interaction in the second person, the second message is presented when describing it in the third person. |
− | |||
− | |||
− | |||
− | The | ||
− | |||
− | |||
− | |||
[CDI:VERB:gesture:gestures:NA] | [CDI:VERB:gesture:gestures:NA] | ||
Line 605: | Line 547: | ||
| [[#Breath Attack Types|Breath attack token]] | | [[#Breath Attack Types|Breath attack token]] | ||
| Can be used with interactions that have [[Interaction_token#I_EFFECT|[I_EFFECT:MATERIAL_EMISSION]]] and [[Interaction_token#IT_LOCATION|[IT_LOCATION:CONTEXT_MATERIAL]]] (or [[Interaction_token#IT_MATERIAL|[IT_MATERIAL:CONTEXT_MATERIAL]]]) to make the interaction emit a special flow type. Valid values: | | Can be used with interactions that have [[Interaction_token#I_EFFECT|[I_EFFECT:MATERIAL_EMISSION]]] and [[Interaction_token#IT_LOCATION|[IT_LOCATION:CONTEXT_MATERIAL]]] (or [[Interaction_token#IT_MATERIAL|[IT_MATERIAL:CONTEXT_MATERIAL]]]) to make the interaction emit a special flow type. Valid values: | ||
− | * ''' | + | * '''FIREBALL''' |
− | * ''' | + | * '''FIREJET''' |
− | * ''' | + | * '''DRAGONFIRE'''. |
|- | |- | ||
Line 641: | Line 583: | ||
===Breath Attack Types=== | ===Breath Attack Types=== | ||
− | + | 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 | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | When using types of FLOW the format would just be: | ||
+ | [CDI:FLOW:FIREBALL] | ||
{| {{prettytable}} | {| {{prettytable}} | ||
Line 670: | Line 594: | ||
! Description | ! Description | ||
|- | |- | ||
− | + | | TRAILING_DUST_FLOW | |
| MATERIAL | | MATERIAL | ||
− | | | + | | 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 | |
| MATERIAL | | MATERIAL | ||
− | | Shoots a trail of liquid mist at the target | + | | Shoots a trail of liquid mist at the target which can condense and trigger contact syndromes. Creature will attack as normal. |
|- | |- | ||
− | + | | TRAILING_GAS_FLOW | |
| MATERIAL | | MATERIAL | ||
− | | Shoots a trail of | + | | Shoots a trail of gas substance at the target which can be inhaled. Creature will attack as normal. |
|- | |- | ||
− | + | | TRAILING_ITEM_FLOW:[[item token]] | |
| MATERIAL | | MATERIAL | ||
− | | 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 | + | | 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}} |
| MATERIAL | | MATERIAL | ||
− | | | + | | 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 |
| MATERIAL | | MATERIAL | ||
− | | | + | | 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 |
| MATERIAL | | MATERIAL | ||
− | | | + | | 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 |
| MATERIAL | | MATERIAL | ||
− | | | + | | Creates a pile of powder at the specified location. |
|- | |- | ||
− | | | + | | SPATTER_LIQUID |
| MATERIAL | | MATERIAL | ||
− | | Creates a | + | | Creates a pool of liquid at the specified location. |
|- | |- | ||
− | | | + | | UNDIRECTED_GAS |
| MATERIAL | | MATERIAL | ||
− | | | + | | 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 |
| MATERIAL | | MATERIAL | ||
− | | | + | | 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 |
| MATERIAL | | MATERIAL | ||
− | | | + | | 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]] |
| MATERIAL | | MATERIAL | ||
− | | | + | | 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 |
| MATERIAL | | MATERIAL | ||
− | | | + | | Emits a burst of [[web]]s that entangle target creatures. |
+ | |- | ||
+ | | DRAGONFIRE | ||
+ | | FLOW | ||
+ | | Emits a wide cone of [[dragon]] [[fire]] that burns target creatures at a scorching {{ct|50000}}. For this you want FLOW instead of a material. | ||
+ | |- | ||
+ | | FIREJET | ||
+ | | FLOW | ||
+ | | Emits a narrow cone of [[fire]] that burns target creatures at {{ct|11000}}. For this you want FLOW instead of a material. | ||
+ | |- | ||
+ | | FIREBALL | ||
+ | | FLOW | ||
+ | | Emits a fireball that burns the target creature. For this you want FLOW instead of a material. | ||
|- | |- | ||
− | | | + | | WEATHER_CREEPING_GAS |
| MATERIAL | | MATERIAL | ||
− | | | + | | Creates a cloud of gas that appears at the edge of the map and slowly creeps across the map. Not usable by creatures. |
|- | |- | ||
− | | | + | | WEATHER_CREEPING_VAPOR |
| MATERIAL | | MATERIAL | ||
− | | Creates a | + | | Creates a cloud of creeping vapor. Not usable by creatures. |
|- | |- | ||
− | | | + | | WEATHER_CREEPING_DUST |
| MATERIAL | | MATERIAL | ||
− | | Creates a | + | | Creates a cloud of creeping dust. Not usable by creatures. |
|- | |- | ||
− | | | + | | WEATHER_FALLING_MATERIAL |
| MATERIAL | | MATERIAL | ||
− | | | + | | Causes it to start raining a particular material. If the material is solid at the outdoor temperatures, it will snow the material instead. Regardless of the nature of the material, being caught in it will give dwarves the bad thought of being 'caught in freakish weather lately'. Not usable by creatures. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | Keep in mind that you can | + | Keep in mind that you can use 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. |
One major difference between GAS, VAPOR, and DUST is that if the material cannot exist in the specified state at the current temperature, it will automatically be created at a temperature allowing it to exist. So if you create a vapor spray that uses rock or metal as a material, that spray will be created at the material's melting point, setting everything it touches on fire. You can also create a freezing spray by using a custom material that has extremely low melting and/or boiling points. | One major difference between GAS, VAPOR, and DUST is that if the material cannot exist in the specified state at the current temperature, it will automatically be created at a temperature allowing it to exist. So if you create a vapor spray that uses rock or metal as a material, that spray will be created at the material's melting point, setting everything it touches on fire. You can also create a freezing spray by using a custom material that has extremely low melting and/or boiling points. | ||
Line 763: | Line 687: | ||
==Creature and Caste Flags== | ==Creature and Caste Flags== | ||
− | Certain interaction and syndrome effects (currently limited to [[Interaction_token#I_EFFECT|[IE_SUMMON_UNIT]]] and [[Syndrome# | + | Certain interaction and syndrome effects (currently limited to [[Interaction_token#I_EFFECT|[IE_SUMMON_UNIT]]] and [[Syndrome#Creature_effect_tokens|[CE_BODY_TRANSFORMATION]]]) permit modders to specify the required/forbidden creature and caste flags of the desired creature. 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). |
{{gamedata|title=Creature Flags| | {{gamedata|title=Creature Flags| | ||
Line 829: | Line 753: | ||
HAS_ANY_CANNOT_BREATHE_AIR | HAS_ANY_CANNOT_BREATHE_AIR | ||
HAS_ANY_CANNOT_BREATHE_WATER | HAS_ANY_CANNOT_BREATHE_WATER | ||
− | HAS_ANY_CAN_SWIM | + | HAS_ANY_CAN_SWIM - currently unusable due to a bug |
HAS_ANY_CARNIVORE | HAS_ANY_CARNIVORE | ||
HAS_ANY_COMMON_DOMESTIC | HAS_ANY_COMMON_DOMESTIC | ||
Line 873: | Line 797: | ||
LOOSE_CLUSTERS | LOOSE_CLUSTERS | ||
MATES_TO_BREED | MATES_TO_BREED | ||
− | MUNDANE | + | MUNDANE - currently unusable due to a bug |
OCCURS_AS_ENTITY_RACE | OCCURS_AS_ENTITY_RACE | ||
SAVAGE | SAVAGE |