SKTilemap

public class SKTilemap : SKEffectNode, SKTiledObject

Overview

The SKTilemap class is a container for managing layers of tiles (sprites), vector objects & images. Tile data is stored in SKTileset tile sets.

Usage

Maps can be loaded with the class function SKTilemap.load(tmxFile:):

if let tilemap = SKTilemap.load(tmxFile: "myfile.tmx") {
   scene.addChild(tilemap)
}

Properties

Property	Description
mapSize	Size of the map (in tiles).
tileSize	Map tile size (in pixels).
renderSize	Size of the map in pixels.
orientation	Map orientation (orthogonal, isometric, etc.)
bounds	Map bounding rect.
tilesets	Array of stored tileset instances.
allowZoom	Allow camera zooming.
layers	Array of child layers.

▶︎TilemapOrientation
Overview

Enum describing map orientation type.

Constants

Property Description

orthogonal Orthogonal(square tiles) tile map.

isometric Isometric tile map.

hexagonal Hexagonal tile map.

staggered Staggered isometric tile map.

See more
Declaration
Swift

public enum TilemapOrientation : String
Show on GitHub

Property	Description
orthogonal	Orthogonal(square tiles) tile map.
isometric	Isometric tile map.
hexagonal	Hexagonal tile map.
staggered	Staggered isometric tile map.

Properties

▶︎url
Tilemap source file path.
Declaration
Swift

public var url: URL!
Show on GitHub
▶︎uuid
Unique SpriteKit node id.
Declaration
Swift

public var uuid: String
Show on GitHub
▶︎tiledversion
Indicates the Tiled application version this map was created with.
Declaration
Swift

public internal(set) var tiledversion: String! { get }
Show on GitHub
▶︎mapversion
Indicates the Tiled map version.
Declaration
Swift

public internal(set) var mapversion: String! { get }
Show on GitHub
▶︎type
Tilemap node type.
Declaration
Swift

public var type: String!
Show on GitHub
▶︎properties
Custom Tiled properties.
Declaration
Swift

public var properties: [String : String]
Show on GitHub
▶︎ignoreProperties
If enabled, custom Tiled properties are ignored.
Declaration
Swift

public var ignoreProperties: Bool
Show on GitHub
▶︎isRendered
Returns true if all of the child layers are rendered.
Declaration
Swift

public internal(set) var isRendered: Bool { get }
Show on GitHub
▶︎mapRenderTime
Returns the render time of this map.
Declaration
Swift

public internal(set) var mapRenderTime: TimeInterval { get }
Show on GitHub
▶︎size
Size of map (in tiles).
Declaration
Swift

public var size: CGSize
Show on GitHub
▶︎tileSize
Tile size (in pixels).
Declaration
Swift

public var tileSize: CGSize
Show on GitHub
▶︎orientation
Map orientation type.
Declaration
Swift

public var orientation: TilemapOrientation
Show on GitHub
▶︎displayName
Map display name. Defaults to the current map source file name (minus the tmx extension).
Declaration
Swift

public var displayName: String?
Show on GitHub
▶︎mapName
String representing the map name. Defaults to the current map source file name (minus the tmx extension).
Declaration
Swift

public var mapName: String { get }
Show on GitHub

Tile Update Mode

▶︎updateMode
Update mode used for tiles & objects.
Declaration
Swift

public var updateMode: TileUpdateMode { get set }
Show on GitHub

Render Quality

▶︎renderQuality
Scaling factor for text objects, etc.
Declaration
Swift

public var renderQuality: CGFloat { get set }
Show on GitHub
▶︎speed
Map animation speed
Declaration
Swift

override public var speed: CGFloat { get set }
Show on GitHub

Camera

▶︎CameraZoomConstraints
Render statistics
Declaration
Swift

public struct CameraZoomConstraints
Show on GitHub
▶︎autoResize
Indicates map should auto-resize upon view changes.
Declaration
Swift

public internal(set) var autoResize: Bool { get }
Show on GitHub
▶︎bounds
Map bounds.
Declaration
Swift

public var bounds: CGRect
Show on GitHub
▶︎receiveCameraUpdates
Receive notifications from camera.
Declaration
Swift

public var receiveCameraUpdates: Bool
Show on GitHub
▶︎cameraBounds
Display bounds that the tilemap is viewable in.
Declaration
Swift

public var cameraBounds: CGRect?
Show on GitHub
▶︎worldScale
Initial world scale
Declaration
Swift

public var worldScale: CGFloat
Show on GitHub
▶︎currentZoom
Map zoom level
Declaration
Swift

public var currentZoom: CGFloat
Show on GitHub
▶︎allowZoom
Allow camera zooming.
Declaration
Swift

public var allowZoom: Bool
Show on GitHub
▶︎allowMovement
Allow camera movement.
Declaration
Swift

public var allowMovement: Bool
Show on GitHub

Tilesets

▶︎firstGID
First global id value.
Declaration
Swift

public var firstGID: Int
Show on GitHub
▶︎tilesets
Current tilesets.
Declaration
Swift

public var tilesets: Set<SKTileset>
Show on GitHub
▶︎layerCount
Layer count.
Declaration
Swift

public var layerCount: Int { get }
Show on GitHub
▶︎objectCount
Object count.
Declaration
Swift

public var objectCount: Int { get }
Show on GitHub
▶︎zDeltaForLayers
Default z-position range between layers.
Declaration
Swift

public var zDeltaForLayers: CGFloat
Show on GitHub

Render Statistics/Debugging

▶︎RenderStatistics
Render statistics structure.
See more
Declaration
Swift

public struct RenderStatistics
Show on GitHub

Layers

▶︎layers
Returns a flattened array of child layers.
Declaration
Swift

public var layers: [SKTiledLayerObject] { get }
Show on GitHub

Background Properties

▶︎ignoreBackground
Ignore Tiled background color.
Declaration
Swift

public var ignoreBackground: Bool { get set }
Show on GitHub
▶︎backgroundColor
Optional background color (read from the Tiled file)
Declaration
Swift

public var backgroundColor: SKColor? { get set }
Show on GitHub
▶︎debugDrawOptions
Debug visualization options.
Declaration
Swift

public var debugDrawOptions: DebugDrawOptions { get set }
Show on GitHub
▶︎overlayColor
Overlay color.
Declaration
Swift

public var overlayColor: SKColor
Show on GitHub

Object Colors

▶︎gravity
dynamics
Declaration
Swift

public var gravity: CGVector
Show on GitHub
▶︎delegate
Reference to SKTilemapDelegate delegate.
Declaration
Swift

weak public var delegate: SKTilemapDelegate?
Show on GitHub
▶︎frame
Map frame.
Declaration
Swift

override public var frame: CGRect { get }
Show on GitHub
▶︎getVertices()
Object vertices.
Declaration
Swift

public func getVertices() -> [CGPoint]
Show on GitHub
▶︎sizeInPoints
Size of the map in points.
Declaration
Swift

public var sizeInPoints: CGSize { get }
Show on GitHub
▶︎lastGID
Returns the last GID for all of the tilesets.
Declaration
Swift

public var lastGID: Int { get }
Show on GitHub
▶︎lastIndex
Returns the last index for all tilesets.
Declaration
Swift

public var lastIndex: Int { get }
Show on GitHub
▶︎lastZPosition
Returns the last (highest) z-position in the map.
Declaration
Swift

public var lastZPosition: CGFloat { get }
Show on GitHub
▶︎tileOverlap
Tile overlap amount. 1 is typically a good value.
Declaration
Swift

public var tileOverlap: CGFloat { get set }
Show on GitHub
▶︎showObjects
Global property to show/hide all SKTileObject objects.
Declaration
Swift

public var showObjects: Bool { get set }
Show on GitHub


                    
                    
                    
                    ▶︎showObjects(forLayers:)

Show objects for the given layers.

Declaration

Swift

public func showObjects(forLayers: [SKTiledLayerObject])

Parameters


                                forLayers

[SKTiledLayerObject] array of layers.

Return Value

[SKTileLayer] array of tile layers.

Show on GitHub


                    
                    
                    
                    ▶︎tileLayers(recursive:)

Return all tile layers. If recursive is false, only returns top-level layers.

Declaration

Swift

public func tileLayers(recursive: Bool = true) -> [SKTileLayer]

Parameters


                                recursive

Bool include nested layers.

Return Value

[SKTileLayer] array of tile layers.

Show on GitHub


                    
                    
                    
                    ▶︎objectGroups(recursive:)

Return all object groups. If recursive is false, only returns top-level layers.

Declaration

Swift

public func objectGroups(recursive: Bool = true) -> [SKObjectGroup]

Parameters


                                recursive

Bool include nested layers.

Return Value

[SKObjectGroup] array of object groups.

Show on GitHub


                    
                    
                    
                    ▶︎imageLayers(recursive:)

Return all image layers. If recursive is false, only returns top-level layers.

Declaration

Swift

public func imageLayers(recursive: Bool = true) -> [SKImageLayer]

Parameters


                                recursive

Bool include nested layers.

Return Value

[SKImageLayer] array of image layers.

Show on GitHub


                    
                    
                    
                    ▶︎groupLayers(recursive:)

Return all group layers. If recursive is false, only returns top-level layers.

Declaration

Swift

public func groupLayers(recursive: Bool = true) -> [SKGroupLayer]

Parameters


                                recursive

Bool include nested layers.

Return Value

[SKGroupLayer] array of image layers.

Show on GitHub

▶︎groupLayers
Convenience property to return all group layers.
Declaration
Swift

public var groupLayers: [SKGroupLayer] { get }
Show on GitHub
▶︎antialiasLines
Global antialiasing of lines
Declaration
Swift

public var antialiasLines: Bool { get set }
Show on GitHub
▶︎tileCount
Global tile count
Declaration
Swift

public var tileCount: Int { get }
Show on GitHub
▶︎isPaused
Pauses the node, and colors all of its children darker.
Declaration
Swift

override public var isPaused: Bool { get set }
Show on GitHub

Loading


                    
                    
                    
                    ▶︎load(tmxFile:)

Load a Tiled tmx file and return a new SKTilemap object. Returns nil if there is a parsing error.

Declaration

Swift

public class func load(tmxFile: String) -> SKTilemap?

Parameters


                                tmxFile

String Tiled file name.

Return Value

SKTilemap? tilemap object (if file read succeeds).

Show on GitHub


                    
                    
                    
                    ▶︎load(tmxFile:_:)

Load a Tiled tmx file and return a new SKTilemap object. Returns nil if there is a parsing error.

Declaration

Swift

public class func load(tmxFile: String, _ completion: ((_ tilemap: SKTilemap) -> Void)? = nil) -> SKTilemap?

Parameters

`tmxFile`	`String` Tiled file name.
`completion`	`((_ tilemap: SKTilemap) -> Void)?` optional completion block.

Return Value

SKTilemap? tilemap object (if file read succeeds).

Show on GitHub


                    
                    
                    
                    ▶︎load(tmxFile:loggingLevel:)

Load a Tiled tmx file and return a new SKTilemap object. Returns nil if there is a parsing error.

Declaration

Swift

public class func load(tmxFile: String, loggingLevel: LoggingLevel) -> SKTilemap?

Parameters

`tmxFile`	`String` Tiled file name.
`loggingLevel`	`LoggingLevel` logging verbosity level.

Return Value

SKTilemap? tilemap object (if file read succeeds).

Show on GitHub


                    
                    
                    
                    ▶︎load(tmxFile:delegate:)

Load a Tiled tmx file and return a new SKTilemap object. Returns nil if there is a parsing error.

Declaration

Swift

public class func load(tmxFile: String,
                       delegate: SKTilemapDelegate) -> SKTilemap?

Parameters

`tmxFile`	`String` Tiled file name.
`delegate`	`SKTilemapDelegate` tilemap delegate instance.

Return Value

SKTilemap? tilemap object (if file read succeeds).

Show on GitHub


                    
                    
                    
                    ▶︎load(tmxFile:delegate:updateMode:)

Load a Tiled tmx file and return a new SKTilemap object. Returns nil if there is a parsing error.

Declaration

Swift

public class func load(tmxFile: String,
                       delegate: SKTilemapDelegate,
                       updateMode: TileUpdateMode) -> SKTilemap?

Parameters

`tmxFile`	`String` Tiled file name.
`delegate`	`SKTilemapDelegate` tilemap delegate instance.
`updateMode`	`TileUpdateMode` tile update mode.

Return Value

SKTilemap? tilemap object (if file read succeeds).

Show on GitHub


                    
                    
                    
                    ▶︎load(tmxFile:delegate:tilesetDataSource:)

Load a Tiled tmx file and return a new SKTilemap object. Returns nil if there is a parsing error.

Declaration

Swift

public class func load(tmxFile: String,
                       delegate: SKTilemapDelegate,
                       tilesetDataSource: SKTilesetDataSource) -> SKTilemap?

Parameters

`tmxFile`	`String` Tiled file name.
`delegate`	`SKTilemapDelegate` tilemap delegate instance.
`tilesetDataSource`	`SKTilesetDataSource` tilemap `SKTilesetDataSource` instance.

Return Value

SKTilemap? tilemap object (if file read succeeds).

Show on GitHub


                    
                    
                    
                    ▶︎load(tmxFile:delegate:tilesetDataSource:updateMode:)

Load a Tiled tmx file and return a new SKTilemap object. Returns nil if there is a parsing error.

Declaration

Swift

public class func load(tmxFile: String,
                       delegate: SKTilemapDelegate,
                       tilesetDataSource: SKTilesetDataSource,
                       updateMode: TileUpdateMode) -> SKTilemap?

Parameters

`tmxFile`	`String` Tiled file name.
`delegate`	`SKTilemapDelegate` tilemap delegate instance.
`tilesetDataSource`	`SKTilesetDataSource` tilemap `SKTilesetDataSource` instance.
`updateMode`	`TileUpdateMode` tile update mode.

Return Value

SKTilemap? tilemap object (if file read succeeds).

Show on GitHub


                    
                    
                    
                    ▶︎load(tmxFile:delegate:tilesetDataSource:withTilesets:)

Load a Tiled tmx file and return a new SKTilemap object. Returns nil if there is a parsing error.

Declaration

Swift

public class func load(tmxFile: String,
                       delegate: SKTilemapDelegate,
                       tilesetDataSource: SKTilesetDataSource,
                       withTilesets: [SKTileset]) -> SKTilemap?

Parameters

`tmxFile`	`String` Tiled file name.
`delegate`	`SKTilemapDelegate` tilemap delegate instance.
`tilesetDataSource`	`SKTilesetDataSource` tilemap `SKTilesetDataSource` instance.
`withTilesets`	`[SKTileset]` pre-loaded tilesets.

Return Value

SKTilemap? tilemap object (if file read succeeds).

Show on GitHub


                    
                    
                    
                    ▶︎load(tmxFile:inDirectory:delegate:tilesetDataSource:updateMode:withTilesets:ignoreProperties:loggingLevel:_:)

Load a Tiled tmx file and return a new SKTilemap object. Returns nil if there is a parsing error.

Declaration

Swift

public class func load(tmxFile: String,
                       inDirectory: String? = nil,
                       delegate: SKTilemapDelegate? = nil,
                       tilesetDataSource: SKTilesetDataSource? = nil,
                       updateMode: TileUpdateMode = TiledGlobals.default.updateMode,
                       withTilesets: [SKTileset]? = nil,
                       ignoreProperties noparse: Bool = false,
                       loggingLevel: LoggingLevel = TiledGlobals.default.loggingLevel,
                       _ completion: ((_ tilemap: SKTilemap) -> Void)? = nil) -> SKTilemap?

Parameters

`tmxFile`	`String` Tiled file name.
`inDirectory`	`String?` search path for assets.
`delegate`	`SKTilemapDelegate?` optional `SKTilemapDelegate` instance.
`tilesetDataSource`	`SKTilesetDataSource?` optional `SKTilesetDataSource` instance.
`updateMode`	`TileUpdateMode` tile update mode.
`withTilesets`	`[SKTileset]?` optional tilesets.
`ignoreProperties`	`Bool` ignore custom properties from Tiled.
`loggingLevel`	`LoggingLevel` logging verbosity level.
`completion`	`((_ tilemap: SKTilemap) -> Void)?` optional completion block.

Return Value

SKTilemap? tilemap object (if file read succeeds).

Show on GitHub

Init

▶︎init(coder:)
Default initializer.
Declaration
Swift

required public init?(coder aDecoder: NSCoder)
Show on GitHub


                    
                    
                    
                    ▶︎init(attributes:)

Initialize with dictionary attributes from xml parser.

Declaration

Swift

public init?(attributes: [String : String])

Parameters


                                attributes

Dictionary attributes dictionary.

Return Value

SKTilemap?

Show on GitHub


                    
                    
                    
                    ▶︎init(_:_:_:_:orientation:)

Initialize with map size/tile size

Declaration

Swift

public init(_ sizeX: Int, _ sizeY: Int,
            _ tileSizeX: Int, _ tileSizeY: Int,
            orientation: TilemapOrientation = .orthogonal)

Parameters

`sizeX`	`Int` map width in tiles.
`sizeY`	`Int` map height in tiles.
`tileSizeX`	`Int` tile width in pixels.
`tileSizeY`	`Int` tile height in pixels.

Return Value

SKTilemap

Show on GitHub

Tilesets


                    
                    
                    
                    ▶︎addTileset(_:)

Add a tileset to tilesets set.

Declaration

Swift

public func addTileset(_ tileset: SKTileset)

Parameters


                                tileset

SKTileset tileset object.

Show on GitHub


                    
                    
                    
                    ▶︎removeTileset(_:)

Remove a tileset from the tilesets set.

Declaration

Swift

public func removeTileset(_ tileset: SKTileset) -> SKTileset?

Parameters


                                tileset

SKTileset removed tileset.

Show on GitHub


                    
                    
                    
                    ▶︎getTileset(named:)

Returns a named tileset from the tilesets set.

Declaration

Swift

public func getTileset(named: String) -> SKTileset?

Parameters


                                named

String tileset to return.

Return Value

SKTileset? tileset object.

Show on GitHub


                    
                    
                    
                    ▶︎getTileset(fileNamed:)

Returns an external tileset with a given filename.

Declaration

Swift

public func getTileset(fileNamed filename: String) -> SKTileset?

Parameters


                                filename

String tileset source file.

Return Value

SKTileset?

Show on GitHub


                    
                    
                    
                    ▶︎getTileset(forTile:)

Returns the tileset associated with a global id.

Declaration

Swift

public func getTileset(forTile: Int) -> SKTileset?

Parameters


                                forTile

Int tile global id.

Return Value

SKTileset? associated tileset.

Show on GitHub

Coordinates


                    
                    
                    
                    ▶︎pointForCoordinate(coord:offsetX:offsetY:)

Returns a point for a given coordinate in the layer, with optional offset values for x/y.

Declaration

Swift

public func pointForCoordinate(coord: CGPoint, offsetX: CGFloat = 0, offsetY: CGFloat = 0) -> CGPoint

Parameters

`coord`	`CGPoint` tile coordinate.
`offsetX`	`CGFloat` x-offset value.
`offsetY`	`CGFloat` y-offset value.

Return Value

CGPoint point in layer.

Show on GitHub


                    
                    
                    
                    ▶︎pointForCoordinate(vec2:)

Returns a tile coordinate for a given vector_int2 coordinate.

Declaration

Swift

public func pointForCoordinate(vec2: int2) -> CGPoint

Parameters


                                vec2

int2 vector int2 coordinate.

Return Value

CGPoint position in layer.

Show on GitHub


                    
                    
                    
                    ▶︎coordinateForPoint(_:)

Returns a tile coordinate for a given point in the layer.

Declaration

Swift

public func coordinateForPoint(_ point: CGPoint) -> CGPoint

Parameters


                                point

CGPoint point in layer.

Return Value

CGPoint tile coordinate.

Show on GitHub


                    
                    
                    
                    ▶︎vectorCoordinateForPoint(_:)

Returns a tile coordinate for a given point in the layer as a vector_int2.

Declaration

Swift

public func vectorCoordinateForPoint(_ point: CGPoint) -> int2

Parameters


                                point

CGPoint point in layer.

Return Value

int2 tile coordinate.

Show on GitHub

Layers


                    
                    
                    
                    ▶︎getLayers(recursive:)

Returns an array of child layers, sorted by index (first is lowest, last is highest).

Declaration

Swift

public func getLayers(recursive: Bool = true) -> [SKTiledLayerObject]

Parameters


                                recursive

Bool include nested layers.

Return Value

[SKTiledLayerObject] array of layers.

Show on GitHub

▶︎getContentLayers()
Returns all content layers (ie. not groups). Sorted by zPosition in scene.
Declaration
Swift

public func getContentLayers() -> [SKTiledLayerObject]
Return Value

[SKTiledLayerObject] array of layers.

Show on GitHub
▶︎layerNames()
Returns an array of layer names.
Declaration
Swift

public func layerNames() -> [String]
Return Value

[String] layer names.

Show on GitHub


                    
                    
                    
                    ▶︎addLayer(_:group:clamped:)

Add a layer to the current layers set. Automatically sets zPosition based on the SKTilemap.zDeltaForLayers property. If the group argument is not nil, layer will be added to the group instead.

Declaration

Swift

@discardableResult
public func addLayer(_ layer: SKTiledLayerObject, group: SKGroupLayer? = nil, clamped: Bool = true) -> (success: Bool, layer: SKTiledLayerObject)

Parameters

`layer`	`SKTiledLayerObject` layer object.
`group`	`SKGroupLayer?` optional group layer.
`clamped`	`Bool` clamp position to nearest pixel.

Return Value

(success: Bool, layer: SKTiledLayerObject) add was successful, layer added.

Show on GitHub


                    
                    
                    
                    ▶︎removeLayer(_:)

Remove a layer from the current layers set.

Declaration

Swift

public func removeLayer(_ layer: SKTiledLayerObject) -> SKTiledLayerObject?

Parameters


                                layer

SKTiledLayerObject layer object.

Return Value

SKTiledLayerObject? removed layer.

Show on GitHub


                    
                    
                    
                    ▶︎newTileLayer(named:group:)

Create and add a new tile layer.

Declaration

Swift

@discardableResult
public func newTileLayer(named: String, group: SKGroupLayer? = nil) -> SKTileLayer

Parameters

`named`	`String` layer name.
`group`	`SKGroupLayer?` optional group layer.

Return Value

SKTileLayer new layer.

Show on GitHub


                    
                    
                    
                    ▶︎newObjectGroup(named:group:)

Create and add a new object group.

Declaration

Swift

@discardableResult
public func newObjectGroup(named: String, group: SKGroupLayer? = nil) -> SKObjectGroup

Parameters

`named`	`String` layer name.
`group`	`SKGroupLayer?` optional group layer.

Return Value

SKObjectGroup new layer.

Show on GitHub


                    
                    
                    
                    ▶︎newImageLayer(named:group:)

Create and add a new image layer.

Declaration

Swift

@discardableResult
public func newImageLayer(named: String, group: SKGroupLayer? = nil) -> SKImageLayer

Parameters

`named`	`String` layer name.
`group`	`SKGroupLayer?` optional group layer.

Return Value

SKImageLayer new layer.

Show on GitHub


                    
                    
                    
                    ▶︎newGroupLayer(named:group:)

Create and add a new group layer.

Declaration

Swift

@discardableResult
public func newGroupLayer(named: String, group: SKGroupLayer? = nil) -> SKGroupLayer

Parameters

`named`	`String` layer name.
`group`	`SKGroupLayer?` optional group layer.

Return Value

SKGroupLayer new layer.

Show on GitHub


                    
                    
                    
                    ▶︎getLayers(named:recursive:)

Return layers matching the given name.

Declaration

Swift

public func getLayers(named layerName: String, recursive: Bool = true) -> [SKTiledLayerObject]

Parameters

`name`	`String` tile layer name.
`recursive`	`Bool` include nested layers.

Return Value

[SKTiledLayerObject] layer objects.

Show on GitHub


                    
                    
                    
                    ▶︎getLayers(withPrefix:recursive:)

Return layers with names matching the given prefix.

Declaration

Swift

public func getLayers(withPrefix: String, recursive: Bool = true) -> [SKTiledLayerObject]

Parameters

`withPrefix`	`String` prefix to match.
`recursive`	`Bool` include nested layers.

Return Value

[SKTiledLayerObject] layer objects.

Show on GitHub


                    
                    
                    
                    ▶︎getLayers(atPath:)

Return layers at the given path.

Declaration

Swift

public func getLayers(atPath: String) -> [SKTiledLayerObject]

Parameters


                                atPath

String layer path.

Return Value

[SKTiledLayerObject] layer objects.

Show on GitHub


                    
                    
                    
                    ▶︎getLayer(withID:)

Returns a layer matching the given UUID.

Declaration

Swift

public func getLayer(withID uuid: String) -> SKTiledLayerObject?

Parameters


                                uuid

String tile layer UUID.

Return Value

SKTiledLayerObject? layer object.

Show on GitHub


                    
                    
                    
                    ▶︎getLayer(atIndex:)

Returns a layer given the index (0 being the lowest).

Declaration

Swift

public func getLayer(atIndex index: Int) -> SKTiledLayerObject?

Parameters


                                index

Int layer index.

Return Value

SKTiledLayerObject? layer object.

Show on GitHub


                    
                    
                    
                    ▶︎getLayers(ofType:recursive:)

Return layers assigned a custom type property.

Declaration

Swift

public func getLayers(ofType: String, recursive: Bool = true) -> [SKTiledLayerObject]

Parameters

`ofType`	`String` layer type.
`recursive`	`Bool` include nested layers.

Return Value

[SKTiledLayerObject] array of layers.

Show on GitHub


                    
                    
                    
                    ▶︎tileLayers(named:recursive:)

Return tile layers matching the given name. If recursive is false, only returns top-level layers.

Declaration

Swift

public func tileLayers(named layerName: String, recursive: Bool = true) -> [SKTileLayer]

Parameters

`named`	`String` tile layer name.
`recursive`	`Bool` include nested layers.

Return Value

[SKTileLayer] array of tile layers.

Show on GitHub


                    
                    
                    
                    ▶︎tileLayers(withPrefix:recursive:)

Return tile layers with names matching the given prefix. If recursive is false, only returns top-level layers.

Declaration

Swift

public func tileLayers(withPrefix: String, recursive: Bool = true) -> [SKTileLayer]

Parameters

`withPrefix`	`String` prefix to match.
`recursive`	`Bool` include nested layers.

Return Value

[SKTileLayer] array of tile layers.

Show on GitHub


                    
                    
                    
                    ▶︎tileLayer(atIndex:)

Returns a tile layer at the given index, otherwise, nil.

Declaration

Swift

public func tileLayer(atIndex index: Int) -> SKTileLayer?

Parameters


                                atIndex

Int layer index.

Return Value

SKTileLayer? matching tile layer.

Show on GitHub


                    
                    
                    
                    ▶︎objectGroups(named:recursive:)

Return object groups matching the given name. If recursive is false, only returns top-level layers.

Declaration

Swift

public func objectGroups(named layerName: String, recursive: Bool = true) -> [SKObjectGroup]

Parameters

`named`	`String` tile layer name.
`recursive`	`Bool` include nested layers.

Return Value

[SKObjectGroup] array of object groups.

Show on GitHub


                    
                    
                    
                    ▶︎objectGroups(withPrefix:recursive:)

Return object groups with names matching the given prefix. If recursive is false, only returns top-level layers.

Declaration

Swift

public func objectGroups(withPrefix: String, recursive: Bool = true) -> [SKObjectGroup]

Parameters

`withPrefix`	`String` prefix to match.
`recursive`	`Bool` include nested layers.

Return Value

[SKObjectGroup] array of object groups.

Show on GitHub


                    
                    
                    
                    ▶︎objectGroup(atIndex:)

Returns an object group at the given index, otherwise, nil.

Declaration

Swift

public func objectGroup(atIndex index: Int) -> SKObjectGroup?

Parameters


                                atIndex

Int layer index.

Return Value

SKObjectGroup? matching group layer.

Show on GitHub


                    
                    
                    
                    ▶︎imageLayers(named:recursive:)

Return image layers matching the given name. If recursive is false, only returns top-level layers.

Declaration

Swift

public func imageLayers(named layerName: String, recursive: Bool = true) -> [SKImageLayer]

Parameters

`named`	`String` tile layer name.
`recursive`	`Bool` include nested layers.

Return Value

[SKImageLayer] array of image layers.

Show on GitHub


                    
                    
                    
                    ▶︎imageLayers(withPrefix:recursive:)

Return image layers with names matching the given prefix. If recursive is false, only returns top-level layers.

Declaration

Swift

public func imageLayers(withPrefix: String, recursive: Bool = true) -> [SKImageLayer]

Parameters

`withPrefix`	`String` prefix to match.
`recursive`	`Bool` include nested layers.

Return Value

[SKImageLayer] array of image layers.

Show on GitHub


                    
                    
                    
                    ▶︎imageLayer(atIndex:)

Returns an image layer at the given index, otherwise, nil.

Declaration

Swift

public func imageLayer(atIndex index: Int) -> SKImageLayer?

Parameters


                                atIndex

Int layer index.

Return Value

SKImageLayer? matching image layer.

Show on GitHub


                    
                    
                    
                    ▶︎groupLayers(named:recursive:)

Return group layers matching the given name. If recursive is false, only returns top-level layers.

Declaration

Swift

public func groupLayers(named layerName: String, recursive: Bool = true) -> [SKGroupLayer]

Parameters

`named`	`String` tile layer name.
`recursive`	`Bool` include nested layers.

Return Value

[SKGroupLayer] array of group layers.

Show on GitHub


                    
                    
                    
                    ▶︎groupLayers(withPrefix:recursive:)

Return group layers with names matching the given prefix. If recursive is false, only returns top-level layers.

Declaration

Swift

public func groupLayers(withPrefix: String, recursive: Bool = true) -> [SKGroupLayer]

Parameters

`withPrefix`	`String` prefix to match.
`recursive`	`Bool` include nested layers.

Return Value

[SKGroupLayer] array of group layers.

Show on GitHub


                    
                    
                    
                    ▶︎groupLayer(atIndex:)

Returns an group layer at the given index, otherwise, nil.

Declaration

Swift

public func groupLayer(atIndex index: Int) -> SKGroupLayer?

Parameters


                                atIndex

Int layer index.

Return Value

SKGroupLayer? matching group layer.

Show on GitHub


                    
                    
                    
                    ▶︎sortLayers(from:)

Sort the layers in z based on a starting value (defaults to the current zPosition).

Declaration

Swift

public func sortLayers(from: CGFloat? = nil)

Parameters


                                from

CGFloat? optional starting z-positon.

Show on GitHub

Tiles


                    
                    
                    
                    ▶︎tilesAt(point:)

Return tiles at the given point (all tile layers).

Declaration

Swift

public func tilesAt(point: CGPoint) -> [SKTile]

Parameters


                                point

CGPoint position in tilemap.

Return Value

[SKTile] array of tiles.

Show on GitHub


                    
                    
                    
                    ▶︎tilesAt(coord:)

Return tiles at the given coordinate (all tile layers).

Declaration

Swift

public func tilesAt(coord: CGPoint) -> [SKTile]

Parameters


                                coord

CGPoint coordinate.

Return Value

[SKTile] array of tiles.

Show on GitHub


                    
                    
                    
                    ▶︎tilesAt(_:_:)

Return tiles at the given coordinate (all tile layers).

Declaration

Swift

public func tilesAt(_ x: Int, _ y: Int) -> [SKTile]

Parameters

`x`	`Int` x-coordinate.
`y`	`Int` - y-coordinate.

Return Value

[SKTile] array of tiles.

Show on GitHub


                    
                    
                    
                    ▶︎tileAt(coord:inLayer:)

Returns a tile at the given coordinate from a layer.

Declaration

Swift

public func tileAt(coord: CGPoint, inLayer named: String?) -> SKTile?

Parameters

`coord`	`CGPoint` tile coordinate.
`inLayer`	`String?` layer name.

Return Value

SKTile? tile, or nil.

Show on GitHub


                    
                    
                    
                    ▶︎tileAt(_:_:inLayer:)

Returns a tile at the given coordinate from a layer.

Declaration

Swift

public func tileAt(_ x: Int, _ y: Int, inLayer named: String?) -> SKTile?

Parameters

`x`	`Int` tile x-coordinate.
`y`	`Int` tile y-coordinate.
`named`	`String?` layer name.

Return Value

SKTile? tile, or nil.

Show on GitHub


                    
                    
                    
                    ▶︎getTiles(recursive:)

Returns all tiles in the map. If recursive is false, only returns tiles from top-level layers.

Declaration

Swift

public func getTiles(recursive: Bool = true) -> [SKTile]

Parameters


                                recursive

Bool include nested layers.

Return Value

[SKTile] array of tiles.

Show on GitHub


                    
                    
                    
                    ▶︎getTiles(ofType:recursive:)

Returns tiles with a property of the given type. If recursive is false, only returns tiles from top-level layers.

Declaration

Swift

public func getTiles(ofType: String, recursive: Bool = true) -> [SKTile]

Parameters

`ofType`	`String` type.
`recursive`	`Bool` include nested layers.

Return Value

[SKTile] array of tiles.

Show on GitHub


                    
                    
                    
                    ▶︎getTiles(globalID:recursive:)

Returns tiles with the given global id. If recursive is false, only returns tiles from top-level layers.

Declaration

Swift

public func getTiles(globalID: Int, recursive: Bool = true) -> [SKTile]

Parameters

`globalID`	`Int` tile globla id.
`recursive`	`Bool` include nested layers.

Return Value

[SKTile] array of tiles.

Show on GitHub


                    
                    
                    
                    ▶︎getTilesWithProperty(_:_:recursive:)

Returns tiles with a property of the given type & value. If recursive is false, only returns tiles from top-level layers.

Declaration

Swift

public func getTilesWithProperty(_ named: String, _ value: Any, recursive: Bool = true) -> [SKTile]

Parameters

`named`	`String` property name.
`value`	`Any` property value.
`recursive`	`Bool` include nested layers.

Return Value

[SKTile] array of tiles.

Show on GitHub

▶︎animatedTiles(recursive:)
Returns an array of all animated tile objects.
Declaration
Swift

public func animatedTiles(recursive: Bool = true) -> [SKTile]
Return Value

[SKTile] array of tiles.

Show on GitHub


                    
                    
                    
                    ▶︎firstTileAt(coord:)

Return the top-most tile at the given coordinate.

Declaration

Swift

public func firstTileAt(coord: CGPoint) -> SKTile?

Parameters


                                coord

CGPoint coordinate.

Return Value

SKTile? first tile in layers.

Show on GitHub

Data


                    
                    
                    
                    ▶︎getTileData(globalID:)

Returns data for a global tile id.

Declaration

Swift

public func getTileData(globalID gid: Int) -> SKTilesetData?

Parameters


                                globalID

Int global tile id.

Return Value

SKTilesetData tile data, if it exists.

Show on GitHub


                    
                    
                    
                    ▶︎getTileData(ofType:)

Return tile data with a property of the given type.

Declaration

Swift

public func getTileData(ofType: String) -> [SKTilesetData]

Parameters


                                ofType

String tile data type.

Return Value

[SKTilesetData] array of tile data.

Show on GitHub


                    
                    
                    
                    ▶︎getTileData(withProperty:)

Return tile data with a property of the given type (all tilesets).

Declaration

Swift

public func getTileData(withProperty named: String) -> [SKTilesetData]

Parameters


                                named

String property name.

Return Value

[SKTilesetData] array of tile data.

Show on GitHub


                    
                    
                    
                    ▶︎getTileData(withProperty:_:)

Return tile data with a property of the given type (all tile layers).

Declaration

Swift

public func getTileData(withProperty named: String, _ value: Any) -> [SKTilesetData]

Parameters

`named`	`String` property name.
`value`	`Any` property value.

Return Value

[SKTile] array of tiles.

Show on GitHub


                    
                    
                    
                    ▶︎getTileData(named:isAnimated:)

Returns tile data with the given name & animated state.

Declaration

Swift

public func getTileData(named name: String, isAnimated: Bool = false) -> [SKTilesetData]

Parameters

`named`	`String` data name.
`isAnimated`	`Bool` filter data that is animated.

Return Value

[SKTilesetData] array of tile data.

Show on GitHub

Objects


                    
                    
                    
                    ▶︎objectsAt(point:)

Return obejects at the given point (all object groups).

Declaration

Swift

public func objectsAt(point: CGPoint) -> [SKTileObject]

Parameters


                                coord

CGPoint coordinate.

Return Value

[SKTileObject] array of objects.

Show on GitHub


                    
                    
                    
                    ▶︎getObjects(recursive:)

Return all of the current tile objects. If recursive is false, only returns objects from top-level layers.

Declaration

Swift

public func getObjects(recursive: Bool = true) -> [SKTileObject]

Parameters


                                recursive

Bool include nested layers.

Return Value

[SKTileObject] array of objects.

Show on GitHub


                    
                    
                    
                    ▶︎getObjects(ofType:recursive:)

Return objects matching a given type. If recursive is false, only returns objects from top-level layers.

Declaration

Swift

public func getObjects(ofType: String, recursive: Bool = true) -> [SKTileObject]

Parameters

`ofType`	`String` object type to query.
`recursive`	`Bool` include nested layers.

Return Value

[SKTileObject] array of objects.

Show on GitHub


                    
                    
                    
                    ▶︎getObjects(named:recursive:)

Return objects matching a given name. If recursive is false, only returns objects from top-level layers.

Declaration

Swift

public func getObjects(named: String, recursive: Bool = true) -> [SKTileObject]

Parameters

`named`	`String` object name to query.
`recursive`	`Bool` include nested layers.

Return Value

[SKTileObject] array of objects.

Show on GitHub


                    
                    
                    
                    ▶︎getObjects(withText:recursive:)

Return objects with the given text value. If recursive is false, only returns objects from top-level layers.

Declaration

Swift

public func getObjects(withText text: String, recursive: Bool = true) -> [SKTileObject]

Parameters

`withText`	`String` text value.
`recursive`	`Bool` include nested layers.

Return Value

[SKTileObject] array of objects.

Show on GitHub


                    
                    
                    
                    ▶︎getObject(withID:)

Returns an object with the given id.

Declaration

Swift

public func getObject(withID id: Int) -> SKTileObject?

Parameters

`id`	`Int` Object id.

Return Value

SKTileObject?

Show on GitHub


                    
                    
                    
                    ▶︎tileObjects(recursive:)

Return objects with a tile id. If recursive is false, only returns objects from top-level layers.

Declaration

Swift

public func tileObjects(recursive: Bool = true) -> [SKTileObject]

Parameters


                                recursive

Bool include nested layers.

Return Value

[SKTileObject] objects with a tile gid.

Show on GitHub


                    
                    
                    
                    ▶︎tileObjects(globalID:recursive:)

Return objects with a tile id. If recursive is false, only returns objects from top-level layers.

Declaration

Swift

public func tileObjects(globalID: Int, recursive: Bool = true) -> [SKTileObject]

Parameters

`globalID`	`Int` global tile id.
`recursive`	`Bool` include nested layers.

Return Value

[SKTileObject] objects with a tile gid.

Show on GitHub


                    
                    
                    
                    ▶︎textObjects(recursive:)

Return text objects. If recursive is false, only returns objects from top-level layers.

Declaration

Swift

public func textObjects(recursive: Bool = true) -> [SKTileObject]

Parameters


                                recursive

Bool include nested layers.

Return Value

[SKTileObject] text objects.

Show on GitHub

Coordinates


                    
                    
                    
                    ▶︎isValid(coord:)

Returns true if the coordinate is valid.

Declaration

Swift

public func isValid(coord: CGPoint) -> Bool

Parameters


                                coord

CGPoint tile coordinate.

Return Value

Bool coodinate is valid.

Show on GitHub

▶︎touchLocation(_:)

Returns a touch location in negative-y space.

Position is in converted space
▶︎coordinateAtTouchLocation(_:)

Returns the tile coordinate at a touch location.


                    
                    
                    
                    ▶︎mouseLocation(event:)

Returns a mouse event location in the default layer. (negative-y space).

Position is in converted space

Declaration

Swift

public func mouseLocation(event: NSEvent) -> CGPoint

Parameters


                                point

CGPoint scene point.

Return Value

CGPoint converted point in layer coordinate system.

Show on GitHub


                    
                    
                    
                    ▶︎coordinateAtMouseEvent(event:)

Returns the tile coordinate at a mouse event location.

Declaration

Swift

public func coordinateAtMouseEvent(event: NSEvent) -> CGPoint

Parameters


                                event

NSEvent mouse event location.

Return Value

CGPoint converted point in layer coordinate system.

Show on GitHub

Shaders


                    
                    
                    
                    ▶︎setShader(named:uniforms:)

Set a shader for the tile layer.

Declaration

Swift

public func setShader(named: String, uniforms: [SKUniform] = [])

Parameters

`named`	`String` shader file name.
`uniforms`	`[SKUniform]` array of shader uniforms.

Show on GitHub

Callbacks


                    
                    
                    
                    ▶︎didFinishParsing(timeStarted:tasks:)

Called when parser has finished reading the map.

Declaration

Swift

public func didFinishParsing(timeStarted: Date, tasks: Int = 0)

Parameters

`timeStarted`	`Date` render start time.
`tasks`	`Int` number of tasks to complete.

Show on GitHub


                    
                    
                    
                    ▶︎didFinishRendering(timeStarted:)

Called when parser has finished rendering the map.

Declaration

Swift

public func didFinishRendering(timeStarted: Date)

Parameters


                                timeStarted

Date render start time.

Show on GitHub

SpriteKit Actions


                    
                    
                    
                    ▶︎runAnimationAsActions(_:restore:)

Run layer animations as SpriteKit actions.

Declaration

Swift

public func runAnimationAsActions(_ value: Bool, restore: Bool = true)

Parameters

`value`	`Bool` on/off toggle.
`restore`	`Bool` restore textures.

Show on GitHub

Updating


                    
                    
                    
                    ▶︎update(_:)

Update the map as each frame is rendered.

Declaration

Swift

public func update(_ currentTime: TimeInterval)

Parameters


                                currentTime

TimeInterval update interval.

Show on GitHub


                    
                    
                    
                    ▶︎gridGraphForLayers(_:walkable:obstacle:diagonalsAllowed:nodeClass:)

Initialize the grid graph with an array of walkable tiles.

Declaration

Swift

public func gridGraphForLayers(_ layers: [SKTileLayer],
                               walkable: [SKTile],
                               obstacle: [SKTile] = [],
                               diagonalsAllowed: Bool = false,
                               nodeClass: String? = nil)

Parameters

`layers`	`[SKTileLayer]` array of tile layers.
`walkable`	`[SKTile]` array of walkable tiles.
`obstacles`	`[SKTile]` array of obstacle tiles.
`diagonalsAllowed`	`Bool` allow diagonal movement in the grid.
`nodeClass`	`String?` graph node type.

Show on GitHub

Properties


                    
                    
                    
                    ▶︎parseProperties(completion:)

Parse properties from the Tiled TMX file.

Declaration

Swift

public func parseProperties(completion: (() -> Void)?)

Parameters


                                completion

Void? optional completion closure.

Show on GitHub

Extensions

▶︎isPortrait
Auto-sizing property for map orientation.
Declaration
Swift

public var isPortrait: Bool { get }
Show on GitHub
▶︎tileWidth
Current tile width value.
Declaration
Swift

public var tileWidth: CGFloat { get }
Show on GitHub
▶︎tileHeight
Current tile height value.
Declaration
Swift

public var tileHeight: CGFloat { get }
Show on GitHub
▶︎graphs
Returns all pathfinding graphs in the map
Declaration
Swift

public var graphs: [GKGridGraph<GKGridGraphNode>] { get }
Show on GitHub
▶︎description
String representation of the map.
Declaration
Swift

override public var description: String { get }
Show on GitHub
▶︎debugDescription
Debug string representation of the map.
Declaration
Swift

override public var debugDescription: String { get }
Show on GitHub
▶︎renderableObjects()
Returns an array of tiles/objects.
Declaration
Swift

public func renderableObjects() -> [SKNode]
Return Value

[SKNode] array of child objects.

Show on GitHub


                    
                    
                    
                    ▶︎renderableObjectsAt(point:)

Return tiles & objects at the given point in the map.

Declaration

Swift

public func renderableObjectsAt(point: CGPoint) -> [SKNode]

Parameters


                                point

CGPoint position in tilemap.

Return Value

[SKNode] array of tiles.

Show on GitHub

▶︎animatedObjects()
Returns an array of animated tiles/objects.
Declaration
Swift

public func animatedObjects() -> [SKNode]
Return Value

[SKNode] array of child objects.

Show on GitHub

Deprecated


                    
                    
                    
                    ▶︎load(fromFile:delegate:withTilesets:)

Load a Tiled tmx file and return a new SKTilemap object. Returns nil if there is a problem reading the file

Declaration

Swift

@available(*, deprecated, renamed: "SKTilemap.load(tmxFile:﹚")
public class func load(fromFile filename: String,
                       delegate: SKTilemapDelegate? = nil,
                       withTilesets: [SKTileset]? = nil) -> SKTilemap?

Parameters

`filename`	`String` Tiled file name.
`delegate`	`SKTilemapDelegate?` optional `SKTilemapDelegate` instance.

Return Value

SKTilemap? tilemap object (if file read succeeds).

Show on GitHub

▶︎allLayers()
Returns an array of all child layers, sorted by index (first is lowest, last is highest).
Declaration
Swift

@available(*, deprecated, message: "use `getLayers(﹚` instead") public func allLayers() -> [SKTiledLayerObject]
Return Value

[SKTiledLayerObject] array of layers.

Show on GitHub


                    
                    
                    
                    ▶︎getLayer(named:)

Returns a named tile layer from the layers set.

Declaration

Swift

@available(*, deprecated, message: "use `getLayers(named:﹚` instead")
public func getLayer(named layerName: String) -> SKTiledLayerObject?

Parameters


                                name

String tile layer name.

Return Value

SKTiledLayerObject? layer object.

Show on GitHub


                    
                    
                    
                    ▶︎tileLayer(named:)

Returns a named tile layer if it exists, otherwise, nil.

Declaration

Swift

@available(*, deprecated, message: "use `tileLayers(named:﹚` instead")
public func tileLayer(named name: String) -> SKTileLayer?

Parameters


                                named

String tile layer name.

Return Value

SKTileLayer?

Show on GitHub


                    
                    
                    
                    ▶︎objectGroup(named:)

Returns a named object group if it exists, otherwise, nil.

Declaration

Swift

@available(*, deprecated, message: "use `objectGroups(named:﹚` instead")
public func objectGroup(named name: String) -> SKObjectGroup?

Parameters


                                named

String tile layer name.

Return Value

SKObjectGroup?

Show on GitHub


                    
                    
                    
                    ▶︎debugLayers(reverse:)

Output a summary of the current scenes layer data.

Declaration

Swift

@available(*, deprecated, message: "use `dumpStatistics` instead")
public func debugLayers(reverse: Bool = false)

Parameters


                                reverse

Bool reverse layer order.

Show on GitHub

Minimum zoom level for the map.

Declaration

Swift

@available(*, deprecated, renamed: "SKTilemap.zoomConstraints.min")
public var minZoom: CGFloat { get set }

Show on GitHub

Maximum zoom level for the map.

Declaration

Swift

@available(*, deprecated, renamed: "SKTilemap.zoomConstraints.max")
public var maxZoom: CGFloat { get set }

Show on GitHub

SKTilemap

Overview

Usage

Properties

Overview

Constants

Declaration

Properties

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Tile Update Mode

Declaration

Render Quality

Declaration

Declaration

Camera

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Tilesets

Declaration

Declaration

Declaration

Declaration

Declaration

Render Statistics/Debugging

Declaration

Layers

Declaration

Background Properties

Declaration

Declaration

Declaration

Declaration

Object Colors

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Declaration