vcmi/config/schemas/obstacle.json

{
	"type" : "object",
	"$schema" : "http://json-schema.org/draft-04/schema",
	"title" : "VCMI obstacle format",
	"description" : "Format used to define new obstacles in VCMI",
	"required" : [ "animation", "width", "height", "blockedTiles" ],
	"anyOf" : [
		{
			"required" : [ "allowedTerrains" ]
		},
		{
			"required" : [ "specialBattlefields" ]
		}
	],
	"additionalProperties" : false,
	"properties" : {
		"allowedTerrains" : {
			"type" : "array",
			"description" : "List of terrains on which this obstacle can be used",
			"items" : { "type" : "string" }
		},
		"specialBattlefields" : {
			"type" : "array",
			"description" : "List of special battlefields on which this obstacle can be used",
			"items" : { "type" : "string" }
		},
		"absolute" : {
			"type" : "boolean",
			"description" : "Should be used absolute or relative coordinates for obstacle. There is possible only one absolute obstacle"
		},
		"width" : {
			"type" : "number",
			"description" : "Width of obstacle"
		},
		"height" : {
			"type" : "number",
			"description" : "height of obstacle"
		},
		"blockedTiles" : {
			"type" : "array",
			"description" : "Blocked hexes - absolute or relative hex id",
			"items" : { "type" : "number" }
		},
		"animation" : {
			"type" : "string",
			"description" : "Image resource",
			"anyOf" : [
				{ "format" : "animationFile" },
				{ "format" : "imageFile" }
			]
		},
		"foreground" : {
			"type" : "boolean",
			"description" : "If set to true, obstacle will appear in front of units or other battlefield objects"
		}
	}
}