Creature examples

2020-03-11T15:46:21Z

IndigoFenix:

Syndrome examples

2020-03-10T15:54:33Z

IndigoFenix: /* Counter Trigger examples */

{{av}}

This page was created to aid those looking to create new syndromes. Those familiar with syndrome design(and [[DF2014:Syndrome#The_anatomy_of_a_syndrome|certain complexities in particular]]) should feel free to add helpful/obscure information to the lists below to help less-experienced members of the community with their syndromes.

The syndromes on this page can be applied through interactions, as creature actions, curses, blessings, or secrets, or through substances, including injected venoms, contact effects, or ingested foods. Examples on this page should operate the same regardless of application method.

==General Tips==

===Synchronizing Adventure and Fort Mode syndrome timers===
Fort mode runs 72 times faster than adventure mode - which means that a syndrome that lasts a single tick in Fort Mode will last 72 ticks in Adventure Mode. For short-term syndromes, this will cause very different behaviors between the two modes. In order to ensure that a syndrome operates the same way regardless of mode, add DWF_STRETCH:72 to the end of the CE effect tag.

It is not possible to make a syndrome that lasts shorter than 72 ticks in Adventure Mode.

===Making a creature with a syndrome always applied===
Some syndromes have effects that you can't add to a creature's basic RAW. To fix this, you can make a secretion that applies the syndrome to the creature's own species, and make it constantly secreted by one of the creature's internal organs.

==Stat Modifying Syndromes==
Syndromes that affect the creature's stats, particularly in combat.

===Size Modification===
BODY_APPEARANCE_MODIFIER not only changes the way a creature is described on the unit viewing screen - it also changes the combat effectiveness of the creature. The square-cube law is respected, meaning that doubling a creature's length, height, and broadness will make them 8 times as massive - an extreme boost in combat effectiveness. This does not affect the clothing they can wear.

{{gamedata|title=Giant Growth|
[SYNDROME]
[SYN_NAME:giant growth]
[CE_BODY_APPEARANCE_MODIFIER:APPEARANCE_MODIFIER:HEIGHT:200:APPEARANCE_MODIFIER:LENGTH:200:APPEARANCE_MODIFIER:BROADNESS:200:START:0]
}}

Also, you can change the size of particular body parts, with appropriate effects. The following syndrome, for example, will make the creature's punches more powerful (but it will not make their.scratches any stronger, because their fingers are still the same size).

{{gamedata|title=Hulk Hands|
[SYNDROME]
[SYN_NAME:freakishly big hands]
[CE_BP_APPEARANCE_MODIFIER:BP:BY_CATEGORY:HAND:APPEARANCE_MODIFIER:HEIGHT:300:APPEARANCE_MODIFIER:LENGTH:300:APPEARANCE_MODIFIER:BROADNESS:300:START:0]
}}

==Counter Trigger examples==
CE_COUNTER_TRIGGER is a fun token that lets you make syndromes with effects that activate under certain circumstances. You can use these to undo a different syndrome effect in order to make a syndrome operate differently in different circumstances.
Each counter trigger only affects the tag directly above it.

===More curse-like vampires===
There's no real reason not to become a vampire in vanilla DF, you don't even really need to drink blood. Let's change that by making a syndrome that weakens you if you don't drink blood, but makes you even stronger than vanilla vampires if you do.

{{gamedata|title=Double-Edged Vampire Curse|
[SYNDROME]
[SYN_NAME:vampire curse]
[CE_PHYS_ATT_CHANGE:STRENGTH:50:0:TOUGHNESS:50:0:AGILITY:50:0:ENDURANCE:50:0:DISEASE_RESISTANCE:50:0:START:0] <-- Weakens the target always
[CE_PHYS_ATT_CHANGE:STRENGTH:800:0:TOUGHNESS:800:0:AGILITY:800:0:ENDURANCE:800:0:DISEASE_RESISTANCE:800:0:START:0] <-- Strengthens the target after drinking blood
[CE:COUNTER_TRIGGER:DRINKING_BLOOD:50:NONE:REQUIRED]
}}

===Creatures that behave Differently Underground===
This is nice if you want to make an above-ground fort mode race, but don't want to actually restrict them to the surface. Instead, you can give them a mood penalty for staying underground for too long.
Note that the creature must have the CAVE_ADAPT tag in order for the CAVE_ADAPT counter trigger to work, and you will also need a constant secretion in order to ensure the syndrome is applied.

{{gamedata|title=Bad thoughts from spending more than a month underground example (Place this in creature raw)|
[CAVE_ADAPT]
[USE_MATERIAL_TEMPLATE:THOUGHTS:CREATURE_EXTRACT_TEMPLATE]
[SYNDROME]
[SYN_CONTACT]
[SYN_NAME:a lack of sunlight]
[SYN_AFFECTED_CREATURE:MY_CREATURE:ALL]
[CE_FEEL_EMOTION:EMOTION:GLUMNESS:SEV:50:START:0]
[CE:COUNTER_TRIGGER:CAVE_ADAPT:33600:NO_END:REQUIRED]
[SECRETION:LOCAL_CREATURE_MAT:THOUGHTS:LIQUID:BY_CATEGORY:BRAIN:ALL]
}}
You can do other things with this, like make a creature that gets extra abilities underground, or is stronger aboveground (by making the syndrome increase their strength normally, but reduce it using the counter trigger, similar to the vampire example).

{{Category|Modding}}

Syndrome examples

2020-03-10T14:39:06Z

IndigoFenix:

{{av}}

This page was created to aid those looking to create new syndromes. Those familiar with syndrome design(and [[DF2014:Syndrome#The_anatomy_of_a_syndrome|certain complexities in particular]]) should feel free to add helpful/obscure information to the lists below to help less-experienced members of the community with their syndromes.

The syndromes on this page can be applied through interactions, as creature actions, curses, blessings, or secrets, or through substances, including injected venoms, contact effects, or ingested foods. Examples on this page should operate the same regardless of application method.

==General Tips==

===Synchronizing Adventure and Fort Mode syndrome timers===
Fort mode runs 72 times faster than adventure mode - which means that a syndrome that lasts a single tick in Fort Mode will last 72 ticks in Adventure Mode. For short-term syndromes, this will cause very different behaviors between the two modes. In order to ensure that a syndrome operates the same way regardless of mode, add DWF_STRETCH:72 to the end of the CE effect tag.

It is not possible to make a syndrome that lasts shorter than 72 ticks in Adventure Mode.

===Making a creature with a syndrome always applied===
Some syndromes have effects that you can't add to a creature's basic RAW. To fix this, you can make a secretion that applies the syndrome to the creature's own species, and make it constantly secreted by one of the creature's internal organs.

==Stat Modifying Syndromes==
Syndromes that affect the creature's stats, particularly in combat.

===Size Modification===
BODY_APPEARANCE_MODIFIER not only changes the way a creature is described on the unit viewing screen - it also changes the combat effectiveness of the creature. The square-cube law is respected, meaning that doubling a creature's length, height, and broadness will make them 8 times as massive - an extreme boost in combat effectiveness. This does not affect the clothing they can wear.

{{gamedata|title=Giant Growth|
[SYNDROME]
[SYN_NAME:giant growth]
[CE_BODY_APPEARANCE_MODIFIER:APPEARANCE_MODIFIER:HEIGHT:200:APPEARANCE_MODIFIER:LENGTH:200:APPEARANCE_MODIFIER:BROADNESS:200:START:0]
}}

Also, you can change the size of particular body parts, with appropriate effects. The following syndrome, for example, will make the creature's punches more powerful (but it will not make their.scratches any stronger, because their fingers are still the same size).

{{gamedata|title=Hulk Hands|
[SYNDROME]
[SYN_NAME:freakishly big hands]
[CE_BP_APPEARANCE_MODIFIER:BP:BY_CATEGORY:HAND:APPEARANCE_MODIFIER:HEIGHT:300:APPEARANCE_MODIFIER:LENGTH:300:APPEARANCE_MODIFIER:BROADNESS:300:START:0]
}}

==Counter Trigger examples==
CE_COUNTER_TRIGGER is a fun token that lets you make syndromes with effects that activate under certain circumstances. You can use these to undo a different syndrome effect in order to make a syndrome more of a double-edged sword.

===More curse-like vampires===
There's no real reason not to become a vampire in vanilla DF, you don't even really need to drink blood. Let's change that by making a syndrome that weakens you if you don't drink blood, but makes you even stronger than vanilla vampires if you do.

{{gamedata|title=Vampire Curse|
[SYNDROME]
[SYN_NAME:vampire curse]
[CE_PHYS_ATT_CHANGE:STRENGTH:50:0:TOUGHNESS:50:0:AGILITY:50:0:ENDURANCE:50:0:DISEASE_RESISTANCE:50:0:START:0]
[CE_PHYS_ATT_CHANGE:STRENGTH:800:0:TOUGHNESS:800:0:AGILITY:800:0:ENDURANCE:800:0:DISEASE_RESISTANCE:800:0:START:0]
[CE:COUNTER_TRIGGER:DRINKING_BLOOD:50:NONE:REQUIRED]
}}

{{Category|Modding}}

Creature examples

2020-03-07T23:08:37Z

IndigoFenix:

{{av}}

This page was created to aid those looking to create new creatures. Those familiar with creature raws should feel free to add helpful/obscure information to the lists below to help members of the community less experienced with creatures.

==Dummy creatures==
Creatures that are not intended to function in general gameplay, but are used as references or in interactions.(the latter of which can mostly be found [[DF2014:interaction examples|here]])

===Material Resource Creature===
Sometimes, you will want to use a custom material in an interaction that is not related to any specific creature or stone. In general, however, you should avoid creating INORGANIC materials that are not intended to be regular stone or metal. Although the [SPECIAL] tag will prevent it from appearing in most places, titans and forgotten beasts can still be composed of it, which will often cause things like creatures wandering onto the site and instantly exploding. Instead, create a dummy creature to store any special materials, and reference that creature instead.

{{gamedata|title=Material resource creature|
[CREATURE:MATERIALS]
[NAME:creature:creatures:creature]
[CASTE_NAME:creature:creatures:creature]
[DESCRIPTION:A living being of unknown description.]
[ARENA_RESTRICTED]
[DOES_NOT_EXIST]
[USE_MATERIAL_TEMPLATE:BLOOD:BLOOD_TEMPLATE][PREFIX:NONE]
[USE_MATERIAL_TEMPLATE:BURNING:STONE_TEMPLATE][PREFIX:NONE][STATE_NAME_ADJ:SOLID:flame magic][MELTING_POINT:0][BOILING_POINT:1][MAT_FIXED_TEMP:35000][DISPLAY_COLOR:6:0:1]
[USE_MATERIAL_TEMPLATE:BURNING_STRONG:STONE_TEMPLATE][PREFIX:NONE][STATE_NAME_ADJ:SOLID:flame magic][MELTING_POINT:0][BOILING_POINT:1][MAT_FIXED_TEMP:90000][DISPLAY_COLOR:6:0:1]
[USE_MATERIAL_TEMPLATE:FREEZING:SWEAT_TEMPLATE][STATE_NAME:ALL:ice magic][STATE_ADJ:ALL:frigid][ENTERS_BLOOD][PREFIX:NONE][STATE_COLOR:ALL:WHITE][DISPLAY_COLOR:7:0:1][EVAPORATES][MELTING_POINT:NONE][BOILING_POINT:4000][HEATDAM_POINT:4001][SPEC_HEAT:1]
}}

===Instantly-evaporating Creature===
To make a creature instantly "poof" into a fine mist, you can transform them into this. You can also give it an ITEMCORPSE if you want it to leave an item behind.

{{gamedata|title=Instantly evaporating creature|
[CREATURE:POOF]
[ARENA_RESTRICTED]
[DOES_NOT_EXIST]
[DESCRIPTION:A creature that has evaporated.]
[NAME:fine mist:fine mists:fine mist]
[CASTE_NAME:fine mist:fine mists:fine mist]
[CREATURE_TILE:250][COLOR:0:0:0]
[NOT_BUTCHERABLE]
[BODY:BASIC_1PARTBODY]
[USE_MATERIAL_TEMPLATE:BREAK:CREATURE_EXTRACT_TEMPLATE]
[STATE_NAME:ALL:mist]
[STATE_COLOR:ALL:BLACK]
[MELTING_POINT:0]
[BOILING_POINT:1]
[HEATDAM_POINT:NONE]
[COLDDAM_POINT:NONE]
[PREFIX:NONE]
[TISSUE:BREAK]
[TISSUE_NAME:mist:NP]
[TISSUE_MATERIAL:LOCAL_CREATURE_MAT:BREAK]
[CONNECTS]
[FUNCTIONAL]
[STRUCTURAL]
[TISSUE_MAT_STATE:SOLID]
[TISSUE_SHAPE:LAYER]
[VASCULAR:50]
[TISSUE_LAYER:BY_CATEGORY:ALL:BREAK]
[BLOOD:LOCAL_CREATURE_MAT:BREAK:LIQUID]
[IMMOBILE]
[BODY_SIZE:0:0:1]
}}

==Creatures with unusual physiology==

===Creature made of plants===
Apart from having a plant-based physiology, this creature also has body parts that are converted into actual plants when butchered.
This example uses two types of tissues. You can easily make an entire creature out of different kinds of plants, and the larger body parts will give you more plants.
This can be very useful, as plants are used in different kinds of interactions than animal parts are. For example, you can use this trick to get booze or thread from an animal's body parts.
You will require both a creature raw file and a plant raw file for this to work.

{{gamedata|title=Plant-based creature (Creature raw)|
[CREATURE:FLEURBERRI_AMT]
[DESCRIPTION:A large sun-loving creature, made up of a mixture of plant and animal tissues. Its heart is a valuable berry.]
[NAME:fleurberri:fleurberris:fleurberri]
[CASTE_NAME:fleurberri:fleurberris:fleurberri]
[CREATURE_TILE:'F'][COLOR:2:0:1]
[LARGE_ROAMING]
[NOBONES]
[NATURAL][BENIGN]
[MEANDERER]
[BIOME:GRASSLAND_TEMPERATE]
[BIOME:SHRUBLAND_TEMPERATE]
[BIOME:SAVANNA_TEMPERATE]
[POPULATION_NUMBER:15:30]
[CLUSTER_NUMBER:3:5]
[FREQUENCY:50]
[PREFSTRING:juicy berries]
[BODY:QUADRUPED:BRAIN:SPINE:2EYES:MOUTH:HEART]
[BODY_DETAIL_PLAN:STANDARD_HEAD_POSITIONS]
[BODY_DETAIL_PLAN:STANDARD_MATERIALS]
[BODY_DETAIL_PLAN:STANDARD_TISSUES]
[USE_MATERIAL_TEMPLATE:WOOD:WOOD_TEMPLATE]
[BUTCHER_SPECIAL:WOOD:NONE] <--This will cause the wood body parts to become logs when butchered.
[TISSUE:CORTEX]
[TISSUE_NAME:cortex:NP]
[THICKENS_ON_ENERGY_STORAGE]
[SCARS]
[TISSUE_MATERIAL:PLANT_MAT:FLEURBERRI_PLANT_AMT:STRUCTURAL] <--This is the line to make the body part out of plant. The plant must also have a BUTCHER_SPECIAL:PLANT:NONE tag for this to work.
[RELATIVE_THICKNESS:1]
[HEALING_RATE:100]
[VASCULAR:3]
[PAIN_RECEPTORS:5]
[CONNECTS]
[TISSUE_SHAPE:LAYER]
[SETTABLE]
[SPLINTABLE]
[TISSUE:PLANT]
[TISSUE_NAME:vascular tissue:NP]
[THICKENS_ON_ENERGY_STORAGE]
[SCARS]
[TISSUE_MATERIAL:PLANT_MAT:FLEURBERRI_PLANT_AMT:STRUCTURAL]
[RELATIVE_THICKNESS:1]
[HEALING_RATE:100]
[VASCULAR:3]
[PAIN_RECEPTORS:5]
[CONNECTS]
[TISSUE_SHAPE:LAYER]
[SETTABLE]
[SPLINTABLE]
[TISSUE:PITH]
[TISSUE_NAME:pith:NP]
[ARTERIES]
[FUNCTIONAL]
[TISSUE_MATERIAL:LOCAL_CREATURE_MAT:WOOD]
[RELATIVE_THICKNESS:2]
[VASCULAR:5]
[PAIN_RECEPTORS:50]
[CONNECTS]
[TISSUE_SHAPE:LAYER]
[TISSUE:BERRY] <--Define the plant-based tissue here.
[TISSUE_NAME:berry:NP]
[FUNCTIONAL]
[STRUCTURAL]
[SCARS]
[TISSUE_MATERIAL:PLANT_MAT:FLEURBERRI_BERRY_AMT:STRUCTURAL] <-- A different kind of plant. Use as many types as you want.
[RELATIVE_THICKNESS:1]
[HEALING_RATE:100]
[VASCULAR:10]
[PAIN_RECEPTORS:5]
[CONNECTS]
[TISSUE_SHAPE:LAYER]
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:CORTEX:NONE:PLANT:PITH:NONE]
[SELECT_TISSUE_LAYER:ALL:BY_CATEGORY:HEART]
[SET_LAYER_TISSUE:BERRY] <--This will set the selected layer or layers as the plant-based tissue.
[TL_MAJOR_ARTERIES]
[USE_MATERIAL_TEMPLATE:SAP:PLANT_EXTRACT_TEMPLATE]
[STATE_NAME_ADJ:ALL:sap]
[BLOOD:LOCAL_CREATURE_MAT:SAP:LIQUID]
[CREATURE_CLASS:PLANT]
[BODY_SIZE:0:0:50000]
[BODY_SIZE:1:0:100000]
[BODY_SIZE:2:0:400000]
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110]
[BODY_APPEARANCE_MODIFIER:BROADNESS:90:95:98:100:102:105:110]
[APPLY_CREATURE_VARIATION:MOUTH_BITE_ATTACK]
[APPLY_CREATURE_VARIATION:KICK_ATTACK]
[MAXAGE:10:20]
[DIURNAL]
[CASTE:FEMALE]
[FEMALE]
[MULTIPLE_LITTER_RARE]
[CASTE:MALE]
[MALE]
[SET_TL_GROUP:BY_CATEGORY:ALL:CORTEX]
[TL_COLOR_MODIFIER:PINK:1:GREEN:5]
[TLCM_NOUN:body:SINGULAR]
}}

{{gamedata|title=Plant based creature (Plant raw)|
Fleurberri plants and berries: Found inside a FLEURBERRI_AMT creature.
They work exactly like regular plant, the only difference is that their structural material have a BUTCHER_SPECIAL tag.
You can make a creature entirely out of plants. You can even give the plants meat-like names and make them out of meat to get brewable 'meat'. (They will still be stockpiled as plants though.)

[PLANT:FLEURBERRI_PLANT_AMT]
[NAME:fleurberri strip]
[NAME_PLURAL:fleurberri strips]
[ADJ:fleur berry]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[MATERIAL_VALUE:1]
[EDIBLE_VERMIN]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[BUTCHER_SPECIAL:PLANT:NONE] <-- This is the important part!
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[PICKED_TILE:21]
[PICKED_COLOR:2:0:1]
[USE_MATERIAL_TEMPLATE:MILL:PLANT_POWDER_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:fleurberri flour]
[STATE_COLOR:ALL_SOLID:GREEN]
[DISPLAY_COLOR:2:0:1]
[MATERIAL_VALUE:20]
[EDIBLE_VERMIN]
[EDIBLE_COOKED]
[PREFIX:NONE]
[MILL:LOCAL_PLANT_MAT:MILL]
[WET]
[DRY]
[VALUE:5]
[PREFSTRING:crunch]

[PLANT:FLEURBERRI_BERRY_AMT]
[NAME:fleur berry]
[NAME_PLURAL:fleur berries]
[ADJ:fleur berry]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[MATERIAL_VALUE:10]
[EDIBLE_VERMIN]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[BUTCHER_SPECIAL:PLANT:NONE] <-- This is the important part!
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[PICKED_TILE:58]
[PICKED_COLOR:4:0:1]
[WET]
[DRY]
[VALUE:15]
[USE_MATERIAL_TEMPLATE:DRINK:PLANT_ALCOHOL_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:frozen fleurberri wine]
[STATE_NAME_ADJ:LIQUID:fleurberri wine]
[STATE_NAME_ADJ:GAS:boiling fleurberri wine]
[MATERIAL_VALUE:15]
[DISPLAY_COLOR:4:0:1]
[EDIBLE_RAW]
[EDIBLE_COOKED]
[PREFIX:NONE]
[DRINK:LOCAL_PLANT_MAT:DRINK]
[PREFSTRING:rarity]
}}

{{Category|Modding}}

IndigoFenix: Added a lot of missing info and useful information on interaction usage.

{{av}}

The following tokens can be used to define and use interactions.

==Interaction Definitions==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Context
! Arguments
! Description

|-
| I_SOURCE
| Global
| type
| Defines what things are capable of triggering this interaction. Can be specified multiple times. Valid values:
* REGION - The interaction takes place in particular types of regions in the world.
* UNDERGROUND_SPECIAL - The interaction takes place in [[Demonic fortress|curious underground structure]]s.
* SECRET - The interaction is a secret that can be learned by particular individuals.
* DISTURBANCE - The interaction is triggered when disturbing a [[tomb]].
* DEITY - The interaction is inflicted upon mortals by the gods.
* ATTACK - The interaction is triggered by an attack during combat.
* INGESTION - The interaction is triggered by eating or drinking something.
* CREATURE_ACTION - The interaction is triggered by an explicit 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 targeted 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
| Presumably, the probability of biome specified by [IS_REGION] to have this interaction.

|-
| 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. See CDI:USAGE_HINT below for valid values - in this context, MAJOR_CURSE is the only value that makes sense.

|-
| I_TARGET
| Global
| id, type
| Specifies what things this interaction acts upon. Can be specified multiple times. Valid values:
* CORPSE - Also includes pieces of corpses
* CREATURE
* MATERIAL
* LOCATION

|-
| IT_LOCATION
| Within I_TARGET
| Location
| Narrows down exactly what the interaction targets. Valid values:
* CONTEXT_REGION - Can only be used by IS_REGION interactions.
* CONTEXT_CREATURE
* CONTEXT_ITEM - Used when the target is a CORPSE.
* CONTEXT_BP - Use body part from CDI:BP_REQUIRED token (below).
* CONTEXT_LOCATION

|-
| IT_MANUAL_INPUT
| Within I_TARGET
| text
| Tells the player what they should be selecting.

|-
| IT_AFFECTED_CREATURE
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| ?
| Specifies specific creatures the interaction can target.

|-
| IT_AFFECTED_CLASS
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature class
| Specifies creature classes the interaction can target.

|-
| IT_IMMUNE_CREATURE
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| ?
| Specifies specific creatures the interaction cannot target.

|-
| IT_IMMUNE_CLASS
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature class
| Specifies creature classes the interaction cannot target.

|-
| IT_REQUIRES
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature token or property
| Indicates that the target must have the specified property. Valid values:
* FIT_FOR_ANIMATION - Any corpse or body part that can become a zombie (heads, hands, etc.)
* FIT_FOR_RESURRECTION - The target corpse's UPPERBODY must be attached.
* HAS_BLOOD
* MORTAL
* NO_AGING
* STERILE
* Creature token: BLOODSUCKER, CAN_LEARN, CAN_SPEAK, CRAZED, EXTRAVISION, LIKES_FIGHTING (or LIKESFIGHTING), MISCHIEVOUS (or MISCHIEVIOUS), NO_CONNECTIONS_FOR_MOVEMENT, NO_DIZZINESS, NO_DRINK, NO_EAT, NO_FEVERS, NO_PHYS_ATT_GAIN, NO_PHYS_ATT_RUST, NO_SLEEP, NO_THOUGHT_CENTER_FOR_MOVEMENT, NOBREATHE, NOEMOTION, NOEXERT, NOFEAR, NONAUSEA, NOPAIN, NOSTUN, NOT_LIVING, NOTHOUGHT, OPPOSED_TO_LIFE, PARALYZEIMMUNE, SUPERNATURAL, TRANCES, UTTERANCES

|-
| IT_FORBIDDEN
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature token or property
| Indicates that the target must not have the specified property. Valid values are the same as for IT_REQUIRES.

|-
| IT_CANNOT_TARGET_IF_ALREADY_AFFECTED
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
|
| Prevents the interaction from targeting a creature that's already under the effect of the same interaction.

|-
| IT_CANNOT_HAVE_SYNDROME_CLASS
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| [[Syndrome]] class
| Prevents the interaction from targeting a creature under the effects of a syndrome having the specified SYN_CLASS value.

|-
| 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 - Use material from CDI:MATERIAL token (below).

|-
| I_EFFECT
| Global
| type
| Specifies what the interaction does to the targets. Can be specified multiple times. Valid values:
* ANIMATE - Raises the target corpse/bodypart as a zombie. 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.
* RESURRECT - 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.
* ADD_SYNDROME - Adds one or more syndromes. The actual syndrome is specified with the [SYNDROME] tag.
* CLEAN - Cleans off most liquids/dust covering the creature.
* HIDE - Allows the creature to hide even if another creature can see it.
* CONTACT - Causes the creatures to touch. The interaction's range must be TOUCHABLE.
* MATERIAL_EMISSION - Used within the MATERIAL_EMISSION interaction.

|-
| 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.

|-
| IE_GRIME_LEVEL
| Within I_EFFECT:CLEAN
| amount?
| [IE_GRIME_LEVEL:2] appears in the default cleaning interaction, and may indicate amount of grime cleaned.

|-
| IE_SYNDROME_TAG
| Within I_EFFECT:CLEAN
| Syndrome flag
| Indicates that cleaning off materials will activate their syndromes if they have this flag.

|-
| GENERATED
| Global
|
| Indicates that this is a generated interaction. Cannot be specified in user-defined raws.

|}

==Interaction Usage==
In order to actually use an interaction, add the [[creature token]] [CAN_DO_INTERACTION:NAME] 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:
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| INTERACTION
| 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.

|-
| TARGET
| target ID, target types
| Specifies how the creature chooses what to . Target ID refers to an I_TARGET defined in the interaction itself. Multiple target types can be specified. Valid target types:
* LINE_OF_SIGHT - the source needs to be able to see the target
* TOUCHABLE - the source needs to be able to touch the target
* DISTURBER_ONLY - the target must be whoever disturbed the source
* SELF_ALLOWED - the target can be the source
* SELF_ONLY - the target '''must''' be the source

|-
| TARGET_RANGE
| target ID, range
| Specifies how far away the target can be, in tiles.

|-
| LOCATION_HINT
| Location Hint (see above)
| ?

|-
| USAGE_HINT
| Usage hint token
| Indicates when and how CPU-controlled creatures will use the interaction. Valid values:
* MAJOR_CURSE - Used in disturbance curses and deity curses. Targets the tomb disturber/temple defiler.
* 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.
* FLEEING - Used when fleeing an enemy. Creature will target itself.

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

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

|-
| WAIT_PERIOD
| number
| Controls how often the interaction can be used.

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

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

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

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

|-
| VERB
| self:other:mutual
| When a creature uses the interaction, a message will display, describing the source as doing this.

|-
| VERB_REVERSE
| ?
| ?

|-
| TARGET_VERB
| self:other
| When a creature uses the interaction, a message will display, describing the target as doing this.

|-
| BP_REQUIRED
| Body part criteria
| 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.

|-
| FLOW
| Breath attack token
| Causes the interaction to create an effect not made of any material. Only makes sense for FIREBALL, FIREJET, or DRAGONFIRE.

|-
| MATERIAL
| [[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.

|}

==See Also==
* [[Syndrome]]

{{Category|Modding}}
{{Category|Tokens}}

v0.34:Interaction token

2012-10-01T17:21:04Z

IndigoFenix: Additional info on VERBAL tag

{{av}}

The following tokens can be used to define and use interactions.

==Interaction Definitions==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Context
! Arguments
! Description

|-
| I_SOURCE
| Global
| type
| Defines what things are capable of triggering this interaction. Can be specified multiple times. Valid values:
* REGION - The interaction takes place in particular types of regions in the world.
* UNDERGROUND_SPECIAL - The interaction takes place in [[Demonic fortress|curious underground structure]]s.
* SECRET - The interaction is a secret that can be learned by particular individuals.
* DISTURBANCE - The interaction is triggered when disturbing a [[tomb]].
* DEITY - The interaction is inflicted upon mortals by the gods.
* ATTACK - The interaction is triggered by an attack during combat.
* INGESTION - The interaction is triggered by eating or drinking something.
* CREATURE_ACTION - The interaction is triggered by an explicit 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 targeted 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
| Presumably, the probability of biome specified by [IS_REGION] to have this interaction.

|-
| 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. See CDI:USAGE_HINT below for valid values - in this context, MAJOR_CURSE is the only value that makes sense.

|-
| I_TARGET
| Global
| id, type
| Specifies what things this interaction acts upon. Can be specified multiple times. 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 - Use body part from CDI:BP_REQUIRED token (below).
* CONTEXT_LOCATION

|-
| IT_MANUAL_INPUT
| Within I_TARGET
| text
| Tells the player what they should be selecting.

|-
| IT_AFFECTED_CREATURE
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| ?
| Specifies specific creatures the interaction can target.

|-
| IT_AFFECTED_CLASS
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature class
| Specifies creature classes the interaction can target.

|-
| IT_IMMUNE_CREATURE
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| ?
| Specifies specific creatures the interaction cannot target.

|-
| IT_IMMUNE_CLASS
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature class
| Specifies creature classes the interaction cannot target.

|-
| IT_REQUIRES
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature token or property
| Indicates that the target must have the specified property. Valid values:
* FIT_FOR_ANIMATION
* FIT_FOR_RESURRECTION
* HAS_BLOOD
* MORTAL
* NO_AGING
* STERILE
* Creature token: BLOODSUCKER, CAN_LEARN, CAN_SPEAK, CRAZED, EXTRAVISION, LIKES_FIGHTING (or LIKESFIGHTING), MISCHIEVOUS (or MISCHIEVIOUS), NO_CONNECTIONS_FOR_MOVEMENT, NO_DIZZINESS, NO_DRINK, NO_EAT, NO_FEVERS, NO_PHYS_ATT_GAIN, NO_PHYS_ATT_RUST, NO_SLEEP, NO_THOUGHT_CENTER_FOR_MOVEMENT, NOBREATHE, NOEMOTION, NOEXERT, NOFEAR, NONAUSEA, NOPAIN, NOSTUN, NOT_LIVING, NOTHOUGHT, OPPOSED_TO_LIFE, PARALYZEIMMUNE, SUPERNATURAL, TRANCES, UTTERANCES

|-
| IT_FORBIDDEN
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature token or property
| Indicates that the target must not have the specified property. Valid values are the same as for IT_REQUIRES.

|-
| IT_CANNOT_TARGET_IF_ALREADY_AFFECTED
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
|
| Prevents the interaction from targeting a creature that's already under the effect of the same interaction.

|-
| IT_CANNOT_HAVE_SYNDROME_CLASS
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| [[Syndrome]] class
| Prevents the interaction from targeting a creature under the effects of a syndrome having the specified SYN_CLASS value.

|-
| 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 - Use material from CDI:MATERIAL token (below).

|-
| I_EFFECT
| Global
| type
| Specifies what the interaction does to the targets. Can be specified multiple times. 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.

|-
| IE_GRIME_LEVEL
| Within I_EFFECT:CLEAN
| amount?
| [IE_GRIME_LEVEL:2] appears in the default cleaning interaction, and may indicate amount of grime cleaned.

|-
| IE_SYNDROME_TAG
| Within I_EFFECT:CLEAN
| Syndrome flag
| Indicates that cleaning off materials will activate their syndromes if they have this flag.

|-
| GENERATED
| Global
|
| Indicates that this is a generated interaction. Cannot be specified in user-defined raws.

|}

==Interaction Usage==
In order to actually use an interaction, add the [[creature token]] [CAN_DO_INTERACTION:NAME] 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:
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| INTERACTION
| 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.

|-
| TARGET
| target ID, target types
| Specifies how the creature chooses what to . Target ID refers to an I_TARGET defined in the interaction itself. Multiple target types can be specified. Valid target types:
* LINE_OF_SIGHT - the source needs to be able to see the target
* TOUCHABLE - the source needs to be able to touch the target
* DISTURBER_ONLY - the target must be whoever disturbed the source
* SELF_ALLOWED - the target can be the source
* SELF_ONLY - the target '''must''' be the source

|-
| TARGET_RANGE
| target ID, range
| Specifies how far away the target can be, in tiles.

|-
| LOCATION_HINT
| Location Hint (see avove)
| ?

|-
| USAGE_HINT
| Usage hint token
| Indicates how the interaction is to be used. Valid values:
* MAJOR_CURSE
* GREETING
* CLEAN_SELF
* CLEAN_FRIEND
* ATTACK
* FLEEING

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

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

|-
| WAIT_PERIOD
| number
| Controls how often the interaction can be used.

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

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

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

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

|-
| VERB
| self:other:mutual
| When a creature uses the interaction, a message will display, describing the source as doing this.

|-
| VERB_REVERSE
| ?
| ?

|-
| TARGET_VERB
| plural:singular
| When a creature uses the interaction, a message will display, describing the target as doing this.

|-
| BP_REQUIRED
| Body part criteria
| 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.

|-
| FLOW
| Breath attack token
| Causes the interaction to create an effect not made of any material. Only makes sense for FIREBALL, FIREJET, or DRAGONFIRE.

|-
| MATERIAL
| [[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.

|}

==See Also==
* [[Syndrome]]

{{Category|Modding}}
{{Category|Tokens}}