Difference between revisions of "Bonus Format"

From VCMI Project Wiki
Jump to: navigation, search
(→‎Full format)
Line 27: Line 27:
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
== Subtype resolution ==
 +
 +
All string identifiers of items can be used in "subtype" field. This allows cross-referencing between the mods and make config more rewadble. The following identifiers are supported:
 +
* [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.]
  
 
== Bonus string constants ==
 
== Bonus string constants ==

Revision as of 10:21, 26 December 2012

Enumerative parameters are described in HeroBonus.h file.

Short format

{
["BONUS_TYPE", val, subtype, additionalInfo]
}

Full format

All parameters but type are optional. 

{
	"type": 	"BONUS_TYPE",
	"subtype": 	0,
	"val" : 	0,
	"valueType", 	"VALUE_TYPE",
	"addInfo" : 	0,

	"duration" : 	"BONUS_DURATION",
	"turns" : 	0,

	"sourceType" : 	"SOURCE_TYPE",
	"sourceID" : 	0,
	"effectRange" : "EFFECT_RANGE",
	"limiter" : 	["LIMITER_TYPE", optional_parameters (...)]
	"propagator" : 	["PROPAGATOR_TYPE", optional_parameters (...)]
	"description" : ""
}

Subtype resolution

All string identifiers of items can be used in "subtype" field. This allows cross-referencing between the mods and make config more rewadble. The following identifiers are supported:

  • [creature.]
  • [artifact.]
  • [skill.]
"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"
  • [resource.]

Possible values: 

 "wood", "mercury", "ore", "sulfur", "crystal", "gems", "gold", "mithril"
  • [hero.]
  • [faction.]

Bonus string constants

Additional links

Bonus system

Retrieved from "https://wiki.vcmi.eu/index.php?title=Bonus_Format&oldid=826"