SKTileset

public class SKTileset : NSObject, CustomReflectable, TiledObjectType

The SKTileset class manages a set of SKTilesetData objects, which store tile data including global id, texture and animation.

Tileset Setup

Tile data is accessed via a local id, and tiles can be instantiated with the resulting SKTilesetData instance:

if let data = tileset.getTileData(localID: 56) {
   let tile = SKTile(data: data)
}

Properties

name: tileset name.
tilemap: reference to parent tilemap.
tileSize: tile size (in pixels).
localRange: range of local tile data id values.
globalRange: range of global tile data id values.
columns: number of columns.
tilecount: tile count.
firstGID: first tile global id.
lastGID: last tile global id.
tileData: set of tile data structures.

Class Functions

load(tsxFile:delegate:): Load a tileset from a file.
load(tsxFiles:delegate:): Load multiple tilesets.

Instance Methods

addTextures(): Generate textures from a spritesheet image.
addTilesetTile(): Add & return new tile data object.

For more information, see the Working with Tilesets page in the official documentation.

url
Tileset url (external tileset).
Declaration
Swift

public var url: URL!
Show on GitHub
uuid
Unique object id.
Declaration
Swift

public var uuid: String
Show on GitHub
filename
Tiled tsx filename (external tileset, ie: “tileset.tsx”).
Declaration
Swift

public var filename: String!
Show on GitHub
name
Tileset name
Declaration
Swift

public var name: String
Show on GitHub
type
Object type.
Declaration
Swift

public var type: String!
Show on GitHub
properties
Custom tileset properties.
Declaration
Swift

public var properties: [String : String]
Show on GitHub
ignoreProperties
Ignore custom properties.
Declaration
Swift

public var ignoreProperties: Bool
Show on GitHub
tilemap
Reference to parent tilemap.
Declaration
Swift

public weak var tilemap: SKTilemap!
Show on GitHub
tileSize
Tileset tile size (in pixels).
Declaration
Swift

public var tileSize: CGSize
Show on GitHub
columns
Number of tileset columns.
Declaration
Swift

public var columns: Int
Show on GitHub
tilecount
Tileset tile count.
Declaration
Swift

public internal(set) var tilecount: Int { get }
Show on GitHub
dataCount
Tileset tile data count (not the same as tile count).
Declaration
Swift

public var dataCount: Int { get }
Show on GitHub

Tileset first gid.

Declaration

Swift

public internal(set) var firstGID: UInt32 { get }

Show on GitHub

lastGID
Returns the last global tile id in the tileset.
Declaration
Swift

public var lastGID: UInt32 { get }
Show on GitHub
localRange
Returns a range of localized tile id values.
Declaration
Swift

public var localRange: ClosedRange<UInt32> { get }
Show on GitHub
globalRange
Returns a range of global tile id values.
Declaration
Swift

public var globalRange: ClosedRange<UInt32> { get }
Show on GitHub

Spacing

spacing
Spritesheet spacing between tiles.
Declaration
Swift

public var spacing: Int
Show on GitHub
margin
Spritesheet border margin.
Declaration
Swift

public var margin: Int
Show on GitHub
tileOffset
Offset for drawing tiles.
Declaration
Swift

public var tileOffset: CGPoint
Show on GitHub
source
Texture name (if created from source).
Declaration
Swift

public var source: String!
Show on GitHub
isImageCollection
Indicates the tileset is a collection of images.
Declaration
Swift

public var isImageCollection: Bool
Show on GitHub
isExternalTileset
The tileset is stored in an external file.
Declaration
Swift

public var isExternalTileset: Bool { get }
Show on GitHub
transparentColor
Source image transparency color.
Declaration
Swift

public var transparentColor: SKColor?
Show on GitHub
isRendered
Indicates tileset is rendered.
Declaration
Swift

public var isRendered: Bool
Show on GitHub
renderQuality
Scaling factor for text objects, etc.
Declaration
Swift

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

Initialization


                    
                    
                    
                    
                    init(name:tileSize:firstgid:columns:offset:)

Initialize with basic properties.

Declaration

Swift

public init(name: String,
            tileSize size: CGSize,
            firstgid: UInt32 = 1,
            columns: Int = 0,
            offset: CGPoint = CGPoint.zero)

Parameters

`name`	tileset name.
`size`	tile size.
`firstgid`	first gid value.
`columns`	number of columns.
`offset`	tileset offset value.

Show on GitHub


                    
                    
                    
                    
                    init(source:firstgid:tilemap:offset:)

Initialize with an external tileset (only source and first gid are given).

Declaration

Swift

public init(source: String,
            firstgid: UInt32,
            tilemap: SKTilemap,
            offset: CGPoint = CGPoint.zero)

Parameters

`source`	source file name.
`firstgid`	first gid value.
`tilemap`	parent tile map node.
`offset`	tile offset value.

Show on GitHub


                    
                    
                    
                    
                    init(attributes:offset:)

Initialize with attributes directly from TMX file.

Declaration

Swift

public init?(attributes: [String: String],
             offset: CGPoint = CGPoint.zero)

Parameters

`attributes`	attributes dictionary.
`offset`	pixel offset in x/y.

Show on GitHub

Loading


                    
                    
                    
                    
                    load(tsxFiles:delegate:ignoreProperties:)

Loads Tiled tsx files and returns an array of SKTileset objects.

Declaration

Swift

public class func load(tsxFiles: [String],
                       delegate: TilemapDelegate? = nil,
                       ignoreProperties noparse: Bool = false) -> [SKTileset]

Parameters

`tsxFiles`	Tiled tileset filenames.
`delegate`	optional `TilemapDelegate` instance.
`noparse`	ignore custom properties from Tiled.

Return Value

array of tilesets.

Show on GitHub


                    
                    
                    
                    
                    load(tsxFile:dataSource:ignoreProperties:)

Load a Tiled tsx file and return a SKTileset object.

Declaration

Swift

public class func load(tsxFile: String,
                       dataSource: TilesetDataSource? = nil,
                       ignoreProperties noparse: Bool = false) -> SKTileset?

Parameters

`tsxFile`	tileset filename.
`dataSource`	tileset data source delegate.
`noparse`	ignore custom properties.

Return Value

tileset, if created.

Show on GitHub

Textures


                    
                    
                    
                    
                    addTextures(fromSpriteSheet:replace:transparent:)

Create tile texture data from a spritesheet image.

Declaration

Swift

public func addTextures(fromSpriteSheet source: String,
                        replace: Bool = false,
                        transparent: String? = nil)

Parameters

`source`	image path referenced in the tileset.
`replace`	replace the current texture.
`transparent`	optional transparent color hex value.

Show on GitHub

Tile Data


                    
                    
                    
                    
                    addTilesetTile(tileID:texture:)

Add tileset tile data attributes. Returns a new SKTilesetData object, or nil if tile data already exists with the given id.

Declaration

Swift

public func addTilesetTile(tileID: UInt32, texture: SKTexture) -> SKTilesetData?

Parameters

`tileID`	local tile ID.
`texture`	texture for tile at the given id.

Return Value

tileset data (or nil if the data exists).

Show on GitHub


                    
                    
                    
                    
                    addTilesetTile(tileID:source:)

Add tileset data from an image source (tileset is a collections tileset).

Declaration

Swift

public func addTilesetTile(tileID: UInt32, source: String) -> SKTilesetData?

Parameters

`tileID`	local tile ID.
`source`	source image name.

Return Value

tileset data (or nil if the data exists).

Show on GitHub


                    
                    
                    
                    
                    addTilesetTile(source:)

Create new data from the given texture image path. Returns a new tileset data instance & the local id associated with it.

Declaration

Swift

public func addTilesetTile(source: String) -> (id: UInt32, data: SKTilesetData)?

Parameters


                                source

source image name.

Return Value

local tile id & tileset data (or nil if the data exists)

Show on GitHub


                    
                    
                    
                    
                    setDataTexture(tileID:texture:)

Set(replace) the texture for a given tile id.

Declaration

Swift

@discardableResult
public func setDataTexture(tileID: UInt32, texture: SKTexture) -> SKTexture?

Parameters

`tileID`	tile ID.
`texture`	texture for tile at the given id.

Return Value

previous tile data texture.

Show on GitHub


                    
                    
                    
                    
                    setDataTexture(tileID:imageNamed:)

Set(replace) the texture for a given tile id.

Declaration

Swift

@discardableResult
public func setDataTexture(tileID: UInt32, imageNamed: String) -> SKTexture?

Parameters

`tileID`	tile ID.
`imageNamed`	source texture name.

Return Value

old tile data texture.

Show on GitHub


                    
                    
                    
                    
                    contains(globalID:)

Returns true if the tileset contains the global ID.

Declaration

Swift

public func contains(globalID: UInt32) -> Bool

Parameters


                                globalID

global tile id.

Return Value

tileset contains the global id.

Show on GitHub


                    
                    
                    
                    
                    getTileData(globalID:)

Returns tile data for the given global tile ID (if it exists).

Declaration

Swift

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

Parameters

gid

global tile id.

Return Value

tile data object.

Show on GitHub


                    
                    
                    
                    
                    getTileData(localID:)

Returns tile data for the given local tile ID.

Declaration

Swift

public func getTileData(localID id: UInt32) -> SKTilesetData?

Parameters

`id`	local tile id.

Return Value

tile data.

Show on GitHub


                    
                    
                    
                    
                    getTileData(withProperty:)

Returns tile data matching the given property.

Declaration

Swift

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

Parameters


                                property

property name.

Return Value

array of tile data.

Show on GitHub


                    
                    
                    
                    
                    getTileData(withProperty:_:)

Returns tile data with the given property & value.

Declaration

Swift

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

Parameters

`property`	property name.
`value`	property value.

Return Value

array of tile data.

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


                    
                    
                    
                    
                    getTileData(ofType:)

Returns tile data with the given type.

Declaration

Swift

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

Parameters


                                ofType

data type.

Return Value

array of tile data.

Show on GitHub

getAnimatedTileData()
Returns animated tile data.
Declaration
Swift

public func getAnimatedTileData() -> [SKTilesetData]
Return Value

array of animated tile data.

Show on GitHub
getTileDataWithCollisionShapes()
Returns tile data with collision shapes.
Declaration
Swift

public func getTileDataWithCollisionShapes() -> [SKTilesetData]
Return Value

array of tile data.

Show on GitHub


                    
                    
                    
                    
                    getGlobalID(forLocalID:)

Convert a global ID to the tileset’s local ID.

Declaration

Swift

public func getGlobalID(forLocalID id: UInt32) -> UInt32

Parameters

id

local id.

Return Value

global tile ID.

Show on GitHub


                    
                    
                    
                    
                    getLocalID(globalID:)

Convert a global ID to the tileset’s local ID.

Declaration

Swift

public func getLocalID(globalID: UInt32) -> UInt32

Parameters


                                globalID

global id.

Return Value

local tile id.

Show on GitHub

Reflection

customMirror
Returns a custom mirror for this object.
Declaration
Swift

public var customMirror: Mirror { get }
Show on GitHub

SKTileset


                    
                    
                    
                    
                    parseProperties(completion:)

Parse the tileset’s properties value.

Declaration

Swift

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

Parameters


                                completion

optional completion closure.

Show on GitHub

Extensions

description
String representation of the tileset object.
Declaration
Swift

public override var description: String { get }
Show on GitHub
debugDescription
Debugging string representation of the tileset object.
Declaration
Swift

public override var debugDescription: String { get }
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 global id.
`tileType`	tile object type.

Return Value

tile instance, if tile data exists.

Show on GitHub


                    
                    
                    
                    
                    newTile(localID:type:)

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

Declaration

Swift

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

Parameters

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

Return Value

tile instance, if tile data exists.

Show on GitHub

tiledElementName
Returns the internal Tiled node type.
Declaration
Swift

@objc public var tiledElementName: String { get }
Show on GitHub
tiledIconName
Returns the internal Tiled node type icon.
Declaration
Swift

@objc public var tiledIconName: String { get }
Show on GitHub
tiledHelpDescription
A description of the node type used for help features.
Declaration
Swift

@objc public var tiledHelpDescription: String { get }
Show on GitHub

Deprecations


                    
                    
                    
                    
                    init(name:tileSize:firstgid:columns:offset:)

Initialize with basic properties.

Declaration

Swift

@available(*, deprecated, renamed: "init(name:tileSize:firstgid:columns:offset:﹚")
public convenience init(name: String,
            tileSize size: CGSize,
            firstgid: Int = 1,
            columns: Int = 0,
            offset: CGPoint = CGPoint.zero)

Parameters

`name`	tileset name.
`size`	tile size.
`firstgid`	first gid value.
`columns`	number of columns.
`offset`	tileset offset value.

Show on GitHub


                    
                    
                    
                    
                    init(source:firstgid:tilemap:offset:)

Initialize with an external tileset (only source and first gid are given).

Declaration

Swift

@available(*, deprecated, renamed: "init(source:firstgid:tilemap:offset:﹚")
public convenience init(source: String,
            firstgid: Int,
            tilemap: SKTilemap,
            offset: CGPoint = CGPoint.zero)

Parameters

`source`	source file name.
`firstgid`	first gid value.
`tilemap`	parent tile map node.
`offset`	tile offset value.

Show on GitHub


                    
                    
                    
                    
                    getTileData(globalID:)

Returns tile data for the given global tile ID (if it exists).

Declaration

Swift

@available(*, deprecated, message: "tile ids should be `UInt32` type.")
public func getTileData(globalID gid: Int) -> SKTilesetData?

Parameters

gid

global tile id.

Return Value

tile data object.

Show on GitHub


                    
                    
                    
                    
                    getGlobalID(forLocalID:)

Convert a global ID to the tileset’s local ID.

Declaration

Swift

@available(*, deprecated, message: "tile ids should be `UInt32` type.")
public func getGlobalID(forLocalID id: Int) -> Int

Parameters

id

local id.

Return Value

global tile ID.

Show on GitHub


                    
                    
                    
                    
                    getLocalID(forGlobalID:)

Convert a global ID to the tileset’s local ID.

Declaration

Swift

@available(*, deprecated, renamed: "getLocalID(globalID:﹚")
public func getLocalID(forGlobalID gid: UInt32) -> UInt32

Parameters

gid

global id.

Return Value

local tile id.

Show on GitHub


                    
                    
                    
                    
                    getTileData(localID:)

Returns tile data for the given local tile ID.

Declaration

Swift

@available(*, deprecated, message: "tile ids should be `UInt32` type.")
public func getTileData(localID id: Int) -> SKTilesetData?

Parameters

`id`	local tile id.

Return Value

tile data.

Show on GitHub


                    
                    
                    
                    
                    addTilesetTile(_:texture:)

Add tileset tile data attributes. Returns a new SKTilesetData object, or nil if tile data already exists with the given id.

Declaration

Swift

@available(*, deprecated, renamed: "addTilesetTile(tileID:texture:﹚")
public func addTilesetTile(_ tileID: Int, texture: SKTexture) -> SKTilesetData?

Parameters

`tileID`	local tile ID.
`texture`	texture for tile at the given id.

Return Value

tileset data (or nil if the data exists).

Show on GitHub


                    
                    
                    
                    
                    addTilesetTile(_:source:)

Add tileset data from an image source (tileset is a collections tileset).

Declaration

Swift

@available(*, deprecated, renamed: "addTilesetTile(tileID:source:﹚")
public func addTilesetTile(_ tileID: Int, source: String) -> SKTilesetData?

Parameters

`tileID`	local tile ID.
`source`	source image name.

Return Value

tileset data (or nil if the data exists).

Show on GitHub


                    
                    
                    
                    
                    setDataTexture(_:texture:)

Set(replace) the texture for a given tile id.

Declaration

Swift

@available(*, deprecated, renamed: "setDataTexture(_:texture:﹚")
@discardableResult
public func setDataTexture(_ id: Int, texture: SKTexture) -> SKTexture?

Parameters

`id`	tile ID.
`texture`	texture for tile at the given id.

Return Value

previous tile data texture.

Show on GitHub