Jacob Schmidt 8c0e8144e5 docs: Update documentation links and function references

This commit updates the documentation to reflect the current function names and link structure. Specifically, it addresses the following:

*   Corrected internal links within the documentation to point to the correct markdown files (e.g., `hashDelete.md` instead of `hashDelete`).
*   Updated related function references to reflect the current function names and include missing functions.
*   Removed outdated function references.
*   Added `ramdb_db_fnc_scheduler` to related functions where appropriate.
*   Updated the links section to use the correct markdown file names.

2025-03-22 16:53:30 -05:00

3.3 KiB

Raw Permalink Blame History

title, icon, excerpt

title	icon	excerpt
ArmaRAMDb - Hash Get All ID	mdi:file-text-outline	Get all fields and values from the hash stored at key from RAMDb.

ramdb_db_fnc_hashGetAllId

Description

Retrieves all fields and values from a specific hash table identified by its key. This function returns the complete hash table data for a specific ID through a callback function, allowing access to all stored key-value pairs associated with that ID. It's particularly useful for retrieving player-specific or entity-specific hash data.

Syntax

[_key, _function, _call, _netId] call ramdb_db_fnc_hashGetAllId

Parameters

Parameter	Type	Description	Default
`_key`	String	Identifier of the hash table to retrieve	""
`_function`	String	Name of the function to receive the retrieved data	""
`_call`	Boolean	Whether to call the function directly (true) or spawn (false)	false
`_netId`	String	(Optional) NetID of the player to receive the data	""

Return Value

None. The retrieved data is passed to the specified callback function asynchronously.

Examples

Retrieve a player's complete hash data:

[getPlayerUID player, "ramdb_db_fnc_test"] call ramdb_db_fnc_hashGetAllId;

Retrieve vehicle data with synchronous callback:

["vehicle_123", "ramdb_db_fnc_processVehicleData", true] call ramdb_db_fnc_hashGetAllId;

Retrieve data and send it to a specific client:

[getPlayerUID player, "ramdb_db_fnc_test", false, netId player] remoteExecCall ["ramdb_db_fnc_hashGetAllId", 2, false];

Notes

Returns the complete hash table with all fields and values as a nested array
Both the key and callback function parameters are required and validated
The data is retrieved asynchronously through the extension's callback system
When a netId is provided, the data is sent to that specific client
The _call parameter determines whether the function is called directly (synchronous) or spawned (asynchronous)
This function retrieves from a specific hash table identified by _key - use hashGetAll for the global hash table
Player UIDs are commonly used as keys to store player-specific data
For large hash tables, retrieving all data may impact performance
All operations are logged for debugging purposes

ramdb_db_fnc_hashGetAll: Retrieves all fields from the global hash table
ramdb_db_fnc_hashGetId: Retrieves a specific field value from a specific hash table
ramdb_db_fnc_hashGet: Retrieves a specific field value from the global hash table
ramdb_db_fnc_hashSetId: Sets a field value in a specific hash table
ramdb_db_fnc_scheduler: Processes the callback from the database extension

Links

3.3 KiB Raw Permalink Blame History