SKTileObject

open class SKTileObject : SKShapeNode, CustomReflectable, TiledObjectType

The SKTileObject class represents a Tiled vector object type (rectangle, ellipse, polygon, point & polyline). When the object is created, points can be added either with an array of points, or a string. In order to render the object, the SKTileObject.getVertices() method is called, which returns the points needed to draw the path.

Properties

id: Tiled object id.
size: object size.
tileData: tile data (for tile objects).
text: text string (for text objects). Setting this redraws the object.
bounds: returns the bounding box of the shape.

For more information, see the Working with Objects page in the [official documentation][sktiled-docroot-url].

TiledObjectType
The TiledObjectType enumeration describes a vector object type (tile object, text object, etc).

Properties
- none: object is a simple vector object type.
- text: object is text object.
- tile: object is effectively a tile.
- point: object is a references a single point.
Declaration
Swift

public enum TiledObjectType : String
Show on GitHub
TiledObjectShape
The TiledObjectType enumeration describes the shape of vector objects.

Properties
- rectangle: rectangular object shape.
- ellipse: circular object shape.
- polygon: closed polygonal object shape.
- polyline: ppen polygonal object shape.
Declaration
Swift

public enum TiledObjectShape : String
Show on GitHub
layer
Object parent layer.
Declaration
Swift

open weak var layer: SKObjectGroup!
Show on GitHub
uuid
Unique id (layer & object names may not be unique).
Declaration
Swift

open var uuid: String
Show on GitHub
id
Tiled object id.
Declaration
Swift

open var id: UInt32
Show on GitHub
type
Object type.
Declaration
Swift

open var type: String!
Show on GitHub
size
Object size.
Declaration
Swift

open var size: CGSize
Show on GitHub

Move Up

isFocused
Indicates the current node has received focus or selected.
Declaration
Swift

public var isFocused: Bool { 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
Show on GitHub
visibleToCamera
Object is visible in camera.
Declaration
Swift

open var visibleToCamera: Bool
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
enableAnimation
Enable tile animation.
Declaration
Swift

open var enableAnimation: Bool { get set }
Show on GitHub
tile
Object tile (for tile objects).
Declaration
Swift

public internal(set) var tile: SKTile? { get }
Show on GitHub
isInitialized
Signifies that the object has been fully initialized.
Declaration
Swift

open internal(set) var isInitialized: Bool { get }
Show on GitHub
drawCount
Number of times this object has been redrawn (debug).
Declaration
Swift

open var drawCount: UInt32
Show on GitHub
tileData
Tile data (for tile objects).
Declaration
Swift

open var tileData: SKTilesetData? { get }
Show on GitHub

Color Attributes

frameColor
Object bounds color.
Declaration
Swift

open var frameColor: SKColor
Show on GitHub
highlightColor
Object highlight color.
Declaration
Swift

open var highlightColor: SKColor
Show on GitHub
proxyColor
Optional proxy color.
Declaration
Swift

open var proxyColor: SKColor?
Show on GitHub
tintColor
Optional tint color.
Declaration
Swift

open var tintColor: SKColor? { get set }
Show on GitHub

Shape Attributes


                    
                    
                    
                    
                    boundsShape

Object 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
CollisionType
The CollisionType enumeration describes tile vector object collision type.

Properties
- none: no physics collisions.
- dynamic: object is a dynamic physics body.
- collision: object records collisions only.
Declaration
Swift

public enum CollisionType
Show on GitHub

Properties

properties
Custom object properties.
Declaration
Swift

open var properties: [String : String]
Show on GitHub
ignoreProperties
Object will ignore custom properties.
Declaration
Swift

open var ignoreProperties: Bool
Show on GitHub
physicsType
Physics collision type.
Declaration
Swift

open var physicsType: CollisionType
Show on GitHub
textAttributes
Text formatting attributes (for text objects)
Declaration
Swift

open var textAttributes: TextObjectAttributes!
Show on GitHub
renderQuality
Text object render quality.
Declaration
Swift

open var renderQuality: CGFloat { get set }
Show on GitHub
text
Text string (for text objects). Setting this attribute will redraw the object automatically.
Declaration
Swift

open var text: String! { get set }
Show on GitHub
boundingRect
Returns the bounding box of the shape.
Declaration
Swift

open override var boundingRect: CGRect { get }
Show on GitHub
anchorPoint
Returns the object anchor point (based on the current map’s tile size).
Declaration
Swift

open var anchorPoint: CGPoint { get }
Show on GitHub
isRenderableType
Signifies that this object is a text or tile object.
Declaration
Swift

open var isRenderableType: Bool { get }
Show on GitHub
isPolyType
Signifies that this object is a polygonal type.
Declaration
Swift

open var isPolyType: Bool { get }
Show on GitHub

Initialization


                    
                    
                    
                    
                    init(width:height:type:)

Initialize the object with width & height attributes.

Declaration

Swift

required public init(width: CGFloat,
                     height: CGFloat,
                     type: TiledObjectShape = .rectangle)

Parameters

`width`	object size width.
`height`	object size height.
`type`	object shape type.

Show on GitHub


                    
                    
                    
                    
                    init(attributes:)

Initialize the object with a dictionary of object attributes from the Tiled source XML.

Declaration

Swift

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

Parameters


                                attributes

attributes parsed from Tiled XML.

Show on GitHub

destroy()
Removes this node from the scene graph.
Declaration
Swift

open override func destroy()
Show on GitHub


                    
                    
                    
                    
                    init(layer:)

Initialize the object with an object group reference.

Declaration

Swift

required public init(layer: SKObjectGroup)

Parameters


                                layer

object group.

Show on GitHub


                    
                    
                    
                    
                    init(coder:)

Instantiate the node with a decoder instance.

Declaration

Swift

required public init?(coder aDecoder: NSCoder)

Parameters


                                aDecoder

decoder.

Show on GitHub

Colors


                    
                    
                    
                    
                    setColor(color:withAlpha:redraw:)

Set the fill & stroke colors (with optional alpha component for the fill).

Declaration

Swift

open func setColor(color: SKColor,
                   withAlpha alpha: CGFloat = 0.35,
                   redraw: Bool = true)

Parameters

`color`	fill & stroke color.
`alpha`	alpha component for fill.
`redraw`	force object to redraw.

Show on GitHub


                    
                    
                    
                    
                    setColor(hexString:withAlpha:redraw:)

Set the fill & stroke colors with a hexadecimal string.

Declaration

Swift

open func setColor(hexString: String,
                   withAlpha alpha: CGFloat = 0.35,
                   redraw: Bool = true)

Parameters

`hexString`	hex color string.
`alpha`	alpha component for fill.
`redraw`	force object to redraw.

Show on GitHub

Tile Data


                    
                    
                    
                    
                    setTileData(_:)

Set the tile object’s tile data.

Declaration

Swift

open func setTileData(_ data: SKTilesetData)

Parameters


                                data

tile data instance.

Show on GitHub

Rendering

draw()
Render the object.
Declaration
Swift

@objc open func draw()
Show on GitHub


                    
                    
                    
                    
                    drawTextObject(withScale:)

Draw the text object. Scale factor is to allow for text to render clearly at higher zoom levels.

Declaration

Swift

open func drawTextObject(withScale: CGFloat = 8) -> CGImage?

Parameters


                                withScale

render quality scaling.

Return Value

rendered text image.

Show on GitHub

Geometry

getVertices(offset:)
Returns the internal SKTileObject.points array, translated into the current map’s projection.
Declaration
Swift

@objc public override func getVertices(offset: CGPoint = CGPoint.zero) -> [CGPoint]
Return Value

array of points.

Show on GitHub


                    
                    
                    
                    
                    contains(touch:)

Returns true if the touch event (mouse or touch) hits this node.

Declaration

Swift

@objc
public override func contains(touch: CGPoint) -> Bool

Parameters


                                touch

touch point in this node.

Return Value

node was touched.

Show on GitHub

Events & Handlers

touchesBegan(_:with:)

Callbacks


                    
                    
                    
                    
                    didBeginRendering(completion:)

Object has begun rendering.

Declaration

Swift

open func didBeginRendering(completion: (() -> Void)? = nil)

Parameters


                                completion

optional completion handler.

Show on GitHub


                    
                    
                    
                    
                    didFinishRendering(completion:)

Object has finished rendering.

Declaration

Swift

open func didFinishRendering(completion: (() -> Void)? = nil)

Parameters


                                completion

optional completion handler.

Show on GitHub

Dynamics

setupPhysics()
Setup physics for the object based on properties set up in Tiled.
Declaration
Swift

open func setupPhysics()
Show on GitHub
getPhysicsPath()
Returns a path representing the physics shape.
Declaration
Swift

open func getPhysicsPath() -> CGPath?
Return Value

path object.

Show on GitHub

Updating

Update the object before each frame is rendered.

Declaration

Swift

open func update(_ deltaTime: TimeInterval)

Parameters


                                deltaTime

update interval.

Show on GitHub

Reflection

customMirror
Returns a custom mirror for this object.
Declaration
Swift

public var customMirror: Mirror { get }
Show on GitHub

Extensions

tilemap
Reference to the objects’s parent tilemap.
Declaration
Swift

open var tilemap: SKTilemap? { get }
Show on GitHub
opacity
Object opacity.
Declaration
Swift

open var opacity: CGFloat { get set }
Show on GitHub
visible
Object visibility.
Declaration
Swift

open var visible: Bool { get set }
Show on GitHub
isAnimated
Returns true if the object references an animated tile.
Declaration
Swift

open var isAnimated: Bool { get }
Show on GitHub
isTextObject
Signifies that the object is a text object.
Declaration
Swift

open var isTextObject: Bool { get }
Show on GitHub
isTileObject
Signifies that the object is a tile object.
Declaration
Swift

open var isTileObject: Bool { get }
Show on GitHub


                    
                    
                    
                    
                    highlightNode(with:duration:)

Highlight the tile 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

gid

Tiled global id (for tile objects).

Declaration

Swift

@available(*, deprecated, renamed: "globalID")
open var gid: UInt32! { get set }

Show on GitHub

Tiled global id (for tile objects).

Declaration

Swift

@available(*, deprecated, renamed: "maskedTileId")
public var realTileId: UInt32 { get }

Show on GitHub

runAnimation()
Runs a tile animation.
Declaration
Swift

@available(*, deprecated) open func runAnimation()
Show on GitHub


                    
                    
                    
                    
                    draw(debug:)

Draw the object.

Declaration

Swift

@available(*, deprecated, renamed: "draw(﹚")
open func draw(debug: Bool = false)

Parameters


                                debug

debug draw option.

Show on GitHub


                    
                    
                    
                    
                    shortDescription

Returns a shortened textual representation for debugging.

Declaration

Swift

@available(*, deprecated, renamed: "tiledListDescription")
open var shortDescription: String { get }

Show on GitHub

SKTileObject


                    
                    
                    
                    
                    parseProperties(completion:)

Parse the object’s properties.

Declaration

Swift

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

Parameters


                                completion

optional completion closure.

Show on GitHub