SKTiledScene

open class SKTiledScene : SKScene, SKPhysicsContactDelegate, SKTiledSceneDelegate, SKTilemapDelegate, SKTilesetDataSource

extension SKTiledScene: SKTiledSceneCameraDelegate

Overview

Custom scene type for managing SKTilemap nodes.

Conforms to the SKTiledSceneDelegate, SKTilemapDelegate & SKTilesetDataSource protocols.

SKTiledScene Hierarchy

Properties

Property	Description
worldNode	Root container node.
tilemap	Tile map object.
cameraNode	Custom scene camera.

Instance Methods

Method	Description
sceneDoubleTapped	Called when the scene receives a double-tap event (iOS only).
cameraPositionChanged	Called when the camera positon changes.
cameraZoomChanged	Called when the camera zoom changes.
cameraBoundsChanged	Called when the camera bounds updated.
sceneDoubleClicked	Called when the scene is double-clicked (macOS only).
mousePositionChanged	Called when the mouse moves in the scene (macOS only).

▶︎worldNode
World container node.
Declaration
Swift

open var worldNode: SKNode!
Show on GitHub
▶︎tilemap
Tile map node.
Declaration
Swift

open var tilemap: SKTilemap!
Show on GitHub
▶︎cameraNode
Custom scene camera.
Declaration
Swift

open var cameraNode: SKTiledSceneCamera!
Show on GitHub
▶︎loggingLevel
Logging verbosity level.
Declaration
Swift

open var loggingLevel: LoggingLevel
Show on GitHub
▶︎graphs
Reference to navigation graphs.
Declaration
Swift

open var graphs: [String : GKGridGraph<GKGridGraphNode>]
Show on GitHub
▶︎receiveCameraUpdates
Receive notifications from camera.
Declaration
Swift

open var receiveCameraUpdates: Bool
Show on GitHub
▶︎speed
Set the tilemap speed.
Declaration
Swift

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

Init


                    
                    
                    
                    ▶︎init(size:)

Initialize without a tiled map.

Declaration

Swift

required override public init(size: CGSize)

Parameters


                                size

CGSize scene size.

Return Value

SKTiledScene scene.

Show on GitHub


                    
                    
                    
                    ▶︎init(coder:)

Default initializer.

Declaration

Swift

required public init?(coder aDecoder: NSCoder)

Parameters


                                aDecoder

decoder instance.

Show on GitHub


                    
                    
                    
                    ▶︎didChangeSize(_:)

Called when the parent view size changes.

Declaration

Swift

override open func didChangeSize(_ oldSize: CGSize)

Parameters


                                oldSize

previous size.

Show on GitHub


                    
                    
                    
                    ▶︎didMove(to:)

Called when the parent view is displayed.

Declaration

Swift

override open func didMove(to view: SKView)

Parameters


                                view

parent view.

Show on GitHub

Setup


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

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

Declaration

Swift

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

Parameters

`url`	`URL` Tiled file url.
`withTilesets`	`[SKTileset]` pre-loaded tilesets.
`ignoreProperties`	`Bool` don’t parse custom properties.
`loggingLevel`	`LoggingLevel` logging verbosity.
`completion`	`((_ SKTilemap) -> Void)?` 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

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`	`String` TMX file name.
`inDirectory`	`String?` search path for assets.
`withTilesets`	`[SKTileset]` optional pre-loaded tilesets.
`ignoreProperties`	`Bool` don’t parse custom properties.
`loggingLevel`	`LoggingLevel` logging verbosity.
`completion`	`((_ SKTilemap) -> Void)?` optional completion handler.

Show on GitHub

Tileset Delegate


                    
                    
                    
                    ▶︎willAddSpriteSheet(to:fileNamed:)

Declaration

Swift

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

Show on GitHub


                    
                    
                    
                    ▶︎willAddImage(to:forId:fileNamed:)

Declaration

Swift

open func willAddImage(to tileset: SKTileset, forId: Int, fileNamed: String) -> String

Show on GitHub

Updating


                    
                    
                    
                    ▶︎update(_:)

Called before each frame is rendered.

Declaration

Swift

override open func update(_ currentTime: TimeInterval)

Parameters


                                currentTime

TimeInterval 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

String graph node type.

Return Value

GKGridGraphNode.Type dictionary insertion was successfull.

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`	`String` name of graph.
`graph`	`GKGridGraph<GKGridGraphNode>`

Return Value

Bool dictionary insertion was successfull.

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

String name of graph.

Return Value

GKGridGraph? removed graph instance.

Show on GitHub


                    
                    
                    
                    ▶︎mouseDown(with:)

Mouse click event handler.

Declaration

Swift

override open func mouseDown(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub


                    
                    
                    
                    ▶︎mouseMoved(with:)

Mouse move event handler.

Declaration

Swift

override open func mouseMoved(with event: NSEvent)

Parameters


                                event

mouse event.

Show on GitHub


                    
                    
                    
                    ▶︎scrollWheel(with:)

Mouse scroll wheel event handler.

Declaration

Swift

override open func scrollWheel(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 positon changes.

Declaration

Swift

@objc
public func cameraPositionChanged(newPosition: CGPoint)

Parameters


                                newPositon

CGPoint updated camera position.

Show on GitHub


                    
                    
                    
                    ▶︎cameraZoomChanged(newZoom:)

Called when the camera zoom changes.

Declaration

Swift

@objc
public func cameraZoomChanged(newZoom: CGFloat)

Parameters


                                newZoom

CGFloat camera zoom amount.

Show on GitHub


                    
                    
                    
                    ▶︎cameraBoundsChanged(bounds:position:zoom:)

Called when the camera bounds updated.

Declaration

Swift

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

Parameters

`bounds`	`CGRect` camera view bounds.
`positon`	`CGPoint` camera position.
`zoom`	`CGFloat` camera zoom amount.

Show on GitHub


                    
                    
                    
                    ▶︎sceneDoubleClicked(event:)

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

Declaration

Swift

@objc
public func sceneDoubleClicked(event: NSEvent)

Parameters


                                event

NSEvent mouse click event.

Show on GitHub


                    
                    
                    
                    ▶︎mousePositionChanged(event:)

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

Declaration

Swift

@objc
public func mousePositionChanged(event: NSEvent)

Parameters


                                event

NSEvent mouse click event.

Show on GitHub