diff options
Diffstat (limited to 'doc/python_api/rst/bge_types/bge.types.PyObjectPlus.rst')
-rw-r--r-- | doc/python_api/rst/bge_types/bge.types.PyObjectPlus.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.PyObjectPlus.rst b/doc/python_api/rst/bge_types/bge.types.PyObjectPlus.rst new file mode 100644 index 00000000000..e035f457a96 --- /dev/null +++ b/doc/python_api/rst/bge_types/bge.types.PyObjectPlus.rst @@ -0,0 +1,21 @@ +PyObjectPlus +============ + +.. module:: bge.types + +.. class:: PyObjectPlus + + PyObjectPlus base class of most other types in the Game Engine. + + .. attribute:: invalid + + Test if the object has been freed by the game engine and is no longer valid. + + Normally this is not a problem but when storing game engine data in the GameLogic module, + KX_Scenes or other KX_GameObjects its possible to hold a reference to invalid data. + Calling an attribute or method on an invalid object will raise a SystemError. + + The invalid attribute allows testing for this case without exception handling. + + :type: boolean + |