API overhaul

- Added api example plugin
- Sound types are no longer hardcoded, extend as you wish
- Added custom per-model properties support
- Added forward `ModelChooser_OnConfigLoaded`
- Added natives `ModelChooser_GetCurrentModelProperty`, `ModelChooser_OpenChooser`, `ModelChooser_PlayRandomSound`
`ModelChooser_GetProperty`, `ModelChooser_GetModelList`, `ModelChooser_GetSoundMap`

Author: Alienmario

.github/workflows/plugin.yml

@@ -62,6 +62,7 @@ jobs:
 
       - name: Create package
         run: |
+          rm plugins/modelchooser_api_example.smx
           OUT="/tmp/build"
           SM="${OUT}/addons/sourcemod"
           mkdir -p $SM/configs

configs-bms/player_models.cfg

@@ -59,6 +59,13 @@
 				"path" "models/example.ext"
 				"path" "models/another.ext"
 			}
+			
+			// Extensibility support for plugin API
+			"custom"
+			{
+				"key" "value"
+			}
+			
 		}
 
 		// ----------------------------------------------------------------------------------------

configs-hl2mp/player_models.cfg

@@ -75,6 +75,13 @@
 				"path" "models/example.ext"
 				"path" "models/another.ext"
 			}
+
+			// Extensibility support for plugin API
+			"custom"
+			{
+				"key" "value"
+			}
+
 		}
 
 		// ----------------------------------------------------------------------------------------

scripting/include/model_chooser.inc

@@ -0,0 +1,75 @@
+#if defined _model_chooser_included
+	#endinput
+#endif
+#define _model_chooser_included
+
+#define MODELCHOOSER_LIBRARY "ModelChooser"
+
+public SharedPlugin __pl_model_chooser = 
+{
+    name = MODELCHOOSER_LIBRARY,
+    file = "ultimate_modelchooser.smx",
+#if defined REQUIRE_PLUGIN
+    required = 1,
+#else
+    required = 0,
+#endif
+};
+
+#if !defined REQUIRE_PLUGIN
+public void __pl_model_chooser_SetNTVOptional()
+{
+    MarkNativeAsOptional("ModelChooser_GetCurrentModelName");
+    MarkNativeAsOptional("ModelChooser_GetCurrentModelPath");
+    MarkNativeAsOptional("ModelChooser_GetCurrentModelProperty");
+    MarkNativeAsOptional("ModelChooser_UnlockModel");
+    MarkNativeAsOptional("ModelChooser_LockModel");
+    MarkNativeAsOptional("ModelChooser_SelectModel");
+    MarkNativeAsOptional("ModelChooser_IsClientChoosing");
+    MarkNativeAsOptional("ModelChooser_OpenChooser");
+    MarkNativeAsOptional("ModelChooser_PlayRandomSound");
+    MarkNativeAsOptional("ModelChooser_GetProperty");
+    MarkNativeAsOptional("ModelChooser_GetModelList");
+    MarkNativeAsOptional("ModelChooser_GetSoundMap");
+}
+#endif
+
+/* Forwards */
+
+forward void ModelChooser_OnConfigLoaded();
+
+forward void ModelChooser_OnModelChanged(int client, const char[] modelName);
+
+/* Natives */
+
+native bool ModelChooser_GetCurrentModelName(int client, char[] modelName, int maxLength);
+
+native bool ModelChooser_GetCurrentModelPath(int client, char[] modelPath, int maxLength);
+
+native bool ModelChooser_GetCurrentModelProperty(int client, const char[] key, char[] value, int maxLength);
+
+native bool ModelChooser_UnlockModel(int client, const char[] modelName, bool select = false);
+
+native bool ModelChooser_LockModel(int client, const char[] modelName);
+
+native bool ModelChooser_SelectModel(int client, const char[] modelName);
+
+native bool ModelChooser_IsClientChoosing(int client);
+
+native bool ModelChooser_OpenChooser(int client, bool printErrorMsg);
+
+native bool ModelChooser_PlayRandomSound(int client, const char[] soundType, bool toAll = false, bool stopLast = true, int pitch = 100, float volume = 1.0);
+
+native bool ModelChooser_GetProperty(const char[] modelName, const char[] key, char[] value, int maxLength);
+
+#if defined MODELCHOOSER_RAWDOG_API
+
+#include <sdktools>
+#include <clientprefs>
+#include <modelchooser/structs>
+
+native ModelList ModelChooser_GetModelList();
+
+native SoundMap ModelChooser_GetSoundMap();
+
+#endif

scripting/include/model_chooser/natives.inc

@@ -61,12 +61,8 @@ int GetCustomSequenceForAnim(int client, PLAYER_ANIM playerAnim, float &playback
 			float time = GetGameTime();
 			if (time > nextJumpSound[client])
 			{
-				{
-					SoundPack soundPack;
-					GetSoundPack(model, soundPack);
-					PlayRandomSound(soundPack.jumpSounds, client, client, SNDCHAN_STATIC, true, JUMP_PITCH_MIN, JUMP_PITCH_MAX, JUMP_VOL);
-					nextJumpSound[client] = time + model.jumpSndParams.cooldown.Rand();
-				}
+				PlayRandomSound(GetSoundPack(model).GetSoundList("jump"), client, client, SNDCHAN_STATIC, true, JUMP_PITCH_MIN, JUMP_PITCH_MAX, JUMP_VOL);
+				nextJumpSound[client] = time + model.jumpSndParams.cooldown.Rand();
 			}
 		}
 		else if (playerAnim == PLAYER_WALK)

scripting/include/modelchooser.inc

@@ -18,7 +18,7 @@ public Action Command_UnlockModel(int client, int args)
 		return Plugin_Handled;
 	}
 
-	char arg1[65], arg2[MAX_MODELNAME];
+	char arg1[65], arg2[MODELCHOOSER_MAX_NAME];
 	GetCmdArg(1, arg1, sizeof(arg1));
 	GetCmdArg(2, arg2, sizeof(arg2));
 
@@ -42,8 +42,7 @@ public Action Command_UnlockModel(int client, int args)
 
 	String_ToUpper(arg2, arg2, sizeof(arg2));
 
-	PlayerModel model;
-	if (modelList.FindByName(arg2, model) == -1)
+	if (modelList.FindByName(arg2) == -1)
 	{
 		ReplyToCommand(client, "Model named %s doesn't exist!", arg2);
 		return Plugin_Handled;
@@ -74,7 +73,7 @@ public Action Command_LockModel(int client, int args)
 		return Plugin_Handled;
 	}
 
-	char arg1[65], arg2[MAX_MODELNAME];
+	char arg1[65], arg2[MODELCHOOSER_MAX_NAME];
 	GetCmdArg(1, arg1, sizeof(arg1));
 	GetCmdArg(2, arg2, sizeof(arg2));
 
@@ -98,8 +97,7 @@ public Action Command_LockModel(int client, int args)
 
 	String_ToUpper(arg2, arg2, sizeof(arg2));
 
-	PlayerModel model;
-	if (modelList.FindByName(arg2, model) == -1)
+	if (modelList.FindByName(arg2) == -1)
 	{
 		ReplyToCommand(client, "Model named %s doesn't exist!", arg2);
 		return Plugin_Handled;