Difference between revisions of "Spell Format"

From VCMI Project Wiki
Jump to: navigation, search
Line 17: Line 17:
 
//Mandatory
 
//Mandatory
 
"name": "Localizable name",
 
"name": "Localizable name",
 
//Mandatory
 
"abbName": "Localizable abbreviated name",
 
  
 
//Mandatory(?), Spell school
 
//Mandatory(?), Spell school

Revision as of 20:36, 15 February 2014

Current draft. WiP.

{
	"spells":
	{
		"spellName":
		{
			//numeric id of spell required only for original spells, prohibited for new spells
			"index": 0,

			//Original info
			
			//Mandatory, spell type 
			"type": "adventure",//"adventure", "combat", "ability"

			//Mandatory
			"name": "Localizable name",

			//Mandatory(?), Spell school 			
			"school": ["air", "earth", "fire", "water"],

			//number, mandatory; Spell level
			"level": 0,

			//Mandatory, base power
			"power": 10,


			"defaultGainChance": 0, //by default for all factions

			//Mandatory, chance in % to gain for faction
			//NOTE: this field is merged with faction config
			"gainChance":
			{
				"factionName": 3
			},


			//VCMI info

			
			//   anim: main effect animation (AC format), -1 - none
			//TODO: arbitary resourceID
			"anim": -1,
			
			//	 counters: array of ids of countering spells
			"counters": ["spellID", ...]

			//Mandatory, string array of:
			//              indifferent, negative, positive - Positiveness of spell for target (required)
			//		damage - spell does damage (direct or indirect)
			//		offensive - direct damage (implicitly sets damage and negative)
			//		rising - rising spell (implicitly sets positive)
			//		summoning //todo:
			"flags" : ["flag1", "flag2"],

			//string array of bonus names, any one of these bonus grants immunity
			"immunity": ["BONUS_NAME", ...],
			
			//optional| no default | string array of bonus names
			//any one of these bonus grants immunity, cant be negated
			"absoluteImmunity": ["BONUS_NAME", ...],

			//string array of bonus names, presence of all bonuses required to be affected by
			"limit": ["BONUS_NAME", ...],

			//graphics - OPTIONAL; object;
			"graphics":
			{
				//  iconImmune - OPTIONAL; string; 
				//resourse path of icon for SPELL_IMMUNITY bonus (relative to DATA or SPRITES)
				"iconImmune":"ZVS/LIB1.RES/E_SPMET"
			},

			//Mandatory 4 element array of objects
			//configuration for no skill, basic, adv, expert
			"levels":[
			{
				//Mandatory, localizable description
				//Use {xxx} for formatting
				"description": "",


				//Mandatory, number, 
				//cost in mana points
				"cost": 1,

				//Mandatory, number
				"power": 10,

				//Mandatory, number
				"aiValue": 20,

				//Mandatory, spell target type
				"targetType":"NO_TARGET",//"CREATURE","OBSTACLE"
				
				//Mandatory
				//spell range description in SRSL
				"range": "X",

				//Optional, bonus format array
				//timed effects 
				"effects":
				[
				{bonus format}, ...
				]
			},
			{...},{...},{...}
			]


		}
	}
}


Modding related articles

Main articles
Modding changelog Modding guidelines Mod Handler


Formats
Mod file Format
Town Format Creature Format Hero Classes Format
Artifact Format Animation Format Hero Format
Bonus Format Object Format Spell Format


Work-in-progress formats
Building bonuses Map format
Bonus Type Format Random map template


Outdated pages
Mod system proposal