SKTilesetData

public class SKTilesetData : SKTiledObject

extension SKTilesetData: Hashable

extension SKTilesetData: CustomStringConvertible, CustomDebugStringConvertible

Overview

The SKTilesetData object stores data for a single tileset tile, referencing the tile texture, animation frames (for animated tiles) as well as tile orientation.

Also includes navigation properties for tile accessability, and graph node weight.

Properties

Property	Description
id	Tile id (local)
type	Tiled type
texture	Tile texture
tileOffset	Tile offset

▶︎uuid
Unique id.
Declaration
Swift

public var uuid: String
Show on GitHub
▶︎id
Tile id (local).
Declaration
Swift

public var id: Int
Show on GitHub
▶︎type
Tiled type.
Declaration
Swift

public var type: String!
Show on GitHub
▶︎name
Tile data name.
Declaration
Swift

public var name: String? { get }
Show on GitHub
▶︎texture
Tile texture.
Declaration
Swift

public var texture: SKTexture!
Show on GitHub
▶︎source
Source image name (collections tileset)
Declaration
Swift

public var source: String!
Show on GitHub
▶︎probability
Tile occurance probability (parsed from Tiled, not currently used).
Declaration
Swift

public var probability: CGFloat
Show on GitHub
▶︎properties
Custom Tiled properties.
Declaration
Swift

public var properties: [String : String]
Show on GitHub
▶︎ignoreProperties
Node ignores custom properties.
Declaration
Swift

public var ignoreProperties: Bool
Show on GitHub
▶︎tileOffset
Tile offset.
Declaration
Swift

public var tileOffset: CGPoint
Show on GitHub
▶︎renderQuality
Render scaling property.
Declaration
Swift

public var renderQuality: CGFloat
Show on GitHub
▶︎frames
Tile animation frame storate.
Declaration
Swift

public var frames: [TileAnimationFrame] { get }
Show on GitHub
▶︎isAnimated
Indicates the tile is animated.
Declaration
Swift

public var isAnimated: Bool { get }
Show on GitHub
▶︎animationAction
Returns an aniamtion action for the tile data.
Declaration
Swift

public var animationAction: SKAction? { get }
Show on GitHub

Tile Orientation

▶︎flipHoriz
Tile is flipped horizontally
Declaration
Swift

public var flipHoriz: Bool
Show on GitHub
▶︎flipVert
Tile is flipped vertically.
Declaration
Swift

public var flipVert: Bool
Show on GitHub
▶︎flipDiag
Tile is flipped diagonally.
Declaration
Swift

public var flipDiag: Bool
Show on GitHub

Pathfinding Attributes

▶︎walkable
Tile is walkable.
Declaration
Swift

public var walkable: Bool
Show on GitHub
▶︎obstacle
Tile represents an obstacle.
Declaration
Swift

public var obstacle: Bool
Show on GitHub
▶︎weight
Pathfinding weight.
Declaration
Swift

public var weight: CGFloat
Show on GitHub
▶︎collisions
Collision objects (not yet implemented).
Declaration
Swift

public var collisions: [SKTileObject]
Show on GitHub
▶︎globalID
Global id for this tile.
Declaration
Swift

public var globalID: Int { get }
Show on GitHub

Init

▶︎init()
Initialize an empty data structure.
Declaration
Swift

public init()
Show on GitHub


                    
                    
                    
                    ▶︎init(id:withTileset:)

Initialize the data with a tileset, id.

Declaration

Swift

public init(id: Int, withTileset tileSet: SKTileset)

Parameters

`tileId`	`Int` unique tile id.
`tileSet`	`SKTileset` tileset reference.

Return Value

SKTilesetData tile data.

Show on GitHub


                    
                    
                    
                    ▶︎init(id:texture:tileSet:)

Initialize the data with a tileset, id & texture.

Declaration

Swift

public init(id: Int, texture: SKTexture, tileSet: SKTileset)

Parameters

`id`	`Int` unique tile id.
`texture`	`SKTexture` tile texture.
`tileSet`	`SKTileset` tileset reference.

Return Value

SKTilesetData tile data.

Show on GitHub

Animation


                    
                    
                    
                    ▶︎addFrame(withID:interval:tileTexture:)

Add tile animation to the data.

Declaration

Swift

public func addFrame(withID: Int, interval: Int, tileTexture: SKTexture? = nil) -> TileAnimationFrame

Parameters

`withID`	`Int` id for frame.
`interval`	`Int` frame interval (in milliseconds).
`tileTexture`	`SKTexture?` frame texture.

Return Value

TileAnimationFrame animation frame container.

Show on GitHub


                    
                    
                    
                    ▶︎frameAt(index:)

Returns an animation frame at the given index.

Declaration

Swift

public func frameAt(index: Int) -> TileAnimationFrame?

Parameters


                                index

Int frame index.

Return Value

TileAnimationFrame? animation frame container.

Show on GitHub

▶︎forceAnimatedFramesUpdate()
Force the animated frames to update textuers.
Declaration
Swift

public func forceAnimatedFramesUpdate()
Show on GitHub


                    
                    
                    
                    ▶︎setTexture(_:)

Set the texture for the tile data.

Declaration

Swift

public func setTexture(_ newTexture: SKTexture?) -> SKTexture?

Parameters


                                texture

SKTexture? new texture.

Return Value

SKTexture? old texture (if it exists).

Show on GitHub


                    
                    
                    
                    ▶︎setTexture(_:forFrame:)

Set the texture for an animated frame at the given index.

Declaration

Swift

public func setTexture(_ texture: SKTexture?, forFrame: Int) -> SKTexture?

Parameters

`texture`	`SKTexture?` new texture.
`forFrame`	`Int` frame index.

Return Value

SKTexture? old texture (if it exists).

Show on GitHub


                    
                    
                    
                    ▶︎setDuration(interval:forFrame:)

Set the duration for an animated frame at the given index.

Declaration

Swift

public func setDuration(interval: Int, forFrame: Int) -> Bool

Parameters

`interval`	`Int` frame interval (in milliseconds).
`forFrame`	`Int` frame index.

Return Value

Bool frame duration was set correctly.

Show on GitHub


                    
                    
                    
                    ▶︎removeFrame(at:)

Remove a tile animation frame at a given index.

Declaration

Swift

public func removeFrame(at index: Int) -> TileAnimationFrame?

Parameters

`at`	`Int` frame index.

Return Value

TileAnimationFrame? animation frame (if it exists).

Show on GitHub

▶︎runAnimation()
Run tile animation.
Declaration
Swift

public func runAnimation()
Show on GitHub


                    
                    
                    
                    ▶︎removeAnimation(restore:)

Remove tile animation. Animation is not actually destroyed, but rather blocked.

Declaration

Swift

public func removeAnimation(restore: Bool = false)

Parameters


                                restore

Bool restore the initial texture.

Show on GitHub

Generic Properties

▶︎parseProperties(completion:)
Parse the tile data’s properties value.
Declaration
Swift

public func parseProperties(completion: (() -> Void)?)
Show on GitHub

Deprecated

Local id for this tile data.

Declaration

Swift

@available(*, deprecated, renamed: "id")
public var localID: Int { get }

Show on GitHub