The MapDisplay is an single view of a game’s MapData.
| MapDisplay | The MapDisplay is an single view of a game’s MapData. |
| Implementation Details | The MapDisplay is a very general UI element that is not specific to any particular game. |
| XML Definition | This is the MapDisplay xml definition. |
| Optional Attributes | These attributes are optional, depending on the MapDisplay that you are trying to create. |
| shape | The shape of the map. |
| iconScale | The amount to scale the icons. |
| loadingAnim | A reference to an AnimatedImage to display while the map is loading data. |
| Window Callbacks | These are the SliderBar specific callback events. |
| Callbacks | |
| OnPointMouseOver | Called when the user mouses over a icon map point (or points). |
The MapDisplay is a very general UI element that is not specific to any particular game. It is only the visual front end for a game’s map system.
Under the hood, the Map display creates a ‘map’ background image, and supports the display various icons. When the game adds icon, or other data to a MapDisplay, the MapDisplay provides the game a unique display index for each map point. When you mouse over or click on a map icon, you must pass that id number into your game-specific callback to get your game relevant data.
The MapDisplay uses a stencil buffer, so it will not work correctly if placed as a child element of any other stencil-using window element. These include..
This is the MapDisplay xml definition.
| Optional Attributes | These attributes are optional, depending on the MapDisplay that you are trying to create. |
| shape | The shape of the map. |
| iconScale | The amount to scale the icons. |
| loadingAnim | A reference to an AnimatedImage to display while the map is loading data. |
These attributes are optional, depending on the MapDisplay that you are trying to create.
The shape of the map.
A string value, that is one of the following...
| ”rect” | A rectangular map. |
| ”circular” | A circular map. |
A reference to an AnimatedImage to display while the map is loading data. This image will be shown/hidden by the game when map data is being loaded for this display.
A string value, which is a valid AnimatedImage definition.
These are the SliderBar specific callback events.
| Callbacks | |
| OnPointMouseOver | Called when the user mouses over a icon map point (or points). |