games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2025-11-23 22:37:55 +02:00
Code Issues Releases Activity

Update documentation

Browse Source
This commit is contained in:
Ivan Savenko
2024-09-02 15:35:02 +00:00
parent a19a55b4ae
commit 525ae72f8e
3 changed files with 199 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/modders/Map_Object_Format.md
View File

@@ -14,14 +14,6 @@ Full object consists from 3 parts:
generated by the game. When new object is created its starting
appearance will be copied from template
## Object types
- [Rewardable](Map_Objects/Rewardable.md) - Visitable object which grants all kinds of rewards (gold, experience, Bonuses etc...)
- [Creature Bank](Map_Objects/Creature_Bank.md) - Object that grants award on defeating guardians
- [Dwelling](Map_Objects/Dwelling.md) - Object that allows recruitments of units outside of towns
- [Market](Map_Objects/Market.md) - Trading resources, artifacts, creatures and such
- [Boat](Map_Objects/Boat.md) - Object to move across different terrains, such as water
## Object group format
``` javascript
@@ -33,7 +25,8 @@ Full object consists from 3 parts:
// human readable name, localized
"name": "My cool object",
//defines C++/script class name that handles behavior of this object
// defines C++ class name that handles behavior of this object
// see Object Types section below for possible values
"handler" : "mine",
// default values, will be merged with each type during loading
@@ -46,6 +39,61 @@ Full object consists from 3 parts:
}
```
## Object types
### Moddable types
These are object types that are available for modding and have configurable properties
- `configurable` - see [Rewardable](Map_Objects/Rewardable.md). Visitable object which grants all kinds of rewards (gold, experience, Bonuses etc...)
- `bank` - see [Creature Bank](Map_Objects/Creature_Bank.md). Object that grants award on defeating guardians. Deprectated in favor of [Rewardable](Map_Objects/Rewardable.md)
- `dwelling` - see [Dwelling](Map_Objects/Dwelling.md). Object that allows recruitments of units outside of towns
- `market` - see [Market](Map_Objects/Market.md). Trading resources, artifacts, creatures and such
- `boat` - see [Boat](Map_Objects/Boat.md). Object to move across different terrains, such as water
- `hillFort` - TODO: documentation. See config files in vcmi installation for reference
- `shipyard` - TODO: documentation. See config files in vcmi installation for reference
- `terrain` - Defines terrain overlays such as magic grounds. TODO: documentation. See config files in vcmi installation for reference
### Common types
These are types that don't have configurable properties, however it is possible to add additional map templates for this objects, for use in editor or in random maps generator
- `static` - Defines unpassable static map obstacles that can be used by RMG
- `generic` - Defines empty object type that provides no functionality. Note that unlike `static`, objects of this type are never used by RMG
- `borderGate`
- `borderGuard`
- `lighthouse`
- `magi`
- `mine`
- `obelisk`
- `subterraneanGate`
- `whirlpool`
- `resource`
- `denOfThieves`
- `garrison`
- `keymaster`
- `pandora`
- `prison`
- `questGuard`
- `seerHut`
- `sign`
- `siren`
- `monolith`
### Internal types
These are internal types that are generally not available for modding and are handled by vcmi internally.
- `hero`
- `town`
- `monster`
- `randomArtifact`
- `randomHero`
- `randomResource`
- `randomTown`
- `randomMonster`
- `randomDwelling`
- `artifact`
- `event`
- `heroPlaceholder`
## Object type format
``` javascript
@@ -151,4 +199,4 @@ Full object consists from 3 parts:
"zIndex": 0
}
}
```
```