mirror of
https://github.com/panda3d/panda3d.git
synced 2025-10-03 02:15:43 -04:00
actor: improve API documentation for Actor.cleanup()
Intended to address panda3d/panda3d-docs#40 [skip ci]
This commit is contained in:
parent
28711814e7
commit
3b361974dc
@ -500,7 +500,12 @@ class Actor(DirectObject, NodePath):
|
|||||||
|
|
||||||
def cleanup(self):
|
def cleanup(self):
|
||||||
"""
|
"""
|
||||||
Actor cleanup function
|
This method should be called when intending to destroy the Actor, and
|
||||||
|
cleans up any additional resources stored on the Actor class before
|
||||||
|
removing the underlying node using `removeNode()`.
|
||||||
|
|
||||||
|
Note that `removeNode()` itself is not sufficient to destroy actors,
|
||||||
|
which is why this method exists.
|
||||||
"""
|
"""
|
||||||
self.stop(None)
|
self.stop(None)
|
||||||
self.clearPythonData()
|
self.clearPythonData()
|
||||||
@ -512,6 +517,11 @@ class Actor(DirectObject, NodePath):
|
|||||||
self.removeNode()
|
self.removeNode()
|
||||||
|
|
||||||
def removeNode(self):
|
def removeNode(self):
|
||||||
|
"""
|
||||||
|
You should call `cleanup()` for Actor objects instead, since
|
||||||
|
:meth:`~panda3d.core.NodePath.removeNode()` is not sufficient for
|
||||||
|
completely destroying Actor objects.
|
||||||
|
"""
|
||||||
if self.__geomNode and (self.__geomNode.getNumChildren() > 0):
|
if self.__geomNode and (self.__geomNode.getNumChildren() > 0):
|
||||||
assert self.notify.warning("called actor.removeNode() on %s without calling cleanup()" % self.getName())
|
assert self.notify.warning("called actor.removeNode() on %s without calling cleanup()" % self.getName())
|
||||||
NodePath.removeNode(self)
|
NodePath.removeNode(self)
|
||||||
@ -525,7 +535,7 @@ class Actor(DirectObject, NodePath):
|
|||||||
|
|
||||||
def flush(self):
|
def flush(self):
|
||||||
"""
|
"""
|
||||||
Actor flush function
|
Actor flush function. Used by `cleanup()`.
|
||||||
"""
|
"""
|
||||||
self.clearPythonData()
|
self.clearPythonData()
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user