Merge tf2wearables functionality

I ended up maintaining that plugin anyways, so I might as well pull it
in so there are fewer dependencies to manage.

Author: nosoop

gamedata/tf2.utils.nosoop.txt

@@ -20,6 +20,12 @@
 				"windows"	"86"
 				"linux"		"87"
 			}
+			"CBaseEntity::IsWearable()"
+			{
+				"windows"	"87"
+				"linux"		"88"
+				"mac"		"88"
+			}
 			"CBaseEntity::TakeHealth()"
 			{
 				"windows"	"64"
@@ -35,6 +41,12 @@
 				"windows"	"372"
 				"linux"		"378"
 			}
+			"CTFPlayer::EquipWearable()"
+			{
+				"windows"	"430"
+				"linux"		"431"
+				"mac"		"431"
+			}
 
 			// member offsets
 			// any resemblance to the names present in official game code is purely coincidental
@@ -48,6 +60,14 @@
 		}
 		"Signatures"
 		{
+			"CTFPlayer::GetEntityForLoadoutSlot()"
+			{
+				// called a few blocks after function with unique x-ref string "enable_misc2_noisemaker"
+				"library"	"server"
+				"windows"	"\x55\x8b\xec\x51\x53\x8b\x5d\x2a\x57\x8b\xf9\x89\x7d\x2a\x83\xfb\x07\x74\x2a\x83\xfb\x08\x74\x2a\x83\xfb\x09\x74\x2a\x83\xfb\x0a\x74\x2a"
+				"linux"		"@_ZN9CTFPlayer23GetEntityForLoadoutSlotEib"
+				"mac"		"@_ZN9CTFPlayer23GetEntityForLoadoutSlotEib"
+			}
 			"CTFPlayer::GetMaxAmmo()"
 			{
 				"library"		"server"

scripting/include/tf2utils.inc

@@ -60,6 +60,13 @@ native void TF2Util_GetPlayerShootPosition(int client, float result[3]);
  */
 native bool TF2Util_IsEntityWeapon(int entity);
 
+/**
+ * Returns whether or not the given entity is a wearable.
+ * 
+ * @error Entity is not valid.
+ */
+native bool TF2Util_IsEntityWearable(int entity);
+
 /**
  * Returns the slot for the given weapon entity.
  * 
@@ -93,6 +100,26 @@ native int TF2Util_GetPlayerWearable(int client, int index);
  */
 native int TF2Util_GetPlayerWearableCount(int client);
 
+/**
+ * If `includeWearableWeapons` is true, weapon slots (primary, secondary, melee, utility,
+ * building, pda, pda2) are also checked for wearable items.  Otherwise, non-wearables are
+ * ignored.
+ * 
+ * Note that this validates that the player is using a class that can equip the given item; any
+ * items not applicable to the class are ignored.
+ * 
+ * @return Entity on the given client occupying the given loadout slot.
+ */
+native int TF2Util_GetPlayerLoadoutEntity(int client, int loadoutSlot,
+		bool includeWearableWeapons = true);
+
+/**
+ * Equips the given wearable entity onto the given client.
+ * 
+ * @error Client is invalid or entity is not a wearable.
+ */
+native void TF2Util_EquipPlayerWearable(int client, int wearable);
+
 /**
  * Forces an update to the given player's speed.
  * 
@@ -118,6 +145,13 @@ native void TF2Util_UpdatePlayerSpeed(int client, bool immediate = false);
 native bool TF2Util_IsPointInRespawnRoom(const float[3] position,
 		int entity = INVALID_ENT_REFERENCE, bool bRestrictToSameTeam = false);
 
+// compile-time compatibility shim for tf2wearables natives
+#if defined USE_TF2WEARABLE_FUNCTION_SHIMS
+	#define TF2_GetPlayerLoadoutSlot    TF2Util_GetPlayerLoadoutEntity
+	#define TF2_EquipPlayerWearable     TF2Util_EquipPlayerWearable
+	#define TF2_IsWearable              TF2Util_IsEntityWearable
+#endif
+
 public SharedPlugin __pl_tf2utils = {
 	name = "nosoop_tf2utils",
 	file = "tf2utils.smx",

scripting/tf2utils.sp

@@ -11,7 +11,7 @@
 
 #include <stocksoup/memory>
 
-#define PLUGIN_VERSION "0.10.0"
+#define PLUGIN_VERSION "0.11.0"
 public Plugin myinfo = {
 	name = "TF2 Utils",
 	author = "nosoop",
@@ -26,6 +26,7 @@ bool g_bDeferredSpeedUpdate[MAXPLAYERS + 1];
 Handle g_SDKCallPlayerGetMaxAmmo;
 Handle g_SDKCallPlayerTakeHealth;
 Handle g_SDKCallPlayerGetShootPosition;
+Handle g_SDKCallPlayerGetEntityForLoadoutSlot;
 
 Handle g_SDKCallPlayerSharedGetMaxHealth;
 
@@ -34,6 +35,9 @@ Handle g_SDKCallWeaponGetSlot;
 Handle g_SDKCallWeaponGetID;
 Handle g_SDKCallWeaponGetMaxClip;
 
+Handle g_SDKCallIsEntityWearable;
+Handle g_SDKCallPlayerEquipWearable;
+
 Handle g_SDKCallPointInRespawnRoom;
 
 Address offs_CTFPlayer_hMyWearables;
@@ -46,14 +50,18 @@ public APLRes AskPluginLoad2(Handle self, bool late, char[] error, int maxlen) {
 	CreateNative("TF2Util_GetPlayerMaxHealth", Native_GetMaxHealth);
 	CreateNative("TF2Util_GetPlayerMaxAmmo", Native_GetMaxAmmo);
 
+	CreateNative("TF2Util_IsEntityWearable", Native_IsEntityWearable);
 	CreateNative("TF2Util_GetPlayerWearable", Native_GetPlayerWearable);
 	CreateNative("TF2Util_GetPlayerWearableCount", Native_GetPlayerWearableCount);
+	CreateNative("TF2Util_EquipPlayerWearable", Native_EquipPlayerWearable);
 
 	CreateNative("TF2Util_IsEntityWeapon", Native_IsEntityWeapon);
 	CreateNative("TF2Util_GetWeaponSlot", Native_GetWeaponSlot);
 	CreateNative("TF2Util_GetWeaponID", Native_GetWeaponID);
 	CreateNative("TF2Util_GetWeaponMaxClip", Native_GetWeaponMaxClip);
 
+	CreateNative("TF2Util_GetPlayerLoadoutEntity", Native_GetPlayerLoadoutEntity);
+	
 	CreateNative("TF2Util_GetPlayerShootPosition", Native_GetPlayerShootPosition);
 
 	CreateNative("TF2Util_IsPointInRespawnRoom", Native_IsPointInRespawnRoom);
@@ -104,6 +112,11 @@ public void OnPluginStart() {
 	PrepSDKCall_SetReturnInfo(SDKType_Bool, SDKPass_Plain);
 	g_SDKCallIsEntityWeapon = EndPrepSDKCall();
 
+	StartPrepSDKCall(SDKCall_Entity);
+	PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "CBaseEntity::IsWearable()");
+	PrepSDKCall_SetReturnInfo(SDKType_Bool, SDKPass_Plain);
+	g_SDKCallIsEntityWearable = EndPrepSDKCall();
+	
 	StartPrepSDKCall(SDKCall_Entity);
 	PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "CBaseCombatWeapon::GetSlot()");
 	PrepSDKCall_SetReturnInfo(SDKType_PlainOldData, SDKPass_Plain);
@@ -119,6 +132,19 @@ public void OnPluginStart() {
 	PrepSDKCall_SetReturnInfo(SDKType_PlainOldData, SDKPass_Plain);
 	g_SDKCallWeaponGetMaxClip = EndPrepSDKCall();
 
+	StartPrepSDKCall(SDKCall_Player);
+	PrepSDKCall_SetFromConf(hGameConf, SDKConf_Signature,
+			"CTFPlayer::GetEntityForLoadoutSlot()");
+	PrepSDKCall_AddParameter(SDKType_PlainOldData, SDKPass_Plain);
+	PrepSDKCall_AddParameter(SDKType_Bool, SDKPass_Plain);
+	PrepSDKCall_SetReturnInfo(SDKType_CBaseEntity, SDKPass_Pointer);
+	g_SDKCallPlayerGetEntityForLoadoutSlot = EndPrepSDKCall();
+	
+	StartPrepSDKCall(SDKCall_Player);
+	PrepSDKCall_SetFromConf(hGameConf, SDKConf_Virtual, "CTFPlayer::EquipWearable()");
+	PrepSDKCall_AddParameter(SDKType_CBaseEntity, SDKPass_Pointer);
+	g_SDKCallPlayerEquipWearable = EndPrepSDKCall();
+	
 	StartPrepSDKCall(SDKCall_Static);
 	PrepSDKCall_SetFromConf(hGameConf, SDKConf_Signature, "PointInRespawnRoom()");
 	PrepSDKCall_SetReturnInfo(SDKType_Bool, SDKPass_Plain);
@@ -221,6 +247,20 @@ public int Native_GetMaxHealth(Handle plugin, int nParams) {
 			bIgnoreAttributes, bIgnoreOverheal);
 }
 
+public int Native_EquipPlayerWearable(Handle plugin, int numParams) {
+	int client = GetNativeCell(1);
+	if (client < 1 || client > MaxClients || !IsClientInGame(client)) {
+		ThrowNativeError(SP_ERROR_NATIVE, "Client index %d is invalid", client);
+	}
+	
+	int wearable = GetNativeCell(2);
+	if (!IsEntityWearable(wearable)) {
+		ThrowNativeError(SP_ERROR_NATIVE, "Entity index %d is not a wearable",
+				EntRefToEntIndex(wearable));
+	}
+	SDKCall(g_SDKCallPlayerEquipWearable, client, wearable);
+}
+
 // int(int client, int index);
 public int Native_GetPlayerWearable(Handle plugin, int nParams) {
 	int client = GetNativeCell(1);
@@ -266,6 +306,12 @@ public int Native_IsEntityWeapon(Handle plugin, int nParams) {
 	return IsEntityWeapon(entity);
 }
 
+// bool(int entity);
+public int Native_IsEntityWearable(Handle plugin, int nParams) {
+	int entity = GetNativeCell(1);
+	return IsEntityWearable(entity);
+}
+
 // int(int entity);
 public int Native_GetWeaponSlot(Handle plugin, int nParams) {
 	int entity = GetNativeCell(1);
@@ -316,6 +362,18 @@ public int Native_IsPointInRespawnRoom(Handle plugin, int nParams) {
 	return SDKCall(g_SDKCallPointInRespawnRoom, entity, origin, bRestrictToSameTeam);
 }
 
+// int(int client, int loadoutSlot, bool includeWearableWeapons);
+int Native_GetPlayerLoadoutEntity(Handle plugin, int numParams) {
+	int client = GetNativeCell(1);
+	if (client < 1 || client > MaxClients || !IsClientInGame(client)) {
+		ThrowNativeError(SP_ERROR_NATIVE, "Client index %d is invalid", client);
+	}
+	int loadoutSlot = GetNativeCell(2);
+	bool check_wearable = numParams <3 ? true : GetNativeCell(3);
+	
+	return SDKCall(g_SDKCallPlayerGetEntityForLoadoutSlot, client, loadoutSlot, check_wearable);
+}
+
 bool IsEntityWeapon(int entity) {
 	if (!IsValidEntity(entity)) {
 		ThrowNativeError(SP_ERROR_NATIVE, "Entity %d (%d) is invalid", entity,
@@ -324,6 +382,14 @@ bool IsEntityWeapon(int entity) {
 	return SDKCall(g_SDKCallIsEntityWeapon, entity);
 }
 
+bool IsEntityWearable(int entity) {
+	if (!IsValidEntity(entity)) {
+		ThrowNativeError(SP_ERROR_NATIVE, "Entity %d (%d) is invalid", entity,
+				EntRefToEntIndex(entity));
+	}
+	return SDKCall(g_SDKCallIsEntityWearable, entity);
+}
+
 static Address GameConfGetAddressOffset(Handle gamedata, const char[] key) {
 	Address offs = view_as<Address>(GameConfGetOffset(gamedata, key));
 	if (offs == view_as<Address>(-1)) {