Difference between revisions of "Reference Section"

Revision as of 14:59, 12 June 2011

TEMPORARY COPY - NEEDS REFORMATTED STILL
Information may not be accurate.

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.

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

This is Under construction dull green.

This is Under construction dull blue.

This is Under construction brown.

This is Under construction pale cyan.

This is Under construction calm blue.

build cottage:0:0

build cottage:0:0

This is Under construction.