DOOM-3-BFG

DOOM 3 BFG Edition
Log | Files | Refs

Leaderboards.h (3037B)

      1 /*
      2 ===========================================================================
      3 
      4 Doom 3 BFG Edition GPL Source Code
      5 Copyright (C) 1993-2012 id Software LLC, a ZeniMax Media company. 
      6 
      7 This file is part of the Doom 3 BFG Edition GPL Source Code ("Doom 3 BFG Edition Source Code").  
      8 
      9 Doom 3 BFG Edition Source Code is free software: you can redistribute it and/or modify
     10 it under the terms of the GNU General Public License as published by
     11 the Free Software Foundation, either version 3 of the License, or
     12 (at your option) any later version.
     13 
     14 Doom 3 BFG Edition Source Code is distributed in the hope that it will be useful,
     15 but WITHOUT ANY WARRANTY; without even the implied warranty of
     16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     17 GNU General Public License for more details.
     18 
     19 You should have received a copy of the GNU General Public License
     20 along with Doom 3 BFG Edition Source Code.  If not, see <http://www.gnu.org/licenses/>.
     21 
     22 In addition, the Doom 3 BFG Edition Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 BFG Edition Source Code.  If not, please request a copy in writing from id Software at the address below.
     23 
     24 If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
     25 
     26 ===========================================================================
     27 */
     28 
     29 #ifndef __LEADERBOARDS_LOCAL_H__
     30 #define __LEADERBOARDS_LOCAL_H__
     31 
     32 
     33 struct leaderboardStats_t {
     34 	int		frags;
     35 	int		wins;
     36 	int		teamfrags;
     37 	int		deaths;
     38 };
     39 
     40 struct columnGameMode_t {
     41 
     42 	columnDef_t *	columnDef;					// The Column definition for the game mode.
     43 	int				numColumns;					
     44 	rankOrder_t		rankOrder;					// rank ordering of the game mode. (  RANK_GREATEST_FIRST, RANK_LEAST_FIRST )
     45 	bool			supportsAttachments;		
     46 	bool			checkAgainstCurrent;
     47 	const char *	abrevName;					// Leaderboard Game Mode Abrev.
     48 };
     49 
     50 /*
     51 ================================================================================================
     52 
     53 	Leaderboards
     54 
     55 ================================================================================================
     56 */
     57 
     58 
     59 
     60 // creates and stores all the leaderboards inside the internal map ( see Sys_FindLeaderboardDef on retrieving definition )
     61 void			LeaderboardLocal_Init();
     62 
     63 // Destroys any leaderboard definitions allocated by LeaderboardLocal_Init() 
     64 void			LeaderboardLocal_Shutdown();
     65 
     66 // Gets a leaderboard ID with map index and game type.
     67 int				LeaderboardLocal_GetID( int mapIndex, int gametype );
     68 
     69 // Do it all function. Will create the column_t with the correct stats from the game type, and upload it to the leaderboard system.
     70 void			LeaderboardLocal_Upload(  lobbyUserID_t lobbyUserID, int gameType, leaderboardStats_t & stats );
     71 
     72 extern const columnGameMode_t gameMode_columnDefs[];
     73 
     74 #endif // __LEADERBOARDS_LOCAL_H__