ramdb/docs/hash/hashRemove.md
Jacob Schmidt 5b9f3402b6
All checks were successful
Build / Build (push) Successful in 30s
docs: add comprehensive documentation and usage examples for ramdb
2025-03-22 16:31:59 -05:00

2.4 KiB

title, icon, excerpt
title icon excerpt
ArmaRAMDb - Hash Remove mdi:file-text-outline Remove a field from the current client's hash table.

ramdb_db_fnc_hashRemove

Description

Removes a specific field 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 hashRemoveId which requires manually specifying an ID. It deletes a single field and its associated value without affecting other fields in the client's hash table.

Syntax

[_keyField] call ramdb_db_fnc_hashRemove

Parameters

Parameter Type Description Default
_keyField String Name of the field to be removed ""

Return Value

None. The operation runs synchronously to remove the field.

Examples

Remove a specific field:

["loadout"] call ramdb_db_fnc_hashRemove;

Remove a field remotely:

["playerSettings"] remoteExecCall ["ramdb_db_fnc_hashRemove", 2, false];

Notes

  • Only removes a single field from the current client's hash table
  • Validates that the key field parameter is not empty before proceeding
  • Does not affect other fields in the hash table
  • If the field doesn't exist, the operation has no effect
  • This function automatically determines which hash table to use based on the caller's identity
  • Use hashRemoveId when you need to specify a particular hash table by ID
  • The operation is executed immediately and synchronously
  • All operations are logged for debugging purposes
  • ramdb_db_fnc_hashRemoveId: Removes a specific field from a specific hash table (when you need to specify the ID)
  • ramdb_db_fnc_hashDelete: Removes the current client's hash table
  • ramdb_db_fnc_hashDeleteId: Removes a specific hash table
  • ramdb_db_fnc_hashSet: Sets a field value in the current client's hash table
  • ramdb_db_fnc_hashGet: Retrieves a field value from the current client's hash table

Hash Delete | Hash Delete Field | Hash Delete ID | Hash Get | Hash Get All | Hash Get All ID | Hash Get ID | Hash Remove | Hash Remove ID | Hash Set | Hash Set Bulk | Hash Set ID | Hash Set ID Bulk