For developers: ObjectSelection Framework

[Anders]

This tiny framework (just one class) will help you a *lot* when developing extensions that needs to modify or read the Selected Object List. It *should* work in HWA and Unicode versions of MMF2 + it supports qualifiers.

Please report any bugs to me so they can be fixed

Many thanks to Dynasoft for releasing the sourcecodes for his Select Object to the public. I couldn't have made this mini-framework without it.

Overview of the functions:
void SelectAll(short Oi);
- Resets the SOL by reselecting all objects

void SelectNone(short Oi);
- Resets the SOL, not selecting any objects

void SelectOneObject(LPRO object);
- Resets the SOL and inserts one given object into it

void SelectObjects(short Oi, LPRO* objects, int count);
- Resets the SOL and selects the given list of objects

bool ObjectIsOfType(LPRO object, short Oi);
- Returns true if the object is of the type (checks for qualifiers as well)

int GetNumberOfSelected(short Oi);
- Returns the number of selected objects for the given object type or qualifier.

bool FilterObjects(LPRDATA rdPtr, short Oi, bool negate, bool (*filterFunction)(LPRDATA, LPRO));
- Runs a custom filter on the current SOL, removing objects that fails the callback test.
Returns a boolean if the event should run (already inverted by the negate flag for convenience)

Download:
ObjectSelection.cpp - ObjectSelection.h - My website with the same info as here

Sample condition with callback filter

//Should it select the given object?
bool sampleFilter(LPRDATA rdPtr, LPRO object)
{
	return (rdPtr->objectA == object || rdPtr->objectB == object);
}

long WINAPI DLLExport con_IsObjectRemembered(LPRDATA rdPtr, long param1, long param2)
{
	//Initialize the object selection framework
	ObjectSelection select = ObjectSelection(rdPtr->rHo.hoAdRunHeader);

	//Gets a pointer to the event information structure and find out if the condition is negated
	PEVT pe = (PEVT)(((LPBYTE)param1)-CND_SIZE);
	bool isNegated = (pe->evtFlags2 & EVFLAG2_NOT);
	short oi = ((eventParam*)param1)->evp.evpW.evpW0;

	//Runs the "sampleFilter" callback on any object in the SOL.
	return select.FilterObjects(rdPtr, oi, isNegated, &sampleFilter);
}

[Looki]

Awesome
I will definitely find a use for this.

[Dynasoft]

Many thanks to Dynasoft for releasing the sourcecodes for his Select Object to the public. I couldn't have made this mini-framework without it.

And thank you for taking the time to make this.

[Joshtek]

Nice one, Andos and Dynasoft!

[Fernando]

Thanks to both, now in my chest of codes for future uses!!!

[RickyRombo]

WOO! I might be able to finish my Bullet360 object!!

... that is if I still have the source! Uh oh!

[Atom]

Thanks Andos and Dynasoft

[Retriever2]

This should be useful to many people.

Most of the object selection capabilities in XLua is also thanks to the code Dynasoft released. It has been very helpful.