v0.34:Interaction token

v50.13 · v0.47 · v0.34.11 · v0.31 · v0.28 · v0.23 This article is about an older version of DF. More Info · V

The following tokens can be used to define interactions.

Interactions

Token	Context	Arguments	Description
I_SOURCE	Global	type	Defines what things are capable of triggering this interaction. Valid values: REGION UNDERGROUND_SPECIAL SECRET DISTURBANCE DEITY ATTACK INGESTION CREATURE_ACTION
IS_HIST_STRING_1	Within I_SOURCE	text	Describes what the interaction did to a historical figure. Displayed after the name of the historical figure that performed the interaction. [IS_HIST_STRING_1: cursed ]
IS_HIST_STRING_2	Within I_SOURCE	text	Describes what the interaction did to a historical figure. Displayed after the name of the historical figure that was targetted by the interaction. [IS_HIST_STRING_2: to assume the form of a lizard-like monster every full moon]
IS_FREQUENCY	Within I_SOURCE	Number	?
IS_NAME	Within I_SOURCE	string	Generally used with secrets, describes what the secret is about.
IS_REGION	Within I_SOURCE:REGION	Region type	Indicates what types regions are capable of performing this interaction. Can be specified multiple times. Valid values: ANY ANY_TERRAIN NORMAL_ALLOWED EVIL_ALLOWED GOOD_ALLOWED SAVAGE_ALLOWED EVIL_ONLY GOOD_ONLY SAVAGE_ONLY Region type - SWAMP, DESERT, FOREST, MOUNTAINS, OCEAN, LAKE, GLACIER, TUNDRA, GRASSLAND, HILLS
IS_SPHERE	Within I_SOURCE:SECRET	Sphere	Indicates the sphere to which this secret pertains.
IS_SECRET_GOAL	Within I_SOURCE:SECRET	Secret Goal token	Indicates why somebody would want to learn the secret. Valid values: IMMORTALITY
IS_SECRET	Within I_SOURCE:SECRET	Secret Flag	Indicates how the secret can be learned. Valid values: SUPERNATURAL_LEARNING_POSSIBLE - the secret can be learned by supernatural means MUNDANE_RESEARCH_POSSIBLE - the secret can be researched by mundane means MUNDANE_TEACHING_POSSIBLE - the secret can be taught to apprentices MUNDANE_RECORDING_POSSIBLE:objects/text/(book_title).txt:objects/text/(book_topic).txt - the secret can be written in books with the specified title.
IS_USAGE_HINT	Within I_SOURCE:DEITY	Usage Hint token	Indicates why a deity would choose to perform this interaction. Usually MAJOR_CURSE; GREETING, CLEAN_SELF, CLEAN_FRIEND, ATTACK, and FLEEING don't make sense here.
I_TARGET	Global	id, type	Specifies what things this interaction acts upon. Valid values: CORPSE CREATURE MATERIAL LOCATION
IT_LOCATION	Within I_TARGET	Location	Narrows down exactly what the interaction targets. Valid values: CONTEXT_REGION CONTEXT_CREATURE CONTEXT_ITEM CONTEXT_BP CONTEXT_LOCATION
IT_MANUAL_INPUT	Within I_TARGET	text	Tells the player what they should be selecting.
IT_MATERIAL	Within I_TARGET:MATERIAL	Type	Specifies the type of material the interaction targets. Valid values: 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 - Gets the material and breath attack from the relevant creature's CDI:MATERIAL token.
I_EFFECT	Global	type	Specifies what the interaction does to the targets. Valid values: ANIMATE RESURRECT ADD_SYNDROME CLEAN HIDE CONTACT MATERIAL_EMISSION
IE_TARGET	Within I_EFFECT	ID	Specifies which I_TARGET this effect will be applied to
IE_INTERMITTENT	Within I_EFFECT	Frequency	Indicates that the effect happens intermittently and specifies roughly how often. Valid values: WEEKLY
IE_IMMEDIATE	Within I_EFFECT		Indicates that the effect happens immediately.
IE_LOCATION	Within I_EFFECT	Location Hint	Indicates where the effect can take place. Valid values: IN_WATER IN_MAGMA NO_WATER NO_MAGMA
IE_ARENA_NAME	Within I_EFFECT	text	Allows the interaction to be applied to newly spawned creatures in Arena mode.
GENERATED	Global		Indicates that this is a generated interaction. Cannot be specified in user-defined raws.

See Also

• Syndrome