Difference between revisions of "Reference Section"

Latest revision as of 00:42, 23 September 2011

TEMPORARY COPY - NEEDS REFORMATTED STILL

All of the following references have been tested. The results, including the script used to access the variables is availible in the Reference Test section of this wiki.

Every effort has been made in an attempt to make them work. An examination of the code, for example, showed that 'taxrate' was non-functional due to being spelt incorrectly in the Evony code. The proper syntax for all variables is demonstated in the test.

Those that returned errors and could not be made to work were deleted from the output. Generally, this means that no reference to them could be found within the code.

Script References

References allow for the smooth operation of a City.

Resources, Troops, Walldefenses, & Miscellaneous City Information can be referenced from within a script.

Note: All references must begin with ‘m_city.’

When used within a script references are gereally compared to a desired limit in order to determine whether or not to perform the action or subroutine indicated.

Format: ifgoto ( [reference] [operator] [value] ) [label]

Format: ifgosub ( [reference] [operator] [value] ) [label]

Example: ifgosub ( m_city.cityManager.troop.lightCavalry < 20000 ) buildcav

Proper spacing and spelling is essential.

In certain cases the reference returns only a true/false in which case it will compare as either 0 if false or 1 if true.

Creating a script that is both easy to use and functional can be a tricky task for a seasoned veteran, much more so to a raw beginner. Remember, this is your city and troops you are attempting to control, a slight slip in logic can lead to disaster. To avoid such pitfalls it is reccommended that you check out the Tips and Tricks section of this wiki.

A test script has been created to test the output of all of the following references. The script and its resulting output can be found at the Reference Test page.Welcome to Scripts

Material Resources

Applicable Resources : food, wood, stone, iron

Examples :

//===================================================
// Check current amount of Wood, if greater than 10,000 gosub JumpToTraining
// Check if enough Iron is Being Produced, if not, gosub buildMoreMines
//===================================================

      ifgosub ( m_city.cityManager.resource.wood.amount > 10000 ) JumpToTraining
      ifgosub ( m_city.cityManager.resource.iron.increaseRate < 5000 ) buildMoreMines

Troops

Example :

      ifgosub ( m_city.cityManager.troop.archer < 100000 ) buildArchers
      ifgosub ( m_city.cityManager.troop.heavyCavalry < 100000 ) buildPhracts
      ifgosub ( m_city.cityManager.troop.catapults < 15000 ) buildPults

IsHeroInCastle

Arg : m_city.IsHeroInCastle(heroname)
Explanation : Checks your city for a named Hero.
*Note: Checks only if your city has hero registered not if he/she is idle.

Coded Example :

      ifgoto ( m_city.IsHeroInCastle(AtkA) == true ) buildArcher
      ifgoto ( m_city.IsHeroInCastle(AtkS) == true ) buildScout
      ifgoto ( m_city.IsHeroInCastle(AtkP) == true ) buildPike
      ifgoto ( m_city.IsHeroInCastle(AtkW) == true ) buildWarr
      ifgoto ( m_city.IsHeroInCastle(AtkSw) == true ) buildSword
      //
      label buildArcher
      …

Note : Reference Must be spelled & spaced exactly as shown.

AnyIdleHero

Arg : m_city.AnyIdleHero(heroname/any)
Explanation : Checks your city for a named Hero or any Hero that is idle.

Coded Example :

//=======================================
// Attack lvl5 NPC
// goto Check subroutine
// train archers
// Check if ATK295 is Idle, if yes then goto TrainBig
// CHeck if any Hero is Idle, if yes then return to Farming
//=======================================

      attack XXX,YYY any b:400,t:400
      gosub Check
      …
      //
      label Check
      train a:2000 any all
      ifgosub ( m_city.AnyIdleHero(ATK295) == true ) TrainBig
      ifgoto ( m_city.AnyIdleHero(any) == true ) goBack
      sleep 600
      loop Check 0
      label goBack
      gosubreturn
      //
      label TrainBig
      train cata:400 any all
      gosubreturn

Note : Reference Must be spelled & spaced exactly as shown.

City References

Note : Reference Must be spelled & spaced exactly as shown.

Edited City References

All of the following references have been tested. The results, including the script used to access the variables is availible in the Reference Test section of this wiki. Exceptions in orange.

Every effort has been made in an attempt to make them work. An examination of the code, for example, showed that 'taxrate' was non-functional due to being spelt incorrectly in the Evony code.

Those that returned errors and could not be made to work were deleted from the output.

Market Prices

Beginning with version 2070, anew reference class, m_context, has been added. The first members are calls to the current market prices of each commodity.

To find the current buy/sell price of any resource:

The constants for each resource:

Example: a completely runnable 5 minute script...

 1: label check_market
2: ifgoto ( m_city.cityManager.resource.gold < 400000000 ) we_are_broke
3: ifgoto ( m_context.buyPrice(1) < 32 ) buywood 
4: ifgoto ( m_context.buyPrice(3) < 30 ) buyiron 
5: label we_are_broke
6: ifgoto ( m_city.cityManager.resource.gold < 50000 ) we_are_really_broke
7: ifgoto ( m_context.sellPrice(1) > 35 ) sellwood
8: ifgoto ( m_context.sellPrice(1) > 38 ) selliron
9: goto check_market
10: label we_are_really_broke
11: ifgoto ( m_city.cityManager.resource.lumber.amount < 30000 ) and_we_have_no_wood
12: sell lumber 1000 20
13: repeat 20
14: goto we_are_broke
15: label and_we_have_ne_wood
16: ifgoto ( m_city.cityManager.resource.iron.amount < 30000 ) uhoh
17: sell iron 1000 20
18: repeat 20
19: goto we_are_broke
20: label uhoh
21: sleep rnd:250
22: goto we_are_really_broke
23: label sellwood
24: sell lumber 500000 35
25: goto check_market
26: label selliron 
27: sell iron 500000 38
28: goto check_market
29: label buywood
30: buy lumber 500000 32
31: goto checkmarket
32: label buyiron 
33: buy iron 500000 30
34: goto checkmarket