IMapInfo (External Module API 1.5.2 Documentation

```
public interface IMapInfo
```
General map info.

Author:

Andras Belicza

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getBoundaryBottom()` Returns the bottom boundary of the playable size of the map.
`int`	`getBoundaryLeft()` Returns the left boundary of the playable size of the map.
`int`	`getBoundaryRight()` Returns the right boundary of the playable size of the map.
`int`	`getBoundaryTop()` Returns the top boundary of the playable size of the map.
`java.lang.String`	`getCustomLargePreviewPath()` Returns the large preview path in case of custom (`getLargePreviewType()`).
`java.lang.String`	`getCustomSmallPreviewPath()` Returns the small preview path in case of custom (`getSmallPreviewType()`).
`java.lang.String`	`getFogType()` Returns the fog of War type.
`int`	`getHeight()` Returns the height of the map.
`int`	`getLargePreviewType()` Returns the large preview type; 0 = None, 1 = Minimap, 2 = Custom.
`int`	`getPlayableHeight()` Returns the playable height of the map.
`java.lang.String`	`getPlayableSizeString()` Returns the playable size of the map in a format of `WIDTHxHEIGHT`.
`int`	`getPlayableWidth()` Returns the playable width of the map.
`java.lang.String`	`getSizeString()` Returns the size of the map in a format of `WIDTHxHEIGHT`.
`int`	`getSmallPreviewType()` Returns the small preview type; 0 = None, 1 = Minimap, 2 = Custom.
`java.lang.String`	`getTileSet()` Returns the tile set used on the map.
`int`	`getVersion()` Returns the version of the map file.
`int`	`getWidth()` Returns the width of the map.

- Method Detail
  - getVersion
```
int getVersion()
```
    Returns the version of the map file.
    
    Returns:
    the version of the map file
  - getWidth
```
int getWidth()
```
    Returns the width of the map.
    
    Returns:
    the width of the map
  - getHeight
```
int getHeight()
```
    Returns the height of the map.
    
    Returns:
    the height of the map
  - getSmallPreviewType
```
int getSmallPreviewType()
```
    Returns the small preview type; 0 = None, 1 = Minimap, 2 = Custom.
    
    Returns:
    the small preview type; 0 = None, 1 = Minimap, 2 = Custom
  - getCustomSmallPreviewPath
```
java.lang.String getCustomSmallPreviewPath()
```
    Returns the small preview path in case of custom (getSmallPreviewType()).
    
    Returns:
    the small preview path in case of custom (getSmallPreviewType())
  - getLargePreviewType
```
int getLargePreviewType()
```
    Returns the large preview type; 0 = None, 1 = Minimap, 2 = Custom.
    
    Returns:
    the large preview type; 0 = None, 1 = Minimap, 2 = Custom
  - getCustomLargePreviewPath
```
java.lang.String getCustomLargePreviewPath()
```
    Returns the large preview path in case of custom (getLargePreviewType()).
    
    Returns:
    the large preview path in case of custom (getLargePreviewType())
  - getFogType
```
java.lang.String getFogType()
```
    Returns the fog of War type.
    
    Returns:
    the fog of War type
  - getTileSet
```
java.lang.String getTileSet()
```
    Returns the tile set used on the map.
    
    Returns:
    the tile set used on the map
  - getBoundaryLeft
```
int getBoundaryLeft()
```
    Returns the left boundary of the playable size of the map.
    
    Returns:
    the left boundary of the playable size of the map
  - getBoundaryBottom
```
int getBoundaryBottom()
```
    Returns the bottom boundary of the playable size of the map.
    
    Returns:
    the bottom boundary of the playable size of the map
  - getBoundaryRight
```
int getBoundaryRight()
```
    Returns the right boundary of the playable size of the map.
    
    Returns:
    the right boundary of the playable size of the map
  - getBoundaryTop
```
int getBoundaryTop()
```
    Returns the top boundary of the playable size of the map.
    
    Returns:
    the top boundary of the playable size of the map
  - getPlayableWidth
```
int getPlayableWidth()
```
    Returns the playable width of the map.
    
    Returns:
    the playable width of the map
  - getPlayableHeight
```
int getPlayableHeight()
```
    Returns the playable height of the map.
    
    Returns:
    the playable height of the map
  - getSizeString
```
java.lang.String getSizeString()
```
    Returns the size of the map in a format of WIDTHxHEIGHT.
    
    Returns:
    the size of the map in a format of WIDTHxHEIGHT
  - getPlayableSizeString
```
java.lang.String getPlayableSizeString()
```
    Returns the playable size of the map in a format of WIDTHxHEIGHT.
    
    Returns:
    the playable size of the map in a format of WIDTHxHEIGHT

This API documentation is public and is intended for / allowed to be used by anyone.
Scelight home page: https://sites.google.com/site/scelight/
Scelight is a trademark of András Belicza. Copyright © András Belicza, 2013-2015. All rights reserved.

Interface IMapInfo

Method Summary

Method Detail

getVersion

getWidth

getHeight

getSmallPreviewType

getCustomSmallPreviewPath

getLargePreviewType

getCustomLargePreviewPath

getFogType

getTileSet

getBoundaryLeft

getBoundaryBottom

getBoundaryRight

getBoundaryTop

getPlayableWidth

getPlayableHeight

getSizeString

getPlayableSizeString