Game definition jsons - Effect definition json

[Stratego (dev)]

Here is how to create effect definitions (that can be used in "spell" or ability section of a unit json)

effect behaviours:

INSTANT, //SPELL immediate and permanent kind and no long lasting effects
ENCHANTMENT, //EFFECT long lasting modifier, but activates only on the first turn, when removed the modifications are undoed (need to save or something), should not be special ability like convert
ENCHANTMENT_VANISHING, //EFFECT long lasting modifier, but activates only on the first turn, when wears off or removed the modifications are undoed (need to save or something), should not be special ability like convert
INSTANT_REPETITIVE_VANISHING, //EFFECT on impact, and each turn it executes (eg. poisoning), when vanished unit remains as it is (no regaining abilities).
REPETITIVE_VANISHING, //EFFECT on impact does nothing, but each turn it executes (eg. poisoning), when vanished unit remains as it is (no regaining abilities).
REPETITIVE_VANISHING_ENCHANTMENT, //EFFECT on impact does nothing, but each turn it executes (eg. slowing), when vanished unit regains its old abilities
SUSPENDED, //EFFECT does nothing on impact and nothing on countdown, but at the end it executes the effect (eg. delayed conversion), permanent
TRIGGERED_EFFECT, //EFFECT says : no execute, only on trigger.
EFFECT_SPELL, // only places an effect of a different effectID (giving lifelink)
AURA_EFFECT //EFFECT says : no execute, only on AURA TRIGGERS. (an aura)

possible target types:

HIMSELF,
FRIENDLY,
FRIENDLY_BUT_NOT_ME,
ENEMY,
ENEMY_OR_FRIENDLY,
ENEMY_OR_FRIENDLY_BUT_NOT_ME,

special cost options:

SACRIFICE_UNIT, // spell that requires specCostNr number of nearby corpse (consumes it) to be casted
SACRIFICE_HP_AMOUNT,
SACRIFICE_POWER_AMOUNT,
NEARBY_CORPSE, // spell that requires specCostNr number of nearby corpse (consumes it) to be casted
ACTION_POINT //if set than it requires extra action points or even 0 action point, altering the default 1 action cost

also you specify unit types in trnSpecCostTypeList

system special effects

public static final int SYSTEM_SPECIAL_EFFECT_CONVERT = 100;
public static final int SYSTEM_SPECIAL_EFFECT_HEAL = 101;
public static final int SYSTEM_SPECIAL_EFFECT_DISENCHANT = 102;
public static final int SYSTEM_SPECIAL_EFFECT_SUMMON = 103;
public static final int SYSTEM_SPECIAL_EFFECT_REGENERATION = 104;



public static final int SYSTEM_SPECIAL_EFFECT_FORESTWALK = 108;
public static final int SYSTEM_SPECIAL_EFFECT_MOUNTAINWALK = 109;
public static final int SYSTEM_SPECIAL_EFFECT_WATERWALK = 110;
public static final int SYSTEM_SPECIAL_EFFECT_AIRWALK = 111;

public static final int SYSTEM_SPECIAL_EFFECT_TRANSFORM1 = 112;
public static final int SYSTEM_SPECIAL_EFFECT_ANIMATE_DEAD = 113;

public static final int SYSTEM_SPECIAL_EFFECT_ENVIRONMENTAL = 114; //An instant spell that casts a lightning storm, or fireball storm or ice storm - effects in a radius with a special randomization
public static final int SYSTEM_SPECIAL_EFFECT_DISABLE = 115;

public static final int SYSTEM_SPECIAL_EFFECT_LASTSTURN_MODIFIER = 116; // a spell that will modify the lasts turn nr of a running effect on target unit
public static final int SYSTEM_SPECIAL_EFFECT_SUMMON_IMMEDIATE = 117;
public static final int SYSTEM_SPECIAL_EFFECT_RELOCATE = 118; // used to "teleport" the caster unit to the target location, target is read by the green environmental floating action.
public static final int SYSTEM_SPECIAL_EFFECT_REVEAL = 119; // used to reveal a spot on target location, target is read by the green environmental floating action.

Specs Other special settings in a list called "specs" you set these in "trnSpecs":

BYPASS_SPELL_RESISTANCE, // set this to make the spell to be an ability that is not reduced by spell resistance at all (update: any resistance)
RESISTED_BY_DODGE_MELEE, // probability is calculated as dodge melee is calculated
RESISTED_BY_DODGE_RANGED, // probability is calculated as dodge ranged is calculated
RESISTED_BY_HP, // probability is calculated based on DEFINE_UNIT_BIG_HP_VALUE and unit hp
RESISTED_BY_POWER, // probability is calculated based on DEFINE_UNIT_BIG_POWER_VALUE and unit hp
IS_NEGATIVE_EFFECT, // set this to make the effect a negative one like slowing (if not set than considered positive like strengthening), now in AOF disenchant uses if it wants to remove effect or not
IS_EFFECT_RANGE_ABSOLUTE, // if set than effect has ablsolute range - independent from caster spell range.
IS_COOLDOWN_ON_SPAWN, // if set AND it has cooldown, than the cooldown will start right on unit spawning
AMOUNT_BY_STRENGTH, // if set than the caster unit's strength will mutiply the "effect" (effect will run this many times)
AMOUNT_BY_HP, // if set than the caster unit's hp will mutiply the "effect" (effect will run this many times)
IS_TERRAIN_SOURCE, // this effect is from a terrain affection (like in woods foot units can have +1 defense)
WEARS_OFF_AFTER_MOVE, // the effect (if on unit as a enchantment) will wears off after unit moves
WEARS_OFF_AFTER_ATTACK, // the effect (if on unit as a enchantment) will wears off after unit attacs
WEARS_OFF_AFTER_ABILITY_USE, // the effect (if on unit as a enchantment) will wears off after unit uses spell or ability

Summon or Place effect

Here the effect will spawn an other "unit" on pressing the effect button of the "caster" unit, it will start floating like the elf wolf does.
living samples:
- aof: elf wolf, skeleton dragon + orc dragon etc.
- aow: sea mines

{
"effectNameString":"EFFECT_INSTANT_SUMMON_WOLF", ---------------------- effect name
"effectDefID":126,------------------------------------------------------------------effect id
"trnActionUnitID":"UNIT_GER_BLD_WATER_MINES",---------------------which unit to summon ("NO_UNIT" means "unset" value)
"trnActionUnitIDForCaster":"NO_UNIT",--------------------------------------------which effect to apply on caster after casting (ef. losing health) ("NO_UNIT" means "unset" value)

"buttonTextureID":0,----------------------------------------------------------------[OBSOLETE, use trnButtonTextureID]for unique button (if the deafult the summoned unit image is not good enough)
"actionTextureID":0,-----------------------------------------------------------------[OBSOLETE, use trn*...]not used here

"chancePercent":1.0,----------------------------------------------------------------chance of casting the spell, here use 1=100% if you want to be always
// Also on WEAPON_SLOT_1,WEAPON_EFFECT_SLOT_HEAL the probability to take effect on targeted/damaged unit (eg. is weapon fire effect sticks on enemy or not)
"lastsTurnNr":0,-----------------------------------------------------------------------not used here

"effectBehaviour":"INSTANT",--------------------------------------------------------effect behaviour (see above)
"effectTargets":"HIMSELF",-----------------------------------------------------------tagert types (see above)
"trnSystemSpecialEffectID":"SYSTEM_SPECIAL_EFFECT_SUMMON ",-----------Special effects (see above), here this is the summon unit

"trnTransformTo" ----------------------------------------------------------------------transformation ID, used for case of SYSTEM_SPECIAL_EFFECT_TRANSFORM1, if null than the Unit.transformTo1 value will be used


"isOneTimeSpell":false,---------------------------------------------------------------If canster can cast it on only once in his lifetime
"castRangeModifier":0,---------------------------------------------------------------- it can modify the spell range relative to caster default spellrange (eg +3)
"cooldownTurnNr":0,------------------------------------------------------------------If you want the spell has cooldown (caster needs to wait X turns before casting it again.)

"specCost":null,-------------------------------------------------------------------------special cost type (see above)
"specCostNr":1,--------------------------------------------------------------------------special cost amount (eg. 3 nearby corpses)
"trnSpecCostTypeList":null,------------------------------------------------------------- special cost type listt to be sacrificed: eg you can list only goblins, by category or specify exact types
"trnRequires":null,-----------------------------------------------------------------------required techs to be owned before use this effect

"priority":0-------------------------------------------------------------------------------The priority the AI should use when selecting weapons against targets: 0 for irrelevant ones, about 900 on strongest effects, 100-800 the average effects

}

FULL TEMPLATE: just a full template ------

{
"effectNameString":"EFFECT_INSTANT_SUMMON_WOLF", ---------------------- effect name
"effectDefID":126,------------------------------------------------------------------effect id
"effectDefIDRelated":0,------------------------------------------------------------ not used here
"propertyChangerUnitID":308,-----------------------------------------------------which unit to summon (with id)
"propertyChangerUnitIDForCaster":-1,--------------------------------------------which effect to apply on caster after casting (ef. losing health) (-1 means nothing)

"trnIndicatorTextureID":"SOME_TEXTURE_ID",-------------------------------------------------------------use the texture "idString" here to reference
"trnButtonTextureID":null,----------------------------------------------------------------use the texture "idString" here to reference - for unique button (if the deafult the summoned unit image is not good enough - *more details below)
"buttonTextureWithBackground":false,-----------------------------------------------if set, if set you can explicitely tell the engine if the button is with or without button background
"trnProjectileSpriteID":null,---------------------------------------------------------------use the sprite "idString" here to reference
"trnActionTextureID":null,-----------------------------------------------------------------use the texture "idString" here to reference
"trnSpotAnimationSpriteID":null,----------------------------------------------------------use the sprite "idString" here to reference

"chancePercent":1.0,----------------------------------------------------------------chance of casting the spell, here use 1=100% if you want to be always, // Also on WEAPON_SLOT_1,WEAPON_EFFECT_SLOT_HEAL the probability to take effect on targeted/damaged unit (eg. is weapon fire effect sticks on enemy or not)
"lastsTurnNr":0,-----------------------------------------------------------------------not used here

"effectBehaviour":"INSTANT",--------------------------------------------------------effect behaviour (see above)
"effectTargets":"HIMSELF",-----------------------------------------------------------tagert types (see above)
"trnSystemSpecialEffectID":"SYSTEM_SPECIAL_EFFECT_SUMMON ",--------------------------------------------------------Special effects (see above), here this is the summon unit
"effectTriggers":["ON_DAMAGED"], ----------------------------------------------------------------------- what event triggers the effect: ON_DAMAGED, ON_DAMAGED_AMOUNT, ON_DIED, ON_KILL_ENEMY, ON_DAMAGES, ON_DAMAGES_AMOUNT

"groups":["GROUP1", "GROUP2"], -------------------------------------------------- the group(s) of this effect (used in eg. removesEffectGroups), you can configure any string value here
"removesBuffs":"ENEMYSPELLS", --------------------------------------------------- removes buffs debuffs or all (eg. poison/slowing etc) ENEMYSPELLS/ALL/NONE Beware! removesEffectGroups relies on this!
"removesEffectGroups":["GROUP1", "GROUP2"], ----------------------------------- list of effect groups that effects will be removed when this effect applied (as instant or enchantment), combines with removesBuffs! "NONE" considered as "ALL"

"isOneTimeSpell":false,---------------------------------------------------------------If canster can cast it on only once in his lifetime
"castRangeModifier":0,---------------------------------------------------------------- it can modify the spell range relative to caster default spellrange (eg +3)
"cooldownTurnNr":0,------------------------------------------------------------------If you want the spell has cooldown (caster needs to wait X turns before casting it again.)

"specCost":null,-------------------------------------------------------------------------special cost type (see above)
"specCostNr":1,--------------------------------------------------------------------------special cost amount (eg. 3 nearby corpses)
"trnSpecCostTypeList":{
"categories":["U_CHEAP_MELEE","U_BURNABLE", "U_BUILDING_SIZED_UNITS"],
"unitTypes":["UNIT_ORNITHOPTER"]
},------------------------------------------------------------- special cost type listt to be sacrificed: eg you can list only goblins, by category or specify exact types
"trnRequires":["TECH_X","TECH_Y"],-----------------------------------------------------------------------required techs to be owned before use this effect
"removingWeaponSlotTypes":["HEAL", "MEND", "SPELLCAST", "WP1", "WP2"], ----------------------which type of action removes this effect (eg burning removed by MEND)

"priority":0-------------------------------------------------------------------------------The priority the AI should use when selecting weapons against targets: 0 for irrelevant ones, about 900 on strongest effects, 100-800 the average effects

}

Button image appearance

Here see how button image is drawn:
1st prior if u explicitely gave Button image in trnButtonTextureID - than this will appear there
(image includes the button background too in AOf+AOS, in AOW it means only the decoration. You can override with "buttonTextureWithBackground")
2nd prior using the trnActionTextureID over the button background (like a cannonball shot cannonball image in AOF/AOS)
3rd prior in summon type of effect then the summoned unit's image is used over the button background (like the green dragon in AOF)
4th prior if it is a transform effect than a "transformation" image is shown over the button background
5th prior if a "requires" unit/tech is set then the image of that unit/techs is shown over the button background

[Sunrise Samurai]

Can you compile a zip of a bunch of AoF abilities? Please include at least raise dead, fireball, convert, one aura, and one enchantment​ for us to study.

[Stratego (dev)]

Not all AOF and AOS units/effects and other things are defined in jsons *, but here what are in AOF currently (effects, units, and so on - everything in AOF)

AOFJsons.zip

(306.56 KiB) Downloaded 98 times

* : AOW will be the first that is only JSON definition based.

[Stratego (dev)]

"specs":["IS_NEGATIVE_EFFECT"] -- set this to make the effect a negative one like slowing (if not set than considered positive like strengthening), now in AOF disenchant uses if it wants to remove effect or not

new spec.

means all negative effects should be marked (not only sticky ones)

[Midonik]

Can I make disenchant work only on few types of effects, not all? Probably not...

[Stratego (dev)]

The current disenchant removes all.
We need dedicated ones if u need that

[Midonik]

Currently all is ok too.

[makazuwr32]

but can we add undisenchantable effects?

[Stratego (dev)]

Yes. Which would those be?

[makazuwr32]

Many Runic spells that target units i suggested for dwarves.
Rune battle priest all his spells must be undisenchantable.
Rune mage 1 spell is undisenchantable.

Also another question - can we add damage to summoned/elemental unit types for disenchant spell?

[Stratego (dev)]

runes: then what is the counterspell for them?

summoneds: could be, but needs coding , put into the needs list posts to be "vodted"

[makazuwr32]

Runes don't need counter spell but runic magic's weaknesses are
1. long cooldown (4/6/8 turns cooldown) 2. short time effect (1-2 turns exept 2 of them)/until used (these 2 will have long time cooldown and both are castable by unique unit only - the one that can be trained only one per player)

I designed single target runic spells that they will be powerful but have long time cooldown and short time effect

Also another question - can we add some sort of spell that forcibly sets cooldown of target unit's abilities (all) to target value?

[Stratego (dev)]

runes: ok it is easy to make a setting to be exceptional spells that are not removable by disenchant - email me about it please

setting cooldown to abilities: harder, lets put it too "needs" vote

[Stratego (dev)]

"trnSpecCostTypeList":{
"categories":["U_CHEAP_MELEE","U_BURNABLE", "U_BUILDING_SIZED_UNITS"],
"unitTypes":["UNIT_ORNITHOPTER"]
},------------------------------------------------------------- special cost type listt to be sacrificed: eg you can list only goblins, by category or give exact types

[makazuwr32]

Oh. This will come in handy for mounting ability of eagles.

[General Brave]

Will be useful.

[Stratego (dev)]

new spec option:

IS_COOLDOWN_ON_SPAWN -- if set AND it has cooldown, than the cooldown will start right on unit spawning

[Stratego (dev)]

new option to set transformation from now not on unt but on effect:
"trnTransformTo" ----------------------------------------------------------------------transformation ID, used for case of SYSTEM_SPECIAL_EFFECT_TRANSFORM1, if null than the Unit.transformTo1 value will be used

[Stratego (dev)]

new trnSpecs options

AMOUNT_BY_STRENGTH, // if set than the caster unit's strength will mutiply the "effect" (effect will run this many times)
AMOUNT_BY_HP, // if set than the caster unit's hp will mutiply the "effect" (effect will run this many times)

new button texture setting:
"buttonTextureWithBackground":false,-----------------------------------------------if set you can explicitely tell the engine if the button is with or without button background

[Stratego (dev)]

new setting:
"removingWeaponSlotTypes":["HEAL", "MEND", "SPELLCAST", "WP1", "WP2"], ----------------------which type of action removes this effect (eg burning removed by MEND)

[godOfKings]

Where should it b written, on the spell effect json?

[Stratego (dev)]

yes under effects folder (this topic is about jsons in effects folder)

[Stratego (dev)]

an old setting was not documented here, so here new:
"removesBuffs":"ENEMYSPELLS", //removes buffs debuffs or all (eg. poison/slowing etc) ENEMYSPELLS/ALL/NONE

[Stratego (dev)]

new special cost option:
ACTION_POINT //if set than it requires extra action points or even 0 action point, altering the default 1 action cost

[DoomsdayDragonfire]

Can you add something to measure self-developed behaviors of effects?

[Stratego (dev)]

sorry, what do u mean?

[DoomsdayDragonfire]

I want something that measures exactly that... The behavior of effects on units over the time.

[DoomsdayDragonfire]

Should i create a post to explain in details what i mean?

[Stratego (dev)]

sorry can u write an example, from this i dont have tiny little idea what u thinking
(maybe my bad english sorry)

[Stratego (dev)]

Should i create a post to explain in details what i mean?

would be awesome!