SKTilemap Class Reference

File Properties

url
Tilemap source file path.
Declaration
Swift

public internal(set) var url: URL! { get }
Show on GitHub
relativeUrl
Tilemap source file path, relative to the bundle.
Declaration
Swift

public internal(set) var relativeUrl: URL! { get }
Show on GitHub
displayName
Map container display name. Defaults to the current map source file name (minus the tmx extension).
Declaration
Swift

public var displayName: String?
Show on GitHub

Tilesets

tilesets
Array of tilesets associated with this map.
Declaration
Swift

public var tilesets: Set<SKTileset>
Show on GitHub

Basic Properties

uuid
Unique SpriteKit node id.
Declaration
Swift

public internal(set) var uuid: String { get }
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
delegate
Reference to TilemapDelegate delegate.
Declaration
Swift

public weak var delegate: TilemapDelegate?
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
zDeltaForLayers
Default z-position range between layers.
Declaration
Swift

public var zDeltaForLayers: CGFloat
Show on GitHub
isInfinite
Indicates the map type is infinite.
Declaration
Swift

@objc public internal(set) var isInfinite: Bool { get }
Show on GitHub
type
Tilemap mode type.
Declaration
Swift

public var type: String!
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
parseTime
Returns the time taken to parse the map and dependencies.
Declaration
Swift

public internal(set) var parseTime: TimeInterval { get }
Show on GitHub
renderTime
Returns the render time of this map.
Declaration
Swift

public internal(set) var renderTime: TimeInterval { get }
Show on GitHub
mapSize
Size of map (in tiles).
Declaration
Swift

public internal(set) var mapSize: CGSize { get }
Show on GitHub
tileSize
Tile size (in pixels).
Declaration
Swift

public internal(set) var tileSize: CGSize { get }
Show on GitHub
chunkSize
Chunk size (infinite maps).
Declaration
Swift

public internal(set) var chunkSize: CGSize? { get }
Show on GitHub
currentCoordinate
Current focus coordinate.
Declaration
Swift

public var currentCoordinate: simd_int2 { get set }
Show on GitHub

Layers

layers
Returns a flattened array of contained child layers.
Declaration
Swift

public var layers: [TiledLayerObject] { get }
Show on GitHub
layerCount
Returns the number of layers contained in this map.
Declaration
Swift

public var layerCount: Int { get }
Show on GitHub

Pause overlay.

Declaration

Swift

public lazy var overlay: SKSpriteNode { get set }

Show on GitHub

overlayColor
Overlay color.
Declaration
Swift

public var overlayColor: SKColor { get set }
Show on GitHub
overlayOpacity
Overlay transparency amount.
Declaration
Swift

public var overlayOpacity: CGFloat { get set }
Show on GitHub


                    
                    
                    
                    
                    isolatedLayers

Isolated layers.

Declaration

Swift

public var isolatedLayers: [TiledLayerObject]? { get set }

Show on GitHub

Background Properties

backgroundColor
Optional background color (parsed from the source tmx file).
Declaration
Swift

public var backgroundColor: SKColor? { get set }
Show on GitHub
backgroundOpacity
Background opactiy.
Declaration
Swift

public var backgroundOpacity: CGFloat { get set }
Show on GitHub
ignoreBackground
Ignore Tiled background color.
Declaration
Swift

public var ignoreBackground: Bool { get set }
Show on GitHub
backgroundOffset
Background offset.
Declaration
Swift

public var backgroundOffset: CGSize { get set }
Show on GitHub

Positioning

childOffset
Mappable child node offset. By default, the SKTilemap node aligns child layers to its’ center point.

Used when a map container aligns all of the layers.
Declaration
Swift

public var childOffset: CGPoint { get }
Show on GitHub
worldOffset
Defines this map’s position within a Tiled world. This value cannot be changed directly, but matches the value set in the world JSON description.
Declaration
Swift

public internal(set) var worldOffset: CGPoint { get }
Show on GitHub


                    
                    
                    
                    
                    orientation

The map projection type.

Declaration

Swift

public internal(set) var orientation: TilemapOrientation { get }

Show on GitHub

Camera

cameraNode
Reference to the Tiled scene camera.
Declaration
Swift

public var cameraNode: SKTiledSceneCamera? { get }
Show on GitHub
isFocused
Indicates the current node has received focus or selected.
Declaration
Swift

public var isFocused: Bool { get set }
Show on GitHub
visibleToCamera
Node is visible to the camera.
Declaration
Swift

public var visibleToCamera: Bool
Show on GitHub
CameraZoomConstraints
Constraints on camera min/max zoom levels.

Constants
- min: minimum camera zoom level.
- max: maximum camera zoom level.
Declaration
Swift

public struct CameraZoomConstraints
Show on GitHub
zoomConstraints
Camera zoom constraints.
Declaration
Swift

public var zoomConstraints: CameraZoomConstraints
Show on GitHub
autoResize
This flag indicates that the map should auto-resize upon view changes.
Declaration
Swift

public internal(set) var autoResize: Bool { get }
Show on GitHub
receiveCameraUpdates
Enables the map node to receive notifications from camera.
Declaration
Swift

@objc public var receiveCameraUpdates: Bool
Show on GitHub
cameraPosition
The camera’s current position.
Declaration
Swift

public internal(set) var cameraPosition: CGPoint { get }
Show on GitHub
cameraBounds
Display bounds that the tilemap is viewable in.
Declaration
Swift

public internal(set) var cameraBounds: CGRect? { get }
Show on GitHub
currentZoom
Current map zoom level.
Declaration
Swift

public internal(set) var currentZoom: CGFloat { get }
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
allowRotation
Allow camera rotation.
Declaration
Swift

public var allowRotation: Bool
Show on GitHub
worldScale
This value denotes the desired initial world scale. This attribute is ignored if the [autoResize][map-autoresize-url] attribute is enabled.
Declaration
Swift

public var worldScale: CGFloat
Show on GitHub

Hexagonal/Staggered Properties

hexsidelength
Hexagonal side length.
Declaration
Swift

public var hexsidelength: Int
Show on GitHub
staggeraxis
Hexagonal stagger axis.
Declaration
Swift

public var staggeraxis: StaggerAxis
Show on GitHub
staggerindex
Hexagonal stagger index.
Declaration
Swift

public var staggerindex: StaggerIndex
Show on GitHub

Content Root Nodes

isCropped
Setting this property masks the map at its boundaries.
Declaration
Swift

public var isCropped: Bool { get set }
Show on GitHub
objectPath
This object’s CGPath defining the shape of geometry. Used to draw the bounding shape.
Declaration
Swift

@objc public lazy var objectPath: CGPath { get set }
Show on GitHub

Misc Properties

isInitialized
Signifies that the tilemap is fully initialized.
Declaration
Swift

public private(set) var isInitialized: Bool { get }
Show on GitHub

Tile Update Mode

updateMode
Update mode used for tiles & objects.

Constants
- dynamic: dynamically update tiles as needed.
- full: all tiles are updated each frame.
- actions: tiles are not updated, SpriteKit actions are used instead.
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

Content Root

shader
Tilemap custom shader.
Declaration
Swift

public var shader: SKShader? { get set }
Show on GitHub
shouldEnableEffects
A Boolean value that determines whether the tilemap node applies the filter to its child layers as they are drawn.

If the value of this property is true, the effect node applies the filter and blends the results. If the value is false, the effect node is ignored and its children are rendered normally. The default value is false.
Declaration
Swift

public var shouldEnableEffects: Bool { get set }
Show on GitHub
shouldRasterize
Indicates whether the results of rendering the child nodes should be cached.
Declaration
Swift

public var shouldRasterize: Bool { get set }
Show on GitHub
filter
Image processing filter.
Declaration
Swift

public var filter: CIFilter? { get set }
Show on GitHub
speed
Speed modifier applied to all actions executed by the tilemap and its descendants.
Declaration
Swift

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

Debug Overlay

objectCount
Object count.
Declaration
Swift

public var objectCount: Int { get }
Show on GitHub

Debugging

RenderStatistics
Render statistics
See more
Declaration
Swift

public struct RenderStatistics
Show on GitHub


                    
                    
                    
                    
                    boundsShape

Map bounding shape.

Declaration

Swift

@objc
public lazy var boundsShape: SKShapeNode? { get set }

Show on GitHub

anchorShape
Object anchor node visualization node.
Declaration
Swift

@objc public lazy var anchorShape: SKShapeNode { get set }
Show on GitHub
_debugLevel
Declaration
Swift

@objc public var _debugLevel: UInt8
Show on GitHub
debugDrawOptions
Debug visualization options.
Declaration
Swift

public var debugDrawOptions: DebugDrawOptions { get set }
Show on GitHub

Color Attributes

objectColor
Color used to display object frames.
Declaration
Swift

public var objectColor: SKColor
Show on GitHub
color
Default color (used for pause).
Declaration
Swift

public var color: SKColor
Show on GitHub
gridColor
Color used to visualize the tile grid.
Declaration
Swift

public var gridColor: SKColor
Show on GitHub
frameColor
Bounding frame color.
Declaration
Swift

public var frameColor: SKColor
Show on GitHub
highlightColor
Color used to highlight tiles.
Declaration
Swift

public var highlightColor: SKColor
Show on GitHub
navigationColor
Navigation graph color.
Declaration
Swift

public var navigationColor: SKColor
Show on GitHub
gravity
Gravity vector.
Declaration
Swift

public var gravity: CGVector
Show on GitHub
frame
Map frame in parent coordinate space.
Declaration
Swift

public override var frame: CGRect { get }
Show on GitHub
boundingRect
Returns a bounding rect for the entire map. Adapted from Tiled Renderer.mapBoundingRect.
Declaration
Swift

public override var boundingRect: CGRect { get }
Show on GitHub
absoluteSize
The accumulated map size.
Declaration
Swift

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

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

public var lastIndex: UInt32 { 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


                    
                    
                    
                    
                    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

include nested layers.

Return Value

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

include nested layers.

Return Value

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

include nested layers.

Return Value

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

include nested layers.

Return Value

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
A Boolean value that determines whether actions on the node and its descendants are processed.

Pauses the tilemap, and colors all of its children darker via the overlay.
Declaration
Swift

public override 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

Tiled file name.

Return Value

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`	Tiled file name.
`completion`	optional completion block.

Return Value

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`	Tiled file name.
`loggingLevel`	logging verbosity level.

Return Value

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: TilemapDelegate) -> SKTilemap?

Parameters

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

Return Value

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: TilemapDelegate,
                       updateMode: TileUpdateMode) -> SKTilemap?

Parameters

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

Return Value

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: TilemapDelegate,
                       tilesetDataSource: TilesetDataSource) -> SKTilemap?

Parameters

`tmxFile`	Tiled file name.
`delegate`	tilemap delegate instance.
`tilesetDataSource`	tilemap `TilesetDataSource` instance.

Return Value

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: TilemapDelegate,
                       tilesetDataSource: TilesetDataSource,
                       updateMode: TileUpdateMode) -> SKTilemap?

Parameters

`tmxFile`	Tiled file name.
`delegate`	tilemap delegate instance.
`tilesetDataSource`	tilemap `TilesetDataSource` instance.
`updateMode`	tile update mode.

Return Value

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: TilemapDelegate,
                       tilesetDataSource: TilesetDataSource,
                       withTilesets: [SKTileset]) -> SKTilemap?

Parameters

`tmxFile`	Tiled file name.
`delegate`	tilemap delegate instance.
`tilesetDataSource`	tilemap `TilesetDataSource` instance.
`withTilesets`	pre-loaded tilesets.

Return Value

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. This is the primary loading method for tilemaps. Currently used by the demo app.

Declaration

Swift

public class func load(tmxFile: String,
                       inDirectory: String? = nil,
                       delegate: TilemapDelegate? = nil,
                       tilesetDataSource: TilesetDataSource? = 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`	Tiled file name.
`inDirectory`	asset search path.
`delegate`	optional `TilemapDelegate` instance.
`tilesetDataSource`	optional `TilesetDataSource` instance.
`updateMode`	tile update mode.
`withTilesets`	pre-loaded tilesets.
`noparse`	ignore custom properties from Tiled.
`loggingLevel`	logging verbosity level.
`completion`	optional completion block.

Return Value

tilemap object (if file read succeeds).

Show on GitHub

String Loading


                    
                    
                    
                    
                    load(string:documentRoot:delegate:tilesetDataSource:updateMode:withTilesets:ignoreProperties:loggingLevel:_:)

Load tilemap from xml string data.

Declaration

Swift

public class func load(string: String,
                       documentRoot: String? = nil,
                       delegate: TilemapDelegate? = nil,
                       tilesetDataSource: TilesetDataSource? = 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

`string`	xml string data.
`documentRoot`	document root.
`delegate`	optional `TilemapDelegate` instance.
`tilesetDataSource`	optional `TilesetDataSource` instance.
`updateMode`	tile update mode.
`withTilesets`	pre-loaded tilesets.
`noparse`	ignore custom properties from Tiled.
`loggingLevel`	logging verbosity level.
`completion`	optional completion block.

Return Value

tilemap object (if file read succeeds).

Show on GitHub


                    
                    
                    
                    
                    load(data:documentRoot:delegate:tilesetDataSource:updateMode:withTilesets:ignoreProperties:loggingLevel:_:)

Load tilemap from xml string data.

Declaration

Swift

@available(*, deprecated, message: "This method has not yet been implemented.")
public class func load(data: Data,
                       documentRoot: String? = nil,
                       delegate: TilemapDelegate? = nil,
                       tilesetDataSource: TilesetDataSource? = 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

`data`	xml string data.
`documentRoot`	document root.
`delegate`	optional `TilemapDelegate` instance.
`tilesetDataSource`	optional `TilesetDataSource` instance.
`updateMode`	tile update mode.
`withTilesets`	pre-loaded tilesets.
`noparse`	ignore custom properties from Tiled.
`loggingLevel`	logging verbosity level.
`completion`	optional completion block.

Return Value

tilemap object (if file read succeeds).

Show on GitHub

Initialization


                    
                    
                    
                    
                    init(coder:)

Instantiate the map with a decoder instance.

Declaration

Swift

required public init?(coder aDecoder: NSCoder)

Parameters


                                aDecoder

decoder.

Show on GitHub


                    
                    
                    
                    
                    init(attributes:)

Initialize with dictionary attributes from Tiled source XML.

Declaration

Swift

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

Parameters


                                attributes

attributes parsed from Tiled XML.

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`	map width in tiles.
`sizeY`	map height in tiles.
`tileSizeX`	tile width in pixels.
`tileSizeY`	tile height in pixels.
`orientation`	map orientation.

Show on GitHub

Tileset Mangement


                    
                    
                    
                    
                    addTileset(_:)

Add a tileset to tilesets set.

Declaration

Swift

public func addTileset(_ tileset: SKTileset)

Parameters


                                tileset

tileset object.

Show on GitHub


                    
                    
                    
                    
                    removeTileset(_:)

Remove a tileset from the tilesets set.

Declaration

Swift

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

Parameters


                                tileset

tileset object.

Return Value

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

tileset to return.

Return Value

tileset object.

Show on GitHub


                    
                    
                    
                    
                    getTileset(fileNamed:)

Returns an externally referenced tileset with a given filename.

Declaration

Swift

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

Parameters


                                filename

tileset source file.

Return Value

tileset with the given file name.

Show on GitHub


                    
                    
                    
                    
                    getTilesetFor(globalID:)

Returns the tileset associated with a global id.

Declaration

Swift

public func getTilesetFor(globalID: UInt32) -> SKTileset?

Parameters


                                globalID

tile global id.

Return Value

associated tileset.

Show on GitHub


                    
                    
                    
                    
                    contains(globalID:)

Returns the tileset containing the given global id.

Declaration

Swift

public func contains(globalID: UInt32) -> (Bool, SKTileset?)

Parameters


                                globalID

tile global id.

Return Value

tuple of result & matching tileset.

Show on GitHub

Layer Management


                    
                    
                    
                    
                    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) -> [TiledLayerObject]

Parameters


                                recursive

include nested layers.

Return Value

array of layers.

Show on GitHub


                    
                    
                    
                    
                    getLayers(named:recursive:)

Return child layers matching the given name.

Declaration

Swift

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

Parameters

`layerName`	tile layer name.
`recursive`	include nested layers.

Return Value

layer objects.

Show on GitHub


                    
                    
                    
                    
                    getLayers(withPrefix:recursive:)

Return child layers with names matching the given prefix.

Declaration

Swift

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

Parameters

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

Return Value

layer objects.

Show on GitHub


                    
                    
                    
                    
                    getLayers(atPath:)

Return child layers with matching the given path. Tiled allows for duplicate layer names, so we’re returning an array.

Declaration

Swift

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

Parameters


                                withPrefix

layer path to search for.

Return Value

layer objects.

Show on GitHub


                    
                    
                    
                    
                    getLayer(xPath:)

Returns a child layer given an xPath value.

Declaration

Swift

public func getLayer(xPath: String) -> TiledLayerObject?

Parameters


                                xPath

layer xPath.

Return Value

layer objects.

Show on GitHub


                    
                    
                    
                    
                    getLayer(withID:)

Returns a child layer matching the given UUID.

Declaration

Swift

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

Parameters


                                uuid

tile layer UUID.

Return Value

layer object.

Show on GitHub


                    
                    
                    
                    
                    getLayer(atIndex:)

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

Declaration

Swift

public func getLayer(atIndex index: UInt32) -> TiledLayerObject?

Parameters


                                index

layer index.

Return Value

layer object.

Show on GitHub


                    
                    
                    
                    
                    getLayers(ofType:recursive:)

Returns child layers assigned a custom type property.

Declaration

Swift

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

Parameters

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

Return Value

array of layers.

Show on GitHub

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

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

array of layers.

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

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

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: TiledLayerObject,
                     group: SKGroupLayer? = nil,
                     clamped: Bool = true) -> (success: Bool, layer: TiledLayerObject)

Parameters

`layer`	layer object.
`group`	optional group layer.
`clamped`	clamp position to nearest pixel.

Return Value

add was successful, added layer.

Show on GitHub


                    
                    
                    
                    
                    removeLayer(_:)

Remove a layer from the current layers set.

Declaration

Swift

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

Parameters


                                layer

layer object.

Return Value

removed layer.

Show on GitHub


                    
                    
                    
                    
                    newTileLayer(named:group:)

Create and add a new tile layer. By default, the new layer will be parented to the tilemap instance unless an optional group layer is specified.

Declaration

Swift

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

Parameters

`named`	layer name.
`group`	optional group layer.

Return Value

new layer.

Show on GitHub


                    
                    
                    
                    
                    newTileLayer(named:group:data:)

Create and add a new tile layer with optional layer data. By default, the new layer will be parented to the tilemap instance unless an optional group layer is specified.

Declaration

Swift

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

Parameters

`named`	layer name.
`group`	optional group layer.
`data`	array of tile global ids.

Return Value

new tile layer.

Show on GitHub


                    
                    
                    
                    
                    newObjectGroup(named:group:)

Create and add a new object group. By default, the new layer will be parented to the tilemap instance unless an optional group layer is specified.

Declaration

Swift

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

Parameters

`named`	layer name.
`group`	optional group layer.

Return Value

new layer.

Show on GitHub


                    
                    
                    
                    
                    newImageLayer(named:group:)

Create and add a new image layer. By default, the new layer will be parented to the tilemap instance unless an optional group layer is specified.

Declaration

Swift

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

Parameters

`named`	layer name.
`group`	optional group layer.

Return Value

new layer.

Show on GitHub


                    
                    
                    
                    
                    newGroupLayer(named:group:)

Create and add a new group layer. By default, the new layer will be parented to the tilemap instance unless an optional group layer is specified.

Declaration

Swift

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

Parameters

`named`	layer name.
`group`	optional group layer.

Return Value

new layer.

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

`layerName`	tile layer name.
`recursive`	include nested layers.

Return Value

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`	prefix to match.
`recursive`	include nested layers.

Return Value

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


                                index

layer index.

Return Value

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

`layerName`	tile layer name.
`recursive`	include nested layers.

Return Value

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`	prefix to match.
`recursive`	include nested layers.

Return Value

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


                                index

layer index.

Return Value

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

`layerName`	tile layer name.
`recursive`	include nested layers.

Return Value

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`	prefix to match.
`recursive`	include nested layers.

Return Value

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


                                index

layer index.

Return Value

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

`layerName`	tile layer name.
`recursive`	include nested layers.

Return Value

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`	prefix to match.
`recursive`	include nested layers.

Return Value

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


                                index

layer index.

Return Value

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

optional starting z-position.

Show on GitHub

contentLayers()
Returns an array of tile & object layers.
Declaration
Swift

public func contentLayers() -> [TiledLayerObject]
Return Value

tile & vector object layers.

Show on GitHub

Tiles


                    
                    
                    
                    
                    tilesAt(coord:)

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

Declaration

Swift

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

Parameters


                                coord

coordinate.

Return Value

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`	x-coordinate.
`y`	y-coordinate.

Return Value

array of tiles.

Show on GitHub


                    
                    
                    
                    
                    tileAt(coord:inLayer:)

Returns the first tile at the given coordinate from a layer.

Declaration

Swift

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

Parameters

`coord`	tile coordinate.
`named`	layer name.

Return Value

matching tile, if one exists.

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`	tile x-coordinate.
`y`	tile y-coordinate
`named`	layer name.

Return Value

matching tile, if one exists.

Show on GitHub


                    
                    
                    
                    
                    firstTileAt(coord:)

Return the top-most tile at the given coordinate.

Declaration

Swift

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

Parameters


                                coord

coordinate.

Return Value

first tile in layers.

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

include nested layers.

Return Value

array of tiles.

Show on GitHub


                    
                    
                    
                    
                    getTiles(ofType:recursive:)

Returns an array of 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`	tile type.
`recursive`	include nested layers.

Return Value

array of tiles.

Show on GitHub


                    
                    
                    
                    
                    getTiles(globalID:recursive:)

Returns an array of tiles matching the given global id. If recursive is false, only returns tiles from top-level layers.

Declaration

Swift

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

Parameters

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

Return Value

array of tiles.

Show on GitHub


                    
                    
                    
                    
                    getTilesWithProperty(_:recursive:)

Returns tiles with a property matching the given name.

Declaration

Swift

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

Parameters

`named`	property name.
`recursive`	include nested layers.

Return Value

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`	property name.
`value`	property value.
`recursive`	include nested layers

Return Value

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]

Parameters


                                recursive

include nested layers.

Return Value

array of tiles

Show on GitHub


                    
                    
                    
                    
                    newTile(globalID:type:)

Creates and returns a new tile instance with the given global id.

Declaration

Swift

public func newTile(globalID: UInt32, type tileType: SKTile.Type = SKTile.self) -> SKTile?

Parameters

`localID`	tile gobal id.
`tileType`	tile object type.

Return Value

tile instance, if tile data exists.

Show on GitHub

Tile Data


                    
                    
                    
                    
                    getTileData(globalID:)

Returns tile data for a global tile id.

Declaration

Swift

public func getTileData(globalID: UInt32) -> SKTilesetData?

Parameters


                                globalID

global tile id.

Return Value

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

tile data type.

Return Value

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

property name.

Return Value

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`	property name.
`value`	property value.

Return Value

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

`name`	data name.
`isAnimated`	filter data that is animated.

Return Value

array of tile data.

Show on GitHub

Objects


                    
                    
                    
                    
                    objectsAt(point:)

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

Declaration

Swift

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

Parameters


                                point

coordinate.

Return Value

array of objects.

Show on GitHub


                    
                    
                    
                    
                    objectsAt(coord:)

Return objects at the given coordinate (all object groups). Queries the TileObjectOverlay node, which is not exposed to the public API.

Declaration

Swift

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

Parameters


                                coord

coordinate.

Return Value

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

include nested layers.

Return Value

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`	object type to query.
`recursive`	include nested layers.

Return Value

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`	object name to query.
`recursive`	include nested layers.

Return Value

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

`text`	text value.
`recursive`	include nested layers.

Return Value

array of matching objects.

Show on GitHub


                    
                    
                    
                    
                    getObject(withID:)

Returns an object with the given Tiled id.

Declaration

Swift

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

Parameters

`id`	Object id.

Return Value

object matching the given id.

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

include nested layers.

Return Value

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: UInt32, recursive: Bool = true) -> [SKTileObject]

Parameters

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

Return Value

array of objects matching the given tile global id.

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

include nested layers.

Return Value

text objects.

Show on GitHub

Physics

setupTileCollisions()
Setup tile collision shapes in every layer.
Declaration
Swift

public func setupTileCollisions()
Show on GitHub

Coordinates


                    
                    
                    
                    
                    isValid(_:_:)

Returns true if the coordinate is valid (within map bounds).

Declaration

Swift

public func isValid(_ x: Int32, _ y: Int32) -> Bool

Parameters

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

Return Value

coordinate is valid.

Show on GitHub


                    
                    
                    
                    
                    isValid(coord:)

Returns true if the coordinate is valid (within map bounds).

Declaration

Swift

public func isValid(coord: simd_int2) -> Bool

Parameters


                                coord

tile coordinate.

Return Value

coordinate 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


                                event

mouse event.

Return Value

converted point in map coordinate system.

Show on GitHub


                    
                    
                    
                    
                    coordinateAtMouse(event:)

Returns the tile coordinate at a mouse event location.

Declaration

Swift

public func coordinateAtMouse(event: NSEvent) -> simd_int2

Parameters


                                event

mouse event.

Return Value

converted point in layer coordinate system.

Show on GitHub

Shaders


                    
                    
                    
                    
                    setShader(named:uniforms:attributes:)

Set a shader for the map.

Declaration

Swift

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

Parameters

`named`	shader file name.
`uniforms`	array of shader uniforms.
`attributes`	array of shader attributes.

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`	render start time.
`tasks`	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

render start time.

Show on GitHub

SpriteKit Actions


                    
                    
                    
                    
                    runAnimationAsActions(_:restore:)

Toggle tilemap animation rendering as SpriteKit actions.

Declaration

Swift

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

Parameters

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

Show on GitHub

Updating

Updates the tilemap as each frame is rendered.

Declaration

Swift

public func update(_ currentTime: TimeInterval)

Parameters


                                currentTime

update interval.

Show on GitHub

Reflection

customMirror
Returns a custom mirror for this object.
Declaration
Swift

public var customMirror: Mirror { get }
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`	array of tile layers.
`walkable`	array of walkable tiles.
`obstacle`	array of obstacle tiles.
`diagonalsAllowed`	allow diagonal movement in the grid.
`nodeClass`	graph node type.

Show on GitHub

SKTilemap


                    
                    
                    
                    
                    parseProperties(completion:)

Parse properties from the Tiled TMX file.

Declaration

Swift

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

Parameters


                                completion

optional completion closure.

Show on GitHub

Extensions

mapName
String representing the map name (ie: dungeon-16x16).

Defaults to the current map source file name (minus the tmx extension).
Declaration
Swift

public var mapName: String { get }
Show on GitHub
isPortrait
Auto-sizing property for map orientation.
Declaration
Swift

public var isPortrait: Bool { get }
Show on GitHub
width
Returns the width (in tiles) of the map.
Declaration
Swift

public var width: CGFloat { get }
Show on GitHub
height
Returns the height (in tiles) of the map.
Declaration
Swift

public var height: CGFloat { get }
Show on GitHub
tileWidth
Returns the tile width (in pixels) value.
Declaration
Swift

public var tileWidth: CGFloat { get }
Show on GitHub
tileHeight
Returns the tile size height (in pixels).
Declaration
Swift

public var tileHeight: CGFloat { get }
Return Value

tile size height.

Show on GitHub
tileWidthHalf
Returns the tile size width (in pixels), halved.
Declaration
Swift

public var tileWidthHalf: CGFloat { get }
Return Value

tile size half-width.

Show on GitHub
tileHeightHalf
Returns the tile size height (in pixels), halved.
Declaration
Swift

public var tileHeightHalf: CGFloat { get }
Return Value

tile size half-height.

Show on GitHub
sizeHalved
Returns the container size (in tiles), halved.
Declaration
Swift

public var sizeHalved: CGSize { get }
Return Value

container size in tiles, halved.

Show on GitHub
tileSizeHalved
Returns the container tile size (in pixels), halved.
Declaration
Swift

public var tileSizeHalved: CGSize { get }
Return Value

container tile size in tiles, halved.

Show on GitHub
graphs
Returns all pathfinding graphs in the map.
Declaration
Swift

public var graphs: [GKGridGraph<GKGridGraphNode>] { get }
Show on GitHub
renderableObjects()
Returns an array of renderable tiles/objects.
Declaration
Swift

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

array of child objects.

Show on GitHub
animatedObjects()
Returns an array of animated tiles/objects.
Declaration
Swift

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

array of child objects.

Show on GitHub


                    
                    
                    
                    
                    highlightNode(with:duration:)

Highlight the map with a given color & duration.

Declaration

Swift

@objc
public override func highlightNode(with color: SKColor, duration: TimeInterval = 0)

Parameters

`color`	highlight color.
`duration`	duration of highlight effect.

Show on GitHub

removeHighlight()
Remove the current object’s highlight color.
Declaration
Swift

@objc public override func removeHighlight()
Show on GitHub

Deprecations

Container size (in tiles).

Declaration

Swift

@available(*, deprecated, renamed: "mapSize")
public internal(set) var size: CGSize { get set }

Show on GitHub


                    
                    
                    
                    
                    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: TilemapDelegate? = nil,
                       withTilesets: [SKTileset]? = nil) -> SKTilemap?

Parameters

`filename`	Tiled file name.
`delegate`	optional `TilemapDelegate` instance.
`withTilesets`	optional tilesets.

Return Value

tilemap object.

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() -> [TiledLayerObject]
Return Value

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) -> TiledLayerObject?

Parameters


                                layerName

tile layer name.

Return Value

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


                                name

tile layer name.

Return Value

matching tile layer.

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


                                name

tile layer name.

Return Value

object layer matching the given name, if one exists.

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

reverse layer order.

Show on GitHub

Minimum zoom level for the map.

Declaration

Swift

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

Show on GitHub

Maximum zoom level for the map.

Declaration

Swift

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

Show on GitHub


                    
                    
                    
                    
                    mapRenderTime

Returns the render time of this map.

Declaration

Swift

@available(*, deprecated, renamed: "renderTime")
public var mapRenderTime: TimeInterval { get }

Show on GitHub

isShowingGraphs
Returnas true if any of the child layers is showing a graph visual.
Declaration
Swift

@available(*, deprecated, renamed: "isShowingGridGraph") public var isShowingGraphs: Bool { get }
Show on GitHub


                    
                    
                    
                    
                    showObjects(forLayers:)

Show objects for the given layers.

Declaration

Swift

@available(*, deprecated, message: "use `debugDrawOptions` instead")
public func showObjects(forLayers: [TiledLayerObject])

Parameters


                                forLayers

array of layers.

Show on GitHub


                    
                    
                    
                    
                    getTileset(forTile:)

Returns the tileset associated with a global id.

Declaration

Swift

@available(*, deprecated, renamed: "getTilesetFor(globalID:﹚")
public func getTileset(forTile: Int) -> SKTileset?

Parameters


                                forTile

tile global id.

Return Value

associated tileset.

Show on GitHub


                    
                    
                    
                    
                    getObject(withID:)

Returns an object with the given Tiled id.

Declaration

Swift

@available(*, deprecated, renamed: "getObject(withID:﹚")
public func getObject(withID id: Int) -> SKTileObject?

Parameters

`id`	Object id.

Return Value

object matching the given id.

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

@available(*, deprecated, renamed: "tileObjects(globalID:recursive:﹚")
public func tileObjects(globalID: Int, recursive: Bool = true) -> [SKTileObject]

Parameters

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

Return Value

array of objects matching the given tile global id.

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

@available(*, deprecated, renamed: "getTiles(globalID:recursive:﹚")
public func getTiles(globalID: Int, recursive: Bool = true) -> [SKTile]

Parameters

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

Return Value

array of tiles.

Show on GitHub


                    
                    
                    
                    
                    isValid(coord:)

Returns true if the coordinate is valid.

Declaration

Swift

@available(*, deprecated, renamed: "isValid(coord:﹚")
public func isValid(coord: CGPoint) -> Bool

Parameters


                                coord

tile coordinate.

Return Value

coordinate is valid.

Show on GitHub


                    
                    
                    
                    
                    tilesAt(point:)

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

Declaration

Swift

@available(*, deprecated, message: "???")
public func tilesAt(point: CGPoint) -> [SKTile]

Parameters


                                point

position in tilemap.

Return Value

array of tiles.

Show on GitHub


                    
                    
                    
                    
                    tilesAt(coord:)

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

Declaration

Swift

@available(*, deprecated, renamed: "tilesAt(coord:﹚")
public func tilesAt(coord: CGPoint) -> [SKTile]

Parameters


                                coord

coordinate.

Return Value

array of tiles.

Show on GitHub


                    
                    
                    
                    
                    tileAt(coord:inLayer:)

Returns the first tile at the given coordinate from a layer.

Declaration

Swift

@available(*, deprecated, renamed: "tileAt(coord:simd_int2:inLayer:﹚")
public func tileAt(coord: CGPoint, inLayer named: String?) -> SKTile?

Parameters

`coord`	tile coordinate.
`named`	layer name.

Return Value

matching tile, if one exists.

Show on GitHub


                    
                    
                    
                    
                    firstTileAt(coord:)

Return the top-most tile at the given coordinate.

Declaration

Swift

@available(*, deprecated, renamed: "firstTileAt(coord:﹚")
public func firstTileAt(coord: CGPoint) -> SKTile?

Parameters


                                coord

coordinate.

Return Value

first tile in layers.

Show on GitHub


                    
                    
                    
                    
                    pointForCoordinate(vec2:)

Returns a tile coordinate for a given simd_int2 coordinate.

Declaration

Swift

@available(*, deprecated, renamed: "pointForCoordinate(coord:﹚")
public func pointForCoordinate(vec2: simd_int2) -> CGPoint

Parameters


                                vec2

simd_int2 coordinate

Return Value

position in map.

Show on GitHub


                    
                    
                    
                    
                    coordinateForPoint(_:)

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

Declaration

Swift

@available(*, deprecated, renamed: "coordinateForPoint(point:﹚")
public func coordinateForPoint(_ point: CGPoint) -> CGPoint

Parameters


                                point

point in layer.

Return Value

tile coordinate.

Show on GitHub


                    
                    
                    
                    
                    vectorCoordinateForPoint(_:)

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

Declaration

Swift

@available(*, deprecated, message: "use coordinateForPoint(point:﹚")
public func vectorCoordinateForPoint(_ point: CGPoint) -> simd_int2

Parameters


                                point

point in layer.

Return Value

tile coordinate

Show on GitHub


                    
                    
                    
                    
                    coordinateAtMouseEvent(event:)

Returns the tile coordinate at a mouse event location.

Declaration

Swift

@available(*, deprecated, renamed: "coordinateAtMouse(event:﹚")
public func coordinateAtMouseEvent(event: NSEvent) -> CGPoint

Parameters


                                event

mouse event.

Return Value

converted point in layer coordinate system.

Show on GitHub


                    
                    
                    
                    
                    getLayer(atIndex:)

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

Declaration

Swift

@available(*, deprecated, renamed: "getLayer(atIndex:﹚")
public func getLayer(atIndex index: Int) -> TiledLayerObject?

Parameters


                                index

layer index.

Return Value

layer object.

Show on GitHub


                    
                    
                    
                    
                    showObjects

Global property to show/hide all SKTileObject objects.

Declaration

Swift

@available(*, deprecated, renamed: "isShowingObjectBounds")
public var showObjects: Bool { get set }

Show on GitHub

SKTilemap

Usage

Properties

File Properties

Declaration

Declaration

Declaration

Tilesets

Declaration

Basic Properties

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Layers

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Background Properties

Declaration

Declaration

Declaration

Declaration

Positioning

Declaration

Declaration

Declaration

Camera

Declaration

Declaration

Declaration

Constants

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Hexagonal/Staggered Properties

Declaration

Declaration

Declaration

Content Root Nodes

Declaration

Declaration

Misc Properties

Declaration

Tile Update Mode

Constants

Declaration

Render Quality

Declaration

Content Root

Declaration

Declaration

Declaration

Declaration

Declaration

Debug Overlay

Declaration