IDSolutions/client
2
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects 1 Releases 28 Wiki Activity
client/addons/service
History
Jacob Schmidt 21beefe668 feat: Enhance documentation and update variable names 
This commit introduces several enhancements to the Forge client, including improved documentation for the Garage and Locker modules, updates to variable names for consistency, and additions to the .gitignore file.

The following changes were made:

- **Garage and Locker Modules:** Added comprehensive README.md files to the Garage and Locker modules, providing overviews, dependency information, author details, feature descriptions, event handler usage, debugging instructions, and version information.
- **Variable Name Consistency:** Updated variable names in `fnc_playerDBSave.sqf` and `fnc_firstLogin.sqf` to use the `FORGE_PayGrade` constant instead of `Paygrade` for consistency with the Forge naming conventions.
- **.gitignore:** Added `/api` to the .gitignore file to exclude the Forge API directory from version control.
2025-04-05 16:51:53 -05:00
..
functions
feat: Refactor and document client-side functions
2025-04-05 16:12:32 -05:00
$PBOPREFIX$
Initial Repo Setup
2025-01-01 14:35:12 -06:00
CfgEventHandlers.hpp
Initial Repo Setup
2025-01-01 14:35:12 -06:00
config.cpp
Initial Repo Setup
2025-01-01 14:35:12 -06:00
README.md
feat: Enhance documentation and update variable names
2025-04-05 16:51:53 -05:00
script_component.hpp
Initial Repo Setup
2025-01-01 14:35:12 -06:00
XEH_postInit_client.sqf
Initial Repo Setup
2025-01-01 14:35:12 -06:00
XEH_postInit.sqf
Initial Repo Setup
2025-01-01 14:35:12 -06:00
XEH_preInit_server.sqf
Initial Repo Setup
2025-01-01 14:35:12 -06:00
XEH_preInit.sqf
Initial Repo Setup
2025-01-01 14:35:12 -06:00
XEH_PREP.hpp
Major Hotfix 01042025@1925
2025-01-04 19:26:35 -06:00
XEH_preStart.sqf
Initial Repo Setup
2025-01-01 14:35:12 -06:00

README.md

Forge Service Module

Overview

The Service module provides a comprehensive vehicle service system for the Forge client. It includes features for vehicle repair, refueling, rearming, and general maintenance.

Dependencies

  • forge_client_main

Authors

  • J. Schmidt
  • Creedcoder
  • IDSolutions

Features

Service System

  1. Service Initialization (fnc_initService.sqf)

    • Initializes the service system
    • Sets up necessary configurations and service points

  2. Vehicle Maintenance

    • Repair (fnc_repair.sqf)
      • Handles vehicle repair operations
    • Refuel (fnc_refuel.sqf)
      • Manages vehicle refueling
    • Rearm (fnc_rearm.sqf)
      • Handles vehicle rearming
    • Fuel (fnc_fuel.sqf)
      • Manages fuel system operations

  3. Vehicle Service (fnc_vehicle.sqf)

    • Comprehensive vehicle service management
    • Coordinates different service operations

Event Handlers

The module uses several event handlers for initialization and execution:

  • XEH_preInit.sqf: Pre-initialization setup
  • XEH_postInit.sqf: Post-initialization tasks
  • XEH_preStart.sqf: Pre-start configuration
  • XEH_postInit_client.sqf: Client-specific post-initialization
  • XEH_preInit_server.sqf: Server-specific pre-initialization

Usage

To use the service module:

  1. Ensure the module is properly loaded in your mission
  2. Access service points through the provided functions
  3. Perform vehicle maintenance using the appropriate functions
  4. Monitor vehicle status and service operations

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.