BGE Script template for a python module (set EOL to native this time)

BGE PyAPI use defines for error return values
 - del gameOb['var'] error message was wrong.

4 files changed, 59 insertions, 14 deletions

diff --git a/release/scripts/scripttemplate_gamelogic_module.py b/release/scripts/scripttemplate_gamelogic_module.py
new file mode 100644
index 00000000000..2ef4950917b
--- /dev/null
+++ b/release/scripts/scripttemplate_gamelogic_module.py
@@ -0,0 +1,45 @@
+#!BPY
+"""
+Name: 'GameLogic Module'
+Blender: 249
+Group: 'ScriptTemplate'
+Tooltip: 'Basic template for new game logic modules'
+"""
+
+from Blender import Window
+import bpy
+
+script_data = \
+'''
+# This module can be accessed by a python controller with
+# its execution method set to 'Module'
+# * Set the module string to "gamelogic_module.main" (without quotes)
+# * When renaming the script it MUST have a .py extension
+# * External text modules are supported as long as they are at
+#   the same location as the blendfile or one of its libraries.
+
+import GameLogic
+
+# variables defined here will only be set once when the
+# module is first imported. Set object spesific vars
+# inside the function if you intend to use the module
+# with multiple objects.
+
+def main(cont):
+	own = cont.owner
+	
+	sens = cont.sensors['mySensor']
+	actu = cont.actuators['myActuator']
+	
+	if sens.positive:
+		cont.activate(actu)
+	else:
+		cont.deactivate(actu)
+
+# dont call main(GameLogic.getCurrentController()), the py controller will
+'''
+
+new_text = bpy.data.texts.new('gamelogic_module.py')
+new_text.write(script_data)
+bpy.data.texts.active = new_text
+Window.RedrawAll()
diff --git a/source/gameengine/Expressions/PyObjectPlus.cpp b/source/gameengine/Expressions/PyObjectPlus.cpp
index 720094b6f98..defb6853e67 100644
--- a/source/gameengine/Expressions/PyObjectPlus.cpp
+++ b/source/gameengine/Expressions/PyObjectPlus.cpp
@@ -362,12 +362,12 @@ int PyObjectPlus::py_set_attrdef(void *self, const PyAttributeDef *attrdef, PyOb
 		if (!PySequence_Check(value)) 
 		{
 			PyErr_Format(PyExc_TypeError, "expected a sequence for attribute \"%s\"", attrdef->m_name);
-			return 1;
+			return PY_SET_ATTR_FAIL;
 		}
 		if (PySequence_Size(value) != attrdef->m_length)
 		{
 			PyErr_Format(PyExc_TypeError, "incorrect number of elements in sequence for attribute \"%s\"", attrdef->m_name);
-			return 1;
+			return PY_SET_ATTR_FAIL;
 		}
 		switch (attrdef->m_type) 
 		{
@@ -375,7 +375,7 @@ int PyObjectPlus::py_set_attrdef(void *self, const PyAttributeDef *attrdef, PyOb
 			if (attrdef->m_setFunction == NULL) 
 			{
 				PyErr_Format(PyExc_AttributeError, "function attribute without function for attribute \"%s\", report to blender.org", attrdef->m_name);
-				return 1;
+				return PY_SET_ATTR_FAIL;
 			}
 			return (*attrdef->m_setFunction)(self, attrdef, value);
 		case KX_PYATTRIBUTE_TYPE_BOOL:
@@ -394,7 +394,7 @@ int PyObjectPlus::py_set_attrdef(void *self, const PyAttributeDef *attrdef, PyOb
 		default:
 			// should not happen
 			PyErr_Format(PyExc_AttributeError, "Unsupported attribute type for attribute \"%s\", report to blender.org", attrdef->m_name);
-			return 1;
+			return PY_SET_ATTR_FAIL;
 		}
 		// let's implement a smart undo method
 		bufferSize *= attrdef->m_length;
@@ -542,12 +542,12 @@ int PyObjectPlus::py_set_attrdef(void *self, const PyAttributeDef *attrdef, PyOb
 					memcpy(sourceBuffer, undoBuffer, bufferSize);
 					free(undoBuffer);
 				}
-				return 1;
+				return PY_SET_ATTR_FAIL;
 			}
 		}
 		if (undoBuffer)
 			free(undoBuffer);
-		return 0;
+		return PY_SET_ATTR_SUCCESS;
 	}
 	else	// simple attribute value
 	{
@@ -556,7 +556,7 @@ int PyObjectPlus::py_set_attrdef(void *self, const PyAttributeDef *attrdef, PyOb
 			if (attrdef->m_setFunction == NULL)
 			{
 				PyErr_Format(PyExc_AttributeError, "function attribute without function \"%s\", report to blender.org", attrdef->m_name);
-				return 1;
+				return PY_SET_ATTR_FAIL;
 			}
 			return (*attrdef->m_setFunction)(self, attrdef, value);
 		}
@@ -589,7 +589,7 @@ int PyObjectPlus::py_set_attrdef(void *self, const PyAttributeDef *attrdef, PyOb
 				break;
 			default:
 				PyErr_Format(PyExc_AttributeError, "unknown type for attribute \"%s\", report to blender.org", attrdef->m_name);
-				return 1;
+				return PY_SET_ATTR_FAIL;
 			}
 			if (bufferSize)
 			{
@@ -712,7 +712,7 @@ int PyObjectPlus::py_set_attrdef(void *self, const PyAttributeDef *attrdef, PyOb
 				if (!PySequence_Check(value) || PySequence_Size(value) != 3) 
 				{
 					PyErr_Format(PyExc_TypeError, "expected a sequence of 3 floats for attribute \"%s\"", attrdef->m_name);
-					return 1;
+					return PY_SET_ATTR_FAIL;
 				}
 				MT_Vector3 *var = reinterpret_cast<MT_Vector3*>(ptr);
 				for (int i=0; i<3; i++)
diff --git a/source/gameengine/Expressions/Value.cpp b/source/gameengine/Expressions/Value.cpp
index f61ef1455b4..773fd94a0fb 100644
--- a/source/gameengine/Expressions/Value.cpp
+++ b/source/gameengine/Expressions/Value.cpp
@@ -662,7 +662,7 @@ int	CValue::py_delattro(PyObject *attr)
 		return 0;
 	
 	PyErr_Format(PyExc_AttributeError, "attribute \"%s\" dosnt exist", attr_str);
-	return 1;
+	return PY_SET_ATTR_MISSING;
 }
 
 int	CValue::py_setattro(PyObject *attr, PyObject* pyobj)
diff --git a/source/gameengine/Ketsji/KX_GameObject.cpp b/source/gameengine/Ketsji/KX_GameObject.cpp
index f1c3fb89df2..1f7eeca1b69 100644
--- a/source/gameengine/Ketsji/KX_GameObject.cpp
+++ b/source/gameengine/Ketsji/KX_GameObject.cpp
@@ -1342,7 +1342,7 @@ int KX_GameObject::Map_SetItem(PyObject *self_v, PyObject *key, PyObject *val)
 		
 		if (del==0) {
 			if(attr_str)	PyErr_Format(PyExc_KeyError, "gameOb[key] = value: KX_GameObject, key \"%s\" could not be set", attr_str);
-			else			PyErr_SetString(PyExc_KeyError, "gameOb[key] = value: KX_GameObject, key could not be set");
+			else			PyErr_SetString(PyExc_KeyError, "del gameOb[key]: KX_GameObject, key could not be deleted");
 			return -1;
 		}
 		else if (self->m_attr_dict) {
@@ -1902,13 +1902,13 @@ int	KX_GameObject::py_delattro(PyObject *attr)
 	char *attr_str= PyString_AsString(attr); 
 	
 	if (RemoveProperty(attr_str)) // XXX - should call CValues instead but its only 2 lines here
-		return 0;
+		return PY_SET_ATTR_SUCCESS;
 	
 	if (m_attr_dict && (PyDict_DelItem(m_attr_dict, attr) == 0))
-		return 0;
+		return PY_SET_ATTR_SUCCESS;
 	
 	PyErr_Format(PyExc_AttributeError, "del gameOb.myAttr: KX_GameObject, attribute \"%s\" dosnt exist", attr_str);
-	return 1;
+	return PY_SET_ATTR_MISSING;
 }