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

Raw Blame History

title, icon, excerpt

title	icon	excerpt
ArmaDragonflyClient - Print Addon Name	mdi:file-text-outline	Displays the addon name in system chat.

dragonfly_db_fnc_printAddonName

Description

Displays a thank you message with the addon name in the system chat. This is a simple utility function that can be used to acknowledge the use of the framework or to verify that the addon is properly loaded.

Syntax

[] call dragonfly_db_fnc_printAddonName

Parameters

None. This function does not require any parameters.

Return Value

None. The function outputs a message to the system chat.

Examples

Display the addon name message:

[] call dragonfly_db_fnc_printAddonName;

Use in a welcome script:

if (isServer) then {
    [] remoteExec ["dragonfly_db_fnc_printAddonName", 0, true];
};

Notes

The function uses the ADDON macro defined in script_component.hpp
This displays a message directly in the player's system chat
Can be useful as a quick verification that the addon is loaded correctly
Often used during development or for first-time users

dragonfly_db_fnc_init: Initializes the database system

Links

1.3 KiB Raw Blame History