c8d81ba3bb
All checks were successful
Build / Build (push) Successful in 39s
This commit significantly enhances the `README.md` file, providing comprehensive documentation for the ArmaDragonflyClient. Key changes: * **Detailed Function Categories:** Categorized functions for better organization (Core, Basic Data Operations, Hash Operations, List Operations). * **Usage Examples:** Added clear and concise usage examples for basic operations, hash operations (context and ID-specific), and list operations. * **Function Documentation Structure:** Outlined the structure for individual function documentation. * **License Information:** Updated the license information.
50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
---
|
|
title: ArmaDragonflyClient - Delete Key
|
|
icon: mdi:file-text-outline
|
|
excerpt: Remove the specified key from DragonflyClient.
|
|
---
|
|
|
|
# dragonfly_db_fnc_delete
|
|
|
|
## Description
|
|
Removes the specified key from the database. This function deletes the key-value pair completely from storage.
|
|
|
|
## Syntax
|
|
```sqf
|
|
[_key] call dragonfly_db_fnc_delete
|
|
```
|
|
|
|
## Parameters
|
|
| Parameter | Type | Description |
|
|
|-----------|--------|-------------------------------------------|
|
|
| `_key` | String | Name of the key to delete from the database |
|
|
|
|
## Return Value
|
|
None. The operation runs asynchronously.
|
|
|
|
## Examples
|
|
### Delete a key in singleplayer or on the server:
|
|
```sqf
|
|
["playerData"] call dragonfly_db_fnc_delete;
|
|
```
|
|
|
|
### Delete a key on the server from a client:
|
|
```sqf
|
|
["playerData"] remoteExecCall ["dragonfly_db_fnc_delete", 2, false];
|
|
```
|
|
|
|
## Notes
|
|
- This operation is permanent and cannot be undone
|
|
- If the key doesn't exist, the operation will have no effect
|
|
- This function only affects specific keys, not hash tables or lists
|
|
|
|
## Related Functions
|
|
- `dragonfly_db_fnc_get`: Retrieves a value by key
|
|
- `dragonfly_db_fnc_set`: Stores a value by key
|
|
- `dragonfly_db_fnc_scheduler`: Processes the callback response
|
|
|
|
## Links
|
|
|
|
[Delete Key](delete.md) |
|
|
[Get Key](get.md) |
|
|
[Set Key](set.md) |