Military Buildings
Reminder - Keep Daily Backups
When working on a strategy game with a kit as big as the Complete Kit - always keep a working daily backup! Save yourself the trouble of rolling-back changes and losing work.
What are military buildings?
When playing city-building games or battle strategy games you'll always be able to build some sort of structure that doesn't have any economic role. In this case we've added a category in the store for you to place these buildings.
The demo includes a few of these general buildings like the Wizard Hat, School House, or Workshop although some of them like the Tatami can have a special attribute - increase total max army size.
Click to view larger.
Military building special attribute: increase max army size
Other than resource generators and storage buildings - you can also store units in your structure to give the player a bigger maximum army size. The XML sections further down on this page teach what to do for the StoreType and StoreResource variables.
Maximum army size in the HUD.
Shop Menu
Here's a screenshot of the shop menu for the military buildings.
Click to view larger.
The examples here are general buildings that do not affect the player's stats except awarding XP for completion, although the Tatami item is one example that expands the maximum army size. More details below on how to do this in the XML
Click to view larger.
Where to find the military store menu in Unity?
Open the game scene hierarchy and locate the ScrollViewMilitary in UIAnchor > Anchor - Center > Shop > Main. Look at the below screenshot.
UIAnchor. Click to view larger.
Store Item
All of the store details seen in the below screenshot are taken from the XML/Buildings.xml file and loaded by Scripts/Creators/BaseCreator.cs (details below on what part of the script does this)
Breakdown of the information shown to players in the store.
| From Image Above | Description |
|---|---|
| Item Name | This is the Name variable from XML/Buildings.xml |
| Time to Build | The TimeToBuild variable (in minutes) from Buildings.xml. How long the structure will take to to be created. |
| (number) Build / Level Limit | The number of this structure already created versus the number limited by their level in XML/EvolutionBuildings.xml. See Gameplay > XP and Levels documentation for details) |
| Currency Cost | The Price variable from XML/Buildings.xml |
| Currency Type | The Currency variable from XML/Buildings.xml (Either Gold, Mana, or Gems) You could change this to whatever currency you will have in your game and also add additional currencies. |
| View Description | Shows the Description text variable from XML/Buildings.xml |
| Prefab Image | The prefab image which you can edit from the UIAnchor: Center shop main menu. More details on how to change this under the Buildings > Part 2: Customize Menus page of the documentation |
Army Troop Storage Buildings.xml Example
Here's an example of how to do a building that stores extra army units. The most important item in this list to observe is that the StoreType is Distributed and StoreResource is set to Soldiers. The order of items in the XML document must exactly match the scripts you customize in Buildings > Part 2: Customize Menus documentation as this XML item order becomes the structure index used in the scripts.
<Building>
<Name>Tatami Barracks</Name>
<!-- name displayed in the store -->
<StructureType>Tatami</StructureType>
<!-- IMPORTANT: use the same name same as prefab in your XML -->
<Description>Once upon a time, in a distant land filled with mistery and magic, a gathering of mighty heroes found a little dog called Squea... Honey? The pancakes are ready!</Description>
<!-- description displayed in the store -->
<Currency>Mana</Currency>
<!-- save as Gold, Mana, or Crystals to buy; production/storage building, buy with gold, produces mana -->
<Price>100</Price>
<!-- amount of resource necessary to pay for the building -->
<ProdType>Gold</ProdType>
<!-- resource produced - gold/mana/none-->
<ProdPerHour>100</ProdPerHour>
<!-- the amount of the resource generated per hour -->
<StoreType>Distributed</StoreType>
<!-- Distributed (where the troops are stored, in this case 25 troops added to the player max cap stats) -->
<StoreResource>Soldiers</StoreResource>
<!-- resource stored - None/Gold/Mana/Dual (gold+mana)/ or Soldiers-->
<StoreCap>25</StoreCap>
<!-- gold/mana/dual/or soldiers storage -->
<!--although it's not centralized, there is an internal storage-->
<TimeToBuild>10</TimeToBuild>
<!-- the time (in minutes) needed to create the building -->
<Life>300</Life>
<!-- hitpoints for the building in battle -->
<XpAward>100</XpAward>
<!-- experience awarded for the completion of building this -->
</Building>
A closer look at building XML
If you look closely in the above XML, you'll see the building costs 100 of of the Mana currency. You could use whatever currency you want in your game, in the demo we have two placeholders called Gold and Mana. (Plus one rare currency called Crystal Gems)
<Currency>Mana</Currency>
<Price>100</Price>
<ProdType>Gold</ProdType>
<ProdPerHour>100</ProdPerHour>
Further down in the XML for the Tatami item you'll see the type of storage increases the player's army size - by 25 total. (Distributed means Player stats - meanwhile StoreType = Internal is used for resource generators - see the documentation page Shop Menu > Resource Generators for details)
<StoreType>Distributed</StoreType>
<StoreResource>Soldiers</StoreResource>
<StoreCap>25</StoreCap>
XML for a normal building without any army capacity would look like this:
Meanwhile a normal building would look like the Workshop building example in the Buildings.xml, excerpt below:
<Building> <!-- 10 -->
<Name>Workshop</Name> <!--upgrades weapons-->
<StructureType>Workshop</StructureType>
<Description>If it's wood or metal and it makes strange noises, or there's smoke coming out of it, this is where you come to fix it. Unless it's Friday. Or Monday. Maybe Wednesday... Feel free to call first.</Description>
<Currency>Gold</Currency>
<Price>20000</Price>
<ProdType>None</ProdType>
<ProdPerHour>0</ProdPerHour>
<StoreType>None</StoreType>
<StoreResource>None</StoreResource>
<StoreCap>0</StoreCap>
<TimeToBuild>120</TimeToBuild>
<Life>200</Life>
<XpAward>500</XpAward>
</Building>
You'll notice the only major change is that StoreType is set to None, StoreResource is set to None, and StoreCap is set to 0. This means no resources (army or in-game currency) are stored. Here's a closer look:
<StoreType>None</StoreType>
<StoreResource>None</StoreResource>
<StoreCap>0</StoreCap>
BaseCreator.cs - Where the XML is loaded into
In Scripts/Creators/BaseCreator.cs the building data from your XML file (seen above) is loaded using a common system for all the buildings like resource buildings, defense buildings, walls, decorations, and other buildings. Here's an excerpt from BaseCreator.cs of the XML data load:
//reads structures XML
protected void GetBuildingsXML()
{
XmlDocument xmlDoc = new XmlDocument();
xmlDoc.LoadXml(StructuresXML.text);
XmlNodeList structuresList = xmlDoc.GetElementsByTagName(structureXMLTag);
foreach (XmlNode structureInfo in structuresList)
{
XmlNodeList structureContent = structureInfo.ChildNodes;
dictionary = new Dictionary<string, string>();
foreach (XmlNode structureItem in structureContent)
{
// For each of the XML values, it stores the information
// to be used later in BaseCreator.cs
if(structureItem.Name == "Name")
{
dictionary.Add("Name",structureItem.InnerText);
// put this in the dictionary.
}
if(structureItem.Name == "StructureType")
{
dictionary.Add("StructureType",structureItem.InnerText);
// put this in the dictionary.
}
if(structureItem.Name == "Description")
{
dictionary.Add("Description",structureItem.InnerText);
}
if(structureItem.Name == "Currency")
{
dictionary.Add("Currency",structureItem.InnerText);
}
if(structureItem.Name == "Price")
{
dictionary.Add("Price",structureItem.InnerText);
}
if(structureItem.Name == "ProdType")
{
dictionary.Add("ProdType",structureItem.InnerText);
}
if(structureItem.Name == "ProdPerHour")
{
dictionary.Add("ProdPerHour",structureItem.InnerText);
}
if(structureItem.Name == "StoreType")
{
dictionary.Add("StoreType",structureItem.InnerText);
}
if(structureItem.Name == "StoreResource")
{
dictionary.Add("StoreResource",structureItem.InnerText);
}
if(structureItem.Name == "StoreCap")
{
dictionary.Add("StoreCap",structureItem.InnerText);
}
if(structureItem.Name == "PopCap")
{
dictionary.Add("PopCap",structureItem.InnerText);
}
if(structureItem.Name == "TimeToBuild")
{
dictionary.Add("TimeToBuild",structureItem.InnerText);
}
if(structureItem.Name == "Life")
{
dictionary.Add("Life",structureItem.InnerText);
}
if(structureItem.Name == "XpAward")
{
dictionary.Add("XpAward",structureItem.InnerText);
}
// The following two are not currently used in the demo
// but have been provided for developers wishing to expand
// their builings with upgrades. Additional scripting required.
if(structureItem.Name == "Upgrades")
{
dictionary.Add("Upgrades",structureItem.InnerText);
}
if(structureItem.Name == "UpRatio")
{
dictionary.Add("UpRatio",structureItem.InnerText);
}
}
structures.Add(dictionary);
}
}
When the data is loaded, the store panels are updated with the appropriate information.
Construction limits with XP levels
Read the Gameplay > XP and Levels documentation page for more details about how the XML/EvolutionBuildings.xml file limits the number of certain Building.xml structures per level. For example, game players could have a maximum of two gold mines at level one until the player reaches level two, in which the maximum increases to five (or whatever value you choose -- read XP and Levels documentation for more details)
1/2 gold mines built. Maximum not reached.
2/2 maximum reached, can't build more
This is relevant to mention now because the menu items are greyed out for buildings that the player can no longer build until they increase their base level through other ways of gaining XP. The function UpdateLabelStats()
// Excerpt from UpdateLabelStats()
// Check if the player is looking at items in the store that
// would exceed their XP level limits
buildingAllowed =(allowedStructures[i]-existingStructures[i]>0);
// Set the store item's label data
NameLbs[i].text = structures [i] ["Name"];
TimeLbs[i].text = structures [i] ["TimeToBuild"];
// Quantity - for example, 2/2 means they have reached the maximum of 2
QuantityLbs[i].text = existingStructures[i].ToString()+"/"+allowedStructures[i].ToString();
PriceLbs[i].text = structures [i] ["Price"];
// If they can build, set the normal store item background and label colors
if(buildingAllowed)
{
NicheSprites[i].spriteName = "stone_niche";
PortraitSprites[i].atlas = Portraits;
NameLbs[i].color = brown;
TimeLbs[i].color = brown;
QuantityLbs[i].color = brown;
PriceLbs[i].color = brown;
// If the player can no longer build this item, grey out the item in the store
} else {
NicheSprites[i].spriteName = "stone_niche_bw";
PortraitSprites[i].atlas = PortraitsBW;
NameLbs[i].color = black;
TimeLbs[i].color = black;
QuantityLbs[i].color = black;
PriceLbs[i].color = black;
}
What happens when the buy button is clicked for a building?
When the player clicks one of the buttons to build a building in the store, first one of the building functions is triggered, like this example below:
//receive a NGUI button message to build
public void OnBuild0() { currentSelection=0; Verify(); }
//when a building construction menu button is pressed
Verify() is run shortly after, which initiates the conditions checking to see if the player actually can build what they want to build.
private void Verify()
{
if (isArray[currentSelection] == 0)
{
VerifyConditions ();
}
else
{
isField = true;
drawingField = true;
Delay ();
VerifyConditions ();
}
}
VerifyConditions()
Can the player build this structure? In Scripts/Creators/BaseCreator.cs the VerifyConditions() script takes over once the store button has been pushed to determine if the following conditions are met and canBuild is set to true.
VerifyConditions() Test #1 - Maximum structures reached?
First, we check if the player's level restricts the structure from being made. Have they exceeded the number of structures allowed by their level in XML/EvolutionBuildings.xml? (See Gameplay > XP and Levels documentation for more information on this)
0 of 1 maximum structures completed for the player's current level
if (existingStructures[currentSelection] >= maxAllowed){
// Max already reached
// Fails the first test, set canBuild = false
canBuild = false;
// Throws an error message in the in-game messanger
((Messenger)statusMsg).DisplayMessage("Maximum " + maxAllowed.ToString() +
" structures of type " +
structures [currentSelection] ["Name"]+". ");
// Displays the hint:
// you can have only X structures of this type for their level
}
VerifyConditions() Test #2 - Do they have enough funds?
The second test the player data must pass is their funds - do they have enough of the currency the building requires to be constructed?
// Get the building cost
int price = int.Parse (structures [currentSelection] ["Price"]);
// If the building cost is in Gold, do they have enough gold?
if (structures [currentSelection] ["Currency"] == "Gold"){
// Finding out how much gold they have remaning if you subtract it
int existingGold = ((Stats)stats).gold + ((Stats)stats).deltaGoldPlus - ((Stats)stats).deltaGoldMinus;
// See if the gold remaining is less than the price
if (existingGold < price)
{
// not enough
canBuild = false;
((Messenger)statusMsg).DisplayMessage("Not enough gold.");
//updates hint text
}
// Repeat the same above, but instead for the other currency (Mana)
}
else if (structures [currentSelection] ["Currency"] == "Mana")
{
int existingMana = ((Stats)stats).mana + ((Stats)stats).deltaManaPlus - ((Stats)stats).deltaManaMinus;
if(existingMana < price)
{
canBuild = false;
((Messenger)statusMsg).DisplayMessage("Not enough mana.");//updates hint text
}
// Repeat the same above but for the rare Crystal currency
// If you have additional currencies in your game, uncomment the //
// and repeat for each currency
}
else //if (structures [currentSelection] ["Currency"] == "Crystals")
{
int existingCrystals = ((Stats)stats).crystals + ((Stats)stats).deltaCrystalsPlus - ((Stats)stats).deltaCrystalsMinus;
if(existingCrystals < price)
{
canBuild = false;
((Messenger)statusMsg).DisplayMessage("Not enough crystals.");//updates hint text
}
}
VerifyConditions() Test #3 - Do they have an available builder?
In the City Building Kit each building under construction takes one builder. Players get a certain number of builders to start with (default is 1 in the demo) and you can adjust this for your game. It costs extra rare gems to get additional builders like games such as Clash of Clans. (The builder hut is called a dobbit hut in the demo, read the Shop Menu > Resource Generators section on builders for more details.)
//builder available?
if (((Stats)stats).occupiedDobbits >= ((Stats)stats).dobbits)
{
canBuild = false;
((Messenger)statusMsg).DisplayMessage("You need more dobbits.");
}
VerifyConditions() - If all tests pass, greenlight construction.
If the player's data passes all 3 tests and canBuild still is set to true, then the script adjusts the player data awarding the XP they get from the building XML (if any) and deducting the costs involved from the building currency and price.
if (canBuild)
{
((MenuMain)menuMain).constructionGreenlit = true;
//ready to close menus and place the building;
//constructionGreenlit bool necessary because the command is sent by pressing the button anyway
((Stats)stats).experience += int.Parse (structures [currentSelection] ["XpAward"]);
//increases Stats experience
// move this to building finished
if(((Stats)stats).experience>((Stats)stats).maxExperience)
{
((Stats)stats).level++;
((Stats)stats).experience-=((Stats)stats).maxExperience;
((Stats)stats).maxExperience+=100;
}
//pays the gold/mana price to Stats
if(structures [currentSelection] ["Currency"] == "Gold")
{
((Stats)stats).SubstractResources (price, 0, 0);
}
else if(structures [currentSelection] ["Currency"] == "Mana")
{
((Stats)stats).SubstractResources (0, price, 0);
}
else //if(structures [currentSelection] ["Currency"] == "Crystals")
{
// Repeats the same above but for the rare Crystal currency
// If you have additional currencies in your game, uncomment the //if(structures
// above and repeat for each currency in your game
((Stats)stats).SubstractResources (0, 0, price);
}
UpdateButtons ();//payments are made, update all
((Stats)stats).UpdateUI();
//tells stats to update the interface - otherwise new numbers are updated but not displayed
if (!isField || buildingFields)
{
UpdateExistingStructures (+1);
//an array that keeps track of how many structures of each type exist
InstantiateStructure ();
}
}
else
{
((MenuMain)menuMain).constructionGreenlit = false;
//halts construction - the button message is sent anyway, but ignored
}
ConstructionGreenlit = true is sent the MenuMain script which then deactivates the store panel the player was just on and waits for the building to be placed.
((MenuMain)menuMain).constructionGreenlit = true;
// ready to close menus and place the building;
// constructionGreenlit bool necessary because the command is sent by pressing the button anyway
Updated less than a minute ago