SKTiledScene

open class SKTiledScene : SKScene, SKPhysicsContactDelegate, TiledSceneDelegate, TilemapDelegate, TilesetDataSource

extension SKTiledScene: TiledSceneCameraDelegate

The SKTiledScene object represents a scene of content in SpriteKit, customized for including Tiled asset types. This scene type automatically creates camera and world container nodes and sets up interactivity between them and an associated tile map node.

SKTiledScene Hierarchy

The camera node determines what part of the scene’s coordinate space is visible in the view.

Properties

worldNode: Root container node.
tilemap: Tile map node.
cameraNode: Custom scene camera.

Instance Methods

cameraPositionChanged: called when the camera position changes.
cameraZoomChanged: called when the camera zoom changes.
cameraBoundsChanged: called when the camera bounds updated.

Instance Methods (iOS)

sceneDoubleTapped: Called when the scene receives a double-tap event (iOS only).

Instance Methods (macOS)

sceneClicked: called when the scene is clicked (macOS only).
sceneDoubleClicked: called when the scene is double-clicked (macOS only).
mousePositionChanged: called when the mouse moves in the scene (macOS only).

Initialization


                    
                    
                    
                    
                    init(size:)

Initialize without a tiled map name.

Declaration

Swift

required public override init(size: CGSize)

Parameters


                                size

scene size

Show on GitHub


                    
                    
                    
                    
                    didMove(to:)

Called when the scene is displayed in the parent SKView.

Declaration

Swift

open override func didMove(to view: SKView)

Parameters


                                view

parent view.

Show on GitHub

Setup


                    
                    
                    
                    
                    setup(url:delegate:withTilesets:ignoreProperties:loggingLevel:_:)

Load and setup a named TMX file, with optional tilesets.

Declaration

Swift

open func setup(url: URL,
                delegate: TilemapDelegate? = nil,
                withTilesets: [SKTileset] = [],
                ignoreProperties: Bool = false,
                loggingLevel: LoggingLevel = TiledGlobals.default.loggingLevel,
                _ completion: ((_ tilemap: SKTilemap) -> Void)? = nil)

Parameters

`url`	Tiled file url.
`delegate`	optional tilemap delegate instance.
`withTilesets`	pre-loaded tilesets.
`ignoreProperties`	don’t parse custom properties.
`loggingLevel`	logging verbosity.
`completion`	optional completion handler.

Show on GitHub


                    
                    
                    
                    
                    setup(tmxFile:delegate:inDirectory:withTilesets:ignoreProperties:loggingLevel:_:)

Load and setup a named TMX file, with optional tilesets. Allows for an optional completion handler.

Declaration

Swift

open func setup(tmxFile: String,
                delegate: TilemapDelegate? = nil,
                inDirectory: String? = nil,
                withTilesets tilesets: [SKTileset] = [],
                ignoreProperties: Bool = false,
                loggingLevel: LoggingLevel = TiledGlobals.default.loggingLevel,
                _ completion: ((_ tilemap: SKTilemap) -> Void)? = nil)

Parameters

`tmxFile`	TMX file name.
`delegate`	optional tilemap delegate instance.
`inDirectory`	search path for assets.
`tilesets`	optional pre-loaded tilesets.
`ignoreProperties`	don’t parse custom properties.
`loggingLevel`	logging verbosity.
`completion`	optional completion handler.

Show on GitHub

Tilemap Delegate

didBeginParsing(_:)
was size
Declaration
Swift

open func didBeginParsing(_ tilemap: SKTilemap)
Show on GitHub


                    
                    
                    
                    
                    didAddTileset(_:)

Declaration

Swift

open func didAddTileset(_ tileset: SKTileset)

Show on GitHub


                    
                    
                    
                    
                    didAddLayer(_:)

Declaration

Swift

open func didAddLayer(_ layer: TiledLayerObject)

Show on GitHub


                    
                    
                    
                    
                    didReadMap(_:)

Declaration

Swift

open func didReadMap(_ tilemap: SKTilemap)

Show on GitHub


                    
                    
                    
                    
                    didRenderMap(_:)

Declaration

Swift

open func didRenderMap(_ tilemap: SKTilemap)

Show on GitHub


                    
                    
                    
                    
                    didAddNavigationGraph(_:)

Declaration

Swift

open func didAddNavigationGraph(_ graph: GKGridGraph<GKGridGraphNode>)

Show on GitHub


                    
                    
                    
                    
                    objectForTileType(named:)

Declaration

Swift

open func objectForTileType(named: String?) -> SKTile.Type

Show on GitHub


                    
                    
                    
                    
                    objectForVectorType(named:)

Declaration

Swift

open func objectForVectorType(named: String?) -> SKTileObject.Type

Show on GitHub

Tileset Delegate


                    
                    
                    
                    
                    willAddSpriteSheet(to:fileNamed:)

Declaration

Swift

open func willAddSpriteSheet(to tileset: SKTileset, fileNamed: String) -> String

Show on GitHub

Updating

Called before each frame is rendered.

Declaration

Swift

open override func update(_ currentTime: TimeInterval)

Parameters


                                currentTime

update interval.

Show on GitHub

updateCamera()
Update the camera bounds.
Declaration
Swift

open func updateCamera()
Show on GitHub


                    
                    
                    
                    
                    objectForGraphType(named:)

Return a custom graph node type.

Declaration

Swift

open func objectForGraphType(named: String?) -> GKGridGraphNode.Type

Parameters


                                named

graph node type.

Return Value

dictionary insertion was successful.

Show on GitHub


                    
                    
                    
                    
                    addGraph(named:graph:)

Add a GKGridGraph instance to the SKTIledScene.graphs property. Returns false if that name exists already.

Declaration

Swift

open func addGraph(named: String, graph: GKGridGraph<GKGridGraphNode>) -> Bool

Parameters

`named`	name of graph
`graph`	graph object.

Return Value

graph was added sucessfully.

Show on GitHub


                    
                    
                    
                    
                    removeGraph(named:)

Remove a named GKGridGraph from the SKTIledScene.graphs property.

Declaration

Swift

open func removeGraph(named: String) -> GKGridGraph<GKGridGraphNode>?

Parameters


                                named

name of graph.

Return Value

removed graph instance.

Show on GitHub


                    
                    
                    
                    
                    mouseDown(with:)

Handler for mouse down events.

Declaration

Swift

open override func mouseDown(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub


                    
                    
                    
                    
                    rightMouseDown(with:)

Mouse right-click event handler.

Declaration

Swift

open override func rightMouseDown(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub


                    
                    
                    
                    
                    mouseUp(with:)

Handler for mouse up events.

Declaration

Swift

open override func mouseUp(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub


                    
                    
                    
                    
                    rightMouseUp(with:)

Mouse right-click event handler.

Declaration

Swift

open override func rightMouseUp(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub


                    
                    
                    
                    
                    mouseMoved(with:)

Mouse move event handler.

Declaration

Swift

open override func mouseMoved(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub


                    
                    
                    
                    
                    scrollWheel(with:)

Mouse scroll wheel event handler.

Declaration

Swift

open override func scrollWheel(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub


                    
                    
                    
                    
                    mouseDragged(with:)

Mouse drag event handler.

Declaration

Swift

open override func mouseDragged(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub


                    
                    
                    
                    
                    mouseEntered(with:)

Mouse enter event handler.

Declaration

Swift

open override func mouseEntered(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub


                    
                    
                    
                    
                    mouseExited(with:)

Mouse exit event handler.

Declaration

Swift

open override func mouseExited(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub

sceneDoubleTapped(location:)

Called when the scene receives a double-tap event (iOS only).

Delegate Methods


                    
                    
                    
                    
                    cameraPositionChanged(newPosition:)

Called when the camera position changes.

Declaration

Swift

@objc
open func cameraPositionChanged(newPosition: CGPoint)

Parameters


                                newPosition

updated camera position.

Show on GitHub


                    
                    
                    
                    
                    cameraZoomChanged(newZoom:)

Called when the camera zoom changes.

Declaration

Swift

@objc
open func cameraZoomChanged(newZoom: CGFloat)

Parameters


                                newZoom

camera zoom amount.

Show on GitHub


                    
                    
                    
                    
                    cameraBoundsChanged(bounds:position:zoom:)

Called when the camera bounds updated.

Declaration

Swift

@objc
open func cameraBoundsChanged(bounds: CGRect, position: CGPoint, zoom: CGFloat)

Parameters

`bounds`	camera view bounds.
`position`	camera position.
`zoom`	camera zoom amount.

Show on GitHub


                    
                    
                    
                    
                    leftMouseDown(event:)

Called when the scene is clicked (macOS only).

Declaration

Swift

@objc
open func leftMouseDown(event: NSEvent)

Parameters


                                event

mouse click event.

Show on GitHub


                    
                    
                    
                    
                    leftMouseDoubleClicked(event:)

Called when the scene is double-clicked (macOS only).

Declaration

Swift

@objc
open func leftMouseDoubleClicked(event: NSEvent)

Parameters


                                event

mouse click event.

Show on GitHub


                    
                    
                    
                    
                    rightMouseDown(event:)

Called when the scene is right-clicked (macOS only).

Declaration

Swift

@objc
open func rightMouseDown(event: NSEvent)

Parameters


                                event

mouse click event.

Show on GitHub


                    
                    
                    
                    
                    sceneRightClickReleased(event:)

Called when the right mouse button is released (macOS only).

Declaration

Swift

@objc
open func sceneRightClickReleased(event: NSEvent)

Parameters


                                event

mouse click event.

Show on GitHub


                    
                    
                    
                    
                    mousePositionChanged(event:)

Called when the mouse moves in the scene (macOS only).

Declaration

Swift

@objc
open func mousePositionChanged(event: NSEvent)

Parameters


                                event

mouse move event.

Show on GitHub

description
Returns a string representation of the node.
Declaration
Swift

open override var description: String { get }
Show on GitHub

Deprecations


                    
                    
                    
                    
                    setup(url:withTilesets:ignoreProperties:loggingLevel:_:)

Load and setup a named TMX file, with optional tilesets.

Declaration

Swift

@available(*, deprecated, renamed: "setup(url:delegate:withTilesets:ignoreProperties:loggingLevel:_:﹚")
open func setup(url: URL,
                withTilesets: [SKTileset] = [],
                ignoreProperties: Bool = false,
                loggingLevel: LoggingLevel = TiledGlobals.default.loggingLevel,
                _ completion: ((_ tilemap: SKTilemap) -> Void)? = nil)

Parameters

`url`	Tiled file url.
`withTilesets`	pre-loaded tilesets.
`ignoreProperties`	don’t parse custom properties.
`loggingLevel`	logging verbosity.
`completion`	optional completion handler.

Show on GitHub


                    
                    
                    
                    
                    setup(tmxFile:inDirectory:withTilesets:ignoreProperties:loggingLevel:_:)

Load and setup a named TMX file, with optional tilesets. Allows for an optional completion handler.

Declaration

Swift

@available(*, deprecated, renamed: "setup(tmxFile:delegate:inDirectory:withTilesets:ignoreProperties:loggingLevel:_:﹚")
open func setup(tmxFile: String,
                inDirectory: String? = nil,
                withTilesets tilesets: [SKTileset] = [],
                ignoreProperties: Bool = false,
                loggingLevel: LoggingLevel = TiledGlobals.default.loggingLevel,
                _ completion: ((_ tilemap: SKTilemap) -> Void)? = nil)

Parameters

`tmxFile`	TMX file name.
`inDirectory`	search path for assets.
`tilesets`	optional pre-loaded tilesets.
`ignoreProperties`	don’t parse custom properties.
`loggingLevel`	logging verbosity.
`completion`	optional completion handler.

Show on GitHub