Burnout Paradise™
Paradise City Interactive Locations Map KML Support
The Paradise City Interactive Map supports a subset of Google Earth's KML for drawing locations and lines on the map. This makes the map completely customizable allowing you to define custom locations that you can share with others using a simple XML file. To learn how to use KML with the map, see the help page. The following KML Objects are supported:
- Document
- LookAt
- Placemark
- Point
- LineString
- LinearRing
- Polygon
- Style
- IconStyle
- Icon
- LineStyle
- PolyStyle
Each of these objects are found within the root kml tag of a KML XML document. Each object supports all or a subset of their respective KML properties.
Note: Objects are defined in KML with a starting capital letter, e.g. <Document>. Those tags with lowercase letters are considered properties, e.g. <name>.
<Document>
Description
The container element for Placemark objects describing the KML document.
Properties
- name
- The name or title of the document.
- description
- A description of the document.
Child Objects
LookAt, Placemark
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<!-- Document definition -->
</Document>
</kml>
<LookAt>
Description
Defines the start location and zoom of the map. The latitude and longitude properties of the LookAt object for the purpose of this map has been remapped to represent pixel x and y values, respectively. The range property represents the zoom. When a KML document is loaded into the map, the map is immediately repositioned and zoomed to the values indicated in the LookAt tag.
Properties
- latitude
- The x pixel value of the central location of the map indicated by the black cross-hairs.
- logitude
- The y pixel value of the central location of the map indicated by the black cross-hairs.
- range
- The zoom level of the map.
Parent Objects
Document
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<LookAt>
<latitude>1170</latitude>
<longitude>725</longitude>
<range>85</range>
</LookAt>
</Document>
</kml>
<Placemark>
Description
Define a location of interest. They can be defined as one or more points (Point), lines (LineString, LinearRing), or shapes (Polygon).
Properties
- name
- The name or title of the placemark.
- description
- A description of the placemark indicating what it is and how to get there - or, really, any pertinent information relating to the placemark.
- styleUrl
- References the
Styleobject to be used with this placemark. If not specified, a default style will be used.
Parent Objects
Document
Child Objects
Point, LineString, LinearRing, Polygon
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<Placemark>
<name>Billboard</name>
<description>Jump off the steps to land this billboard.</description>
<Point>
<coordinates>1022,561</coordinates>
</Point>
</Placemark>
</Document>
</kml>
<Point>
Description
The location of the placemark as indicated by the coordinates provided below the navigation control pads on the map (these values are subject to change). Points are styled with IconStyle objects.
Properties
- coordinates
- Contains the values of the point. This is in the format of [y-location],[x-location],[optional-altidude] and should only contain numeric values. Though altitude can be specified, it will be ignored when the map is rendered. The location 0,0 on the map is at the top-left corner.
Parent Objects
Placemark
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<Placemark>
<name>Billboard</name>
<description>Jump off the steps to land this billboard.</description>
<Point>
<coordinates>1022,561</coordinates>
</Point>
</Placemark>
</Document>
</kml>
<LineString>
Description
Defines a line drawn within the map that is associated with a placemark. Lines can be given styles through the Style object. Those lines without styles will use the default style (semi-transparent blue in color). The locations of lines are defined within a coordinates property where each point is separated by a space ( ) character. LineStrings are styled with LineStyle objects.
Properties
- coordinates
- Contains the point coordinates that make up the line. Points are in the format of [y-location],[x-location],[optional-altidude] and are separated by a space ( ). Though altitude can be specified, it will be ignored when the map is rendered. The location 0,0 on the map is at the top-left corner.
Parent Objects
Placemark
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<Placemark>
<name>Rail</name>
<description>Rail</description>
<LineString>
<coordinates>1258,739 1323,722 1314,653 1265,650 1239,639 1211,631</coordinates>
</LineString>
</Placemark>
</Document>
</kml>
<LinearRing>
Description
Exactly like LineString objects except a line is drawn from the end coordinate point back to the first coordinate point making a closed path. LinearRings are also used to define the shapes of Polygon objects.
<Polygon>
Description
Defines a (usually filled) shape on the map. Polygon shapes are defined by one or more LinearRing objects which are contained in its outerBoundaryIs or, optionally, its innerBoundaryIs properties. Polygons are styled with PolyStyle and LineStyle objects.
Properties
- outerBoundaryIs
- A container for a single
LinearRingobject that is used to define the shape of the polygon. Additional paths can be added to theinnerBoundaryIstag to "cut out".parts of the shape defined within this property. - innerBoundaryIs
- A container for 0 or more
LinearRingobjects that can be used to define "cut out".portions of the shape defined inouterBoundaryIs.
Parent Objects
Placemark
Child Objects
LinearRing (only within innerBoundaryIs and outerBoundaryIs tags)
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<Placemark>
<name>Rail</name>
<description>Rail</description>
<Polygon>
<outerBoundaryIs>
<LinearRing>
<coordinates>1258,739 1323,722 1314,653 1265,650 1239,639 1211,631</coordinates>
</LinearRing>
</outerBoundaryIs>
</Polygon>
</Placemark>
</Document>
</kml>
<Style>
Description
Defines a placemark style. A single style can be applied to one or many placemarks controlling how points, lines, or polygon shapes are drawn for them. Styles are defined in either the Document object itself at which point they are accessible to all placemarks through a styleUrl reference, or can be included as a child of a Placemark object at which point they only affect that object.
Attributes
- id
- Identifies a style using a unique alpha-numeric name. To reference a style defined in the
Documentobject,Placemarkobjects use the style id in theirstyleUrlproperty with a proceeding pound (#) sign.
Parent Objects
Document, Placemark
Child Objects
No more than one each: IconStyle, LineStyle, PolyStyle
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<Style id="billboardStyle">
<IconStyle>
<Icon>
<href>$billboard</href>
</Icon>
</IconStyle>
</Style>
<Placemark>
<name>Billboard</name>
<description>Jump off the steps to land this billboard.</description>
<styleUrl>#billboardStyle</styleUrl>
<Point>
<coordinates>1022,561</coordinates>
</Point>
</Placemark>
</Document>
</kml>
<IconStyle>
Description
Defines a style for a Point object by specifying an icon to be drawn at that point. Icons can reference icons pre-existing in the map application or link to external images.
Properties
- scale
- The factor to scale an icon beyond its original size where 1 represents 100% normal scale.
Parent Objects
Style
Child Objects
Icon
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<Style id="billboardStyle">
<IconStyle>
<Icon>
<scale>1.5</scale>
<href>$billboard</href>
</Icon>
</IconStyle>
</Style>
<Placemark>
<name>Billboard</name>
<description>Jump off the steps to land this billboard.</description>
<styleUrl>#billboardStyle</styleUrl>
<Point>
<coordinates>1022,561</coordinates>
</Point>
</Placemark>
</Document>
</kml>
<Icon>
Description
Defines the icon graphic for an IconStyle object. It contains one property, href, which references the icon to be used. This can be an external URL or a reference to an icon within the map application.
Properties
- href
- The reference to the icon graphic used for the icon. This can exist in two contexts: native graphics contained within the map application, or external images that can be loaded into the application. When the href value is preceeded with a dollar ($) or pound (#) sign, the value is assumed to be an native graphic reference. Otherwise, it is considered an external reference to a remote graphic. Native graphic references include:
$arrow(default)$billboard$burningrouteevent$checkpoint$dot$downtownparadiselabel$enteronly$exitonly$gasstation$harbortownlabel$junkyard$markedmanevent$paintshop$palmbayheightslabel$parking$raceevent$raceflag$racelight$repairshop$roadrageevent$silverlakelabel$smash$stuntrunevent$superjump$whitemountainlabel
Parent Objects
IconStyle
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<Style id="billboardStyle">
<IconStyle>
<Icon>
<href>$billboard</href>
</Icon>
</IconStyle>
</Style>
<Placemark>
<name>Billboard</name>
<description>Jump off the steps to land this billboard.</description>
<styleUrl>#billboardStyle</styleUrl>
<Point>
<coordinates>1022,561</coordinates>
</Point>
</Placemark>
</Document>
</kml>
<LineStyle>
Description
Defines a style for LineString, LinearRing, and Polygon objects by specifying color and size of the lines drawn.
Properties
- color
- A hexidecimal AABBGGRR color value (alpha, red, green, blue) denoting the color and transparency of the line where FF represents a full application of the color and 00 represents none.
- width
- The width of the line in pixels. Unlike icons, a line's width will scale with the map as you zoom in and out so the width value may not always represent the actual width on the screen.
Parent Objects
Style
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<Style id="railStyle">
<LineStyle>
<color>cccc00b0</color>
<width>6</width>
</LineStyle>
</Style>
<Placemark>
<name>Rail</name>
<styleUrl>#railStyle</styleUrl>
<description>Rail</description>
<LinearRing>
<coordinates>1258,739 1323,722 1314,653 1265,650 1239,639 1211,631</coordinates>
</LinearRing>
</Placemark>
</Document>
</kml>
<PolyStyle>
Description
Defines the style for Polygon objects, namely the fill style. Polygon outline styles are defined by LineStyle objects, however, a PolyStyle object can determine whether or not a outline (or a fill) is used on a polygon.
Properties
- color
- A hexidecimal AABBGGRR color value (alpha, red, green, blue) denoting the color and transparency of the polygon's fill where FF represents a full application of the color and 00 represents none. (For outline styles, use a
LineStyleobject.) - outline
- Indicates whether an outline is used with the polygon shape. 1 means yes, 0 means no. The default is 1.
- fill
- Indicates whether a fill is used with the polygon shape. 1 means yes, 0 means no. The default is 1. If an outline is used and a fille is not, you are basically left with a
LinearRing.
Parent Objects
Style
Example
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://earth.google.com/kml/2.1">
<Document>
<Style id="railStyle">
<PolyStyle>
<color>cccc00b0</color>
<outline>0</outline>
</PolyStyle>
</Style>
<Placemark>
<name>Rail</name>
<styleUrl>#railStyle</styleUrl>
<description>Rail</description>
<Polygon>
<outerBoundaryIs>
<LinearRing>
<coordinates>1258,739 1323,722 1314,653 1265,650 1239,639 1211,631</coordinates>
</LinearRing>
</outerBoundaryIs>
</Polygon>
</Placemark>
</Document>
</kml>
Existing KML Documents
For more examples of KML, here are some of the KML documents used currently by the map:
« Back to the Burnout Paradise Interactive Map