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

2.9 KiB

Raw Permalink Blame History

title, icon, excerpt

title	icon	excerpt
ArmaRAMDb - Hash Set	mdi:file-text-outline	Set a field value in the current client's hash table in RAMDb.

ramdb_db_fnc_hashSet

Description

Sets the value of a specified field in 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 hashSetId which requires manually specifying an ID. It allows storing various data types (arrays, strings, numbers, or booleans) in a field of the client-specific hash structure.

Syntax

[_keyField, _data] call ramdb_db_fnc_hashSet

Parameters

Parameter	Type	Description	Default
`_keyField`	String	Name of the field in the hash to set	""
`_data`	Array, String, Number, or Boolean	The value to store in the hash field	[]

Return Value

None. The operation runs synchronously to store the data.

Examples

Store a player's loadout:

["loadout", [getUnitLoadout player]] call ramdb_db_fnc_hashSet;

Store player preferences:

["settings", [true, 30, "normal"]] call ramdb_db_fnc_hashSet;

Store data from a client:

["clientInfo", [name player, getPlayerUID player]] remoteExecCall ["ramdb_db_fnc_hashSet", 2, false];

Notes

Stores a single field-value pair in the current client's hash table
Both the field name and data parameters are required and validated
If the field already exists, its value will be overwritten
Supports various data types: arrays, strings, numbers, and booleans
This function automatically determines which hash table to use based on the caller's identity
Use hashSetId when you need to specify a particular hash table by ID
Complex data structures should be serialized into arrays
The operation is executed immediately and synchronously
All operations are logged for debugging purposes

ramdb_db_fnc_hashSetId: Sets a field value in a specific hash table (when you need to specify the ID)
ramdb_db_fnc_hashGet: Retrieves a field value from the current client's hash table
ramdb_db_fnc_hashGetAll: Retrieves all fields from the current client's hash table
ramdb_db_fnc_hashSetBulk: Sets multiple fields in the current client's hash table
ramdb_db_fnc_hashDelete: Removes the current client's hash table

Links

2.9 KiB Raw Permalink Blame History