Implement config loader

README.md

@@ -77,7 +77,7 @@ General
 - [x] Migrate events to the 1.7 transitional syntax.
 - [x] Migrate ADT_Arrays to ArrayList.
 - [x] Support "out of the box" installations and SQLite support.
-- [ ] Implement a config file for styles and use Dynamic to save them and load via a native.
+- [ ] Implement a config file for styles and use Dynamic to load them, add Shavit_OnStylesLoaded.
 - [ ] Save timer variables on Dynamic's per-player settings.
 
 Core

scripting/include/shavit.inc

@@ -32,9 +32,7 @@
 #define SHAVIT_VERSION "1.5b"
 #define PREFIX "\x04[Timer]\x01"
 
-#define INVALID_TIMERSETTINGS view_as<TimerSettings>(-1)
 #define STYLE_LIMIT 256
-
 #define MAX_STYLES 8
 #define MAX_ZONES 8
 
@@ -75,6 +73,42 @@ enum ReplayStatus(+=1)
 	Replay_End
 };
 
+enum
+{
+	sStyleName,
+	sShortName,
+	sHTMLColor,
+	sChangeCommand,
+	STYLESTRINGS_SIZE
+};
+
+enum
+{
+	bAutobhop,
+	bEasybhop,
+	bPrespeed,
+	fVelocityLimit,
+	iAiraccelerate,
+	fGravityMultiplier,
+	fSpeedMultiplier,
+	fSpeed,
+	bHalftime,
+	bBlockW,
+	bBlockA,
+	bBlockS,
+	bBlockD,
+	bBlockUse,
+	bForceHSW,
+	bUnranked,
+	bNoReplay,
+	bSync,
+	bStrafeCountW,
+	bStrafeCountA,
+	bStrafeCountS,
+	bStrafeCountD,
+	STYLESETTINGS_SIZE
+};
+
 #if defined USES_STYLE_PROPERTIES
 #define STYLE_NONE				(0)
 #define STYLE_AUTOBHOP			(1 << 0)	// enable autobhop
@@ -418,6 +452,14 @@ forward void Shavit_OnRankUpdated(int client);
  */
 forward void Shavit_OnStyleChanged(int client, BhopStyle oldstyle, BhopStyle newstyle);
 
+/**
+ * Called when the styles configuration finishes loading and it's ready to load everything into the cache.
+ *
+ * @param styles					Amount of styles loaded.
+ * @noreturn
+ */
+forward void Shavit_OnStyleConfigLoaded(int styles);
+
 /**
  * Returns the game type the server is running.
  *
@@ -728,6 +770,20 @@ native void Shavit_OpenStatsMenu(int client, const char[] authid);
  */
 native int Shavit_GetWRCount(int client);
 
+/**
+* Saves the style settings on an `any` reference.
+*
+* @noreturn
+*/
+native void Shavit_GetStyleSettings(any StyleSettings[STYLE_LIMIT][STYLESETTINGS_SIZE]);
+
+/**
+ * Saves the style related strings on a string reference.
+ *
+ * @noreturn
+ */
+native void Shavit_GetStyleStrings(char StyleStrings[STYLE_LIMIT][STYLESTRINGS_SIZE][128]);
+
 /**
  * Use this native when printing anything in chat if it's related to the timer.
  * This native will auto-assign colors and a chat prefix.
@@ -756,28 +812,6 @@ stock void Shavit_PrintToChatAll(const char[] format, any ...)
 	}
 }
 
-methodmap TimerSettings < Dynamic
-{
-	public TimerSettings()
-	{
-		return view_as<TimerSettings>(Dynamic());
-	}
-}
-
-/**
- * Returns a TimerSettings object (Dynamic) that has all loaded styles and their settings on it.
- * Requires the style index and a colon as prefix.
- *
- * For example, use styles.GetInt("0:settings") to get style settings (STYLE_*) for the first style.
- * Available style properties are:
- * 'name' (string), 'speedlimit' (float), 'htmlcolor' (string), 'shortname' (string), 'rankingmultiplier' (float), 'airaccelerate' (int), 'runspeed' (float).
- *
- * Use styles.GetInt("amount") to receive the amount of loaded styles (hardcoded limit is 256).
- *
- * @return							TimerSettings object.
- */
-native TimerSettings Shavit_GetStyleSettings();
-
 public SharedPlugin __pl_shavit =
 {
 	name = "shavit",
@@ -808,6 +842,7 @@ public void __pl_shavit_SetNTVOptional()
 	MarkNativeAsOptional("Shavit_GetReplayBotIndex");
 	MarkNativeAsOptional("Shavit_GetStrafeCount");
 	MarkNativeAsOptional("Shavit_GetStyleSettings");
+	MarkNativeAsOptional("Shavit_GetStyleStrings");
 	MarkNativeAsOptional("Shavit_GetSync");
 	MarkNativeAsOptional("Shavit_GetTimer");
 	MarkNativeAsOptional("Shavit_GetTimerStatus");

scripting/shavit-core.sp

@@ -1,4 +1,4 @@
- /*
+/*
  * shavit's Timer - Core
  * by: shavit
  *
@@ -54,6 +54,7 @@ Handle gH_Forwards_OnEnd = null;
 Handle gH_Forwards_OnPause = null;
 Handle gH_Forwards_OnResume = null;
 Handle gH_Forwards_OnStyleChanged = null;
+Handle gH_Forwards_OnStyleConfigLoaded = null;
 
 // timer variables
 bool gB_TimerEnabled[MAXPLAYERS+1];
@@ -112,7 +113,9 @@ int gI_CachedDefaultAA = 1000;
 ConVar sv_airaccelerate = null;
 
 // timer settings
-TimerSettings gTS_Styles = INVALID_TIMERSETTINGS;
+int gI_Styles = 0;
+char gS_StyleStrings[STYLE_LIMIT][STYLESTRINGS_SIZE][128];
+any gA_StyleSettings[STYLE_LIMIT][STYLESETTINGS_SIZE];
 
 public Plugin myinfo =
 {
@@ -167,6 +170,7 @@ public void OnPluginStart()
 	gH_Forwards_OnPause = CreateGlobalForward("Shavit_OnPause", ET_Event, Param_Cell);
 	gH_Forwards_OnResume = CreateGlobalForward("Shavit_OnResume", ET_Event, Param_Cell);
 	gH_Forwards_OnStyleChanged = CreateGlobalForward("Shavit_OnStyleChanged", ET_Event, Param_Cell, Param_Cell, Param_Cell);
+	gH_Forwards_OnStyleConfigLoaded = CreateGlobalForward("Shavit_OnStyleConfigLoaded", ET_Event, Param_Cell);
 
 	// game types
 	gEV_Type = GetEngineVersion();
@@ -188,14 +192,6 @@ public void OnPluginStart()
 		SetFailState("This plugin was meant to be used in CS:S and CS:GO *only*.");
 	}
 
-	// styles
-	gTS_Styles = LoadStyles();
-
-	if(gTS_Styles == INVALID_TIMERSETTINGS)
-	{
-		SetFailState("Could not load the styles configuration file. Make sure it exists (addons/sourcemod/configs/shavit-styles.cfg) and follows the proper syntax!");
-	}
-
 	// database connections
 	SQL_SetPrefix();
 	SQL_DBConnect();
@@ -286,14 +282,6 @@ public void OnPluginStart()
 	gB_Zones = LibraryExists("shavit-zones");
 }
 
-public void OnPluginEnd()
-{
-	if(gTS_Styles.IsValid)
-	{
-		gTS_Styles.Dispose(true);
-	}
-}
-
 public void OnConVarChanged(ConVar convar, const char[] oldValue, const char[] newValue)
 {
 	gB_Autobhop = gCV_Autobhop.BoolValue;
@@ -347,6 +335,19 @@ public void CategoryHandler(Handle topmenu, TopMenuAction action, TopMenuObject
 
 public void OnMapStart()
 {
+	// styles
+	if(!LoadStyles())
+	{
+		SetFailState("Could not load the styles configuration file. Make sure it exists (addons/sourcemod/configs/shavit-styles.cfg) and follows the proper syntax!");
+	}
+
+	else
+	{
+		Call_StartForward(gH_Forwards_OnStyleConfigLoaded);
+		Call_PushCell(gI_Styles);
+		Call_Finish();
+	}
+
 	// cvar forcing
 	FindConVar("sv_enablebunnyhopping").BoolValue = true;
 	FindConVar("sv_airaccelerate").IntValue = gI_CachedDefaultAA;
@@ -775,7 +776,7 @@ public int Native_GetSync(Handle handler, int numParams)
 
 public int Native_GetStyleSettings(Handle handler, int numParams)
 {
-	return view_as<int>(gTS_Styles);
+	return view_as<int>(2);
 }
 
 public void StartTimer(int client)
@@ -965,37 +966,61 @@ public void SQL_InsertUser_Callback(Database db, DBResultSet results, const char
 	}
 }
 
-public TimerSettings LoadStyles()
+public bool LoadStyles()
 {
+	char[] sPath = new char[PLATFORM_MAX_PATH];
+	BuildPath(Path_SM, sPath, PLATFORM_MAX_PATH, "configs/shavit-dynamic.cfg");
+
 	Dynamic dStylesConfig = Dynamic();
 
-	if(!dStylesConfig.ReadKeyValues("addons/sourcemod/configs/shavit-styles.cfg"))
+	if(!dStylesConfig.ReadKeyValues(sPath))
-	{
-		return INVALID_TIMERSETTINGS;
-	}
-
-	if(dStylesConfig.MemberCount == 0)
 	{
 		dStylesConfig.Dispose();
 
-		return INVALID_TIMERSETTINGS;
+		return false;
 	}
 
-	else
+	gI_Styles = dStylesConfig.MemberCount;
+
+	for(int i = 0; i < gI_Styles; i++)
 	{
-		PrintToServer("count: %d", dStylesConfig.MemberCount);
+		Dynamic dStyle = dStylesConfig.GetDynamicByIndex(i);
+		dStyle.GetString("name", gS_StyleStrings[i][sStyleName], 128);
+		dStyle.GetString("shortname", gS_StyleStrings[i][sShortName], 128);
+		dStyle.GetString("htmlcolor", gS_StyleStrings[i][sHTMLColor], 128);
+		dStyle.GetString("command", gS_StyleStrings[i][sChangeCommand], 128);
+
+		gA_StyleSettings[i][bAutobhop] = dStyle.GetBool("autobhop", true);
+		gA_StyleSettings[i][bEasybhop] = dStyle.GetBool("easybhop", true);
+		gA_StyleSettings[i][bPrespeed] = dStyle.GetBool("prespeed", false);
+		gA_StyleSettings[i][fVelocityLimit] = dStyle.GetFloat("velocity_limit", 0.0);
+		gA_StyleSettings[i][iAiraccelerate] = dStyle.GetInt("airaccelerate", 1000);
+		gA_StyleSettings[i][fRunspeed] = dStyle.GetFloat("runspeed", 260.00);
+		gA_StyleSettings[i][fGravityMultiplier] = dStyle.GetFloat("gravity", 0.0);
+		gA_StyleSettings[i][fGravityMultiplier] = dStyle.GetFloat("speed", 0.0);
+		gA_StyleSettings[i][bHalftime] = dStyle.GetBool("halftime", false);
+		gA_StyleSettings[i][bBlockW] = dStyle.GetBool("block_w", false);
+		gA_StyleSettings[i][bBlockA] = dStyle.GetBool("block_a", false);
+		gA_StyleSettings[i][bBlockS] = dStyle.GetBool("block_s", false);
+		gA_StyleSettings[i][bBlockD] = dStyle.GetBool("block_d", false);
+		gA_StyleSettings[i][bBlockUse] = dStyle.GetBool("block_use", false);
+		gA_StyleSettings[i][bForceHSW] = dStyle.GetBool("force_hsw", false);
+		gA_StyleSettings[i][bUnranked] = dStyle.GetBool("unranked", false);
+		gA_StyleSettings[i][bNoReplay] = dStyle.GetBool("noreplay", false);
+		gA_StyleSettings[i][bSync] = dStyle.GetBool("sync", true);
+		gA_StyleSettings[i][bStrafeCountW] = dStyle.GetBool("strafe_count_w", false);
+		gA_StyleSettings[i][bStrafeCountA] = dStyle.GetBool("strafe_count_a", true);
+		gA_StyleSettings[i][bStrafeCountS] = dStyle.GetBool("strafe_count_s", false);
+		gA_StyleSettings[i][bStrafeCountD] = dStyle.GetBool("strafe_count_d", true);
+
+		dStyle.Dispose();
 	}
 
-	dStylesConfig.Dispose();
+	PrintToServer("styles: %d", gI_Styles);
 
-	TimerSettings tsStyles = TimerSettings();
+	dStylesConfig.Dispose(true);
 
-	/*if(tsStyles.GetInt("amount") == 0)
+	return true;
-	{
-		return INVALID_TIMERSETTINGS;
-	}*/
-
-	return tsStyles;
 }
 
 public void SQL_SetPrefix()
@@ -1123,7 +1148,10 @@ public void SQL_AlterTable2_Callback(Database db, DBResultSet results, const cha
 
 public void PreThink(int client)
 {
-	sv_airaccelerate.IntValue = ((gI_StyleProperties[gBS_Style[client]] & STYLE_100AA) > 0)? 100:gI_CachedDefaultAA;
+	if(IsPlayerAlive(client))
+	{
+		sv_airaccelerate.IntValue = ((gI_StyleProperties[gBS_Style[client]] & STYLE_100AA) > 0)? 100:gI_CachedDefaultAA;
+	}
 }
 
 public Action OnPlayerRunCmd(int client, int &buttons, int &impulse, float vel[3], float angles[3])