plugins/randomcycle.sp
author David Anderson <dvander@alliedmods.net>
Tue Oct 16 19:28:02 2007 +0000 (2007-10-16)
changeset 1594 10ed42f305e1
parent 1539 74121104e67d
child 1606 4fb3959c2c96
permissions -rw-r--r--
cleaned up menu vote code a bit
ferret99gt@1475
     1
/**
ferret99gt@1475
     2
 * vim: set ts=4 :
ferret99gt@1475
     3
 * =============================================================================
ferret99gt@1475
     4
 * SourceMod Random Map Cycle Plugin
ferret99gt@1475
     5
 * Randomly picks a map from the mapcycle.
ferret99gt@1475
     6
 *
ferret99gt@1475
     7
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
ferret99gt@1475
     8
 * =============================================================================
ferret99gt@1475
     9
 *
ferret99gt@1475
    10
 * This program is free software; you can redistribute it and/or modify it under
ferret99gt@1475
    11
 * the terms of the GNU General Public License, version 3.0, as published by the
ferret99gt@1475
    12
 * Free Software Foundation.
ferret99gt@1475
    13
 * 
ferret99gt@1475
    14
 * This program is distributed in the hope that it will be useful, but WITHOUT
ferret99gt@1475
    15
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ferret99gt@1475
    16
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ferret99gt@1475
    17
 * details.
ferret99gt@1475
    18
 *
ferret99gt@1475
    19
 * You should have received a copy of the GNU General Public License along with
ferret99gt@1475
    20
 * this program.  If not, see <http://www.gnu.org/licenses/>.
ferret99gt@1475
    21
 *
ferret99gt@1475
    22
 * As a special exception, AlliedModders LLC gives you permission to link the
ferret99gt@1475
    23
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ferret99gt@1475
    24
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ferret99gt@1475
    25
 * by the Valve Corporation.  You must obey the GNU General Public License in
ferret99gt@1475
    26
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ferret99gt@1475
    27
 * this exception to all derivative works.  AlliedModders LLC defines further
ferret99gt@1475
    28
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ferret99gt@1475
    29
 * or <http://www.sourcemod.net/license.php>.
ferret99gt@1475
    30
 *
ferret99gt@1475
    31
 * Version: $Id$
ferret99gt@1475
    32
 */
ferret99gt@1475
    33
ferret99gt@1475
    34
#pragma semicolon 1
ferret99gt@1475
    35
#include <sourcemod>
ferret99gt@1475
    36
ferret99gt@1475
    37
public Plugin:myinfo =
ferret99gt@1475
    38
{
ferret99gt@1475
    39
	name = "RandomCycle",
ferret99gt@1475
    40
	author = "AlliedModders LLC",
ferret99gt@1475
    41
	description = "Randomly chooses the next map.",
ferret99gt@1475
    42
	version = SOURCEMOD_VERSION,
ferret99gt@1475
    43
	url = "http://www.sourcemod.net/"
ferret99gt@1475
    44
};
ferret99gt@1475
    45
ferret99gt@1475
    46
new Handle:g_Cvar_Nextmap = INVALID_HANDLE;
ferret99gt@1475
    47
new Handle:g_Cvar_Mapfile = INVALID_HANDLE;
ferret99gt@1475
    48
new Handle:g_Cvar_ExcludeMaps = INVALID_HANDLE;
ferret99gt@1475
    49
ferret99gt@1475
    50
new Handle:g_MapList = INVALID_HANDLE;
ferret99gt@1475
    51
new Handle:g_OldMapList = INVALID_HANDLE;
ferret99gt@1475
    52
new g_mapFileTime;
ferret99gt@1475
    53
ferret99gt@1475
    54
public OnPluginStart()
ferret99gt@1475
    55
{
ferret99gt@1475
    56
	g_MapList = CreateArray(33);
ferret99gt@1475
    57
	g_OldMapList = CreateArray(33);
ferret99gt@1475
    58
ferret99gt@1475
    59
	g_Cvar_Mapfile = CreateConVar("sm_randomcycle_file", "configs/maps.ini", "Map file to use. (Def sourcemod/configs/maps.ini)");
ferret99gt@1475
    60
	g_Cvar_ExcludeMaps = CreateConVar("sm_randomcycle_exclude", "5", "Specifies how many past maps to exclude from the vote.", _, true, 0.0);
ferret99gt@1475
    61
	
ferret99gt@1475
    62
	AutoExecConfig(true, "randomcycle");
ferret99gt@1475
    63
}
ferret99gt@1475
    64
ferret99gt@1475
    65
public OnMapStart()
ferret99gt@1475
    66
{
ferret99gt@1475
    67
	g_Cvar_Nextmap = FindConVar("sm_nextmap");
ferret99gt@1475
    68
ferret99gt@1475
    69
	if (g_Cvar_Nextmap == INVALID_HANDLE)
ferret99gt@1475
    70
	{
ferret99gt@1475
    71
		LogError("FATAL: Cannot find sm_nextmap cvar. RandomCycle not loaded.");
ferret99gt@1475
    72
		SetFailState("sm_nextmap not found");
ferret99gt@1475
    73
	}
ferret99gt@1475
    74
	
ferret99gt@1475
    75
	if (LoadMaps())
ferret99gt@1475
    76
	{
ferret99gt@1475
    77
		CreateTimer(5.0, Timer_RandomizeNextmap); // Small delay to give Nextmap time to complete OnMapStart()
ferret99gt@1475
    78
	}
ferret99gt@1475
    79
}
ferret99gt@1475
    80
ferret99gt@1475
    81
public Action:Timer_RandomizeNextmap(Handle:timer)
ferret99gt@1475
    82
{
ferret99gt@1475
    83
	decl String:map[32];
ferret99gt@1475
    84
ferret99gt@1475
    85
	new bool:oldMaps = false;
ferret99gt@1475
    86
	if (GetArraySize(g_MapList) > GetConVarInt(g_Cvar_ExcludeMaps))
ferret99gt@1475
    87
	{
ferret99gt@1475
    88
		oldMaps = true;
ferret99gt@1475
    89
	}
ferret99gt@1475
    90
	
ferret99gt@1475
    91
	new b = GetRandomInt(0, GetArraySize(g_MapList) - 1);
ferret99gt@1475
    92
	GetArrayString(g_MapList, b, map, sizeof(map));
ferret99gt@1475
    93
ferret99gt@1475
    94
	while (oldMaps && IsStringInArray(g_OldMapList, map))
ferret99gt@1475
    95
	{
ferret99gt@1475
    96
		b = GetRandomInt(0, GetArraySize(g_MapList) - 1);
ferret99gt@1475
    97
		GetArrayString(g_MapList, b, map, sizeof(map));
ferret99gt@1475
    98
	}
ferret99gt@1475
    99
	
ferret99gt@1475
   100
	SetConVarString(g_Cvar_Nextmap, map);
ferret99gt@1475
   101
	PushArrayString(g_OldMapList, map);
ferret99gt@1475
   102
ferret99gt@1475
   103
	if (GetArraySize(g_OldMapList) > GetConVarInt(g_Cvar_ExcludeMaps))
ferret99gt@1475
   104
	{
ferret99gt@1475
   105
		RemoveFromArray(g_OldMapList, 0);
ferret99gt@1475
   106
	}
ferret99gt@1475
   107
ferret99gt@1475
   108
	LogMessage("RandomCycle has chosen %s for the nextmap.", map);	
ferret99gt@1475
   109
ferret99gt@1475
   110
	return Plugin_Stop;
ferret99gt@1475
   111
}
ferret99gt@1475
   112
ferret99gt@1475
   113
LoadMaps()
ferret99gt@1475
   114
{
ferret99gt@1475
   115
	new bool:fileFound;
ferret99gt@1475
   116
ferret99gt@1475
   117
	decl String:mapPath[256], String:mapFile[64];
ferret99gt@1475
   118
	GetConVarString(g_Cvar_Mapfile, mapFile, 64);
ferret99gt@1539
   119
	BuildPath(Path_SM, mapPath, sizeof(mapPath), mapFile);
ferret99gt@1475
   120
	fileFound = FileExists(mapPath);
ferret99gt@1475
   121
	if (!fileFound)
ferret99gt@1475
   122
	{
ferret99gt@1475
   123
		new Handle:mapCycleFile = FindConVar("mapcyclefile");
ferret99gt@1475
   124
		GetConVarString(mapCycleFile, mapPath, sizeof(mapPath));
ferret99gt@1475
   125
		fileFound = FileExists(mapPath);
ferret99gt@1475
   126
	}
ferret99gt@1475
   127
	
ferret99gt@1475
   128
	if (!fileFound)
ferret99gt@1475
   129
	{
ferret99gt@1475
   130
		LogError("Unable to locate sm_randomcycle_file or mapcyclefile, no maps loaded.");
ferret99gt@1475
   131
		
ferret99gt@1475
   132
		if (g_MapList != INVALID_HANDLE)
ferret99gt@1475
   133
		{
ferret99gt@1475
   134
			ClearArray(g_MapList);
ferret99gt@1475
   135
		}
ferret99gt@1475
   136
		
ferret99gt@1475
   137
		return 0;		
ferret99gt@1475
   138
	}
ferret99gt@1475
   139
ferret99gt@1475
   140
	// If the file hasn't changed, there's no reason to reload
ferret99gt@1475
   141
	// all of the maps.
ferret99gt@1475
   142
	new fileTime =  GetFileTime(mapPath, FileTime_LastChange);
ferret99gt@1475
   143
	if (g_mapFileTime == fileTime)
ferret99gt@1475
   144
	{
ferret99gt@1475
   145
		return GetArraySize(g_MapList);
ferret99gt@1475
   146
	}
ferret99gt@1475
   147
	
ferret99gt@1475
   148
	g_mapFileTime = fileTime;
ferret99gt@1475
   149
	
ferret99gt@1475
   150
	// Reset the array
ferret99gt@1475
   151
	if (g_MapList != INVALID_HANDLE)
ferret99gt@1475
   152
	{
ferret99gt@1475
   153
		ClearArray(g_MapList);
ferret99gt@1475
   154
	}
ferret99gt@1475
   155
ferret99gt@1475
   156
	LogMessage("[SM] Loading Random Cycle map file [%s]", mapPath);
ferret99gt@1475
   157
ferret99gt@1475
   158
	new Handle:file = OpenFile(mapPath, "rt");
ferret99gt@1475
   159
	if (file == INVALID_HANDLE)
ferret99gt@1475
   160
	{
ferret99gt@1475
   161
		LogError("[SM] Could not open file: %s", mapPath);
ferret99gt@1475
   162
		return 0;
ferret99gt@1475
   163
	}
ferret99gt@1475
   164
ferret99gt@1475
   165
	decl String:currentMap[32];
ferret99gt@1475
   166
	GetCurrentMap(currentMap, sizeof(currentMap));
ferret99gt@1475
   167
	
ferret99gt@1475
   168
	decl String:buffer[64], len;
ferret99gt@1475
   169
	while (!IsEndOfFile(file) && ReadFileLine(file, buffer, sizeof(buffer)))
ferret99gt@1475
   170
	{
ferret99gt@1475
   171
		TrimString(buffer);
ferret99gt@1475
   172
ferret99gt@1475
   173
		if ((len = StrContains(buffer, ".bsp", false)) != -1)
ferret99gt@1475
   174
		{
ferret99gt@1475
   175
			buffer[len] = '\0';
ferret99gt@1475
   176
		}
ferret99gt@1475
   177
ferret99gt@1475
   178
		if (buffer[0] == '\0' || !IsValidConVarChar(buffer[0]) || !IsMapValid(buffer)
ferret99gt@1475
   179
			|| strcmp(currentMap, buffer, false) == 0)
ferret99gt@1475
   180
		{
ferret99gt@1475
   181
			continue;
ferret99gt@1475
   182
		}
ferret99gt@1475
   183
ferret99gt@1475
   184
		PushArrayString(g_MapList, buffer);
ferret99gt@1475
   185
	}
ferret99gt@1475
   186
ferret99gt@1475
   187
	CloseHandle(file);
ferret99gt@1475
   188
	return GetArraySize(g_MapList);
ferret99gt@1475
   189
}