Fix related to #33340: add a warning to bge from_id documentation to not store id()
authorBrecht Van Lommel <brechtvanlommel@pandora.be>
Thu, 29 Nov 2012 01:25:38 +0000 (01:25 +0000)
committerBrecht Van Lommel <brechtvanlommel@pandora.be>
Thu, 29 Nov 2012 01:25:38 +0000 (01:25 +0000)
in game object integer properties since it may not fit in 32 bits integers.

doc/python_api/rst/bge.types.rst

index f7a63b48f61e9f43167545de23fe4c3e7db63012..8cf9ccb794cba85e8412f8b9a6426a58c87f84e5 100644 (file)
@@ -759,6 +759,10 @@ Types
 
          The id is derived from a memory location and will be different each time the game engine starts.
 
+      .. warning::
+
+         The id can't be stored as an integer in game object properties, as those only have a limited range that the id may not be contained in. Instead an id can be stored as a string game property and converted back to an integer for use in from_id lookups.
+
 .. class:: KX_BlenderMaterial(PyObjectPlus)
 
    KX_BlenderMaterial