Add an "output iterator"

Provides a wrapper around KeyValues that iterates over the output
strings, parsing them into their components.

Also updated the test plugin to use an entity that usually has outputs.

Author: nosoop

scripting/include/level_keyvalues.inc

@@ -10,6 +10,62 @@
  */
 native KeyValues LevelEntity_GetKeysByHammerID(int iHammerID);
 
+/** 
+ * A KeyValues-backed handle that returns and iterates over keys that match the given output
+ * name, parsing the output value into its components while being iterated.
+ */
+methodmap LevelEntityOutputIterator < KeyValues {
+	/**
+	 * Creates an output iterator for a given Hammer ID.
+	 */
+	public LevelEntityOutputIterator(int hammerID, const char[] output) {
+		KeyValues outputs = LevelEntity_GetKeysByHammerID(hammerID);
+		if (outputs) {
+			char keyBuffer[128], valueBuffer[128];
+			outputs.GotoFirstSubKey(false);
+			bool bNext;
+			do {
+				outputs.GetSectionName(keyBuffer, sizeof(keyBuffer));
+				outputs.GetString(NULL_STRING, valueBuffer, sizeof(valueBuffer));
+				
+				if (!StrEqual(keyBuffer, output)) {
+					bNext = outputs.DeleteThis() != -1;
+				} else {
+					bNext = outputs.GotoNextKey(false);
+				}
+			} while (bNext);
+			outputs.GotoFirstSubKey(false);
+		}
+		return view_as<LevelEntityOutputIterator>(outputs);
+	}
+	
+	/**
+	 * Returns an output iterator for a given entity (reference), looking it up by its Hammer
+	 * ID.
+	 */
+	public static LevelEntityOutputIterator FromEntity(int entref, const char[] output) {
+		int entity = EntRefToEntIndex(entref);
+		return new LevelEntityOutputIterator(GetEntProp(entity, Prop_Data, "m_iHammerID"),
+				output);
+	}
+	
+	/**
+	 * Parses the current output string, storing the values by reference and advancing to the
+	 * next key.
+	 */
+	public bool Next(char[] targetName, int targetNameLength,
+			char[] inputName, int inputNameLength, char[] variantValue, int variantValueLength,
+			float &delay, int &nFireCount) {
+		char outputString[512];
+		this.GetString(NULL_STRING, outputString, sizeof(outputString));
+		
+		// this.GoBack() is a disgusting hack just to make sure it returns true on the last item
+		return ParseEntityOutputString(outputString, targetName, targetNameLength, inputName,
+				inputNameLength, variantValue, variantValueLength, delay, nFireCount)
+				&& (this.GotoNextKey(false) || this.GoBack());
+	}
+}
+
 /**
  * Returns a copy of the KeyValues associated with a given entity.
  */
@@ -20,15 +76,28 @@ stock KeyValues LevelEntity_GetKeysByEntity(int entref) {
 
 /**
  * Parses an entity's output value (as formatted in the entity string).
- * 
  * Refer to https://developer.valvesoftware.com/wiki/AddOutput for the format.
+ * 
+ * @return True if the output string was successfully parsed, false if not.
  */
 stock bool ParseEntityOutputString(const char[] output, char[] targetName, int targetNameLength,
 		char[] inputName, int inputNameLength, char[] variantValue, int variantValueLength,
 		float &delay, int &nFireCount) {
 	int delimiter;
 	char buffer[32];
 
+	{
+		// validate that we have something resembling an output string (four commas)
+		int i, c, nDelim;
+		while ((c = FindCharInString(output[i], ',')) != -1) {
+			nDelim++;
+			i += c + 1;
+		}
+		if (nDelim < 4) {
+			return false;
+		}
+	}
+	
 	delimiter = SplitString(output, ",", targetName, targetNameLength);
 	delimiter += SplitString(output[delimiter], ",", inputName, inputNameLength);
 	delimiter += SplitString(output[delimiter], ",", variantValue, variantValueLength);

scripting/level_keyvalues_test.sp

@@ -9,13 +9,16 @@
 #pragma newdecls required
 #include <level_keyvalues>
 
+
+#define OUTPUT_NAME "OnCapTeam1"
+
 public void OnMapStart() {
-	int logicAuto = FindEntityByClassname(-1, "team_control_point");
+	int captureArea = FindEntityByClassname(-1, "trigger_capture_area");
 
-	if (logicAuto != -1) {
-		LogMessage("%s", "Found a team_control_point with keys:");
+	if (captureArea != -1) {
+		LogMessage("---- %s", "Found a trigger_capture_area with keys:");
 
-		KeyValues entityKeys = LevelEntity_GetKeysByEntity(logicAuto);
+		KeyValues entityKeys = LevelEntity_GetKeysByEntity(captureArea);
 
 		if (entityKeys) {
 			char keyBuffer[128], valueBuffer[128];
@@ -28,5 +31,21 @@ public void OnMapStart() {
 			} while (entityKeys.GotoNextKey(false));
 			delete entityKeys;
 		}
+		
+		LogMessage("---- %s", "List of " ... OUTPUT_NAME ... " outputs:");
+		
+		LevelEntityOutputIterator captureOutputEvents =
+				LevelEntityOutputIterator.FromEntity(captureArea, OUTPUT_NAME);
+		
+		char targetName[32], inputName[64], variantValue[32];
+		float delay;
+		int nFireCount;
+		
+		while (captureOutputEvents.Next(targetName, sizeof(targetName), inputName,
+				sizeof(inputName), variantValue, sizeof(variantValue), delay, nFireCount)) {
+			LogMessage("target %s -> input %s (value %s, delay %.2f, refire %d)",
+					targetName, inputName, variantValue, delay, nFireCount);
+		}
+		delete captureOutputEvents;
 	}
 }