AlliedModders - Module: Custom Entity Data

AlliedModders (https://forums.alliedmods.net/index.php)

- Module Coding (https://forums.alliedmods.net/forumdisplay.php?f=9)

- - Module: Custom Entity Data (https://forums.alliedmods.net/showthread.php?t=294188)

Module: Custom Entity Data

Description:

This module lets you bind custom user data to entities without dealing with fields like pev_iuser[1-4] or similar. The reason this module is created is that this way you are not limited by the amount of pev_* fields and plugins or the game dll won't interfere with each other (modifying the same pev_* fields).

API:

The API is pretty similar to the Trie API - you can retrieve or set cells, arrays and strings, which are identified by a string key.
When an entity is destroyed, all data bound to it gets destroyed too - that means that you have to free any handles (like Trie, Array, Stack or others) bound to that entity or they will get lost/leaked.

customentdata.inc

PHP Code:


		
			
/**
 * Sets custom entity data as cell
 *
 * @param entity            Entity to set data for
 * @param key               Identifier for data
 * @param data              Data to be set
 *
 * @noreturn
 */
native CED_SetCell(entity, const key[], any:data);

/**
 * Sets custom entity data as array
 *
 * @param entity            Entity to set data for
 * @param key               Identifier for data
 * @param data              Data to be set
 * @param size              Size of the data array
 *
 * @noreturn
 */
native CED_SetArray(entity, const key[], const any:data[], size);

/**
 * Sets custom entity data as string
 *
 * @param entity            Entity to set data for
 * @param key               Identifier for data
 * @param buffer            Data to be set
 *
 * @noreturn
 */
native CED_SetString(entity, const key[], const buffer[]);

/**
 * Gets custom entity data as cell
 *
 * @param entity            Entity to get data for
 * @param key               Identifier for data
 * @param data              Variable to put data in
 *
 * @return                  true if data identified by |key| exists, false otherwise
 */
native bool:CED_GetCell(entity, const key[], &any:data);

/**
 * Gets custom entity data as array
 *
 * @param entity            Entity to get data for
 * @param key               Identifier for data
 * @param data              Array to fill with data
 * @param size              Maximum size of |data| array
 *
 * @return                  true if data identified by |key| exists, false otherwise
 */
native bool:CED_GetArray(entity, const key[], any:data[], size);

/**
 * Gets custom entity data as string
 *
 * @param entity            Entity to get data for
 * @param key               Identifier for data
 * @param buffer            Buffer to put string data in
 * @param maxLength         Maximum length of |buffer| buffer
 *
 * @return                  true if data identified by |key| existed, false otherwise
 */
native bool:CED_GetString(entity, const key[], buffer[], maxLength);

Install instructions:

Put customentdata_amxx.dll (Windows) or customentdata_amxx_i386.so (Linux) into $moddir/addons/amxmodx/modules.

Todo:

Create an "OnEntityDestroyed" hook or similar to let the user easily free any bound handles.

Downloads:

Source code on GitHub

Re: Module: Custom Entity Data

One entity data module to rule them all.
Thank you master Klippy.

Re: Module: Custom Entity Data

Good job, but you can hook OnFreeEntPrivateData from API instead of hooking ED_Free.

Re: Module: Custom Entity Data

Thank you peeps.

@PRoSToTeM@: I just took a look, that would be more proper, thanks, I'll fix that soon.

Re: Module: Custom Entity Data

Updated per PRoSToTeM@'s suggestion.

Re: Module: Custom Entity Data

You misunderstood me. I mean hook OnFreeEntPrivateData via NewDLL API. You should uncomment

PHP Code:


		
			
#define FN_OnFreeEntPrivateData                OnFreeEntPrivateData

PHP Code:


		
			
#define FN_OnFreeEntPrivateData_Post            OnFreeEntPrivateData_Post

in moduleconfig to use it.

Re: Module: Custom Entity Data

I am aware of that it exists there, but calls to engine/game dll functions via Metamod plugins aren't propagated to other Metamod plugins IIRC. That's why for example you can't hook FM_PrecacheModel that other AMXX plugin executed. That's why I kept on using CHooker.

Re: Module: Custom Entity Data

There are two kinds of functions in API that you can call (they are located in engfuncs) and that you can hook (events) (I mean original API from engine, not metamod, they are located in EntityAPI(2) and NewDLLFunctions). PrecacheModel is that you can call, so basically you can hook it to customize gamedll behaviour only. FreeEntPrivateData has two versions FreeEntPrivateData that you can call (engfunc) and OnFreeEntPrivateData event (NewDllFunction). FreeEntPrivateData engfunc calls OnFreeEntPrivateData (you can see that in ReHLDS). So, you can hook OnFreeEntPrivateData via API without any problems. Emulating OnFreeEntPrivateData can break some code in gamedll, this is like undefined behaviour (I mean fakecall from some plugin).

Re: Module: Custom Entity Data

I was thinking on doing something like this, I complained because I thought it would be slow. Good job, this kind of addons will have a big impact if is integrated in the main AMXX package.