plugins/basetriggers.sp
author David Anderson <dvander@alliedmods.net>
Sat Feb 16 15:57:00 2013 -0800 (2013-02-16)
changeset 3792 d8a07e40bcb6
parent 3433 d57b0bd42c1d
child 3852 581be3c32b91
permissions -rw-r--r--
Move DebugReporter from core to logic (bug 5607, r=psychonic).
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod Basic Info Triggers Plugin
     5  * Implements basic information chat triggers like ff and timeleft.
     6  *
     7  * SourceMod (C)2004-2008 AlliedModders LLC.  All rights reserved.
     8  * =============================================================================
     9  *
    10  * This program is free software; you can redistribute it and/or modify it under
    11  * the terms of the GNU General Public License, version 3.0, as published by the
    12  * Free Software Foundation.
    13  * 
    14  * This program is distributed in the hope that it will be useful, but WITHOUT
    15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    17  * details.
    18  *
    19  * You should have received a copy of the GNU General Public License along with
    20  * this program.  If not, see <http://www.gnu.org/licenses/>.
    21  *
    22  * As a special exception, AlliedModders LLC gives you permission to link the
    23  * code of this program (as well as its derivative works) to "Half-Life 2," the
    24  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    25  * by the Valve Corporation.  You must obey the GNU General Public License in
    26  * all respects for all other code used.  Additionally, AlliedModders LLC grants
    27  * this exception to all derivative works.  AlliedModders LLC defines further
    28  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    29  * or <http://www.sourcemod.net/license.php>.
    30  *
    31  * Version: $Id$
    32  */
    33 
    34 #pragma semicolon 1
    35 
    36 #include <sourcemod>
    37 
    38 #undef REQUIRE_PLUGIN
    39 #include <mapchooser>
    40 #define REQUIRE_PLUGIN
    41 
    42 public Plugin:myinfo = 
    43 {
    44 	name = "Basic Info Triggers",
    45 	author = "AlliedModders LLC",
    46 	description = "Adds ff, timeleft, thetime, and others.",
    47 	version = SOURCEMOD_VERSION,
    48 	url = "http://www.sourcemod.net/"
    49 };
    50 
    51 new Handle:g_Cvar_TriggerShow = INVALID_HANDLE;
    52 new Handle:g_Cvar_TimeleftInterval = INVALID_HANDLE;
    53 new Handle:g_Cvar_FriendlyFire = INVALID_HANDLE;
    54 
    55 new Handle:g_Timer_TimeShow = INVALID_HANDLE;
    56 
    57 new Handle:g_Cvar_WinLimit = INVALID_HANDLE;
    58 new Handle:g_Cvar_FragLimit = INVALID_HANDLE;
    59 new Handle:g_Cvar_MaxRounds = INVALID_HANDLE;
    60 
    61 #define TIMELEFT_ALL_ALWAYS		0		/* Print to all players */
    62 #define TIMELEFT_ALL_MAYBE		1		/* Print to all players if sm_trigger_show allows */
    63 #define TIMELEFT_ONE			2		/* Print to a single player */
    64 
    65 new bool:mapchooser;
    66 
    67 new g_TotalRounds;
    68 
    69 public OnPluginStart()
    70 {
    71 	LoadTranslations("common.phrases");
    72 	LoadTranslations("basetriggers.phrases");
    73 	
    74 	g_Cvar_TriggerShow = CreateConVar("sm_trigger_show", "1", "Display triggers message to all players? (0 off, 1 on, def. 1)", 0, true, 0.0, true, 1.0);	
    75 	g_Cvar_TimeleftInterval = CreateConVar("sm_timeleft_interval", "0.0", "Display timeleft every x seconds. Default 0.", 0, true, 0.0, true, 1800.0);
    76 	g_Cvar_FriendlyFire = FindConVar("mp_friendlyfire");
    77 	
    78 	AddCommandListener(Command_Say, "say");
    79 	AddCommandListener(Command_Say, "say2");
    80 	AddCommandListener(Command_Say, "say_team");
    81 	
    82 	RegConsoleCmd("timeleft", Command_Timeleft);
    83 	RegConsoleCmd("nextmap", Command_Nextmap);
    84 	RegConsoleCmd("motd", Command_Motd);
    85 	
    86 	HookConVarChange(g_Cvar_TimeleftInterval, ConVarChange_TimeleftInterval);
    87 
    88 	decl String:folder[64];   	 
    89    	GetGameFolderName(folder, sizeof(folder));
    90 
    91    	if (strcmp(folder, "insurgency") == 0)
    92    	{
    93    		HookEvent("game_newmap", Event_GameStart);
    94    	}
    95    	else
    96    	{
    97    		HookEvent("game_start", Event_GameStart);
    98    	}
    99 	
   100 	if (strcmp(folder, "nucleardawn") == 0)
   101 	{
   102 		HookEvent("round_win", Event_RoundEnd);
   103 	}
   104 	else
   105 	{
   106 		HookEvent("round_end", Event_RoundEnd);
   107 	}
   108 	
   109 	HookEventEx("teamplay_win_panel", Event_TeamPlayWinPanel);
   110 	HookEventEx("teamplay_restart_round", Event_TFRestartRound);
   111 	HookEventEx("arena_win_panel", Event_TeamPlayWinPanel);
   112 	
   113 	g_Cvar_WinLimit = FindConVar("mp_winlimit");
   114 	g_Cvar_FragLimit = FindConVar("mp_fraglimit");
   115 	g_Cvar_MaxRounds = FindConVar("mp_maxrounds");
   116 	
   117 	mapchooser = LibraryExists("mapchooser");
   118 }
   119 
   120 public OnMapStart()
   121 {
   122 	g_TotalRounds = 0;	
   123 }
   124 
   125 /* Round count tracking */
   126 public Event_TFRestartRound(Handle:event, const String:name[], bool:dontBroadcast)
   127 {
   128 	/* Game got restarted - reset our round count tracking */
   129 	g_TotalRounds = 0;	
   130 }
   131 
   132 public Event_GameStart(Handle:event, const String:name[], bool:dontBroadcast)
   133 {
   134 	/* Game got restarted - reset our round count tracking */
   135 	g_TotalRounds = 0;	
   136 }
   137 
   138 public Event_TeamPlayWinPanel(Handle:event, const String:name[], bool:dontBroadcast)
   139 {
   140 	if(GetEventInt(event, "round_complete") == 1 || StrEqual(name, "arena_win_panel"))
   141 	{
   142 		g_TotalRounds++;
   143 	}
   144 }
   145 /* You ask, why don't you just use team_score event? And I answer... Because CSS doesn't. */
   146 public Event_RoundEnd(Handle:event, const String:name[], bool:dontBroadcast)
   147 {
   148 	g_TotalRounds++;
   149 }
   150 
   151 public OnLibraryRemoved(const String:name[])
   152 {
   153 	if (StrEqual(name, "mapchooser"))
   154 	{
   155 		mapchooser = false;
   156 	}
   157 }
   158  
   159 public OnLibraryAdded(const String:name[])
   160 {
   161 	if (StrEqual(name, "mapchooser"))
   162 	{
   163 		mapchooser = true;
   164 	}
   165 }
   166 
   167 public ConVarChange_TimeleftInterval(Handle:convar, const String:oldValue[], const String:newValue[])
   168 {
   169 	new Float:newval = StringToFloat(newValue);
   170 	
   171 	if (newval < 1.0)
   172 	{
   173 		if (g_Timer_TimeShow != INVALID_HANDLE)
   174 		{
   175 			KillTimer(g_Timer_TimeShow);		
   176 		}
   177 		
   178 		return;
   179 	}
   180 	
   181 	if (g_Timer_TimeShow != INVALID_HANDLE)
   182 	{
   183 		KillTimer(g_Timer_TimeShow);
   184 		g_Timer_TimeShow = CreateTimer(newval, Timer_DisplayTimeleft, _, TIMER_REPEAT);
   185 	}
   186 	else
   187 		g_Timer_TimeShow = CreateTimer(newval, Timer_DisplayTimeleft, _, TIMER_REPEAT);
   188 }
   189 
   190 public Action:Timer_DisplayTimeleft(Handle:timer)
   191 {
   192 	ShowTimeLeft(0, TIMELEFT_ALL_ALWAYS);	
   193 }
   194 
   195 public Action:Command_Timeleft(client, args)
   196 {
   197 	ShowTimeLeft(client, TIMELEFT_ONE);
   198 	
   199 	return Plugin_Handled;
   200 }
   201 
   202 public Action:Command_Nextmap(client, args)
   203 {
   204 	decl String:map[64];
   205 	
   206 	GetNextMap(map, sizeof(map));
   207 	
   208 	if (mapchooser && EndOfMapVoteEnabled() && !HasEndOfMapVoteFinished())
   209 	{
   210 		ReplyToCommand(client, "[SM] %t", "Pending Vote");			
   211 	}
   212 	else
   213 	{
   214 		ReplyToCommand(client, "[SM] %t", "Next Map", map);
   215 	}
   216 	
   217 	return Plugin_Handled;
   218 }
   219 
   220 public Action:Command_Motd(client, args)
   221 {
   222 	if (client == 0)
   223 	{
   224 		ReplyToCommand(client, "[SM] %t", "Command is in-game only");
   225 		return Plugin_Handled;
   226 	}
   227 
   228 	ShowMOTDPanel(client, "Message Of The Day", "motd", MOTDPANEL_TYPE_INDEX);
   229 
   230 	return Plugin_Handled;
   231 }
   232 
   233 public Action:Command_Say(client, const String:command[], argc)
   234 {
   235 	decl String:text[192];
   236 	new startidx = 0;
   237 	if (GetCmdArgString(text, sizeof(text)) < 1)
   238 	{
   239 		return Plugin_Continue;
   240 	}
   241 	
   242 	if (text[strlen(text)-1] == '"')
   243 	{
   244 		text[strlen(text)-1] = '\0';
   245 		startidx = 1;
   246 	}
   247 
   248 	if (strcmp(command, "say2", false) == 0)
   249 		startidx += 4;
   250 
   251 	if (strcmp(text[startidx], "timeleft", false) == 0)
   252 	{
   253 		ShowTimeLeft(client, TIMELEFT_ALL_MAYBE);
   254 	}
   255 	else if (strcmp(text[startidx], "thetime", false) == 0)
   256 	{
   257 		decl String:ctime[64];
   258 		FormatTime(ctime, 64, NULL_STRING);
   259 		
   260 		if(GetConVarInt(g_Cvar_TriggerShow))
   261 		{
   262 			PrintToChatAll("[SM] %t", "Thetime", ctime);
   263 		}
   264 		else
   265 		{
   266 			PrintToChat(client,"[SM] %t", "Thetime", ctime);
   267 		}
   268 	}
   269 	else if (strcmp(text[startidx], "ff", false) == 0 || strcmp(text[startidx], "/ff", false) == 0)
   270 	{
   271 		if (g_Cvar_FriendlyFire != INVALID_HANDLE)
   272 		{
   273 			decl String:phrase[24];
   274 			if (GetConVarBool(g_Cvar_FriendlyFire))
   275 			{
   276 				strcopy(phrase, sizeof(phrase), "Friendly Fire On");
   277 			}
   278 			else
   279 			{
   280 				strcopy(phrase, sizeof(phrase), "Friendly Fire Off");
   281 			}
   282 		
   283 			if(GetConVarInt(g_Cvar_TriggerShow))
   284 			{
   285 				PrintToChatAll("[SM] %t", phrase);
   286 			}
   287 			else
   288 			{
   289 				PrintToChat(client,"[SM] %t", phrase);
   290 			}
   291 		}
   292 	}
   293 	else if (strcmp(text[startidx], "currentmap", false) == 0)
   294 	{
   295 		decl String:map[64];
   296 		GetCurrentMap(map, sizeof(map));
   297 		
   298 		if(GetConVarInt(g_Cvar_TriggerShow))
   299 		{
   300 			PrintToChatAll("[SM] %t", "Current Map", map);
   301 		}
   302 		else
   303 		{
   304 			PrintToChat(client,"[SM] %t", "Current Map", map);
   305 		}
   306 	}
   307 	else if (strcmp(text[startidx], "nextmap", false) == 0)
   308 	{
   309 		decl String:map[32];
   310 		GetNextMap(map, sizeof(map));
   311 			
   312 		if(GetConVarInt(g_Cvar_TriggerShow))
   313 		{
   314 			if (mapchooser && EndOfMapVoteEnabled() && !HasEndOfMapVoteFinished())
   315 			{
   316 				PrintToChatAll("[SM] %t", "Pending Vote");			
   317 			}
   318 			else
   319 			{
   320 				PrintToChatAll("[SM] %t", "Next Map", map);
   321 			}
   322 		}
   323 		else
   324 		{
   325 			if (mapchooser && EndOfMapVoteEnabled() && !HasEndOfMapVoteFinished())
   326 			{
   327 				PrintToChat(client, "[SM] %t", "Pending Vote");			
   328 			}
   329 			else
   330 			{
   331 				PrintToChat(client, "[SM] %t", "Next Map", map);
   332 			}
   333 		}
   334 	}
   335 	else if (strcmp(text[startidx], "motd", false) == 0)
   336 	{
   337 		ShowMOTDPanel(client, "Message Of The Day", "motd", MOTDPANEL_TYPE_INDEX);
   338 	}
   339 	
   340 	return Plugin_Continue;
   341 }
   342 
   343 ShowTimeLeft(client, who)
   344 {
   345 	new bool:lastround = false;
   346 	new bool:written = false;
   347 	new bool:notimelimit = false;
   348 	
   349 	decl String:finalOutput[1024];
   350 	finalOutput[0] = 0;
   351 	
   352 	if (who == TIMELEFT_ALL_ALWAYS
   353 		|| (who == TIMELEFT_ALL_MAYBE && GetConVarInt(g_Cvar_TriggerShow)))
   354 	{
   355 		client = 0;	
   356 	}
   357 	
   358 	new timeleft;
   359 	if (GetMapTimeLeft(timeleft))
   360 	{
   361 		new mins, secs;
   362 		new timelimit;
   363 		
   364 		if (timeleft > 0)
   365 		{
   366 			mins = timeleft / 60;
   367 			secs = timeleft % 60;
   368 			written = true;
   369 			FormatEx(finalOutput, sizeof(finalOutput), "%T %d:%02d", "Timeleft", client, mins, secs);
   370 		}
   371 		else if (GetMapTimeLimit(timelimit) && timelimit == 0)
   372 		{
   373 			notimelimit = true;
   374 		}
   375 		else
   376 		{
   377 			/* 0 timeleft so this must be the last round */
   378 			lastround=true;
   379 		}
   380 	}
   381 	
   382 	if (!lastround)
   383 	{
   384 		if (g_Cvar_WinLimit != INVALID_HANDLE)
   385 		{
   386 			new winlimit = GetConVarInt(g_Cvar_WinLimit);
   387 			
   388 			if (winlimit > 0)
   389 			{
   390 				if (written)
   391 				{
   392 					new len = strlen(finalOutput);
   393 					if (len < sizeof(finalOutput))
   394 					{
   395 						if (winlimit > 1)
   396 						{
   397 							FormatEx(finalOutput[len], sizeof(finalOutput)-len, "%T", "WinLimitAppendPlural" ,client, winlimit);
   398 						}
   399 						else
   400 						{
   401 							FormatEx(finalOutput[len], sizeof(finalOutput)-len, "%T", "WinLimitAppend" ,client);
   402 						}
   403 					}
   404 				}
   405 				else
   406 				{
   407 					if (winlimit > 1)
   408 					{
   409 						FormatEx(finalOutput, sizeof(finalOutput), "%T", "WinLimitPlural", client, winlimit);
   410 					}
   411 					else
   412 					{
   413 						FormatEx(finalOutput, sizeof(finalOutput), "%T", "WinLimit", client);
   414 					}
   415 					
   416 					written = true;
   417 				}
   418 			}
   419 		}
   420 		
   421 		if (g_Cvar_FragLimit != INVALID_HANDLE)
   422 		{
   423 			new fraglimit = GetConVarInt(g_Cvar_FragLimit);
   424 			
   425 			if (fraglimit > 0)
   426 			{
   427 				if (written)
   428 				{
   429 					new len = strlen(finalOutput);
   430 					if (len < sizeof(finalOutput))
   431 					{
   432 						if (fraglimit > 1)
   433 						{
   434 							FormatEx(finalOutput[len], sizeof(finalOutput)-len, "%T", "FragLimitAppendPlural", client, fraglimit);
   435 						}
   436 						else
   437 						{
   438 							FormatEx(finalOutput[len], sizeof(finalOutput)-len, "%T", "FragLimitAppend", client);
   439 						}
   440 					}	
   441 				}
   442 				else
   443 				{
   444 					if (fraglimit > 1)
   445 					{
   446 						FormatEx(finalOutput, sizeof(finalOutput), "%T", "FragLimitPlural", client, fraglimit);
   447 					}
   448 					else
   449 					{
   450 						FormatEx(finalOutput, sizeof(finalOutput), "%T", "FragLimit", client);
   451 					}
   452 					
   453 					written = true;
   454 				}			
   455 			}
   456 		}
   457 		
   458 		if (g_Cvar_MaxRounds != INVALID_HANDLE)
   459 		{
   460 			new maxrounds = GetConVarInt(g_Cvar_MaxRounds);
   461 			
   462 			if (maxrounds > 0)
   463 			{
   464 				new remaining = maxrounds - g_TotalRounds;
   465 				
   466 				if (written)
   467 				{
   468 					new len = strlen(finalOutput);
   469 					if (len < sizeof(finalOutput))
   470 					{
   471 						if (remaining > 1)
   472 						{
   473 							FormatEx(finalOutput[len], sizeof(finalOutput)-len, "%T", "MaxRoundsAppendPlural", client, remaining);
   474 						}
   475 						else
   476 						{
   477 							FormatEx(finalOutput[len], sizeof(finalOutput)-len, "%T", "MaxRoundsAppend", client);
   478 						}
   479 					}
   480 				}
   481 				else
   482 				{
   483 					if (remaining > 1)
   484 					{
   485 						FormatEx(finalOutput, sizeof(finalOutput), "%T", "MaxRoundsPlural", client, remaining);
   486 					}
   487 					else
   488 					{
   489 						FormatEx(finalOutput, sizeof(finalOutput), "%T", "MaxRounds", client);
   490 					}
   491 					
   492 					written = true;
   493 				}			
   494 			}		
   495 		}
   496 	}
   497 	
   498 	if (lastround)
   499 	{
   500 		FormatEx(finalOutput, sizeof(finalOutput), "%T", "LastRound", client);
   501 	}
   502 	else if (notimelimit && !written)
   503 	{
   504 		FormatEx(finalOutput, sizeof(finalOutput), "%T", "NoTimelimit", client);
   505 	}
   506 
   507 	if (who == TIMELEFT_ALL_ALWAYS
   508 		|| (who == TIMELEFT_ALL_MAYBE && GetConVarInt(g_Cvar_TriggerShow)))
   509 	{
   510 		PrintToChatAll("[SM] %s", finalOutput);
   511 	}
   512 	else if (client != 0)
   513 	{
   514 		PrintToChat(client, "[SM] %s", finalOutput);
   515 	}
   516 	
   517 	if (client == 0)
   518 	{
   519 		PrintToServer("[SM] %s", finalOutput);
   520 	}
   521 }