Diff for "BuildingFunctions" - NEAT Portal Wiki

Diff for "BuildingFunctions"

Differences between revisions 4 and 8 (spanning 4 versions)

Contents

getBuildingLevel
getBuildingByTypeId
getBuildingByPosId
countBuilding

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 MaxLevel parameter in countBuilding is optional. If you do not specify a maximum level, it defaults to level 10.

CategoryFunctions

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

-  ⇤ ← Revision 4 as of 2014-11-23 21:53:48 → 
  Size: 4026
  Editor: Inanna
  Comment:
+   ← Revision 8 as of 2014-11-25 05:07:06 → ⇥
  Size: 4388
  Editor: Inanna
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 3:
+See also: [[Building|Building Objects]]<<BR>>
See also: [[BuildingTypes|Building Types|]]
-Line 4:
+Line 7:
-||<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.getBuildingLevel ( BuildingTypes ) ||
+||<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.getBuildingLevel(!BuildingType) ||
-Line 8:
+Line 11:
-this example finds the level of the !MarketPlace(23)
+This example finds the level of the Market (typeID = 23).
 . {{{
echo city.getBuildingLevel(23)
}}}
-Line 10:
+Line 16:
+This example cancels all trades if the number of trades is equal to the level of the Market (typeID = 23).
-Line 14:
+Line 21:
-This sample cancels all trades if the number of trades is equal to the Level of the Market Place... (Hence the Market is full)

 . {{{
echo city.getBuildingLevel(23)
}}}
 10<<BR>>Script stopped
-Line 22:
+Line 23:
-||<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.getBuildingByTypeId(buildingType) ||
+||<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.getBuildingByTypeId(!BuildingType) ||
-Line 27:
+Line 28:
-For example, to find your highest level barrack (typeId = 2):
+For example, to find your highest level barrack (typeID = 2):
-Line 35:
+Line 36:
-See also: BuildingTypes
-Line 54:
+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([[BuildingTypes|buildingType]],minLevel,maxLevel) ||
||<#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;">totalmines = city.countBuilding(6,1,10) ||
+||<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)] ||
||<#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;">totalmines = city.countBuilding(6,1,10) ||
-Line 58:
+Line 57:
-The above example gives the total count of all iron mines between level 1 and 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 !MaxLevel parameter in countBuilding is optional. If you do not specify a maximum level, it defaults to level 10.