
All checks were successful
Build / Build (push) Successful in 28s
This commit refactors several client-side functions to improve code consistency and readability. - Standardizes function descriptions by removing redundant "Function: forge_client..." prefixes and "[Description]" sections, focusing on concise descriptions of the function's purpose. - Updates variable handling in arsenal functions to use GVAR and EGVARS for default values, improving consistency and reducing code duplication. - Removes the bank init function as it is no longer needed. - Adds a done variable to the preinit file.
Forge Arsenal Module
Overview
The Arsenal module provides a comprehensive weapon and vehicle management system for the Forge client. It includes features for managing armory items, vehicle garages, and unlock systems.
Dependencies
- forge_client_main
Authors
- J. Schmidt
- Creedcoder
- IDSolutions
Features
Armory Management
-
Armory Initialization (
fnc_initArsenal.sqf
)- Initializes the arsenal system
- Sets up necessary configurations and permissions
-
Armory Interface (
fnc_openArmory.sqf
)- Opens the armory user interface
- Provides access to weapon and equipment management
-
Item Management
- Add Armory Items (
fnc_addArmoryItem.sqf
)- Handles adding new items to the armory
- Save Unlocks (
fnc_saveUnlocks.sqf
)- Manages the persistence of unlocked items
- Update Unlocks (
fnc_updateUnlocks.sqf
)- Updates the unlock status of items
- Add Armory Items (
Vehicle Management
- Garage System
- Open Garage (
fnc_openGarage.sqf
)- Provides access to the vehicle garage interface
- Add Garage Vehicle (
fnc_addGarageVehicle.sqf
)- Handles adding new vehicles to the garage
- Add Virtual Vehicles (
fnc_addVirtualVehicles.sqf
)- Manages virtual vehicle entries in the garage
- Open Garage (
Event Handlers
The module uses several event handlers for initialization and execution:
XEH_preInit.sqf
: Pre-initialization setupXEH_postInit.sqf
: Post-initialization tasksXEH_preStart.sqf
: Pre-start configurationXEH_postInit_client.sqf
: Client-specific post-initializationXEH_preInit_server.sqf
: Server-specific pre-initialization
Usage
To use the arsenal module:
- Ensure the module is properly loaded in your mission
- Access the armory through the provided UI for weapon management
- Use the garage interface for vehicle management
- Manage unlocks and permissions through the appropriate functions
Debugging
Debug mode can be enabled by uncommenting the following in script_component.hpp
:
#define DEBUG_MODE_FULL
Version Information
Version information is managed through the main Forge client system configuration.