SpriteKit TileMapNode MemoryLeak Bug

Question

Fabi5500 OP

Created Dec ’17

Replies 4

Boosts 0

Views 3.6k

Participants 3

Hello community,

after days and days of researching and trying out my best, i do not find a solution on my memory leak problem.

I load my GameScene.sks with this code like everyone else does:

extension SKNode {

class func unarchiveFromFile(file:String) -> SKNode? {

  if let path = Bundle.main.path(forResource: file, ofType: "sks") {

     let url = URL(fileURLWithPath: path)

```
          do {
```

             let sceneData = try Data(contentsOf: url, options: .mappedIfSafe)

             let archiver = NSKeyedUnarchiver(forReadingWith: sceneData)

archiver.setClass(self.classForKeyedUnarchiver(), forClassName: "SKScene")

             let scene = archiver.decodeObject(forKey: NSKeyedArchiveRootObjectKey)

                  as! SKNode

             archiver.finishDecoding()

```
             return scene
```
```
             }
```

          catch { print(error.localizedDescription) return nil }

```
    } else {
```
```
       return nil
```
```
    }
```
```
}
```

and i am using it in my code here:

```
func load(level: String) {
```

     if let levelNode = SKNode.unarchiveFromFile(file: level) {

```
     mapNode = levelNode
```
```
     self.worldLayer.addChild(mapNode)
```
```
     loadTileMap()
```
```
     }
```
```
}
```

If i comment out the line

self.worldLayer.addChild(mapNode)

everything works perfect and memory will never rise. But if i use it (i need it :D) memory keeps climbing and climbing.

With use of Instruments it says that the line with

let scene = archiver.decodeObject(forKey: NSKeyedArchiveRootObjectKey) as! SKNode

causes all the memory leaks.

Unfortunately i do not get it managed to remove my leaks.

I appreciate all help.

Boost

Answer 1

QuinceyMorris OP

Dec ’17

>> With use of Instruments it says that the line with

let scene = […]
causes all the memory leaks.

No, that's not the cause of the leaks. That's the place where the leaked objects are created. Based on your code, the cause of the leak seems to be your "load" function. You add a new child of "worldLayer", but you don't remove it when moving to a new level. So, all of your levels exist in the scene at one time, and memory usage goes up. You need something like this:

func load(level: String) {
     if let levelNode = SKNode.unarchiveFromFile(file: level) {
          mapNode.removeFromParent () // discard the old level
          mapNode = levelNode
          self.worldLayer.addChild(mapNode)
          loadTileMap()
     }
}

If you are, in fact, removing the old level from "worldLayer" somewhere else, then the leak indicates you still have a reference to it somewhere in your code.

0

Answer 2

KMT OP

Dec ’17

Hello and welcome to the forums.

>it says that the line with

let scene = archiver.decodeObject(forKey: NSKeyedArchiveRootObjectKey) as! SKNode
causes all the memory leaks.

...only points to where the issue bubbled up, not it's root cause. Set break points and step thru your code to help isolate, and/or brush up on the process according to Apple via the Instruments User Guide 'Find Memory Leaks': https://developer.apple.com/library/content/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/FindingLeakedMemory.html

Speak up if more questions, and good luck.

Ken

0

Answer 3

Fabi5500 OP

Dec ’17

Hello and thank you for your answer. I forgot to say that i already implemented removing the child and everything that belongs to it.

override func willMove(from view: SKView) {

mapNode.removeFromParent()

worldLayer.removeAllActions()

worldLayer.removeAllChildren()

worldLayer.removeFromParent()

mapNode = nil

worldLayer = nil

self.removeAllActions()

self.removeAllChildren()

self.removeFromParent()

}

But unfortunately this is not working for me. The leak still exists.

Setting `mapNode.removeFromParent ()` before initializing it cannot work because it will have nil. I tried it anyways and this was the expected result.

I don´t know why removing the child in `willMove` doesn´t do it for me.

Greetings

0

Answer 4

Fabi5500 OP

Jan ’18

Apple still didn‘t reply to my bug report... :/

0