[Feature Request] A method to catch entity lump parse failures

[ghost]

sourcemod/core/sourcemod.cpp

Lines 425 to 434 in 96727a7

	logicore.SetEntityLumpWritable(true);
	g_pOnMapInit->PushString(pMapName);
	g_pOnMapInit->Execute();
	logicore.SetEntityLumpWritable(false);
	if (!success)
	{
	logger->LogError("Map entity lump parsing for %s failed with error code %d on position %d", pMapName, parseError, position);
	RETURN_META_VALUE(MRES_IGNORED, true);
	}

Plugins like the SourcePawn plugin for Stripper will not be able to make changes if entity lump parsing fails. If there is a method to catch fails developers can find another work around such as reloading the map.

[asherkin]

What parsing failures have you run into that would have been recoverable?

[ghost]

Without SM, some maps sometimes crash on map start with MapEntity_ParseAllEntities: found ? when expecting {.

With SM, instead of crash on map start receive log Map entity lump parsing for failed with error code 1 on position -1 and reloading map fixes it.

Entity lump does write the changes but does not appear in the map.

[nosoop]

The entity lump is packed into the map file, so the general assumption is that a failure in parsing would only come from a malformed map file (which would not be a sometimes-issue that is fixed on a reload).

In your case, you could probably check that EntityLump.Length() == 0 during either OnMapInit() or OnMapStart(). Failures to parse mid-file would return a partly filled entity lump, but neither of those behaviors are strictly specified.

Error code 0 does suggest that parsing returned Status_OK, so I'm not sure how you're hitting this case. If you could list your environment and reproduction steps, that would probably help.

[ghost]

Sorry, meant error code 1. But I will try EntityLump.Length() == 0 as I guess what on position -1 does mean.

[nosoop]

Position -1 would be end-of-file, so either the whole string was consumed (unlikely if you're hitting the parse failure) or the string was empty. Empty string would mean EntityLump.Length() == 0 should work in your case.

[ghost]

Unfortunately didn't work for my case. The map is tr_walkway. Stripper extension can make changes without issue. I am thinking maybe adding the success bool to OnMapInit.