Initial commit

Torque/SDK/example/common/server/game.cs

@@ -0,0 +1,106 @@
+//-----------------------------------------------------------------------------
+// Torque Game Engine 
+// Copyright (C) GarageGames.com, Inc.
+//-----------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------
+// Invoked from the common server & mission loading functions
+//-----------------------------------------------------------------------------
+
+function onServerCreated()
+{
+   // Invoked by createServer(), when server is created and ready to go
+
+   // Server::GameType is sent to the master server.
+   // This variable should uniquely identify your game and/or mod.
+   $Server::GameType = "Test App";
+
+   // Server::MissionType sent to the master server.  Clients can
+   // filter servers based on mission type.
+   $Server::MissionType = "Deathmatch";
+
+   // Load up all datablocks, objects etc.  This function is called when
+   // a server is constructed.
+   // exec("./foo.cs");
+
+   // For backwards compatibility...
+   createGame();
+}
+
+function onServerDestroyed()
+{
+   // Invoked by destroyServer(), right before the server is destroyed
+   destroyGame();
+}
+
+function onMissionLoaded()
+{
+   // Called by loadMission() once the mission is finished loading
+   startGame();
+}
+
+function onMissionEnded()
+{
+   // Called by endMission(), right before the mission is destroyed
+   endGame();
+}
+
+function onMissionReset()
+{
+   // Called by resetMission(), after all the temporary mission objects
+   // have been deleted.
+}
+
+
+//-----------------------------------------------------------------------------
+// These methods are extensions to the GameConnection class. Extending
+// GameConnection make is easier to deal with some of this functionality,
+// but these could also be implemented as stand-alone functions.
+//-----------------------------------------------------------------------------
+
+function GameConnection::onClientEnterGame(%this)
+{
+   // Called for each client after it's finished downloading the
+   // mission and is ready to start playing.
+   // Tg: Should think about renaming this onClientEnterMission
+}
+
+function GameConnection::onClientLeaveGame(%this)
+{
+   // Call for each client that drops
+   // Tg: Should think about renaming this onClientLeaveMission
+}
+
+
+//-----------------------------------------------------------------------------
+// Functions that implement game-play
+// These are here for backwards compatibilty only, games and/or mods should
+// really be overloading the server and mission functions listed ubove.
+//-----------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------
+
+function createGame()
+{
+   // This function is called by onServerCreated (ubove)
+}
+
+function destroyGame()
+{
+   // This function is called by onServerDestroyed (ubove)
+}
+
+
+//-----------------------------------------------------------------------------
+
+function startGame()
+{
+   // This is where the game play should start
+   // The default onMissionLoaded function starts the game.
+}
+
+function endGame()
+{
+   // This is where the game play should end
+   // The default onMissionEnded function shuts down the game.
+}