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.2 KiB

Raw Blame History

title, icon, excerpt

title	icon	excerpt
ArmaRAMDb - Hash Get All	mdi:file-text-outline	Get all fields from the current client's hash table in RAMDb.

ramdb_db_fnc_hashGetAll

Description

Retrieves all fields and values from the hash table associated with the current client/player. This function automatically determines the appropriate hash ID based on the caller's identity, making it more convenient than hashGetAllId which requires manually specifying an ID. It returns the entire hash table data through a callback function, allowing access to all stored key-value pairs at once.

Syntax

[_function, _call, _netId] call ramdb_db_fnc_hashGetAll

Parameters

Parameter	Type	Description	Default
`_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 all client hash data:

["ramdb_db_fnc_test"] call ramdb_db_fnc_hashGetAll;

Retrieve data with synchronous callback:

["ramdb_db_fnc_processAllData", true] call ramdb_db_fnc_hashGetAll;

Retrieve data and send it to a specific client:

["ramdb_db_fnc_test", false, netId player] remoteExecCall ["ramdb_db_fnc_hashGetAll", 2, false];

Notes

Returns the complete hash table for the current client with all fields and values as a nested array
The data is retrieved asynchronously through the extension's callback system
The callback function name must be provided and is validated
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 automatically determines which hash table to use based on the caller's identity
Use hashGetAllId when you need to specify a particular hash table by ID
For large hash tables, retrieving all data may impact performance
All operations are logged for debugging purposes

ramdb_db_fnc_hashGet: Retrieves a specific field value from the current client's hash table
ramdb_db_fnc_hashGetId: Retrieves a specific field value from a specific hash table (when you need to specify the ID)
ramdb_db_fnc_hashGetAllId: Retrieves all fields from a specific hash table (when you need to specify the ID)
ramdb_db_fnc_hashSet: Sets a field value in the current client's hash table
ramdb_db_fnc_scheduler: Processes the callback from the database extension

Links

3.2 KiB Raw Blame History