Add a safe pointer model to ScriptInterface, additional bug/crash fixes.

This commit introduces pointer checks to various functions;
so that entity_* will no longer crash or produce weird results
if passed a Node pointer, etc.
The checks are disabled by default, but can be enabled in
ScriptInterface.cpp.

Fixed possible crashes in a few more functions due to missing NULL-checks.

There was a "feature" in the single Lua state that it would keep globals
intact until the game was quit. That made any globals from mods "leak"
into the game or other mods. Now it resets the Lua state when a mod
is loaded or closed.

BBGE/Quad.cpp

@@ -918,6 +918,7 @@ void Quad::onSetTexture()
 
 PauseQuad::PauseQuad() : Quad(), pauseLevel(0)
 {
+	addType(SCO_PAUSEQUAD);
 }
 
 void PauseQuad::onUpdate(float dt)

BBGE/Quad.h

@@ -22,6 +22,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #define __quad__
 
 #include "RenderObject.h"
+#include "ScriptObject.h"
 
 class QuadLight
 {
@@ -149,7 +150,7 @@ private:
 	void initQuad();
 };
 
-class PauseQuad : public Quad
+class PauseQuad : public ScriptObject, public Quad
 {
 public:
 	PauseQuad();

BBGE/ScriptObject.cpp

@@ -0,0 +1,60 @@
+/*
+Copyright (C) 2007, 2012 - Bit-Blot
+
+This file is part of Aquaria.
+
+Aquaria is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+*/
+
+#include <sstream>
+
+#include "ScriptObject.h"
+
+static const char *scriptObjTypeNames[] =
+{
+	/* (1 << 0) */ "Entity",
+	/* (1 << 1) */ "Ingredient",
+	/* (1 << 2) */ "CollideEntity",
+	/* (1 << 3) */ "ScriptedEntity",
+	/* (1 << 4) */ "Beam",
+	/* (1 << 5) */ "Shot",
+	/* (1 << 6) */ "Web",
+	/* (1 << 7) */ "Bone",
+	/* (1 << 8) */ "Path/Node",
+	/* (1 << 9) */ "PauseQuad",
+	NULL
+};
+
+std::string ScriptObject::getTypeString(unsigned int ty)
+{
+	if (ty == SCO_NONE)
+		return "NO TYPE";
+
+	bool more = false;
+	std::ostringstream os;
+	for (int i = 0; scriptObjTypeNames[i]; ++i)
+	{
+		if (ty & (1 << i))
+		{
+			if (more)
+				os << ", ";
+			os << scriptObjTypeNames[i];
+			more = true;
+		}
+	}
+	return os.str();
+}
+

BBGE/ScriptObject.h

@@ -0,0 +1,74 @@
+/*
+Copyright (C) 2007, 2012 - Bit-Blot
+
+This file is part of Aquaria.
+
+Aquaria is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+*/
+#pragma once
+
+enum ScriptObjectType
+{
+	SCO_NONE              = 0x0000,
+
+	// If you change this enum, do not forget to adjust the string array in the cpp,
+	// and to add additional compile time assertions to ScriptInterface.cpp as necessary!
+	SCO_ENTITY            = 0x0001,
+	SCO_INGREDIENT        = 0x0002,
+	SCO_COLLIDE_ENTITY    = 0x0004,
+	SCO_SCRIPTED_ENTITY   = 0x0008,
+	SCO_BEAM              = 0x0010,
+	SCO_SHOT              = 0x0020,
+	SCO_WEB               = 0x0040,
+	SCO_BONE              = 0x0080,
+	SCO_PATH              = 0x0100,
+	SCO_PAUSEQUAD         = 0x0200,
+
+	SCO_FORCE_32BIT = 0xFFFFFFFF
+};
+
+
+class ScriptObject
+{
+public:
+
+	ScriptObject()
+		: _objtype(SCO_NONE)
+	{
+	}
+
+	virtual ~ScriptObject() {}
+
+	inline void addType(ScriptObjectType ty)
+	{
+		_objtype  = ScriptObjectType(int(ty) | int(_objtype)); // prevent the compiler from crying
+	}
+
+	inline bool isType(ScriptObjectType bt) const
+	{
+		return (_objtype & bt) != 0;
+	}
+
+	inline std::string getTypeString() const
+	{
+		return getTypeString(_objtype);
+	}
+
+	static std::string getTypeString(unsigned int ty);
+
+	// public to allow the static compile check in ScriptInterface.cpp to work
+	ScriptObjectType _objtype;
+};

BBGE/SkeletalSprite.cpp

@@ -42,6 +42,7 @@ void SkeletalKeyframe::copyAllButTime(SkeletalKeyframe *copy)
 
 Bone::Bone() : Quad()
 {
+	addType(SCO_BONE);
 	fileRenderQuad = true;
 	skeleton = 0;
 	generateCollisionMask = true;

BBGE/SkeletalSprite.h

@@ -37,7 +37,7 @@ enum AnimationCommand
 class ParticleEffect;
 class SkeletalSprite;
 
-class Bone : public Quad
+class Bone : public ScriptObject, public Quad
 {
 public:
 	Bone();