Initial gamerules commit

Author: Ayuto

addons/source-python/docs/source-python/source/developing/modules/engines.gamerules.rst

@@ -0,0 +1,7 @@
+engines.gamerules module
+=========================
+
+.. automodule:: engines.gamerules
+    :members:
+    :undoc-members:
+    :show-inheritance:

addons/source-python/packages/source-python/engines/gamerules.py

@@ -0,0 +1,78 @@
+# ../engines/gamerules.py
+
+"""Provides access to the gamerules instance."""
+
+# =============================================================================
+# >> IMPORTS
+# =============================================================================
+# Source.Python Imports
+#   Memory
+from memory import make_object
+#   Entities
+from entities.entity import BaseEntity
+from entities.factories import factory_dictionary
+
+
+# =============================================================================
+# >> FORWARD IMPORTS
+# =============================================================================
+# Source.Python Imports
+#   Engines
+from _engines._gamerules import GameSystem
+from _engines._gamerules import GameSystemPerFrame
+from _engines._gamerules import BaseGameSystemPerFrame
+from _engines._gamerules import AutoGameSystemPerFrame
+from _engines._gamerules import GameRules
+
+
+# =============================================================================
+# >> ALL DECLARATION
+# =============================================================================
+__all__ = (
+    'AutoGameSystemPerFrame',
+    'BaseGameSystemPerFrame',
+    'GameSystem',
+    'GameSystemPerFrame',
+    'find_gamerules',
+    'find_gamerules_proxy_name')
+
+
+# =============================================================================
+# >> FUNCTIONS
+# =============================================================================
+def find_gamerules_proxy_name():
+    """Tries to find the gamerules proxy name (e. g. ``cs_gamerules``).
+
+    :raise ValueError:
+        Raised if the gamerules proxy name wasn't found.
+    :rtype: str
+    """
+    for classname in factory_dictionary:
+        if 'gamerules' not in classname:
+            continue
+
+        return classname
+
+    raise ValueError('Unable to find gamerules proxy name.')
+
+def find_gamerules():
+    """Tries to find the gamerules instance.
+
+    :raise ValueError:
+        Raised if the gamerules instance wasn't found.
+    :rtype: GameRules
+    """
+    proxy = BaseEntity.find_or_create(find_gamerules_proxy_name())
+    cls = proxy.server_class
+    while cls:
+        for prop in cls.table:
+            if 'gamerules_data' not in prop.name:
+                continue
+
+            return make_object(
+                GameRules,
+                prop.data_table_proxy_function(None, None, None, None, 0))
+
+        cls = cls.next
+
+    raise ValueError('Unable to find gamerules.')

src/CMakeLists.txt

@@ -193,6 +193,7 @@ Set(SOURCEPYTHON_ENGINES_MODULE_SOURCES
     core/modules/engines/engines_server_wrap.cpp
     core/modules/engines/engines_sound_wrap.cpp
     core/modules/engines/engines_trace_wrap.cpp
+    core/modules/engines/engines_gamerules_wrap.cpp
 )
 
 # ------------------------------------------------------------------

src/core/modules/engines/engines_gamerules_wrap.cpp

@@ -0,0 +1,110 @@
+/**
+* =============================================================================
+* Source Python
+* Copyright (C) 2012-2015 Source Python Development Team.  All rights reserved.
+* =============================================================================
+*
+* This program is free software; you can redistribute it and/or modify it under
+* the terms of the GNU General Public License, version 3.0, as published by the
+* Free Software Foundation.
+*
+* 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, see <http://www.gnu.org/licenses/>.
+*
+* As a special exception, the Source Python Team gives you permission
+* to link the code of this program (as well as its derivative works) to
+* "Half-Life 2," the "Source Engine," and any Game MODs that run on software
+* by the Valve Corporation.  You must obey the GNU General Public License in
+* all respects for all other code used.  Additionally, the Source.Python
+* Development Team grants this exception to all derivative works.
+*/
+
+//---------------------------------------------------------------------------------
+// Includes.
+//---------------------------------------------------------------------------------
+// Source.Python
+#include "export_main.h"
+#include "sp_main.h"
+
+// SDK
+#include "game/shared/gamerules.h"
+
+
+//---------------------------------------------------------------------------------
+// Forward declarations.
+//---------------------------------------------------------------------------------
+void export_gamerules(scope);
+
+
+//---------------------------------------------------------------------------------
+// Declare the _sound module.
+//---------------------------------------------------------------------------------
+DECLARE_SP_SUBMODULE(_engines, _gamerules)
+{
+	export_gamerules(_gamerules);
+}
+
+
+//-----------------------------------------------------------------------------
+// Expose gamerules.
+//-----------------------------------------------------------------------------
+void export_gamerules(scope _gamerules)
+{
+	// IGameSystem
+	class_<IGameSystem, boost::noncopyable> GameSystem("GameSystem", no_init);
+	
+	GameSystem.add_property(
+		"name", 
+		&IGameSystem::Name);
+
+	GameSystem ADD_MEM_TOOLS(IGameSystem);
+
+
+	// IGameSystemPerFrame
+	class_<IGameSystemPerFrame, bases<IGameSystem>, boost::noncopyable> GameSystemPerFrame("GameSystemPerFrame", no_init);
+
+	GameSystemPerFrame ADD_MEM_TOOLS(IGameSystemPerFrame);
+
+
+	// CBaseGameSystemPerFrame
+	class_<CBaseGameSystemPerFrame, bases<IGameSystemPerFrame>, boost::noncopyable> BaseGameSystemPerFrame("BaseGameSystemPerFrame", no_init);
+
+	BaseGameSystemPerFrame ADD_MEM_TOOLS(CBaseGameSystemPerFrame);
+
+
+	// CAutoGameSystemPerFrame
+	class_<CAutoGameSystemPerFrame, bases<CBaseGameSystemPerFrame>, boost::noncopyable> AutoGameSystemPerFrame("AutoGameSystemPerFrame", no_init);
+
+	AutoGameSystemPerFrame.add_property(
+		"next", 
+		make_getter(&CAutoGameSystemPerFrame::m_pNext, reference_existing_object_policy()));
+
+	AutoGameSystemPerFrame ADD_MEM_TOOLS(CAutoGameSystemPerFrame);
+
+
+	// CGameRules
+	class_<CGameRules, bases<CAutoGameSystemPerFrame>, boost::noncopyable> GameRules("GameRules", no_init);
+
+	GameRules.add_property(
+		"game_description",
+		&CGameRules::GetGameDescription);
+
+	GameRules.def(
+		"should_collide",
+		&CGameRules::ShouldCollide);
+
+	GameRules.def(
+		"get_tagged_convar_list",
+		&CGameRules::GetTaggedConVarList);
+
+	GameRules ADD_MEM_TOOLS(CGameRules);
+
+	BEGIN_CLASS_INFO(CGameRules)
+		FUNCTION_INFO(DeathNotice)
+	END_CLASS_INFO()
+}