Difference between revisions of "Bonus Format"

From VCMI Project Wiki
Jump to: navigation, search
(Available prefixes)
(Replaced content with "{{Template:MovedToWebpage|https://vcmi.eu/modders/Bonus_Format/}}")
 
Line 1: Line 1:
Enumerative parameters are described in HeroBonus.h file.
+
{{Template:MovedToWebpage|https://vcmi.eu/modders/Bonus_Format/}}
===Short format===
 
<syntaxhighlight lang="javascript">
 
{
 
["BONUS_TYPE", val, subtype, addInfo]
 
}
 
</syntaxhighlight>
 
 
 
===Full format===
 
All parameters but type are optional.
 
<syntaxhighlight lang="javascript">
 
{
 
"type": "BONUS_TYPE",
 
"subtype": 0,
 
"val" : 0,
 
"valueType": "VALUE_TYPE",
 
"addInfo" : 0, // or [1, 2, ...]
 
 
 
"duration" : "BONUS_DURATION", //or ["BONUS_DURATION1", "BONUS_DURATION2", ...]"
 
"turns" : 0,
 
 
 
"sourceType" : "SOURCE_TYPE",
 
"sourceID" : 0,
 
"effectRange" : "EFFECT_RANGE",
 
"limiters" : [
 
"PREDEFINED_LIMITER", optional_parameters (...), //whhich one is preferred?
 
{"type" : LIMITER_TYPE, "parameters" : [1,2,3]}
 
],
 
"propagator" : ["PROPAGATOR_TYPE", optional_parameters (...)],
 
"updater" : {Bonus Updater},
 
"propagationUpdater" : {Bonus Updater, but works during propagation},
 
"description" : "",
 
"stacking" :   ""
 
}
 
</syntaxhighlight>
 
 
 
== Subtype resolution ==
 
 
 
All string identifiers of items can be used in "subtype" field. This allows cross-referencing between the mods and make config file more readable.
 
=== Available prefixes ===
 
* creature.
 
* artifact.
 
* skill.
 
<syntaxhighlight lang="javascript">
 
"pathfinding",  "archery",      "logistics",    "scouting",    "diplomacy",
 
"navigation",  "leadership",  "wisdom",      "mysticism",    "luck",
 
"ballistics",  "eagleEye",    "necromancy",  "estates",      "fireMagic",
 
"airMagic",    "waterMagic",  "earthMagic",  "scholar",      "tactics",
 
"artillery",    "learning",    "offence",      "armorer",      "intelligence",
 
"sorcery",      "resistance",  "firstAid"
 
</syntaxhighlight>
 
* resource.
 
Possible values:
 
<syntaxhighlight lang="javascript">
 
"wood", "mercury", "ore", "sulfur", "crystal", "gems", "gold", "mithril"
 
</syntaxhighlight>
 
* hero.
 
* faction.
 
* spell.
 
* primSkill.
 
* primarySkill. (since 1.3)
 
<syntaxhighlight lang="javascript">
 
"attack", "defence", "spellpower", "knowledge"
 
</syntaxhighlight>
 
* terrain (since 0.99)
 
<syntaxhighlight lang="javascript">
 
"dirt", "sand", "grass", "snow", "swamp", "rough", "subterra", "lava", "water", "rock"
 
</syntaxhighlight>
 
 
 
* spellSchool.
 
<syntaxhighlight lang="javascript">
 
  "any", "fire", "air", "water", "earth"
 
</syntaxhighlight>
 
 
 
=== Example ===
 
<syntaxhighlight lang="javascript">
 
"bonus" :
 
{
 
"type" : "HATE",
 
"subtype" : "creature.enchanter",
 
"val" : 50
 
}
 
</syntaxhighlight>
 
This bonus makes creature do 50% more damage to Enchanters.
 
 
 
{{Bonuses}}
 

Latest revision as of 16:18, 16 July 2024

Logo256.png    Page moved to VCMI-Homepage