Diff for "Field" - NEAT Portal Wiki

Diff for "Field"

Differences between revisions 3 and 16 (spanning 13 versions)

The Fields objects can reference details about valleys you own.

Field objects can be referenced as:

m_city.cityManager.fields[#].property or city.fields[#].property

The # will be which valley slot you are referencing, between 0-9. The .property at the end is how you will specify which detail you are referencing. Using the table below, you can for example get the level of the 5th valley you own with city.fields[4].level.

Properties

Property	Type	Description
id	int	The fieldID of the valley
level	int	Level of field 1-10
name	String	Name of field ("Forest","Desert","Hill","Swamp","Grassland","Lake")
type	int	Type of field in numerical format

The following functions can give further information about valleys, but are used as:

m_city.cityManager.fields.method or city.fields.method

Methods

Method	Type	Description
length	int	How many fields are owned by the city

Examples

echo FieldIdToCoords(city.fields[0].id)

outputs the coords of field[0] using the associated FieldId

ScriptObjects

Field (last edited 2014-02-10 18:48:46 by Inanna)

-  ⇤ ← Revision 3 as of 2012-10-23 14:36:12 → 
  Size: 6822
  Editor: Inanna
  Comment:
+   ← Revision 16 as of 2014-02-10 18:48:46 → ⇥
  Size: 1431
  Editor: Inanna
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-<<TableOfContents>>
+## page was renamed from FieldBean
## page was renamed from Fields
The Fields objects can reference details about valleys you own.
-Line 3:
+Line 5:
-== fields[0].id ==
+'''Field objects can be referenced as:'''
-Line 5:
+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.fields[0].id ||
||<#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.fields[0].id ||
+ . ''m_city.cityManager.fields[#].property '''or''' city.fields[#].property''
-Line 8:
+Line 9:
-Description goes here.
+The # will be which valley slot you are referencing, between 0-9. The .property at the end is how you will specify which detail you are referencing. Using the table below, you can for example get the level of the 5th valley you own with ''city.fields[4].level''.
-Line 10:
+Line 11:
-== fields[0].level ==
+'''Properties'''
||<tablewidth="796px" tableheight="123px"#cccccc>'''Property ''' ||<#cccccc>'''Type''' ||<#cccccc>'''Description ''' ||
||id ||int ||The fieldID of the valley ||
||level ||int ||Level of field 1-10 ||
||name ||String ||Name of field ("Forest","Desert","Hill","Swamp","Grassland","Lake") ||
||[[FieldTypes|type]] ||int ||Type of field in numerical format ||
-Line 12:
+Line 18:
-||<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.fields[0].level ||
||<#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.fields[0].level ||
-Line 15:
+Line 19:
-Description goes here.
-Line 17:
+Line 20:
-== fields[0].name ==
-Line 19:
+Line 21:
-||<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.fields[0].name ||
||<#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.fields[0].name ||
+The following functions can give further information about valleys, but are used as:
-Line 22:
+Line 23:
-Description goes here.
+ . ''m_city.cityManager.fields.method '''or''' city.fields.method''
-Line 24:
+Line 25:
-== fields[0].type ==
+'''Methods'''
||<tablewidth="796px" tableheight="43px"#cccccc>'''Method ''' ||<#cccccc>'''Type''' ||<#cccccc>'''Description ''' ||
||length ||int ||How many fields are owned by the city ||
-Line 26:
+Line 29:
-||<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.fields[0].type ||
||<#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.fields[0].type ||
-Line 29:
+Line 30:
-Description goes here.
 Line 31:
-== fields[1].id ==
-Line 33:
+Line 32:
-||<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.fields[1].id ||
||<#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.fields[1].id ||
+'''Examples'''
-Line 36:
+Line 34:
-Description goes here.
+ . {{{
echo FieldIdToCoords(city.fields[0].id)
-Line 38:
+Line 37:
-== fields[1].level ==

||<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.fields[1].level ||
||<#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.fields[1].level ||

Description goes here.

== fields[1].name ==

||<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.fields[1].name ||
||<#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.fields[1].name ||

Description goes here.

== fields[1].type ==

||<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.fields[1].type ||
||<#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.fields[1].type ||

Description goes here.

== fields.length ==

||<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.fields.length ||
||<#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.fields.length ||

Description goes here.

== fields[9].type ==

||<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.fields[9].type ||
||<#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.fields[9].type ||

Description goes here.
+outputs the coords of field[0] using the associated FieldId
}}}
-Line 74:
+Line 40:
-CategoryVariables
+ScriptObjects