Diff for "Map" - NEAT Portal Wiki

Diff for "Map"

Differences between revisions 4 and 6 (spanning 2 versions)

mapCastleBean objects reference details about a location on the map.

mapCastleBean objects can be referenced as:

userDefinedObject.property

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 name of the city with city.name.

Properties

Property	Type	Description
lastUpdated	int	time the information in the mapCastleBean was last updated
furlough	Boolean	If player at indicated coords is in holiday, returns True, otherwise returns False
changeface	int	not sure what this indicates. seems to always be 0.
flag	String	returns the player's flag (or null if unowned/unoccupied)
canLoot	Boolean	If you can loot from the coords. Returns: True / False
canSend	Boolean	If you can send to the coords. Returns: True / False
canOccupy	Boolean	If you can occupy the coords. Returns: True / False

fieldId

int

Gives the FieldID of the mapCastleBean

Examples

fid = GetFieldId(123,456) // convert coordinates into FieldId
mcb = GetDetailInfo(fid) // retrieve mapCastleBean object containing details for specified FieldId
if mcb == null repeat // if the server did not send updated info, repeat last step
echo mcb.name
echo mcb.allianceName
echo mcb.prestige

ScriptObjects

"playerLogoUrl":"string"

"userName":"string"

"canScout":false

"zoneName":"string - name of state"

"":false

"canTrans":true

"allianceName":"string"

"name":"string"

"id": int - same as FieldId

"relation":0

"npc":false

"state":1 see player state

"prestige":int

"":true

"honor":0

ScriptObjects

Map (last edited 2015-10-22 05:51:14 by Inanna)

-  ⇤ ← Revision 4 as of 2013-08-02 00:30:07 → 
  Size: 4407
  Editor: tech
  Comment:
+   ← Revision 6 as of 2013-08-02 00:40:27 → ⇥
  Size: 1873
  Editor: tech
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
 mapCastleBean objects reference details about a location on the map.
 Line 7:
-Line 13:
+Line 11:
-|| lastUpdated || int || time the information in the mapCastleBean was last updated ||
|| furlough || Boolean || If player at indicated coords is in holiday, returns True, otherwise returns False ||
|| changeface || int || not sure what this indicates. seems to always be 0. ||
|| flag || String || returns the player's flag (or null if unowned/unoccupied) ||
|| canLoot || || ||
||directionChange ||Boolean ||Internal bot useage only. Used by medal hunting to set to true every time army is recalled, and then it forces citymanager to do 1 cycle without auto-recalling troops from valleys. Returns: True / False ||
||distanceSettings ||Array ||Returns all 5 values of DistancePolicy for the city. distanceSettings[0] through distanceSettings[4] will return the value for npc farming, npc building, medal hunting, valley acquisition, and map scanning in order. ||
||[[ArmyBean|enemyArmies]] ||!ArrayCollection ||Contains information about incoming enemy [[ArmyBean|armies]]. ||
||estResource || ||(type is !EstimateResource) ||
+||lastUpdated ||int ||time the information in the mapCastleBean was last updated ||
||furlough ||Boolean ||If player at indicated coords is in holiday, returns True, otherwise returns False ||
||changeface ||int ||not sure what this indicates. seems to always be 0. ||
||flag ||String ||returns the player's flag (or null if unowned/unoccupied) ||
||canLoot || Boolean || If you can loot from the coords. Returns: True / False ||
||canSend || Boolean || If you can send to the coords. Returns: True / False ||
||canOccupy || Boolean ||If you can occupy the coords. Returns: True / False  ||
-Line 23:
+Line 20:
-||findHeroByName || || ||
||[[FortificationBean|fortification]] ||object? ||Contains information about the wall defenses in your city. ||
||fortificationProduceQueue || || ||
||fortificationQueueStatus ||int ||Tells if wall building status has started up or not.  0 = ready 1 = not ready ||
||[[FortificationBean|fortificationRequirement]] || || ||
||friendlyArmies ||object ||Contains information about incoming alliance armies. ||
||furtherInitNeeded ||Boolean ||Tells True / False if town has had the first focus set on a town. ||
||!GateControl ||int ||Shows current status of the city gates. 0 = Auto 1 = Open 2 = Closed ||
||hasEnemyArmies || || ||
||[[HeroBean|heroes]] ||object ||Contains information about the heroes in your city. ||
||id ||int ||Gives the number ID of town that is ran in ||
||[[HeroBean|innheroes]] ||object ||Contains information about the heroes in the inn. ||
||innStatus ||int ||Returns the ready / not ready status for the inn in that town. 0 = ready 1 = not ready ||
||isSafeFarming || || ||
||mapInitState ||int ||Tells if map screen has loaded yet. 0 - ok 1 - pending 2 - init needed ||
||myArmies ||object ||Contains information about your own armies. Same as selfArmies. ||
||name ||String ||Gives the name of the town it's run in. ||
||!NumberOfRealAttacks || || ||
||pendingProductionRates ||array ||? ||
||PRFactor || || ||
||researches || ||(array coll.) ||
||reservedResource || ||(type is resource bean) ||
||[[CityResource|resource]] ||object ||Contains information about the resources in your city. ||
||!ResourceProduction || || ||
||!SafeFarmingList || || ||
||selfArmies ||object ||Contains information about your own armies. Same as myArmies. ||
||timeSlot ||int ||Gives the order of towns that the bot reads from 0-X, where X = The number of towns you have starting at 0 ||
||tradesArray || || ||
||!TrainingHeroIsHere || || ||
||trainingHeroName ||String ||Returns the name of the town's listed training hero. ||
||transingTradesArray || || ||
||troop || ||(type is !TroopBean) ||
||troopQueueStatus ||int ||Tells if troop building status has started up or not. 0 = ready 1 = not ready ||
||troopStillInProduction || || ||
||x || || ||
||y || || ||
-Line 60:
+Line 21:
+||id ||int ||Gives the FieldID of the mapCastleBean ||
-Line 66:
+Line 28:
-//Check the status of my embassy
ifgoto (city.castle.allowAlliance) itsOpen
goto itsClosed
-Line 70:
+Line 29:
-label itsOpen
print My embassy is open
end
+fid = GetFieldId(123,456) // convert coordinates into FieldId
mcb = GetDetailInfo(fid) // retrieve mapCastleBean object containing details for specified FieldId
if mcb == null repeat // if the server did not send updated info, repeat last step
echo mcb.name
echo mcb.allianceName
echo mcb.prestige
-Line 74:
+Line 36:
-label itsClosed
print My embassy is closed
end
-Line 83:
+Line 43:
+"playerLogoUrl":"string"
-Line 84:
+Line 45:
+"userName":"string"
-Line 85:
+Line 47:
-"":0
+"canScout":false
-Line 87:
+Line 49:
-"":"DCK"
+"zoneName":"string - name of state"
-Line 91:
+Line 53:
-"playerLogoUrl":"images/icon/player/faceA3.jpg"

"userName":"18inches"

"canScout":false

"zoneName":"TUSCANY"

"canOccupy":false
-Line 103:
+Line 55:
-"allianceName":"666"
+"allianceName":"string"
-Line 105:
+Line 57:
-"name":"D1LD0"
+"name":"string"
-Line 107:
+Line 59:
-"id":542934
+"id": int - same as FieldId
-Line 113:
+Line 65:
-"state":1
+"state":1 see player state
-Line 115:
+Line 67:
-"prestige":189939
+"prestige":int
-Line 117:
+Line 69:
-"canSend":true
+"":true
-Line 120:
+Line 72: