SKGroupLayer

public class SKGroupLayer : TiledLayerObject

Subclass of TiledLayerObject, the SKGroupLayer node is a container for managing groups of layers.

Usage

Query child layers:

for child in group.layers {
    child.opacity = 0.5
}

Add layers to the group with:

groupLayer.addLayer(playerLayer)

Remove with:

groupLayer.removeLayer(playerLayer)
  • lastIndex

    Returns the last index for all layers.

    Declaration

    Swift

    public var lastIndex: UInt32 { get }
    Show on GitHub
  • lastZPosition

    Returns the last (highest) z-position in the map.

    Declaration

    Swift

    public var lastZPosition: CGFloat { get }
    Show on GitHub
  • layers

    Returns a flattened array of contained child layers.

    Declaration

    Swift

    public override var layers: [TiledLayerObject] { get }
    Show on GitHub
  • speed

    Speed modifier applied to all actions executed by the layer and its descendants.

    Declaration

    Swift

    public override var speed: CGFloat { get set }
    Show on GitHub
  • tintColor

    Overview

    Set the layer tint color. Tiles contained in this layer will be tinted with the given color.

    Declaration

    Swift

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

Initialization

Layers

  • allLayers()

    Returns all layers, sorted by index (first is lowest, last is highest).

    Declaration

    Swift

    public func allLayers() -> [TiledLayerObject]

    Return Value

    array of layers.

    Show on GitHub
  • layerNames()

    Returns an array of layer names.

    Declaration

    Swift

    public func layerNames() -> [String]

    Return Value

    layer names.

    Show on GitHub
  • addLayer(_:clamped:)

    Add a layer to the layers set. Automatically sets zPosition based on the tilemap zDeltaForLayers attributes.

    Declaration

    Swift

    @discardableResult
public func addLayer(_ layer: TiledLayerObject, clamped: Bool = true) -> (success: Bool, layer: TiledLayerObject)

    Parameters

    layer

    layer object.
    clamped

    clamp position to nearest pixel.

    Return Value

    add was successful, layer added.

    Show on GitHub
  • removeLayer(_:)

    Remove a layer from the current layers set.

    Declaration

    Swift

    public func removeLayer(_ layer: TiledLayerObject) -> TiledLayerObject?

    Parameters

    layer

    layer object.

    Return Value

    removed layer.

    Show on GitHub

Updating

  • update(_:)

    Update the group layer before each frame is rendered.

    Declaration

    Swift

    public override func update(_ currentTime: TimeInterval)

    Parameters

    currentTime

    update interval.
    Show on GitHub

Extensions

  • tiledElementName

    Returns the internal Tiled node type.

    Declaration

    Swift

    @objc
public var tiledElementName: String { get }
    Show on GitHub
  • tiledNodeNiceName

    Returns a “nicer” node name, for usage in the inspector.

    Declaration

    Swift

    @objc
public override var tiledNodeNiceName: String { get }
    Show on GitHub
  • tiledIconName

    Returns the internal Tiled node type icon.

    Declaration

    Swift

    @objc
public override var tiledIconName: String { get }
    Show on GitHub
  • tiledListDescription

    A description of the node used in list or outline views.

    Declaration

    Swift

    @objc
public override var tiledListDescription: String { get }
    Show on GitHub
  • tiledDisplayItemDescription

    A description of the node used for debug output text.

    Declaration

    Swift

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

    A description of the node type used for help features.

    Declaration

    Swift

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