1
0
mirror of https://github.com/vcmi/vcmi.git synced 2025-06-15 00:05:02 +02:00

Updated documentation

This commit is contained in:
Ivan Savenko
2024-10-25 18:47:19 +00:00
parent ee59bc4e71
commit 93096dc63c
2 changed files with 27 additions and 1 deletions

View File

@ -0,0 +1,26 @@
# Flaggable objects
Flaggable object are those that can be captured by a visiting hero. H3 examples are mines, dwellings, or lighthouse.
```jsonc
{
"baseObjectName" : {
"name" : "Object name",
"handler" : "flaggable",
"types" : {
"objectName" : {
// Text for message that player will get on capturing this object with a hero
// Alternatively, it is possible to reuse existing string from H3 using form '@core.advevent.69'
"onVisit" : "{Object Name}\r\n\r\nText of messages that player will see on visit.",
// List of bonuses that will be granted to player that owns this object
"bonuses" : {
"firstBonus" : { BONUS FORMAT },
"secondBonus" : { BONUS FORMAT },
}
}
}
}
}
```