1
0
mirror of https://github.com/vcmi/vcmi.git synced 2025-11-23 22:37:55 +02:00

One more documentation update iteration

This commit is contained in:
Ivan Savenko
2023-09-26 13:22:36 +03:00
parent 8210a2cafd
commit 0ab766479d
13 changed files with 128 additions and 18 deletions

View File

@@ -1,3 +1,27 @@
< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Battle Obstacle Format
TODO
```jsonc
// List of terrains on which this obstacle can be used
"allowedTerrains" : []
// List of special battlefields on which this obstacle can be used
"specialBattlefields" : []
// If set to true, this obstacle will use absolute coordinates. Only one such obstacle can appear on the battlefield
"absolute" : false
// Width of an obstacle, in hexes
"width" : 1
// Height of an obstacle, in hexes
"height" : 1
// List of tiles blocked by an obstacles. For non-absolute obstacles uses relative hex indices
"blockedTiles" : [ 0, 20, 50 ]
// For absolute obstacle - image with static obstacle. For non-absolute - animation with an obstacle
"animation" : "",
// If set to true, obstacle will appear in front of units or other battlefield objects
"foreground" : false
```

View File

@@ -1,3 +1,19 @@
< [Documentation](../../Readme.md) / [Modding](../Readme.md) / Entities Format / Battlefield Format
TODO
```jsonc
// Human-readable name of the battlefield
"name" : ""
// If set to true, obstacles will be taken from "specialBattlefields" property of an obstacle
// If set to false, obstacles will be taken from "allowedTerrains" instead
"isSpecial" : false
// List of bonuses that will affect all battles on this battlefield
"bonuses" : { BONUS_FORMAT }
// Background image for this battlefield
"graphics" : ""
// List of battle hexes that will be always blocked on this battlefield (e.g. ship to ship battles)
"impassableHexes" : [ 10, 20, 50 ]
```

View File

@@ -26,14 +26,14 @@ In order to make functional hero class you also need:
}
},
// Description of map object representing this hero class. See map template format for details
// Description of map object representing this hero class.
"mapObject" : {
// Optional, hero ID-base filter, using same rules as building requirements
"filters" : {
"mutare" : [ "anyOf", [ "mutare" ], [ "mutareDrake" ]]
},
// List of templates used for this object, normally - only one is needed
// List of templates used for this object, normally - only one is needed. See map template format for details
"templates" : {
"normal" : { "animation" : "AH00_.def" }
}

View File

@@ -119,14 +119,17 @@ In order to make functional hero you also need:
// Description of specialty mechanics using bonuses (with updaters)
"specialty" : {
// to be merged with all bonuses, use for specialties with multiple similar bonuses (optional)
// Optional. Section that will be added into every bonus instance, for use in specialties with multiple similar bonuses
"base" : {common bonus properties},
// List of bonuses added by this specialty. See bonus format for more details
"bonuses" : {
// use updaters for bonuses that grow with level
"someBonus" : {Bonus Format},
"anotherOne" : {Bonus Format}
},
// adds creature specialty following the HMM3 default formula
// Optional. Shortcut for defining creature specialty, using standard H3 rules
"creature" : "griffin"
}
}