Build / Build (push) Successful in 39s

Details

docs: Update README.md with detailed documentation

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.

2025-03-30 17:15:35 -05:00

1.9 KiB

Raw Permalink Blame History

title, icon, excerpt

title	icon	excerpt
ArmaDragonflyClient - Set Key	mdi:file-text-outline	Set the value of stored key from DragonflyClient.

dragonfly_db_fnc_set

Description

Stores a value in the database with the specified key. This function allows saving various data types (arrays, strings, numbers, or booleans) that can be retrieved later using the key.

Syntax

[_key, _data] call dragonfly_db_fnc_set

Parameters

Parameter	Type	Description	Default
`_key`	String	Name of the key to store the data under	""
`_data`	Array, String, Number, or Boolean	The value to store in the database	[]

Return Value

None. The operation runs asynchronously.

Examples

Store a simple array:

["playerInventory", ["item1", "item2", "item3"]] call dragonfly_db_fnc_set;

Store player data under their UID:

[getPlayerUID player, [name player, getPos player, getAllGear player]] call dragonfly_db_fnc_set;

Call the set function remotely from a client:

["serverSetting", [true, 30, "normal"]] remoteExecCall ["dragonfly_db_fnc_set", 2, false];

Notes

The function validates both the key and data before attempting to store
If the key already exists, its value will be overwritten
Complex data structures should be serialized into arrays
There are no size limits for data, but extremely large values might impact performance
For structured data, consider using hash tables instead of key-value pairs

dragonfly_db_fnc_get: Retrieves a value by key
dragonfly_db_fnc_delete: Removes a value by key
dragonfly_db_fnc_scheduler: Processes the callback response

Links

Delete Key | Get Key | Set Key

1.9 KiB Raw Permalink Blame History