Diff for "BuildingFunctions" - NEAT Portal Wiki

Diff for "BuildingFunctions"

Differences between revisions 8 and 12 (spanning 4 versions)

Contents

getBuildingLevel
getBuildingByTypeId
getBuildingByPosId
countBuilding
hasBuilding
getTownHallLevel
getWallLevel

See also: Building Objects
See also: Building Types

getBuildingLevel

Usage:	city.getBuildingLevel(BuildingType)
Example:	level = city.getBuildingLevel(23)

This example finds the level of the Market (typeID = 23).

```
echo city.getBuildingLevel(23)
```

This example cancels all trades if the number of trades is equal to the level of the Market (typeID = 23).

if city.tradesArray.length == city.getBuildingLevel(23) canceltrade

getBuildingByTypeId

Usage:	city.getBuildingByTypeId(BuildingType)
Example:	city.getBuildingByTypeId(23)

This function returns an object for the building with the highest level of that typeId. For example, to find your highest level barrack (typeID = 2):

```
echo city.getBuildingByTypeId(2).level
```

Valid parameters for this object are level, name, positionId, startTime, endTime, typeId, and status. For example you can echo city.getBuildingByTypeId(2).name or city.getBuildingByTypeId(2).status.

getBuildingByPosId

Usage:	city.getBuildingByPosId(pos)
Example:	city.getBuildingByPosId(2)

This example finds the name of the building at position 2:

```
echo city.getBuildingByPosId(2).name
```

You can find the positions with this:

countBuilding

Usage:	city.countBuilding(BuildingType[,MinLevel[,MaxLevel]])
Example:	totalmines = city.countBuilding(6,1,10)

This example gives the total count of all iron mines (typeID = 6) between level 1 and 10:

```
totalmines = city.countBuilding(6,1,10)
```

This example will check if you have at least 3 sawmills (typeID = 4) at level 5 or higher:

if city.countBuilding(4,5,10) >= 3 echo "I have at least 3 level 5+ sawmills."

The MinLevel and MaxLevel parameters in countBuilding are optional. If you do not specify a minimum level, it defaults to level 1. If you do not specify a maximum level, it defaults to level 10.

hasBuilding

Usage:	city.hasBuilding(typeId[,!Minlevel])
Example:	city.hasBuilding(2,10)

This function allows you to check if you have a building of a certain typeId of at least a specified level. The MinLevel is optional. If you do not specify a minimum level, it defaults to level 1.

In the example above, the check would return true if the city had a level 10 barrack in it.

getTownHallLevel

Usage:	city.getTownHallLevel()
Example:	echo city.getTownHallLevel()

This function returns the level of the townhall in the city.

getWallLevel

Usage:	city.getWallLevel()
Example:	echo city.getWallLevel()

This function returns the level of the wall in the city.

CategoryFunctions

BuildingFunctions (last edited 2016-02-01 18:02:03 by Inanna)

-  ⇤ ← Revision 8 as of 2014-11-25 05:07:06 → 
  Size: 4388
  Editor: Inanna
  Comment:
+   ← Revision 12 as of 2015-06-25 04:38:18 → ⇥
  Size: 6959
  Editor: Inanna
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 53:
-||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;                    " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;                    ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">city.countBuilding(!BuildingType,!MinLevel[,!MaxLevel)] ||
+||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;                    " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;                    ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">city.countBuilding(!BuildingType[,!MinLevel[,!MaxLevel]]) ||
 Line 67:
-The !MaxLevel parameter in countBuilding is optional. If you do not specify a maximum level, it defaults to level 10.
+The !MinLevel and !MaxLevel parameters in countBuilding are optional. If you do not specify a minimum level, it defaults to level 1. If you do not specify a maximum level, it defaults to level 10.

== hasBuilding ==
||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;                    " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;                    ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">city.hasBuilding(typeId[,!Minlevel]) ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">city.hasBuilding(2,10) ||

This function allows you to check if you have a building of a certain typeId of at least a specified level. The !MinLevel is optional. If you do not specify a minimum level, it defaults to level 1.
 
In the example above, the check would return true if the city had a level 10 barrack in it.

== getTownHallLevel ==
||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;                    " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;                    ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">city.getTownHallLevel() ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo city.getTownHallLevel() ||

This function returns the level of the townhall in the city.

== getWallLevel ==
||<tablebgcolor="#F9F9F9" tablestyle="margin:1em 1em 1em 0px;border-style:solid;border-color:rgb(170, 170, 170);color:rgb(0, 0, 0);font-family:sans-serif;font-size:13px;line-height:19.5px;text-align:start;                    " tableclass="wikitable"#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;                    ">Usage: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">city.getWallLevel() ||
||<#F2F2F2 style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">Example: ||<style="border-style:solid;border-color:rgb(170, 170, 170);padding:0.2em;">echo city.getWallLevel() ||

This function returns the level of the wall in the city.