This script is not a standalone script. Its purpose is to be included in your Greasemonkey scripts to provide you with quick tools to accomplish common tasks. It automatically reads and stores information about your cities, resources, etc.

Scripts that use these tools

• Ikariam Alliance Online
• Ikariam Army Helper
• Ikariam Auto Build & Upgrade
• Ikariam Empire Links
• Ikariam Notifier
• Ikariam Research Times

Usage

This script can be included in your scripts by including the following two lines in the meta data block at the top of your script.

// @require    http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js
// @require    http://userscripts.org/scripts/source/57377.user.js

The first line downloads a local copy of JQuery for inclusion, while the second downloads a copy of this script. Note that these two scripts will only be downloaded when you install your script. Just adding the two lines above without re-installing the script will do nothing. For more information, read about the @require meta tag

At the top of your actual code, call IkaTools.init() to load everything into memory so that the tools will be available.

The following methods (functions) are available. For more details about each method, see the "Method Details" section below (use page search to search for method names for faster access).

Method Details

Method documentation as of v0.02 ... will update soon.

The following method names are available and can be called as follows: IkaTools.methodName(params)

IkaTools.addInfoBox(titleHtml, contentDiv)

• Adds an info box to the left bar of the Ikariam window.
• Parameters
  • titleHtml - String representing the HTML to be used within the info boxe's h3 header tag
  • contentDiv - Div element to be used as the content of the info box.
• Usage Example
  • var myContent = document.createElement('div');
myContent.innerHTML = "<p>Hello world, try <a href"http://google.com">Google</a></p>";
IkaTools.addInfoBox("Hello World", myContent);
    

IkaTools.cityGetBuildingByPosition(position, city)

• Returns a building object for the given city and position or false if the building can't be found.
• Parameters
  • city - An optional city object. If none is given, the current city will be used.
  • position - The numerical position to check (0 to 14)

IkaTools.cityGetLevel(city)

• Returns the level of the city supplied as a parameter or the level of the current city if none is supplied.
• Parameters
  • city - An optional city object for which to get the level. If none is supplied, the current city will be used.

IkaTools.getCityById(id)

• Returns a city object or false if the city can't be found.
• Parameters
  • id - The ID of the city you wish to get

IkaTools.getCurrentCityId()

• Returns a city object representing the current city.

IkaTools.getCurrentCityId()

• Returns the ID of the current city.

IkaTools.getDomain()

• Returns the current Ikariam domain as a string (e.g. "s1.ikariam.com")

IkaTools.getVal(key, useDomain)

• Gets the stored value for the current Ikariam server from the Firefox config. Similar to GM_getValue() except that it automatically pulls data for the specific domain you are currently on (e.g. s2.ikariam.org). Capable of directly returning stored objects.
• Parameters
  • key - String representing the unique value you wish to retrieve
  • useDomain - Optional boolean parameter to specify whether or not to get data for the current Ikariam domain. Defaults to true.

IkaTools.goTo(url, cityId)

• Redirects to a new url, automatically handling any city changes if a city ID is provided and does not match the current city.
• Parameters
  • url - String representing the url to navigate to (e.g. "/index.php?view=academy&id=12345&position=4")
  • cityId- Optional integer value representing the ID of the city to load. If this is provided and does not match the current city ID, the current city will automatically be changed to the new city ID.

IkaTools.getView()

• Returns the current view as a string (e.g. "city", "island", "academy").

IkaTools.setVal(key, value, useDomain)

• Sets a stored value for the current Ikariam server to the Firefox config. Similar to GM_setValue() except that it automatically associates data with the specific domain you are currently on (e.g. s2.ikariam.org). Capable of storing just about anything (integers, strings, objects, arrays, etc.)
• Parameters
  • key - String representing the unique value you wish to set
  • value - String, value, or object to store. Note that 0 (zero) should be set as a string as follows: "0"
  • useDomain - Optional boolean parameter to specify whether or not to set data for the current Ikariam domain. Defaults to true.

Objects

building - represents an Ikariam building

• Properties
  • position - The numerical position in the city (0 to 14)
  • name - The name of the building
  • level - The building's current level
  • cityId - The ID of the city to which the building belongs

city - represents an Ikariam city

• Properties
  • id - The ID of the city
  • name - The name of the city
  • buildings - An array containing the building objects for each building in the city

Version History

• Put in a fix to help reduce data loss on page errors

• Simplified IkaTools.getView()

• Fixed bug in saving current construction right after build

• Added IkaTools.getText() method (to be documented)
• Minor code improvements
• Added public IkaTools.buildingTypes array that contains all building types

• Fixed corruption of current city data when viewing someone else's city with a spy

• Fixed addInfoBox() not working on some pages (museum for example)

• Added some trackData config parameters (to be documented later)

• Added IkaTools.formatMilliseconds() method
• Added IkaTools.formatSeconds() method
• Added IkaTools.formatMilliseconds() method
• Added IkaTools.formatMilliseconds() method

• Added IkaTools.addCommas() method
• Fixed detection of cities of glass tradegood type

• Cleaned up the code a bit
• Fixed bug where troop production in barracks would make the script think the barracks was being upgraded

• Wine consumption is now taken into account
• Added IkaTools.cityGetWineConsumption() method
• Resource gain no longer is calculated beyond max capacity

• Added IkaTools.getRemoteDocument() method

• Added IkaTools.cityGetBuildBuilding() method
• Added IkaTools.cityGetBuildSecondsRemaining() method

• Buildings are now correctly updated when their respective views
• Added IkaTools.cityGetBuildingByType() method
• Added IkaTools.buildingGetResourceRequired() method
• Added IkaTools.buildingGetResourceRequiredTotal() method
• Added IkaTools.buildingGetResourceMissing() method
• Added IkaTools.buildingGetResourceMissingTotal() method

• Added research resource tracking

• Calling IkaTools.cityGetResource("gold") now returns a city's net income (income minus upkeep)

• Added IkaTools.getCurrentIslandId() method
• Added IkaTools.cityGetIncome() method
• Added IkaTools.cityGetIslandId() method
• Added IkaTools.cityGetResource() method
• Added IkaTools.cityGetResourceChange() method
• Added IkaTools.cityGetResourceMax() method
• Added IkaTools.cityGetSawmillLevel() method
• Added IkaTools.cityGetTradegoodType() method
• Added IkaTools.cityGetTradegoodLevel() method

• Added options that can be submitted to IkaTools.init()
• Added debugMode option
• Added IkaTools.cityGetLevel() method

Share

Tags

• developer
• ikariam
• library
• phasma
• script
• tools

Other Scripts by Author

• Script Updater (userscripts.org)
• Ikariam Auto Build & Upgrade
• Ikariam Sexy Theme
• Ikariam Pillage Helper
• Growl Tools
• Ikariam Empire Overview
• Ikariam Notifier (email & more)
• Ikariam Military Cargo
• Ikariam Resource Links
• Ikariam Library Tools

and 18 more