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

1.9 KiB

Raw Blame History

Forge Medical Module

Overview

The Medical module provides a comprehensive medical system for the Forge client. It includes features for handling player health, death, respawn, and medical costs.

Dependencies

forge_client_main

Authors

J. Schmidt
Creedcoder
IDSolutions

Features

Medical System

Medical Initialization (fnc_initMedical.sqf)
- Initializes the medical system
- Sets up necessary configurations and health monitoring
Health Management
- Heart Beat (fnc_heartBeat.sqf)
  - Monitors player vital signs
- On Killed (fnc_onKilled.sqf)
  - Handles player death events
- On Respawn (fnc_onRespawn.sqf)
  - Manages player respawn process
Inventory Management
- Move Inventory (fnc_moveInventory.sqf)
  - Handles inventory transfers during medical events
- Save Dropped Weapons (fnc_saveDroppedWeapons.sqf)
  - Manages weapon preservation on death
Medical Costs
- Deduct Medical Cost (fnc_deductMedicalCost.sqf)
  - Handles medical service payments

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 medical module:

Ensure the module is properly loaded in your mission
Monitor player health through the medical system
Handle medical events using the appropriate functions
Manage medical costs and inventory during medical events

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.

1.9 KiB Raw Blame History