Diff for "Map" - NEAT Portal Wiki

Diff for "Map"

Differences between revisions 3 and 4

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
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.
enemyArmies	ArrayCollection	Contains information about incoming enemy armies.
estResource		(type is EstimateResource)
fieldId
findHeroByName
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
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
heroes	object	Contains information about the heroes in your city.
id	int	Gives the number ID of town that is ran in
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)
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

Examples

//Check the status of my embassy
ifgoto (city.castle.allowAlliance) itsOpen
goto itsClosed

label itsOpen
print My embassy is open
end

label itsClosed
print My embassy is closed
end

ScriptObjects

"":0

"":"DCK"

"":false

"playerLogoUrl":"images/icon/player/faceA3.jpg"

"userName":"18inches"

"canScout":false

"zoneName":"TUSCANY"

"canOccupy":false

"canTrans":true

"allianceName":"666"

"name":"D1LD0"

"id":542934

"relation":0

"npc":false

"state":1

"prestige":189939

"canSend":true

"honor":0

ScriptObjects

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

-  ⇤ ← Revision 3 as of 2013-08-01 23:35:26 → 
  Size: 0
  Editor: tech
  Comment:
+   ← Revision 4 as of 2013-08-02 00:30:07 → ⇥
  Size: 4407
  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.  

'''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 c''ity.name''.

'''Properties'''
||<tablewidth="796px" tableheight="123px"#cccccc>'''Property ''' ||<#cccccc>'''Type''' ||<#cccccc>'''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 || || ||
||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) ||
||fieldId || || ||
||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 || || ||




'''Examples'''

 . {{{
//Check the status of my embassy
ifgoto (city.castle.allowAlliance) itsOpen
goto itsClosed

label itsOpen
print My embassy is open
end

label itsClosed
print My embassy is closed
end
}}}

----
----
ScriptObjects



"":0

"":"DCK"

"":false

"playerLogoUrl":"images/icon/player/faceA3.jpg"

"userName":"18inches"

"canScout":false

"zoneName":"TUSCANY"

"canOccupy":false

"canTrans":true

"allianceName":"666"

"name":"D1LD0"

"id":542934

"relation":0

"npc":false

"state":1

"prestige":189939

"canSend":true

"honor":0
----
ScriptObjects