IGB Javascript Methods

In order to facilitate communication between EVE IGB sites and the EVE Client, certain methods have been provided via JavaScript. These methods allow IGB-driven sites to interact directly with the EVE client.

Note that these methods are heavily locked-down within the client code; any input deviating from the specification found herein is likely to be discarded as malicious. Further, only sites that the user has designated as Trustworthy will be allowed to execute these methods.

Contents 1 Arguments and Return Values 1.1 A Note on Arguments 1.2 A Note on ID Numbers 1.2.1 Some Helpful Type ID Numbers 2 Website Trust 3 CCPEVE Object 3.1 openEveMail Method 3.2 showInfo Method 3.3 showPreview Method 3.4 showRouteTo Method 3.5 showMap Method 3.6 showFitting Method 3.7 showContract Method 3.8 showMarketDetails Method 3.9 requestTrust Method 3.10 setDestination Method 3.11 addWaypoint Method 3.12 joinChannel Method 3.13 joinMailingList Method 3.14 createContract Method 3.15 buyType Method 3.16 findInContracts Method 3.17 addToMarketQuickBar Method 3.18 addContact Method 3.19 removeContact Method 3.20 addCorpContact Method 3.21 removeCorpContact Method 3.22 block Method 3.23 addBounty Method 3.24 inviteToFleet Method 3.25 startConversation Method 3.26 showContracts Method 3.27 showOnMap Method 3.28 editMember Method 3.29 awardDecoration Method 3.30 sendMail Method 3.31 showContents Method 3.32 bookmark Method

Arguments and Return Values

All methods are called by the convention CCPEVE.methodName(methodArg1, methodArg2, ...). No methods provide a return value. (Method Names are case sensitive)

Possible argument types as of Awesomium 1.5 are:

Boolean

A boolean value is one of two unique values, true and false.

String

A string value is a sequence of zero or more characters.

Number

A number value is a direct representation of a number.

Array

An array is an ordered collection of values.

Object

An object is an unordered collection of properties each of which contains a primitive value, object or function.

Undefined

The undefined value is used when a variable has not been assigned a value.

Null

The null value represents the null, empty, or non-existent reference.

A Note on Arguments

In the original IGB, and in earlier builds on SiSi, the JavaScript methods used a single-argument calling convention, where multiple arguments were concatenated into a single string, delimited by some sort of substring - in many cases, this was a double-slash (//).

As we now have the capability to process multiple arguments, we are shifting Moondoggie to behave like a proper software package. As such, we are deprecating support for old-style arguments in the SiSi build released on October 14th, and will be entirely removing support in the SiSi build released on October 28th.

In order to update your websites, you will need to find any places where you are using the following pattern:

CCPEVE.showInfo('5//30003276')

And change it to the following pattern:

CCPEVE.showInfo(5, 30003276)

This pattern is identical for all calls that take delimited strings. Conversions can be found in the documentation for each individual calls.

A Note on ID Numbers

Behind the scenes, many things in EVE are identified by unique numbers. Among these, IGB development exposes solar system ID numbers, item ID numbers, type ID numbers, and character ID numbers.

Solar System ID numbers

uniquely identify solar systems in EVE. For example, Jita has one solar system ID number while Rens has another. No two solar systems in EVE have the same solar system ID number.

Character ID numbers

uniquely identify player and non-player characters in EVE. No NPC or PC has the same identification number - even if they are on the same account.

Type ID numbers

uniquely identify types of items. This is analogous to a model number on a car or television. It does not uniquely identify any given object in the game; instead, it specifies what that item is, and what properties it has. For example, all Bloodclaw Light Missiles share the same type ID number. However, Bloodclaw Light Missiles and Havoc Heavy Missiles have different type ID numbers.

Item ID numbers

uniquely identify objects in the game. Every single object (or stack of objects) in EVE has its own item ID number. Your Rifter has a unique item ID number differentiating it from your friend's Rifter. Think of this as the serial number on a television, or the VIN on a car.

Character ID numbers and solar system ID numbers are actually special cases of item ID numbers. No item in EVE will have the same number as a character or solar system.

This is most important when using the CCPEVE.showInfo method, which requires a type ID number and optionally allows you to specify an item ID number. When viewing the attributes on a generic class of objects, you need only specify a type ID number - for example, if you want to see the attributes for a Rifter in general, you can just specify a type ID number.

However, if you would like to see the attributes of your character, you will need to pass in the character's type ID number and the character ID number - recall that character ID numbers are just special item ID numbers.

Some Helpful Type ID Numbers

Alliance

16159

Character

1377 (see note 1)

Corporation

2

Constellation

4

Region

3

Solar System

5

Station

3867 (see note 2)

Note 1: There are actually different type IDs for each character race. However, for the purposes of the showInfo command, you can pass in any character race type ID - we suggest 1377 - and we will automatically detect that you are attempting to show information on a character. We will then fill in the appropriate type ID automatically.

Note 2: There are actually many different type IDs for various types of station. However, for the purposes of the showInfo command, you should pass in type ID 3867, which we will detect and automatically convert to the appropriate type ID for you.

Website Trust

This section is a stub. You can help Evelopedia by expanding it with more content and relevant information.

A website can have different levels of trust:

• Trusted
• Neutral
• Not Trusted

Different methods require different levels of trust. The trust level can be changed by invoking the requestTrust method.

The trust level also influences if IGB Headers are sent to the website.

CCPEVE Object

openEveMail Method

Opens the character's mail inbox.

showInfo Method

typeID (Number)

Type ID of item to show info on.

itemID (Number)

Optional item ID of specific item of type typeID to show info on. This is required for specific types of items, such as solar systems, stations, regions, and constellations.

Opens the show info window for typeID. If itemID is given, the show info window will open for that item.

• Deprecated Syntax - Convert this to the example shown above ASAP

  <button type="button" onclick="CCPEVE.showInfo('5//30003276')">Show Info (Solar System 30003276)</button>

showPreview Method

typeID (Number)

Type ID of item to preview.

Opens the preview window for typeID.

showRouteTo Method

destinationID (Number)

ID of destination solar system.

sourceID (Number)

Optional ID of source solar system.

Shows the route to the destinationID from the sourceID. If sourceID is not given, the source system is taken to be the system the user is currently in.

• Example of Deprecated Syntax - Convert this to the example shown above ASAP

  <button type="button" onclick="CCPEVE.showRouteTo('30003276::30000380')">Show Route (30000380 to 30003276)</button>

showMap Method

systemID (Number)

Optional ID of solar system to focus map on.

Opens the map. If systemID is given, the map will focus on that system.

showFitting Method

fitting (String)

A Ship DNA string.

Opens the fitting window and displays the fitting represented by fitting.

showContract Method

solarSystemID (Number)

The ID number of the solar system in which the contract is located.

contractID (Number)

The ID number of the contract to display.

Opens the contract window and displays the contract represented by the contractID argument. Contracts are, however, assigned per-solar-system, and so a solarSystemID must also be provided.

• Example of Deprecated Syntax - Convert this to the example shown above ASAP

  <button type="button" onclick="CCPEVE.showContract('30003410//14')">Show Contract</button>

showMarketDetails Method

typeID (Number)

Type ID to display market details about

Opens the market details window and displays the information about the item represented by typeID.

requestTrust Method

trustableUrl (String)

This is a fully-qualified domain name and path (e.g. http://wiki.eveonline.com/w/) to which your site would like the user to grant trust.

This method will pop-up a trust prompt in the client, allowing the user to either grant the trust request, ignore it, or always ignore trust requests from your site.

The page will not be automatically refreshed if the user grants the trust request. Trust will take effect the next time the user refreshes the page, or navigates within the site.

Note that trustableUrl is processed and only the protocol, domain and path will be used from it. If you supply a query string or anchor, they will be discarded. It is recommended that you primarily pass in only fully-qualified domain names without paths (e.g. http://wiki.eveonline.com instead of http://wiki.eveonline.com/w/index.php), as this avoids pestering the user for trust on every page.

To auto-request trust on page load, modify your body tag to add an onLoad JavaScript call, like so:

setDestination Method

This method requires that the user grant Trust to the calling site.

solarSystemID (Number)

The numerical identifier of the solar system to which you wish to set the client's autopilot destination.

Sets the client's autopilot destination to the specified solarsystem.

addWaypoint Method

This method requires that the user grant Trust to the calling site.

solarSystemID (Number)

The numerical identifier of the solar system which you wish to append to the client's autopilot route.

Adds the specified solar system to the end of the client's autopilot route. If the solar system is already in the route, no changes are made and the method fails silently.

joinChannel Method

This method requires that the user grant Trust to the calling site.

channelName (String)

The name of the channel which the user will join.

Causes the user to attempt to join the named channel. Normal channel access control rules apply. If the user is unable to join the channel, the method fails silently.

joinMailingList Method

This method requires that the user grant Trust to the calling site.

mailingListName (String)

The name of the mailing list which the user will join.

Causes the user to subscribe to the named mailing list.

createContract Method

This method requires that the user grant Trust to the calling site.

contractType (Number)

The contract type: 1 = Item exchange 2 = Auction 3 = Courier .

station (Number)

Station id where items are located.

itemIDs (Number)

Comma seperated list of item ids.

Launches Create Contract wizard with contract type, and optional items pre selected.

buyType Method

This method requires that the user grant Trust to the calling site.

typeID (Number)

The type id you want to buy.

Opens buy window, with sell offers of typeID selected.

findInContracts Method

This method requires that the user grant Trust to the calling site.

typeID (Number)

The type id you want to find.

Opens the contract window, with contracts of typeID selected.

addToMarketQuickBar Method

This method requires that the user grant Trust to the calling site.

typeID (Number)

The type id you want add to the market quickbar.

Adds typeID to the market quickbar.

addContact Method

This method requires that the user grant Trust to the calling site.

characterID (Number)

The character id you of the contact you want to add to your address book.

Adds characterID to address book, opens Edit Contact if he's already a contact.

removeContact Method

This method requires that the user grant Trust to the calling site.

characterID (Number)

The character id you of the contact you want to remove from your address book.

Removes characterID from address book.

addCorpContact Method

This method requires that the user grant Trust to the calling site.

typeID (Number)

The character id you of the corp contact you want to add your address book.

Adds corporation contact to address book.

removeCorpContact Method

This method requires that the user grant Trust to the calling site.

characterID (Number)

The character id of the corp contact you want to remove from your address book.

Removes corporation contact.

block Method

This method requires that the user grant Trust to the calling site.

characterID (Number)

The character id of the contact you want to block.

Blocks contact.

addBounty Method

This method requires that the user grant Trust to the calling site.

characterID (Number)

The character id of the contact you want to add a bounty to.

Adds bounty to contact.

inviteToFleet Method

This method requires that the user grant Trust to the calling site.

characterID (Number)

The character id of the contact you want to invite to you fleet.

Invites contact to fleet.

startConversation Method

This method requires that the user grant Trust to the calling site.

characterID (Number)

The character id of the contact you want to start a conversation with.

Starts a conversation with contact.

showContracts Method

This method requires that the user grant Trust to the calling site.

ownerID (Number)

The character id of the contact who's contracts you want to show.

Shows the contracts of a given owner.

showOnMap Method

This method requires that the user grant Trust to the calling site.

corporationID (Number)

The corporationID of the corporation to show on map.

Shows the location of a given corporation on map.

editMember Method

This method requires that the user grant Trust to the calling site.

characterID (Number)

The characterID of the character you want to edit.

Opens contact editor with character characterID loaded.

awardDecoration Method

This method requires that the user grant Trust to the calling site.

characterID (Number)

The characterID of the character you want award a decoration.

Opens award decoration dialog for character.

sendMail Method

This method requires that the user grant Trust to the calling site.

characterID (Number)

The characterID of the character you want send mail to.

subject (String)

Subject of mail.

body (String)

Body of mail.

Opens mail editor with character, subject, and body pre filled out.

showContents Method

This method requires that the user grant Trust to the calling site.

stationID (Number)

Station where item is located.

itemID (Number)

Item id of container.

Shows the contents of a given container item.

bookmark Method

This method requires that the user grant Trust to the calling site.

itemID (Number)

Item to bookmark.

Opens bookmark editor for item.

<button type="button" onclick="CCPEVE.joinMailingList('IGB Announcements')">Join IGB Announcements List</button>}}