[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [52646] trunk/blender/doc/python_api/rst/ bge.types.rst: Fix related to #33340: add a warning to bge from_id documentation to not store id()

[Brecht Van Lommel]

Revision: 52646
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=52646
Author:   blendix
Date:     2012-11-29 01:25:38 +0000 (Thu, 29 Nov 2012)
Log Message:
-----------
Fix related to #33340: add a warning to bge from_id documentation to not store id()
in game object integer properties since it may not fit in 32 bits integers.

Modified Paths:
--------------
    trunk/blender/doc/python_api/rst/bge.types.rst

Modified: trunk/blender/doc/python_api/rst/bge.types.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.types.rst	2012-11-29 00:43:50 UTC (rev 52645)
+++ trunk/blender/doc/python_api/rst/bge.types.rst	2012-11-29 01:25:38 UTC (rev 52646)
@@ -759,6 +759,10 @@
 
          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