PlayfulKit

NODES

PKMapNode:

Create a grid map of sprite nodes.

// The setup includes the configuration of the scene size. It is needed to display the node correctly.
setup()

let squareSize = CGSize(width: 30, height: 30)
let matrix = Matrix(row: 10, column: 10)
let origin: CGPoint = cornerPosition(corner: .topLeft, 
                                     node: self, 
                                     padding: EdgeInsets(top: 100, leading: 60, bottom: 0, trailing: 0))

let map = PKMapNode(squareSize: squareSize, matrix: matrix, origin: origin)

addChild(map)

PKProgressBarNode:

Create a progress bar with or without images.

// The setup includes the configuration of the scene size. It is needed to display the node correctly.

setup()

let configuration = PKProgressBarNode.ShapeConfiguration(amount: 0.4, 
                                                         size: CGSize(width: 200, height: 20),
                                                         color: .green,
                                                         underColor: .gray,
                                                         cornerRadius: 15)

let progressBar = PKProgressBarNode(configuration: configuration)
progressBar.position = .center

addChild(progressBar)

PKTypewriterNode

Create a writing text.

// The setup includes the configuration of the scene size. It is needed to display the content of the node correctly.

setup()

let content = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"
let padding = EdgeInsets(top: 60, leading: 30, bottom: 0, trailing: 30)

let parameter = TextManager.Paramater(content: content, padding: padding)

let typewriterNode = PKTypewriterNode(container: self, parameter: parameter)

addChild(typewriterNode)

PKTimerNode

Create a timer node.

setup()
let countdown: Int = 5

let label = SKLabelNode(text: "\(countdown)")
label.position = .center

addChild(label)

let configuration = PKTimerNode.TimerConfiguration(countdown: countdown)

let timer = PKTimerNode(label: label, configuration: configuration)

label.addChild(timer)

timer.start()

SOUND MANAGER

// Instanciate the manager
let soundManager = SoundManager()

Play a music.

try? soundManager.playMusic(name: "sound.wav")

Play a music sequence.

try? soundManager.playMusicSequence(names: ["sound1.wav", "sound2.wav", "sound3.wav"])

Play a SFX.

try? soundManager.playSFX(name: "step.wav")

ASSEMBLY MANAGER

// Instanciate the manager
let assemblyManager = AssemblyManager()

// Create your nodes
var nodes: [SKSpriteNode] = []
for _ in 0..<10 {
   let node = SKSpriteNode(imageNamed: "sprite")
   node.size = CGSize(width: 50, height: 50)
   nodes.append(node)
}

Create a non scrollable list of nodes.

assemblyManager.createNodeList(of nodes: nodes, in node: self)

Play a non scrollable grid collection of nodes.

assemblyManager.createNodeCollection(of: nodes, in: self)

Controller Manager

// Instanciate the manager
let manager = ControllerManager(scene: scene)

// Setup the controller elements for the virtual controller (button, dpad, etc...)
func setupVirtualController() {
    manager.virtualControllerElements = [.directionPad, .buttonA, .buttonB, .buttonX, .buttonY]
}

// Assign the actions to inputs.
func setupActions() {
    manager.action = ControllerManager.ControllerAction()
        
    manager.action?.buttonA = ControllerManager.ButtonAction(symbol: .a,
                                                             press: actionA,
                                                             release: releaseA)

    manager.action?.buttonB = ControllerManager.ButtonAction(symbol: .b,
                                                             press: actionB,
                                                             release: releaseB)

    manager.action?.buttonX = ControllerManager.ButtonAction(symbol: .x,
                                                             press: actionX,
                                                             release: releaseX)

    manager.action?.buttonY = ControllerManager.ButtonAction(symbol: .y,
                                                             press: actionY,
                                                             release: releaseY)
        
    manager.action?.dpad = ControllerManager.DPadAction(leftPress: action.leftPadActionPress,
                                                        rightPress: action.rightPadActionPress,
                                                        upPress: action.upPadActionPress,
                                                        downPress: action.downPadActionPress,
                                                        release: action.releaseDPad)
}
    
// Setup the controllers.
func setupControllers() {
    setupVirtualController()
    setupActions()
    manager.observeControllers()
}

setupControllers()