feat: Enhance module documentation and features
All checks were successful
Build / Build (push) Successful in 28s
All checks were successful
Build / Build (push) Successful in 28s
This commit updates the documentation for several Forge modules, adding comprehensive details about their functionalities, user interfaces, and integration with other systems. Key enhancements include: - Expanded descriptions for the Admin, Arsenal, Bank, Garage, Interaction, Locker, Medical, Organization, Service, Store, and other modules. - Added new features such as financial operations, user interface improvements, and integration with organization systems. - Improved clarity on usage instructions and configuration options across modules. These changes aim to provide better guidance for users and developers interacting with the Forge client system.
This commit is contained in:
parent
dfaddaa279
commit
9936d6ddc3
@ -1,7 +1,7 @@
|
|||||||
# Forge Admin Module
|
# Forge Admin Module
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The Admin module provides administrative functionality for the Forge client system. It includes features for user management, messaging, and administrative controls.
|
The Admin module provides comprehensive administrative functionality for the Forge client system. It includes features for user management, financial operations, messaging, and administrative controls through both traditional and web-based interfaces.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- forge_client_main
|
- forge_client_main
|
||||||
@ -18,9 +18,13 @@ The Admin module provides administrative functionality for the Forge client syst
|
|||||||
- Initializes the admin system
|
- Initializes the admin system
|
||||||
- Sets up necessary permissions and configurations
|
- Sets up necessary permissions and configurations
|
||||||
|
|
||||||
2. **Admin Interface** (`fnc_openAdmin.sqf`)
|
2. **Admin Interface**
|
||||||
- Opens the administrative user interface
|
- **Traditional UI** (`fnc_openAdmin.sqf`)
|
||||||
- Provides access to administrative controls
|
- Opens the administrative user interface
|
||||||
|
- Provides access to administrative controls
|
||||||
|
- **Web-based UI** (`RscWebAdmin.hpp`)
|
||||||
|
- Modern web interface for administrative tasks
|
||||||
|
- Real-time player statistics and management
|
||||||
|
|
||||||
3. **User Management**
|
3. **User Management**
|
||||||
- **Promotion** (`fnc_adminPromote.sqf`)
|
- **Promotion** (`fnc_adminPromote.sqf`)
|
||||||
@ -30,16 +34,36 @@ The Admin module provides administrative functionality for the Forge client syst
|
|||||||
- **Refresh** (`fnc_adminRefresh.sqf`)
|
- **Refresh** (`fnc_adminRefresh.sqf`)
|
||||||
- Updates administrative permissions and states
|
- Updates administrative permissions and states
|
||||||
|
|
||||||
4. **Communication**
|
4. **Financial Operations**
|
||||||
|
- **Payday System**
|
||||||
|
- Distributes funds based on player ranks
|
||||||
|
- Configurable paygrade amounts
|
||||||
|
- **Money Management**
|
||||||
|
- Advance funds to players
|
||||||
|
- Deduct funds from players
|
||||||
|
- Global money distribution
|
||||||
|
- Company account balance tracking
|
||||||
|
|
||||||
|
5. **Communication**
|
||||||
- **Admin Messages** (`fnc_adminMessage.sqf`)
|
- **Admin Messages** (`fnc_adminMessage.sqf`)
|
||||||
- Handles administrative messaging system
|
- Handles administrative messaging system
|
||||||
|
- **Broadcast System**
|
||||||
|
- Send messages to all players
|
||||||
|
- Targeted player messaging
|
||||||
|
|
||||||
### User Interface
|
### User Interface Components
|
||||||
The module includes two main UI components:
|
1. **Traditional UI** (`RscAdmin.hpp`)
|
||||||
1. **RscCommon.hpp**
|
- Player list management
|
||||||
- Common UI elements and definitions
|
- Rank selection and promotion
|
||||||
2. **RscAdmin.hpp**
|
- Financial operations
|
||||||
- Administrative interface specific elements
|
- Messaging system
|
||||||
|
|
||||||
|
2. **Web Interface** (`ui/_site/`)
|
||||||
|
- Modern, responsive design
|
||||||
|
- Real-time statistics
|
||||||
|
- Player management
|
||||||
|
- Financial operations
|
||||||
|
- Messaging system
|
||||||
|
|
||||||
## Event Handlers
|
## Event Handlers
|
||||||
The module uses several event handlers for initialization and execution:
|
The module uses several event handlers for initialization and execution:
|
||||||
@ -50,7 +74,9 @@ The module uses several event handlers for initialization and execution:
|
|||||||
## Usage
|
## Usage
|
||||||
To use the admin module:
|
To use the admin module:
|
||||||
1. Ensure the module is properly loaded in your mission
|
1. Ensure the module is properly loaded in your mission
|
||||||
2. Access administrative functions through the provided UI
|
2. Access administrative functions through either:
|
||||||
|
- Traditional UI: Use the provided dialog interface
|
||||||
|
- Web Interface: Access through the modern web-based panel
|
||||||
3. Use appropriate administrative commands based on your role
|
3. Use appropriate administrative commands based on your role
|
||||||
|
|
||||||
## Debugging
|
## Debugging
|
||||||
@ -60,4 +86,18 @@ Debug mode can be enabled by uncommenting the following in `script_component.hpp
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Version Information
|
## Version Information
|
||||||
Version information is managed through the main Forge client system configuration.
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Security
|
||||||
|
The module includes built-in security features:
|
||||||
|
- Admin authentication
|
||||||
|
- Permission-based access control
|
||||||
|
- Secure financial transactions
|
||||||
|
- Protected administrative functions
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Supports both traditional Arma 3 UI and modern web interface
|
||||||
|
- Real-time data updates
|
||||||
|
- Configurable paygrade system
|
||||||
|
- Comprehensive player management
|
||||||
|
- Secure financial operations
|
74
addons/ambient/README.md
Normal file
74
addons/ambient/README.md
Normal file
@ -0,0 +1,74 @@
|
|||||||
|
# Forge Ambient Module
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The Ambient module provides environmental sound management for the Forge client system. It enables the creation and management of ambient sound effects in the game environment, enhancing the immersive experience for players.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Sound Management
|
||||||
|
1. **Ambient Sound System** (`fnc_ambientSound.sqf`)
|
||||||
|
- Creates and manages sound sources in the game world
|
||||||
|
- Handles sound effect playback and cleanup
|
||||||
|
- Supports timed and continuous sound effects
|
||||||
|
|
||||||
|
2. **Sound Source Features**
|
||||||
|
- Dynamic sound source creation
|
||||||
|
- Position-based sound placement
|
||||||
|
- Automatic cleanup of sound sources
|
||||||
|
- Support for various sound types and durations
|
||||||
|
|
||||||
|
3. **Sound Control**
|
||||||
|
- Lifecycle management of sound sources
|
||||||
|
- Automatic cleanup when source is destroyed
|
||||||
|
- Configurable sound duration
|
||||||
|
- Position tracking for moving sound sources
|
||||||
|
|
||||||
|
## 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 ambient module:
|
||||||
|
1. Ensure the module is properly loaded in your mission
|
||||||
|
2. Create sound sources using the ambient sound function:
|
||||||
|
```sqf
|
||||||
|
[source, "sfx_sound_name"] spawn forge_client_ambient_fnc_ambientSound
|
||||||
|
```
|
||||||
|
3. Optionally specify a duration for temporary sounds:
|
||||||
|
```sqf
|
||||||
|
[source, "sfx_sound_name", duration] spawn forge_client_ambient_fnc_ambientSound
|
||||||
|
```
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
The ambient sound function accepts the following parameters:
|
||||||
|
1. `source`: The object or position where the sound will be played
|
||||||
|
2. `sfx`: The name of the sound effect to play
|
||||||
|
3. `time` (optional): Duration in seconds before the sound is removed
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Supports both object-attached and position-based sound sources
|
||||||
|
- Automatic cleanup of sound sources when source is destroyed
|
||||||
|
- Configurable sound duration for temporary effects
|
||||||
|
- Efficient sound source management
|
||||||
|
- Client-side sound processing
|
@ -1,7 +1,7 @@
|
|||||||
# Forge Arsenal Module
|
# Forge Arsenal Module
|
||||||
|
|
||||||
## Overview
|
## 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.
|
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, with support for both traditional and virtual arsenals.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- forge_client_main
|
- forge_client_main
|
||||||
@ -17,27 +17,52 @@ The Arsenal module provides a comprehensive weapon and vehicle management system
|
|||||||
1. **Armory Initialization** (`fnc_initArsenal.sqf`)
|
1. **Armory Initialization** (`fnc_initArsenal.sqf`)
|
||||||
- Initializes the arsenal system
|
- Initializes the arsenal system
|
||||||
- Sets up necessary configurations and permissions
|
- Sets up necessary configurations and permissions
|
||||||
|
- Configures default armory and garage data
|
||||||
|
- Supports both traditional and virtual arsenal types
|
||||||
|
|
||||||
2. **Armory Interface** (`fnc_openArmory.sqf`)
|
2. **Armory Interface** (`fnc_openArmory.sqf`)
|
||||||
- Opens the armory user interface
|
- Opens the armory user interface
|
||||||
- Provides access to weapon and equipment management
|
- Provides access to weapon and equipment management
|
||||||
|
- Supports both traditional and ACE arsenal interfaces
|
||||||
|
|
||||||
3. **Item Management**
|
3. **Item Management**
|
||||||
- **Add Armory Items** (`fnc_addArmoryItem.sqf`)
|
- **Add Armory Items** (`fnc_addArmoryItem.sqf`)
|
||||||
- Handles adding new items to the armory
|
- Handles adding new items to the armory
|
||||||
|
- Supports multiple item types:
|
||||||
|
- Facewear (goggles, masks)
|
||||||
|
- Headgear (helmets, caps)
|
||||||
|
- HMD (night vision devices)
|
||||||
|
- Items (tools, medical supplies)
|
||||||
|
- Uniforms
|
||||||
|
- Vests
|
||||||
|
- Weapons
|
||||||
|
- Magazines
|
||||||
|
- Backpacks
|
||||||
- **Save Unlocks** (`fnc_saveUnlocks.sqf`)
|
- **Save Unlocks** (`fnc_saveUnlocks.sqf`)
|
||||||
- Manages the persistence of unlocked items
|
- Manages the persistence of unlocked items
|
||||||
|
- Integrates with player database system
|
||||||
- **Update Unlocks** (`fnc_updateUnlocks.sqf`)
|
- **Update Unlocks** (`fnc_updateUnlocks.sqf`)
|
||||||
- Updates the unlock status of items
|
- Updates the unlock status of items
|
||||||
|
- Maintains synchronization between client and server
|
||||||
|
|
||||||
### Vehicle Management
|
### Vehicle Management
|
||||||
1. **Garage System**
|
1. **Garage System**
|
||||||
- **Open Garage** (`fnc_openGarage.sqf`)
|
- **Open Garage** (`fnc_openGarage.sqf`)
|
||||||
- Provides access to the vehicle garage interface
|
- Provides access to the vehicle garage interface
|
||||||
|
- Categorizes vehicles by type
|
||||||
- **Add Garage Vehicle** (`fnc_addGarageVehicle.sqf`)
|
- **Add Garage Vehicle** (`fnc_addGarageVehicle.sqf`)
|
||||||
- Handles adding new vehicles to the garage
|
- Handles adding new vehicles to the garage
|
||||||
|
- Supports vehicle categories:
|
||||||
|
- Cars
|
||||||
|
- Armored vehicles
|
||||||
|
- Helicopters
|
||||||
|
- Planes
|
||||||
|
- Naval vessels
|
||||||
|
- Static weapons
|
||||||
- **Add Virtual Vehicles** (`fnc_addVirtualVehicles.sqf`)
|
- **Add Virtual Vehicles** (`fnc_addVirtualVehicles.sqf`)
|
||||||
- Manages virtual vehicle entries in the garage
|
- Manages virtual vehicle entries in the garage
|
||||||
|
- Automatically categorizes vehicles by type
|
||||||
|
- Maintains vehicle model information
|
||||||
|
|
||||||
## Event Handlers
|
## Event Handlers
|
||||||
The module uses several event handlers for initialization and execution:
|
The module uses several event handlers for initialization and execution:
|
||||||
@ -54,6 +79,27 @@ To use the arsenal module:
|
|||||||
3. Use the garage interface for vehicle management
|
3. Use the garage interface for vehicle management
|
||||||
4. Manage unlocks and permissions through the appropriate functions
|
4. Manage unlocks and permissions through the appropriate functions
|
||||||
|
|
||||||
|
## Item Types
|
||||||
|
The module supports various item categories:
|
||||||
|
- Weapons (Primary, Secondary, Handgun)
|
||||||
|
- Magazines
|
||||||
|
- Items (Tools, Medical, etc.)
|
||||||
|
- Uniforms
|
||||||
|
- Vests
|
||||||
|
- Backpacks
|
||||||
|
- Facewear
|
||||||
|
- Headgear
|
||||||
|
- HMD (Night Vision)
|
||||||
|
|
||||||
|
## Vehicle Categories
|
||||||
|
Vehicles are organized into the following categories:
|
||||||
|
1. Cars (Light vehicles, transport)
|
||||||
|
2. Armor (Tanks, APCs)
|
||||||
|
3. Helicopters (All rotary-wing aircraft)
|
||||||
|
4. Planes (Fixed-wing aircraft)
|
||||||
|
5. Naval (Boats, ships)
|
||||||
|
6. Static (Weapons, emplacements)
|
||||||
|
|
||||||
## Debugging
|
## Debugging
|
||||||
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
```cpp
|
```cpp
|
||||||
@ -61,4 +107,13 @@ Debug mode can be enabled by uncommenting the following in `script_component.hpp
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Version Information
|
## Version Information
|
||||||
Version information is managed through the main Forge client system configuration.
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Supports both traditional Arma 3 arsenal and ACE arsenal systems
|
||||||
|
- Automatic vehicle categorization based on class inheritance
|
||||||
|
- Persistent unlock system with database integration
|
||||||
|
- Efficient item and vehicle management
|
||||||
|
- Client-server synchronization for unlocks
|
||||||
|
- Integration with the locker system for item storage
|
||||||
|
- Support for virtual and physical vehicle spawning
|
@ -1,7 +1,7 @@
|
|||||||
# Forge Bank Module
|
# Forge Bank Module
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The Bank module provides a comprehensive banking system for the Forge client. It includes features for managing player finances, transfers, and timesheet functionality.
|
The Bank module provides a comprehensive banking system for the Forge client. It includes features for managing player finances, transfers, and timesheet functionality, with a modern web-based interface for seamless user experience.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- forge_client_main
|
- forge_client_main
|
||||||
@ -17,39 +17,70 @@ The Bank module provides a comprehensive banking system for the Forge client. It
|
|||||||
1. **Bank Initialization** (`fnc_initBank.sqf`)
|
1. **Bank Initialization** (`fnc_initBank.sqf`)
|
||||||
- Initializes the banking system
|
- Initializes the banking system
|
||||||
- Sets up necessary configurations and account structures
|
- Sets up necessary configurations and account structures
|
||||||
|
- Configures player account data and balances
|
||||||
|
- Handles server-side synchronization
|
||||||
|
|
||||||
2. **Bank Interface** (`fnc_openBank.sqf`)
|
2. **Bank Interface** (`fnc_openBank.sqf`)
|
||||||
- Opens the banking user interface
|
- Opens the banking user interface
|
||||||
- Provides access to all banking functions
|
- Provides access to all banking functions
|
||||||
|
- Modern web-based UI with real-time updates
|
||||||
|
- Responsive design for optimal user experience
|
||||||
|
|
||||||
3. **Transaction Management**
|
3. **Transaction Management**
|
||||||
- **Deposit** (`fnc_deposit.sqf`)
|
- **Deposit** (`fnc_deposit.sqf`)
|
||||||
- Handles money deposits into bank accounts
|
- Handles money deposits into bank accounts
|
||||||
|
- Validates transaction amounts
|
||||||
|
- Updates account balances in real-time
|
||||||
- **Withdraw** (`fnc_withdraw.sqf`)
|
- **Withdraw** (`fnc_withdraw.sqf`)
|
||||||
- Manages money withdrawals from bank accounts
|
- Manages money withdrawals from bank accounts
|
||||||
|
- Ensures sufficient funds
|
||||||
|
- Updates wallet balance immediately
|
||||||
- **Transfer** (`fnc_transfer.sqf`)
|
- **Transfer** (`fnc_transfer.sqf`)
|
||||||
- Handles money transfers between players
|
- Handles money transfers between players
|
||||||
|
- Validates recipient and amount
|
||||||
|
- Supports both account-to-account and wallet transfers
|
||||||
- **Submit** (`fnc_submit.sqf`)
|
- **Submit** (`fnc_submit.sqf`)
|
||||||
- Processes transaction submissions
|
- Processes transaction submissions
|
||||||
|
- Handles timesheet submissions
|
||||||
|
- Manages pending payments
|
||||||
- **Refresh** (`fnc_refresh.sqf`)
|
- **Refresh** (`fnc_refresh.sqf`)
|
||||||
- Updates account information and balances
|
- Updates account information and balances
|
||||||
|
- Synchronizes with server data
|
||||||
|
- Updates UI elements
|
||||||
|
|
||||||
### User Interface
|
### User Interface
|
||||||
The module includes several UI components:
|
The module includes a modern web-based interface with:
|
||||||
1. **Base Controls** (`BaseControls.hpp`)
|
1. **Account Overview**
|
||||||
- Common UI elements and definitions
|
- Current wallet balance
|
||||||
2. **Bank Dialog** (`RscBankDialog.hpp`)
|
- Bank account balance
|
||||||
- Banking interface specific elements
|
- Pending payments
|
||||||
|
- Transaction history
|
||||||
|
|
||||||
### Interface Elements
|
2. **Transaction Features**
|
||||||
The module defines several UI control IDs:
|
- Transfer between wallet and account
|
||||||
- Account Information Display
|
- Player-to-player transfers
|
||||||
- Amount Input Fields
|
- Timesheet submission
|
||||||
- Player Selection
|
- Transaction history view
|
||||||
- Transaction Buttons (Deposit, Withdraw, Transfer)
|
|
||||||
- Wallet and Bank Balance Displays
|
3. **UI Components**
|
||||||
- Rating System
|
- Real-time balance updates
|
||||||
- Timesheet Integration
|
- Transaction notifications
|
||||||
|
- Input validation
|
||||||
|
- Error handling
|
||||||
|
- Responsive design
|
||||||
|
|
||||||
|
### Timesheet System
|
||||||
|
1. **Rating Integration**
|
||||||
|
- Tracks player rating
|
||||||
|
- Calculates pending payments
|
||||||
|
- Automatic payment processing
|
||||||
|
- Rating reset after submission
|
||||||
|
|
||||||
|
2. **Payment Processing**
|
||||||
|
- Automatic calculation based on rating
|
||||||
|
- Configurable payment multiplier
|
||||||
|
- Pending payment tracking
|
||||||
|
- Instant payment processing
|
||||||
|
|
||||||
## Event Handlers
|
## Event Handlers
|
||||||
The module uses several event handlers for initialization and execution:
|
The module uses several event handlers for initialization and execution:
|
||||||
@ -63,8 +94,12 @@ The module uses several event handlers for initialization and execution:
|
|||||||
To use the bank module:
|
To use the bank module:
|
||||||
1. Ensure the module is properly loaded in your mission
|
1. Ensure the module is properly loaded in your mission
|
||||||
2. Access the bank through the provided UI
|
2. Access the bank through the provided UI
|
||||||
3. Perform transactions using the appropriate functions
|
3. Perform transactions using the appropriate functions:
|
||||||
4. Monitor account status and transactions
|
- Transfer money between wallet and account
|
||||||
|
- Send money to other players
|
||||||
|
- Submit timesheets for payment
|
||||||
|
- View transaction history
|
||||||
|
4. Monitor account status and transactions in real-time
|
||||||
|
|
||||||
## Debugging
|
## Debugging
|
||||||
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
@ -73,4 +108,16 @@ Debug mode can be enabled by uncommenting the following in `script_component.hpp
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Version Information
|
## Version Information
|
||||||
Version information is managed through the main Forge client system configuration.
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Web-based interface using HTML5, CSS3, and JavaScript
|
||||||
|
- Real-time data synchronization with server
|
||||||
|
- Secure transaction processing
|
||||||
|
- Client-server event system
|
||||||
|
- Persistent data storage
|
||||||
|
- Rating-based payment system
|
||||||
|
- Transaction history tracking
|
||||||
|
- Input validation and error handling
|
||||||
|
- Responsive UI design
|
||||||
|
- Cross-browser compatibility
|
114
addons/briefing/README.md
Normal file
114
addons/briefing/README.md
Normal file
@ -0,0 +1,114 @@
|
|||||||
|
# Forge Briefing Module
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The Briefing module provides a comprehensive presentation and lecture system for the Forge client. It includes features for creating interactive slideshows, managing presentations, and delivering lectures with synchronized audio and visual elements.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Presentation System
|
||||||
|
1. **Slide Show Management** (`fnc_initSlideShow.sqf`)
|
||||||
|
- Initializes interactive slide shows
|
||||||
|
- Configures display screens and controllers
|
||||||
|
- Sets up image sequences and timing
|
||||||
|
- Manages presentation flow and transitions
|
||||||
|
|
||||||
|
2. **Presentation Controls**
|
||||||
|
- **Start Slide Show** (`fnc_startSlideShow.sqf`)
|
||||||
|
- Initiates the presentation sequence
|
||||||
|
- Synchronizes audio and visual elements
|
||||||
|
- Manages presentation state
|
||||||
|
- **Next Image** (`fnc_nextImage.sqf`)
|
||||||
|
- Advances to the next slide
|
||||||
|
- Updates display screens
|
||||||
|
- Maintains presentation state
|
||||||
|
- **Previous Image** (`fnc_prevImage.sqf`)
|
||||||
|
- Returns to the previous slide
|
||||||
|
- Updates display screens
|
||||||
|
- Maintains presentation state
|
||||||
|
- **End Slide Show** (`fnc_endSlideShow.sqf`)
|
||||||
|
- Terminates the presentation
|
||||||
|
- Cleans up resources
|
||||||
|
- Resets presentation state
|
||||||
|
|
||||||
|
3. **Lecture System**
|
||||||
|
- **Spawn Lecture** (`fnc_spawnLecture.sqf`)
|
||||||
|
- Initiates AI-driven lectures
|
||||||
|
- Manages speaker animations
|
||||||
|
- Controls presentation timing
|
||||||
|
- **Spawn Presentation** (`fnc_spawnPresentation.sqf`)
|
||||||
|
- Creates automated presentations
|
||||||
|
- Manages slide timing
|
||||||
|
- Controls visual transitions
|
||||||
|
|
||||||
|
### Presentation Features
|
||||||
|
1. **Interactive Controls**
|
||||||
|
- Manual slide navigation
|
||||||
|
- Auto-scroll capability
|
||||||
|
- Presentation state management
|
||||||
|
- Speaker control integration
|
||||||
|
|
||||||
|
2. **Visual Elements**
|
||||||
|
- Multiple display screen support
|
||||||
|
- Synchronized image transitions
|
||||||
|
- Customizable timing
|
||||||
|
- Power-of-2 image optimization
|
||||||
|
|
||||||
|
3. **Audio Integration**
|
||||||
|
- Speaker synchronization
|
||||||
|
- Topic-based conversations
|
||||||
|
- Sentence-specific playback
|
||||||
|
- Multi-speaker support
|
||||||
|
|
||||||
|
## 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 briefing module:
|
||||||
|
1. Ensure the module is properly loaded in your mission
|
||||||
|
2. Set up presentation screens and controllers
|
||||||
|
3. Configure slide shows or lectures:
|
||||||
|
```sqf
|
||||||
|
// Initialize a slide show
|
||||||
|
[Screen01, [Controller01], ["images/folder/image.paa"]] call forge_client_briefing_fnc_initSlideShow;
|
||||||
|
|
||||||
|
// Start a lecture
|
||||||
|
[player, "topic", "sentence"] call forge_client_briefing_fnc_spawnLecture;
|
||||||
|
|
||||||
|
// Create a presentation
|
||||||
|
[screen, [["texture.paa", 5]]] call forge_client_briefing_fnc_spawnPresentation;
|
||||||
|
```
|
||||||
|
4. Control the presentation using the provided functions
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Support for multiple display screens
|
||||||
|
- Synchronized audio-visual presentations
|
||||||
|
- Interactive control system
|
||||||
|
- AI-driven lecture capabilities
|
||||||
|
- Power-of-2 image optimization
|
||||||
|
- State management for presentations
|
||||||
|
- Multi-speaker support
|
||||||
|
- Customizable timing controls
|
||||||
|
- Resource cleanup on completion
|
||||||
|
- Error handling and validation
|
125
addons/db/README.md
Normal file
125
addons/db/README.md
Normal file
@ -0,0 +1,125 @@
|
|||||||
|
# Forge Database Module
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The Database module provides a comprehensive data persistence system for the Forge client. It includes features for managing player data, organization information, and game state persistence using the ArmaDragonflyClient database system.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
- ArmaDragonflyClient
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Database System
|
||||||
|
1. **Server Communication** (`fnc_requestServerDB.sqf`)
|
||||||
|
- Handles client-server database communication
|
||||||
|
- Manages asynchronous database operations
|
||||||
|
- Provides callback support for data retrieval
|
||||||
|
- Ensures data consistency across clients
|
||||||
|
|
||||||
|
2. **Data Management**
|
||||||
|
- **Player Data**
|
||||||
|
- Armory unlocks
|
||||||
|
- Garage unlocks
|
||||||
|
- Locker contents
|
||||||
|
- Vehicle inventory
|
||||||
|
- Financial information
|
||||||
|
- Contact details
|
||||||
|
- Organization membership
|
||||||
|
- Player statistics
|
||||||
|
- Equipment loadouts
|
||||||
|
- Position and state
|
||||||
|
|
||||||
|
- **Organization Data**
|
||||||
|
- Member information
|
||||||
|
- Asset tracking
|
||||||
|
- Financial records
|
||||||
|
- Reputation system
|
||||||
|
- Activity logs
|
||||||
|
- Creation timestamps
|
||||||
|
- Modification history
|
||||||
|
|
||||||
|
3. **Persistence Features**
|
||||||
|
- Automatic data saving
|
||||||
|
- Periodic state synchronization
|
||||||
|
- Data validation and sanitization
|
||||||
|
- Error recovery mechanisms
|
||||||
|
- Transaction logging
|
||||||
|
- Data versioning
|
||||||
|
|
||||||
|
### Data Operations
|
||||||
|
1. **Storage Operations**
|
||||||
|
- Hash-based storage (HSET)
|
||||||
|
- Bulk data operations
|
||||||
|
- Atomic transactions
|
||||||
|
- Data serialization
|
||||||
|
- String normalization
|
||||||
|
|
||||||
|
2. **Retrieval Operations**
|
||||||
|
- Hash-based retrieval (HGET)
|
||||||
|
- Bulk data loading
|
||||||
|
- Data deserialization
|
||||||
|
- Error handling
|
||||||
|
- Default value management
|
||||||
|
|
||||||
|
3. **Synchronization**
|
||||||
|
- Client-server sync
|
||||||
|
- Real-time updates
|
||||||
|
- Conflict resolution
|
||||||
|
- State verification
|
||||||
|
- Data integrity checks
|
||||||
|
|
||||||
|
## 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 database module:
|
||||||
|
1. Ensure the module is properly loaded in your mission
|
||||||
|
2. Initialize database connections
|
||||||
|
3. Perform database operations:
|
||||||
|
```sqf
|
||||||
|
// Request data from server
|
||||||
|
["hgetall", "Hello World!", {
|
||||||
|
systemChat format ["Message: %1", _this];
|
||||||
|
}] call forge_db_fnc_requestServerDB;
|
||||||
|
|
||||||
|
// Save player data
|
||||||
|
[] call forge_client_init_fnc_playerDBSave;
|
||||||
|
|
||||||
|
// Load player data
|
||||||
|
[] call forge_client_init_fnc_playerDBLoad;
|
||||||
|
```
|
||||||
|
4. Handle database callbacks and responses
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Asynchronous database operations
|
||||||
|
- Callback-based response handling
|
||||||
|
- Data serialization and normalization
|
||||||
|
- Error handling and recovery
|
||||||
|
- Transaction logging
|
||||||
|
- State management
|
||||||
|
- Data validation
|
||||||
|
- Conflict resolution
|
||||||
|
- Real-time synchronization
|
||||||
|
- Bulk operation support
|
||||||
|
- Atomic transactions
|
||||||
|
- Data versioning
|
||||||
|
- Integrity verification
|
90
addons/dialogue/README.md
Normal file
90
addons/dialogue/README.md
Normal file
@ -0,0 +1,90 @@
|
|||||||
|
# Forge Dialogue Module
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The Dialogue module provides a comprehensive AI conversation system for the Forge client. It enables dynamic interactions between players and AI units, supporting topic-based conversations, sentence management, and AI behavior control.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### AI Dialogue System
|
||||||
|
1. **AI Selection** (`fnc_selectAI.sqf`)
|
||||||
|
- Manages AI unit selection for dialogue
|
||||||
|
- Controls AI behavior during conversations
|
||||||
|
- Handles unit state management
|
||||||
|
- Disables AI actions during dialogue
|
||||||
|
|
||||||
|
2. **Dialogue Management** (`fnc_selectDialogue.sqf`)
|
||||||
|
- Topic-based conversation system
|
||||||
|
- Sentence management and playback
|
||||||
|
- AI unit synchronization
|
||||||
|
- Conversation flow control
|
||||||
|
|
||||||
|
3. **Conversation Features**
|
||||||
|
- **Topic Management**
|
||||||
|
- Dynamic topic selection
|
||||||
|
- Context-aware conversations
|
||||||
|
- Topic-based responses
|
||||||
|
- Conversation branching
|
||||||
|
|
||||||
|
- **Sentence Control**
|
||||||
|
- Sentence playback
|
||||||
|
- Timing management
|
||||||
|
- Response coordination
|
||||||
|
- Conversation state tracking
|
||||||
|
|
||||||
|
- **AI Behavior**
|
||||||
|
- Animation control
|
||||||
|
- Movement management
|
||||||
|
- State synchronization
|
||||||
|
- Interaction handling
|
||||||
|
|
||||||
|
## 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 dialogue module:
|
||||||
|
1. Ensure the module is properly loaded in your mission
|
||||||
|
2. Select AI units for dialogue:
|
||||||
|
```sqf
|
||||||
|
// Select AI units for dialogue
|
||||||
|
[units group player] call forge_client_dialogue_fnc_selectAI;
|
||||||
|
|
||||||
|
// Select specific dialogue for AI
|
||||||
|
[units, [["topic", "sentence"]]] call forge_client_dialogue_fnc_selectDialogue;
|
||||||
|
```
|
||||||
|
3. Manage conversation flow and AI behavior
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Topic-based conversation system
|
||||||
|
- AI behavior control
|
||||||
|
- Sentence management
|
||||||
|
- State synchronization
|
||||||
|
- Animation handling
|
||||||
|
- Movement control
|
||||||
|
- Interaction management
|
||||||
|
- Conversation flow control
|
||||||
|
- Response coordination
|
||||||
|
- Error handling
|
||||||
|
- Debug support
|
||||||
|
- Event system integration
|
@ -1,7 +1,7 @@
|
|||||||
# Forge Garage Module
|
# Forge Garage Module
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The Garage module provides a comprehensive vehicle management system for the Forge client. It includes features for storing, spawning, and managing vehicles in a garage environment.
|
The Garage module provides a comprehensive vehicle management system for the Forge client. It includes features for storing, spawning, and managing vehicles in a garage environment, with support for various vehicle types and states.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- forge_client_main
|
- forge_client_main
|
||||||
@ -16,21 +16,72 @@ The Garage module provides a comprehensive vehicle management system for the For
|
|||||||
### Garage System
|
### Garage System
|
||||||
1. **Garage Initialization** (`fnc_initGarage.sqf`)
|
1. **Garage Initialization** (`fnc_initGarage.sqf`)
|
||||||
- Initializes the garage system
|
- Initializes the garage system
|
||||||
- Sets up necessary configurations and vehicle storage
|
- Sets up vehicle storage and management
|
||||||
|
- Configures garage locations and spawn points
|
||||||
|
- Manages vehicle state persistence
|
||||||
|
|
||||||
2. **Garage Interface** (`fnc_openGarage.sqf`)
|
2. **Vehicle Management**
|
||||||
- Opens the garage user interface
|
|
||||||
- Provides access to vehicle management functions
|
|
||||||
|
|
||||||
3. **Vehicle Management**
|
|
||||||
- **Spawn Vehicle** (`fnc_spawnVehicle.sqf`)
|
- **Spawn Vehicle** (`fnc_spawnVehicle.sqf`)
|
||||||
- Handles vehicle spawning from garage
|
- Handles vehicle spawning from garage
|
||||||
|
- Manages spawn locations and orientations
|
||||||
|
- Preserves vehicle type information
|
||||||
|
- Updates garage inventory
|
||||||
|
|
||||||
- **Store Vehicle** (`fnc_storeVehicle.sqf`)
|
- **Store Vehicle** (`fnc_storeVehicle.sqf`)
|
||||||
- Manages vehicle storage in garage
|
- Manages vehicle storage in garage
|
||||||
|
- Handles vehicle cleanup
|
||||||
|
- Updates garage inventory
|
||||||
|
- Preserves vehicle data
|
||||||
|
|
||||||
- **Fetch Garage** (`fnc_fetchGarage.sqf`)
|
- **Fetch Garage** (`fnc_fetchGarage.sqf`)
|
||||||
- Retrieves garage vehicle information
|
- Retrieves garage vehicle information
|
||||||
|
- Updates garage interface
|
||||||
|
- Manages vehicle listings
|
||||||
|
- Handles vehicle categorization
|
||||||
|
|
||||||
- **Fetch Nearby** (`fnc_fetchNearby.sqf`)
|
- **Fetch Nearby** (`fnc_fetchNearby.sqf`)
|
||||||
- Locates and manages nearby vehicles
|
- Locates and manages nearby vehicles
|
||||||
|
- Validates vehicle ownership
|
||||||
|
- Handles vehicle state checks
|
||||||
|
- Updates interface with nearby vehicles
|
||||||
|
|
||||||
|
3. **Vehicle Categories**
|
||||||
|
- Cars (Light vehicles, transport)
|
||||||
|
- Armor (Tanks, APCs)
|
||||||
|
- Helicopters (All rotary-wing aircraft)
|
||||||
|
- Planes (Fixed-wing aircraft)
|
||||||
|
- Naval (Boats, ships)
|
||||||
|
- Static (Weapons, emplacements)
|
||||||
|
|
||||||
|
4. **Vehicle States**
|
||||||
|
- Available
|
||||||
|
- In Use
|
||||||
|
- Maintenance
|
||||||
|
- Damaged
|
||||||
|
- Fuel Status
|
||||||
|
- Condition Tracking
|
||||||
|
|
||||||
|
### User Interface
|
||||||
|
1. **Garage Dialog**
|
||||||
|
- Vehicle listing and management
|
||||||
|
- Category filtering
|
||||||
|
- Status indicators
|
||||||
|
- Action buttons (Spawn/Store)
|
||||||
|
- Vehicle details display
|
||||||
|
|
||||||
|
2. **Vehicle Information**
|
||||||
|
- Vehicle name and type
|
||||||
|
- Status indicators
|
||||||
|
- Fuel level
|
||||||
|
- Damage state
|
||||||
|
- Maintenance status
|
||||||
|
- Last used timestamp
|
||||||
|
|
||||||
|
3. **Controls**
|
||||||
|
- Category filters
|
||||||
|
- Vehicle actions
|
||||||
|
- Status management
|
||||||
|
- Quick access buttons
|
||||||
|
|
||||||
## Event Handlers
|
## Event Handlers
|
||||||
The module uses several event handlers for initialization and execution:
|
The module uses several event handlers for initialization and execution:
|
||||||
@ -44,7 +95,17 @@ The module uses several event handlers for initialization and execution:
|
|||||||
To use the garage module:
|
To use the garage module:
|
||||||
1. Ensure the module is properly loaded in your mission
|
1. Ensure the module is properly loaded in your mission
|
||||||
2. Access the garage through the provided UI
|
2. Access the garage through the provided UI
|
||||||
3. Manage vehicles using the appropriate functions
|
3. Manage vehicles using the appropriate functions:
|
||||||
|
```sqf
|
||||||
|
// Open garage interface
|
||||||
|
[] call forge_client_garage_fnc_openGarage;
|
||||||
|
|
||||||
|
// Store a vehicle
|
||||||
|
[] call forge_client_garage_fnc_storeVehicle;
|
||||||
|
|
||||||
|
// Spawn a vehicle
|
||||||
|
[] call forge_client_garage_fnc_spawnVehicle;
|
||||||
|
```
|
||||||
4. Monitor vehicle status and location
|
4. Monitor vehicle status and location
|
||||||
|
|
||||||
## Debugging
|
## Debugging
|
||||||
@ -54,4 +115,18 @@ Debug mode can be enabled by uncommenting the following in `script_component.hpp
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Version Information
|
## Version Information
|
||||||
Version information is managed through the main Forge client system configuration.
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Vehicle state persistence
|
||||||
|
- Category-based organization
|
||||||
|
- Status tracking system
|
||||||
|
- Location management
|
||||||
|
- Spawn point configuration
|
||||||
|
- Vehicle cleanup handling
|
||||||
|
- Interface synchronization
|
||||||
|
- Event system integration
|
||||||
|
- Error handling
|
||||||
|
- Debug support
|
||||||
|
- Data validation
|
||||||
|
- State management
|
118
addons/init/README.md
Normal file
118
addons/init/README.md
Normal file
@ -0,0 +1,118 @@
|
|||||||
|
# Forge Initialization Module
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The Initialization module provides a comprehensive player initialization and data persistence system for the Forge client. It handles player data loading, saving, and synchronization with the database, ensuring a seamless experience across sessions.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
- ArmaDragonflyClient
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Player Initialization
|
||||||
|
1. **Player Setup** (`fnc_initPlayer.sqf`)
|
||||||
|
- Initializes player state
|
||||||
|
- Clears default equipment
|
||||||
|
- Sets up player variables
|
||||||
|
- Configures initial loadout
|
||||||
|
- Manages loading screen
|
||||||
|
|
||||||
|
2. **Data Management**
|
||||||
|
- **Player Load** (`fnc_playerDBLoad.sqf`)
|
||||||
|
- Loads player data from database
|
||||||
|
- Handles first-time login
|
||||||
|
- Restores player state
|
||||||
|
- Manages data synchronization
|
||||||
|
|
||||||
|
- **Player Save** (`fnc_playerDBSave.sqf`)
|
||||||
|
- Saves player data to database
|
||||||
|
- Manages data persistence
|
||||||
|
- Handles state synchronization
|
||||||
|
- Preserves player information
|
||||||
|
|
||||||
|
- **Save Loop** (`fnc_playerSaveLoop.sqf`)
|
||||||
|
- Periodic data saving
|
||||||
|
- Configurable save intervals
|
||||||
|
- Automatic state persistence
|
||||||
|
- Error handling
|
||||||
|
|
||||||
|
3. **Data Handling** (`fnc_handlePlayerLoad.sqf`)
|
||||||
|
- Processes loaded data
|
||||||
|
- Restores player state
|
||||||
|
- Manages default values
|
||||||
|
- Handles data validation
|
||||||
|
|
||||||
|
### Persisted Data
|
||||||
|
1. **Player Information**
|
||||||
|
- Armory unlocks
|
||||||
|
- Garage unlocks
|
||||||
|
- Locker contents
|
||||||
|
- Vehicle inventory
|
||||||
|
- Financial data (cash/bank)
|
||||||
|
- Contact details
|
||||||
|
- Organization membership
|
||||||
|
- Player statistics
|
||||||
|
- Equipment loadouts
|
||||||
|
- Position and state
|
||||||
|
|
||||||
|
2. **State Management**
|
||||||
|
- Player position
|
||||||
|
- Player direction
|
||||||
|
- Weapon state
|
||||||
|
- Stance information
|
||||||
|
- Rating/reputation
|
||||||
|
- Paygrade
|
||||||
|
- Organization status
|
||||||
|
|
||||||
|
## 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 initialization module:
|
||||||
|
1. Ensure the module is properly loaded in your mission
|
||||||
|
2. The module automatically handles player initialization
|
||||||
|
3. Access player data using the appropriate functions:
|
||||||
|
```sqf
|
||||||
|
// Initialize player
|
||||||
|
[] call forge_client_init_fnc_initPlayer;
|
||||||
|
|
||||||
|
// Load player data
|
||||||
|
[] call forge_client_init_fnc_playerDBLoad;
|
||||||
|
|
||||||
|
// Save player data
|
||||||
|
[] call forge_client_init_fnc_playerDBSave;
|
||||||
|
```
|
||||||
|
4. Monitor player state and data persistence
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Automatic player initialization
|
||||||
|
- Database integration
|
||||||
|
- Periodic data saving
|
||||||
|
- State persistence
|
||||||
|
- Error handling
|
||||||
|
- Data validation
|
||||||
|
- First-time login handling
|
||||||
|
- Default value management
|
||||||
|
- Position tracking
|
||||||
|
- Equipment management
|
||||||
|
- Financial synchronization
|
||||||
|
- Organization integration
|
@ -1,4 +1,124 @@
|
|||||||
forge_interaction
|
# Forge Interaction Module
|
||||||
===============
|
|
||||||
|
|
||||||
Core interaction addon that handles all player interactions with the game world. This system manages how players engage with objects, NPCs, items and other interactive elements in the environment.
|
## Overview
|
||||||
|
The Interaction module provides a comprehensive player interaction system for the Forge client. It manages how players engage with objects, NPCs, items, and other interactive elements in the environment through a dynamic and context-sensitive interface.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Interaction System
|
||||||
|
1. **Interaction Initialization** (`fnc_initInteraction.sqf`)
|
||||||
|
- Initializes the interaction system
|
||||||
|
- Sets up interaction buttons and items
|
||||||
|
- Configures team coordination settings
|
||||||
|
- Manages virtual arsenal integration
|
||||||
|
|
||||||
|
2. **Interaction Interface**
|
||||||
|
- **Open Interaction** (`fnc_openInteraction.sqf`)
|
||||||
|
- Opens the interaction menu
|
||||||
|
- Displays available actions
|
||||||
|
- Manages button visibility
|
||||||
|
- Handles action execution
|
||||||
|
|
||||||
|
- **Interaction Action** (`fnc_interactionAction.sqf`)
|
||||||
|
- Processes selected actions
|
||||||
|
- Executes interaction commands
|
||||||
|
- Manages action feedback
|
||||||
|
- Handles interface updates
|
||||||
|
|
||||||
|
3. **Available Interactions**
|
||||||
|
- **Player Interactions**
|
||||||
|
- Give Cash
|
||||||
|
- Add Contact
|
||||||
|
- Access ATM
|
||||||
|
- Access CPOF (Company Point of Finance)
|
||||||
|
- Take Cash
|
||||||
|
- Open Locker
|
||||||
|
- Access Store
|
||||||
|
- Open Garage
|
||||||
|
- Virtual Armory (if enabled)
|
||||||
|
- Virtual Garage (if enabled)
|
||||||
|
|
||||||
|
4. **Team Coordination**
|
||||||
|
- Company garage access
|
||||||
|
- Team-specific interactions
|
||||||
|
- Permission-based actions
|
||||||
|
- Organization integration
|
||||||
|
|
||||||
|
### User Interface
|
||||||
|
1. **Interaction Menu**
|
||||||
|
- Dynamic button display
|
||||||
|
- Context-sensitive actions
|
||||||
|
- Distance-based availability
|
||||||
|
- Permission-based options
|
||||||
|
|
||||||
|
2. **Control Elements**
|
||||||
|
- Action buttons
|
||||||
|
- Status indicators
|
||||||
|
- Feedback messages
|
||||||
|
- Error handling
|
||||||
|
|
||||||
|
## 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 interaction module:
|
||||||
|
1. Ensure the module is properly loaded in your mission
|
||||||
|
2. Access interactions using the configured key (default: TAB)
|
||||||
|
3. Interact with objects and players:
|
||||||
|
```sqf
|
||||||
|
// Open interaction menu
|
||||||
|
[] call forge_client_interaction_fnc_openInteraction;
|
||||||
|
|
||||||
|
// Initialize interaction system
|
||||||
|
[] call forge_client_interaction_fnc_initInteraction;
|
||||||
|
```
|
||||||
|
4. Monitor interaction feedback and results
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
The module can be configured through the main Forge client configuration:
|
||||||
|
```cpp
|
||||||
|
// Interaction key (default: TAB)
|
||||||
|
interactionKey = 15;
|
||||||
|
|
||||||
|
// Team coordination mode
|
||||||
|
FORGE_Team_Coord = 1;
|
||||||
|
|
||||||
|
// Virtual arsenal enable
|
||||||
|
FORGE_VA_Enable = 1;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Dynamic interaction system
|
||||||
|
- Context-sensitive actions
|
||||||
|
- Distance-based availability
|
||||||
|
- Permission management
|
||||||
|
- Team coordination
|
||||||
|
- Virtual arsenal integration
|
||||||
|
- Error handling
|
||||||
|
- User feedback
|
||||||
|
- Interface management
|
||||||
|
- Action validation
|
||||||
|
- State tracking
|
||||||
|
- Event system integration
|
@ -1,7 +1,7 @@
|
|||||||
# Forge Locker Module
|
# Forge Locker Module
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The Locker module provides a comprehensive equipment management system for the Forge client. It includes features for storing, equipping, and managing player gear in a secure locker system.
|
The Locker module provides a comprehensive equipment management system for the Forge client. It includes features for storing, equipping, and managing player gear in a secure locker system with a modern web-based interface.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- forge_client_main
|
- forge_client_main
|
||||||
@ -16,21 +16,76 @@ The Locker module provides a comprehensive equipment management system for the F
|
|||||||
### Locker System
|
### Locker System
|
||||||
1. **Locker Initialization** (`fnc_initLocker.sqf`)
|
1. **Locker Initialization** (`fnc_initLocker.sqf`)
|
||||||
- Initializes the locker system
|
- Initializes the locker system
|
||||||
- Sets up necessary configurations and storage structures
|
- Sets up storage structures
|
||||||
|
- Configures player variables
|
||||||
|
- Manages equipment tracking
|
||||||
|
|
||||||
2. **Locker Interface** (`fnc_openLocker.sqf`)
|
2. **Equipment Management**
|
||||||
- Opens the locker user interface
|
|
||||||
- Provides access to equipment management functions
|
|
||||||
|
|
||||||
3. **Equipment Management**
|
|
||||||
- **Store Gear** (`fnc_storeGear.sqf`)
|
- **Store Gear** (`fnc_storeGear.sqf`)
|
||||||
- Handles equipment storage in locker
|
- Stores equipment in locker
|
||||||
|
- Handles different item types:
|
||||||
|
- Backpacks (with contents)
|
||||||
|
- Facewear (goggles)
|
||||||
|
- Headgear
|
||||||
|
- HMD (Head Mounted Display)
|
||||||
|
- Uniforms
|
||||||
|
- Vests
|
||||||
|
- Weapons (with attachments)
|
||||||
|
- Items
|
||||||
|
- Magazines (with ammo count)
|
||||||
|
- Manages storage space
|
||||||
|
- Preserves item condition
|
||||||
|
|
||||||
- **Equip Gear** (`fnc_equipGear.sqf`)
|
- **Equip Gear** (`fnc_equipGear.sqf`)
|
||||||
- Manages equipment equipping from locker
|
- Equips items from locker
|
||||||
|
- Handles equipment compatibility
|
||||||
|
- Manages inventory space
|
||||||
|
- Preserves attachments and magazines
|
||||||
|
- Provides feedback on actions
|
||||||
|
|
||||||
|
3. **Data Management**
|
||||||
- **Fetch Locker** (`fnc_fetchLocker.sqf`)
|
- **Fetch Locker** (`fnc_fetchLocker.sqf`)
|
||||||
- Retrieves locker contents and information
|
- Retrieves locker contents
|
||||||
|
- Updates UI display
|
||||||
|
- Manages item categorization
|
||||||
|
- Handles item metadata
|
||||||
|
|
||||||
- **Fetch Player** (`fnc_fetchPlayer.sqf`)
|
- **Fetch Player** (`fnc_fetchPlayer.sqf`)
|
||||||
- Retrieves player equipment information
|
- Retrieves player equipment
|
||||||
|
- Updates UI display
|
||||||
|
- Manages equipment lists
|
||||||
|
- Handles item metadata
|
||||||
|
|
||||||
|
### User Interface
|
||||||
|
1. **Modern Web Interface**
|
||||||
|
- Responsive design
|
||||||
|
- Category filtering
|
||||||
|
- Item categorization
|
||||||
|
- Storage statistics
|
||||||
|
- Equipment details view
|
||||||
|
|
||||||
|
2. **Interface Features**
|
||||||
|
- Storage space tracking
|
||||||
|
- Item count display
|
||||||
|
- Category filters:
|
||||||
|
- All Items
|
||||||
|
- Weapons
|
||||||
|
- Clothing
|
||||||
|
- Equipment
|
||||||
|
- Magazines
|
||||||
|
- Item details:
|
||||||
|
- Name
|
||||||
|
- Category
|
||||||
|
- Condition
|
||||||
|
- Quantity
|
||||||
|
- Attachments
|
||||||
|
|
||||||
|
3. **Control Elements**
|
||||||
|
- Store button
|
||||||
|
- Equip button
|
||||||
|
- Category filters
|
||||||
|
- Item lists
|
||||||
|
- Status indicators
|
||||||
|
|
||||||
## Event Handlers
|
## Event Handlers
|
||||||
The module uses several event handlers for initialization and execution:
|
The module uses several event handlers for initialization and execution:
|
||||||
@ -43,9 +98,30 @@ The module uses several event handlers for initialization and execution:
|
|||||||
## Usage
|
## Usage
|
||||||
To use the locker module:
|
To use the locker module:
|
||||||
1. Ensure the module is properly loaded in your mission
|
1. Ensure the module is properly loaded in your mission
|
||||||
2. Access the locker through the provided UI
|
2. Access the locker through the interaction menu
|
||||||
3. Manage equipment using the appropriate functions
|
3. Manage equipment using the interface:
|
||||||
4. Monitor equipment status and storage
|
```sqf
|
||||||
|
// Open locker interface
|
||||||
|
[] call forge_client_locker_fnc_openLocker;
|
||||||
|
|
||||||
|
// Store equipment
|
||||||
|
[] call forge_client_locker_fnc_storeGear;
|
||||||
|
|
||||||
|
// Equip items
|
||||||
|
[] call forge_client_locker_fnc_equipGear;
|
||||||
|
```
|
||||||
|
4. Monitor storage space and item status
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
The module can be configured through the main Forge client configuration:
|
||||||
|
```cpp
|
||||||
|
// Locker storage space (default: 100)
|
||||||
|
FORGE_Locker_Space = 100;
|
||||||
|
|
||||||
|
// Enable/disable features
|
||||||
|
FORGE_Locker_EnableAttachments = 1;
|
||||||
|
FORGE_Locker_EnableMagazines = 1;
|
||||||
|
```
|
||||||
|
|
||||||
## Debugging
|
## Debugging
|
||||||
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
@ -54,4 +130,20 @@ Debug mode can be enabled by uncommenting the following in `script_component.hpp
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Version Information
|
## Version Information
|
||||||
Version information is managed through the main Forge client system configuration.
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Modern web-based interface
|
||||||
|
- Real-time storage tracking
|
||||||
|
- Equipment condition preservation
|
||||||
|
- Attachment management
|
||||||
|
- Magazine ammo tracking
|
||||||
|
- Category-based filtering
|
||||||
|
- Responsive UI design
|
||||||
|
- Error handling
|
||||||
|
- User feedback
|
||||||
|
- State management
|
||||||
|
- Event system integration
|
||||||
|
- Database persistence
|
||||||
|
- Inventory validation
|
||||||
|
- Space management
|
@ -1,7 +1,7 @@
|
|||||||
# Forge Medical Module
|
# Forge Medical Module
|
||||||
|
|
||||||
## Overview
|
## 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.
|
The Medical module provides a comprehensive medical system for the Forge client. It includes features for handling player health, death, respawn, medical costs, and inventory management during medical events.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- forge_client_main
|
- forge_client_main
|
||||||
@ -16,25 +16,85 @@ The Medical module provides a comprehensive medical system for the Forge client.
|
|||||||
### Medical System
|
### Medical System
|
||||||
1. **Medical Initialization** (`fnc_initMedical.sqf`)
|
1. **Medical Initialization** (`fnc_initMedical.sqf`)
|
||||||
- Initializes the medical system
|
- Initializes the medical system
|
||||||
- Sets up necessary configurations and health monitoring
|
- Sets up stretcher detection and triggers
|
||||||
|
- Configures medical service points
|
||||||
|
- Manages occupancy tracking
|
||||||
|
- Handles system variables
|
||||||
|
|
||||||
2. **Health Management**
|
2. **Health Management**
|
||||||
- **Heart Beat** (`fnc_heartBeat.sqf`)
|
- **Heart Beat** (`fnc_heartBeat.sqf`)
|
||||||
- Monitors player vital signs
|
- Monitors player vital signs
|
||||||
|
- Tracks medical costs
|
||||||
|
- Manages respawn conditions
|
||||||
|
- Handles payment verification
|
||||||
|
- Controls spectator mode
|
||||||
|
|
||||||
- **On Killed** (`fnc_onKilled.sqf`)
|
- **On Killed** (`fnc_onKilled.sqf`)
|
||||||
- Handles player death events
|
- Handles player death events
|
||||||
|
- Creates body bag
|
||||||
|
- Saves dropped weapons
|
||||||
|
- Manages inventory transfer
|
||||||
|
- Triggers respawn process
|
||||||
|
|
||||||
- **On Respawn** (`fnc_onRespawn.sqf`)
|
- **On Respawn** (`fnc_onRespawn.sqf`)
|
||||||
- Manages player respawn process
|
- Manages player respawn process
|
||||||
|
- Handles medical costs
|
||||||
|
- Sets default loadout
|
||||||
|
- Manages stretcher placement
|
||||||
|
- Controls spectator mode
|
||||||
|
- Processes payment verification
|
||||||
|
|
||||||
3. **Inventory Management**
|
3. **Inventory Management**
|
||||||
- **Move Inventory** (`fnc_moveInventory.sqf`)
|
- **Move Inventory** (`fnc_moveInventory.sqf`)
|
||||||
- Handles inventory transfers during medical events
|
- Transfers player inventory to body bag
|
||||||
|
- Handles all equipment types:
|
||||||
|
- Headgear
|
||||||
|
- Uniforms and items
|
||||||
|
- Vests and contents
|
||||||
|
- Backpacks and contents
|
||||||
|
- Weapons and attachments
|
||||||
|
- Magazines and ammo
|
||||||
|
- Assigned items
|
||||||
|
- Dropped equipment
|
||||||
|
- Manages weapon holders
|
||||||
|
- Preserves item condition
|
||||||
|
|
||||||
- **Save Dropped Weapons** (`fnc_saveDroppedWeapons.sqf`)
|
- **Save Dropped Weapons** (`fnc_saveDroppedWeapons.sqf`)
|
||||||
- Manages weapon preservation on death
|
- Tracks dropped weapons
|
||||||
|
- Manages weapon attachments
|
||||||
|
- Preserves magazine data
|
||||||
|
- Handles handgun equipment
|
||||||
|
- Stores item information
|
||||||
|
|
||||||
4. **Medical Costs**
|
4. **Medical Costs**
|
||||||
- **Deduct Medical Cost** (`fnc_deductMedicalCost.sqf`)
|
- **Deduct Medical Cost** (`fnc_deductMedicalCost.sqf`)
|
||||||
- Handles medical service payments
|
- Handles medical service payments
|
||||||
|
- Manages account selection
|
||||||
|
- Processes payment deduction
|
||||||
|
- Provides payment feedback
|
||||||
|
- Updates account balances
|
||||||
|
|
||||||
|
### Medical Features
|
||||||
|
1. **Stretcher System**
|
||||||
|
- Automatic stretcher detection
|
||||||
|
- Occupancy tracking
|
||||||
|
- Position management
|
||||||
|
- Respawn placement
|
||||||
|
- Trigger-based activation
|
||||||
|
|
||||||
|
2. **Body Bag System**
|
||||||
|
- Custom body bag class
|
||||||
|
- Increased storage capacity
|
||||||
|
- ACE dragging support
|
||||||
|
- Inventory preservation
|
||||||
|
- Equipment management
|
||||||
|
|
||||||
|
3. **Payment System**
|
||||||
|
- Insurance deductible
|
||||||
|
- Medical service costs
|
||||||
|
- Account balance checking
|
||||||
|
- Payment processing
|
||||||
|
- Transaction feedback
|
||||||
|
|
||||||
## Event Handlers
|
## Event Handlers
|
||||||
The module uses several event handlers for initialization and execution:
|
The module uses several event handlers for initialization and execution:
|
||||||
@ -48,9 +108,36 @@ The module uses several event handlers for initialization and execution:
|
|||||||
To use the medical module:
|
To use the medical module:
|
||||||
1. Ensure the module is properly loaded in your mission
|
1. Ensure the module is properly loaded in your mission
|
||||||
2. Monitor player health through the medical system
|
2. Monitor player health through the medical system
|
||||||
3. Handle medical events using the appropriate functions
|
3. Handle medical events using the appropriate functions:
|
||||||
|
```sqf
|
||||||
|
// Initialize medical system
|
||||||
|
[] call forge_client_medical_fnc_initMedical;
|
||||||
|
|
||||||
|
// Handle player death
|
||||||
|
[player, killer, instigator, true] call forge_client_medical_fnc_onKilled;
|
||||||
|
|
||||||
|
// Process respawn
|
||||||
|
[player, corpse] call forge_client_medical_fnc_onRespawn;
|
||||||
|
```
|
||||||
4. Manage medical costs and inventory during medical events
|
4. Manage medical costs and inventory during medical events
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
The module can be configured through the main Forge client configuration:
|
||||||
|
```cpp
|
||||||
|
// Medical cost (default: 1000)
|
||||||
|
MED_COST = 1000;
|
||||||
|
|
||||||
|
// Insurance deductible (default: 200)
|
||||||
|
INS_DEDUCT = 200;
|
||||||
|
|
||||||
|
// Stretcher types
|
||||||
|
FORGE_Medical_StretcherTypes = [
|
||||||
|
"Land_Stretcher_01_F",
|
||||||
|
"Land_Stretcher_01_olive_F",
|
||||||
|
"Land_Stretcher_01_sand_F"
|
||||||
|
];
|
||||||
|
```
|
||||||
|
|
||||||
## Debugging
|
## Debugging
|
||||||
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
```cpp
|
```cpp
|
||||||
@ -58,4 +145,20 @@ Debug mode can be enabled by uncommenting the following in `script_component.hpp
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Version Information
|
## Version Information
|
||||||
Version information is managed through the main Forge client system configuration.
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Stretcher-based respawn system
|
||||||
|
- Body bag inventory management
|
||||||
|
- Medical cost processing
|
||||||
|
- Insurance system integration
|
||||||
|
- Inventory preservation
|
||||||
|
- Equipment tracking
|
||||||
|
- Payment verification
|
||||||
|
- Spectator mode control
|
||||||
|
- Trigger-based activation
|
||||||
|
- Event system integration
|
||||||
|
- State management
|
||||||
|
- Error handling
|
||||||
|
- User feedback
|
||||||
|
- Database persistence
|
132
addons/misc/README.md
Normal file
132
addons/misc/README.md
Normal file
@ -0,0 +1,132 @@
|
|||||||
|
# Forge Misc Module
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The Misc module provides a collection of utility functions and features for the Forge client. It includes a notification system, string handling, number formatting, and various helper functions used throughout the client.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Notification System
|
||||||
|
1. **Notification Display** (`fnc_notify.sqf`)
|
||||||
|
- Creates customizable notifications
|
||||||
|
- Supports multiple notification types:
|
||||||
|
- Error (red)
|
||||||
|
- Warning (amber)
|
||||||
|
- Success (green)
|
||||||
|
- Info (blue)
|
||||||
|
- Custom colors
|
||||||
|
- Configurable display options:
|
||||||
|
- Text content
|
||||||
|
- Display duration
|
||||||
|
- Display side (left/right)
|
||||||
|
- Animation speed
|
||||||
|
- Material Design color scheme
|
||||||
|
- Sound effects
|
||||||
|
- Stacking support
|
||||||
|
- Fade animations
|
||||||
|
|
||||||
|
### String Handling
|
||||||
|
1. **String Serialization** (`fnc_serializeString.sqf`)
|
||||||
|
- Converts strings to serialized format
|
||||||
|
- Handles special characters
|
||||||
|
- Supports data transfer
|
||||||
|
|
||||||
|
2. **String Deserialization** (`fnc_deserializeString.sqf`)
|
||||||
|
- Converts serialized strings back to original format
|
||||||
|
- Restores special characters
|
||||||
|
- Processes received data
|
||||||
|
|
||||||
|
### Number Formatting
|
||||||
|
1. **Number Format** (`fnc_formatNumber.sqf`)
|
||||||
|
- Formats numbers for display
|
||||||
|
- Adds thousand separators
|
||||||
|
- Handles decimal places
|
||||||
|
- Currency formatting support
|
||||||
|
|
||||||
|
### Utility Functions
|
||||||
|
1. **System Time** (`fnc_getSystemTime.sqf`)
|
||||||
|
- Gets current system time
|
||||||
|
- Timestamp generation
|
||||||
|
- Time-based operations
|
||||||
|
|
||||||
|
2. **Equipment Checks**
|
||||||
|
- **Binocular Check** (`fnc_isAssignableBinocular.sqf`)
|
||||||
|
- Validates binocular equipment
|
||||||
|
- Checks compatibility
|
||||||
|
- Equipment type verification
|
||||||
|
|
||||||
|
- **Weapon Type Check** (`fnc_isWeaponType.sqf`)
|
||||||
|
- Validates weapon types
|
||||||
|
- Equipment categorization
|
||||||
|
- Type verification
|
||||||
|
|
||||||
|
3. **Cargo Management** (`fnc_cargoToPairs.sqf`)
|
||||||
|
- Converts cargo to paired format
|
||||||
|
- Inventory management
|
||||||
|
- Equipment organization
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
To use the misc module functions:
|
||||||
|
```sqf
|
||||||
|
// Create a notification
|
||||||
|
["Hello World!", "default", 3, "right"] call forge_client_misc_fnc_notify;
|
||||||
|
|
||||||
|
// Format a number
|
||||||
|
[1000000] call forge_client_misc_fnc_formatNumber; // Returns "1,000,000"
|
||||||
|
|
||||||
|
// Get system time
|
||||||
|
[] call forge_client_misc_fnc_getSystemTime;
|
||||||
|
|
||||||
|
// Check weapon type
|
||||||
|
["arifle_MX_F"] call forge_client_misc_fnc_isWeaponType;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
The module can be configured through the main Forge client configuration:
|
||||||
|
```cpp
|
||||||
|
// Notification colors (Material Design)
|
||||||
|
#define COLOR_RED [0.957, 0.263, 0.212, 1]
|
||||||
|
#define COLOR_GREEN [0.298, 0.686, 0.314, 1]
|
||||||
|
#define COLOR_BLUE [0.129, 0.588, 0.953, 1]
|
||||||
|
#define COLOR_AMBER [1, 0.757, 0.027, 1]
|
||||||
|
|
||||||
|
// Notification settings
|
||||||
|
#define NOTIFICATION_DEFAULT_DURATION 3
|
||||||
|
#define NOTIFICATION_MAX_STACK 3
|
||||||
|
#define NOTIFICATION_MARGIN 0.01
|
||||||
|
```
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Material Design color scheme
|
||||||
|
- Responsive notification system
|
||||||
|
- String serialization/deserialization
|
||||||
|
- Number formatting utilities
|
||||||
|
- Equipment validation
|
||||||
|
- Time management
|
||||||
|
- Cargo handling
|
||||||
|
- Event system integration
|
||||||
|
- Error handling
|
||||||
|
- User feedback
|
||||||
|
- Cross-module compatibility
|
120
addons/money/README.md
Normal file
120
addons/money/README.md
Normal file
@ -0,0 +1,120 @@
|
|||||||
|
# Forge Money Module
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The Money module provides a comprehensive currency management system for the Forge client. It includes features for handling cash transactions, money transfers, and currency management across the client's various systems.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Cash Management
|
||||||
|
1. **Give Cash** (`fnc_giveCash.sqf`)
|
||||||
|
- Handles giving cash to players
|
||||||
|
- Validates transaction amounts
|
||||||
|
- Updates player balances
|
||||||
|
- Provides transaction feedback
|
||||||
|
- Supports direct transfers
|
||||||
|
|
||||||
|
2. **Take Cash** (`fnc_takeCash.sqf`)
|
||||||
|
- Manages cash removal from players
|
||||||
|
- Validates available funds
|
||||||
|
- Updates player balances
|
||||||
|
- Provides transaction feedback
|
||||||
|
- Supports direct deductions
|
||||||
|
|
||||||
|
3. **Cash Submission** (`fnc_giveCashSubmit.sqf`)
|
||||||
|
- Processes cash transactions
|
||||||
|
- Validates transaction data
|
||||||
|
- Updates player balances
|
||||||
|
- Handles transaction feedback
|
||||||
|
- Manages transaction history
|
||||||
|
|
||||||
|
### Transaction Features
|
||||||
|
1. **Direct Transfers**
|
||||||
|
- Player-to-player transfers
|
||||||
|
- Amount validation
|
||||||
|
- Balance verification
|
||||||
|
- Transaction confirmation
|
||||||
|
- Error handling
|
||||||
|
|
||||||
|
2. **Balance Management**
|
||||||
|
- Real-time balance updates
|
||||||
|
- Transaction history
|
||||||
|
- Balance verification
|
||||||
|
- Error prevention
|
||||||
|
- Transaction logging
|
||||||
|
|
||||||
|
3. **Transaction Validation**
|
||||||
|
- Amount verification
|
||||||
|
- Player validation
|
||||||
|
- Balance checks
|
||||||
|
- Error handling
|
||||||
|
- Transaction confirmation
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
To use the money module:
|
||||||
|
```sqf
|
||||||
|
// Give cash to a player
|
||||||
|
[player, 1000] call forge_client_money_fnc_giveCash;
|
||||||
|
|
||||||
|
// Take cash from a player
|
||||||
|
[player, 500] call forge_client_money_fnc_takeCash;
|
||||||
|
|
||||||
|
// Submit a cash transaction
|
||||||
|
[player, 750, "Payment for services"] call forge_client_money_fnc_giveCashSubmit;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Integration
|
||||||
|
The money module integrates with other Forge client systems:
|
||||||
|
1. **Bank System**
|
||||||
|
- Wallet management
|
||||||
|
- Account transfers
|
||||||
|
- Balance synchronization
|
||||||
|
- Transaction history
|
||||||
|
|
||||||
|
2. **Organization System**
|
||||||
|
- Organization funds
|
||||||
|
- Member payments
|
||||||
|
- Transaction tracking
|
||||||
|
- Balance management
|
||||||
|
|
||||||
|
3. **Admin System**
|
||||||
|
- Administrative transfers
|
||||||
|
- Balance modifications
|
||||||
|
- Transaction oversight
|
||||||
|
- System management
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Real-time transaction processing
|
||||||
|
- Secure balance management
|
||||||
|
- Transaction validation
|
||||||
|
- Error handling
|
||||||
|
- User feedback
|
||||||
|
- Cross-module integration
|
||||||
|
- Event system integration
|
||||||
|
- State management
|
||||||
|
- Database persistence
|
||||||
|
- Transaction logging
|
||||||
|
- Balance verification
|
||||||
|
- Player validation
|
@ -1,126 +1,134 @@
|
|||||||
# Player Organization Module
|
# Forge Organization Module
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
The Organization module provides a comprehensive system for managing player-created organizations in the Forge client. It enables players to create, join, and manage organizations with features including member management, asset tracking, financial operations, and reputation systems.
|
||||||
|
|
||||||
The Player Organization Module provides a comprehensive system for managing player-created organizations in Arma 3. This module enables players to create, join, and manage organizations with features including member management, asset tracking, financial operations, and reputation systems.
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
- ArmaDragonflyClient
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Organization Creation & Management**: Create and disband organizations with customizable names
|
### Organization Management
|
||||||
- **Member Management**: Add, remove, and manage organization members with different roles
|
1. **Creation & Disbanding**
|
||||||
- **Asset Tracking**: Register and manage organization-owned assets (vehicles, buildings, etc.)
|
- Create new organizations with custom names
|
||||||
- **Financial System**: Track organization funds with deposit and withdrawal capabilities
|
- Set initial funds and reputation
|
||||||
- **Reputation System**: Manage organization reputation that can influence gameplay mechanics
|
- Disband organizations (owner only)
|
||||||
- **Database Integration**: Persistent storage using ArmaDragonflyClient for reliable data management
|
- Automatic database persistence
|
||||||
- **User-Friendly Notifications**: Visual feedback for all organization operations
|
|
||||||
|
2. **Member Management**
|
||||||
|
- Add and remove members
|
||||||
|
- Role-based permissions
|
||||||
|
- Member status tracking
|
||||||
|
- Join date tracking
|
||||||
|
- Leave organization option
|
||||||
|
|
||||||
|
3. **Asset Management**
|
||||||
|
- Track organization-owned assets
|
||||||
|
- Categorize assets by type
|
||||||
|
- Store custom properties
|
||||||
|
- Asset value tracking
|
||||||
|
- Asset history logging
|
||||||
|
|
||||||
|
### Financial System
|
||||||
|
1. **Fund Management**
|
||||||
|
- Add and remove funds
|
||||||
|
- Transaction history
|
||||||
|
- Balance tracking
|
||||||
|
- Financial logging
|
||||||
|
- Real-time updates
|
||||||
|
|
||||||
|
2. **Reputation System**
|
||||||
|
- Reputation tracking
|
||||||
|
- Reputation adjustments
|
||||||
|
- Reputation history
|
||||||
|
- Impact on gameplay
|
||||||
|
- Reputation logging
|
||||||
|
|
||||||
|
### Data Management
|
||||||
|
1. **Database Integration**
|
||||||
|
- Persistent storage
|
||||||
|
- Automatic synchronization
|
||||||
|
- Data validation
|
||||||
|
- Error handling
|
||||||
|
- Backup support
|
||||||
|
|
||||||
|
2. **Logging System**
|
||||||
|
- Comprehensive activity logs
|
||||||
|
- Transaction history
|
||||||
|
- Member changes
|
||||||
|
- Asset modifications
|
||||||
|
- System events
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
To use the organization module:
|
||||||
### Creating an Organization
|
|
||||||
|
|
||||||
```sqf
|
```sqf
|
||||||
// Create a new organization with default funds and reputation
|
// Create a new organization
|
||||||
[getPlayerUID player, "My Organization"] call forge_client_org_fnc_create;
|
[getPlayerUID player, "My Organization", 5000, 100] call forge_client_org_fnc_create;
|
||||||
|
|
||||||
// Create an organization with custom initial funds and reputation
|
// Add a member
|
||||||
[getPlayerUID player, "Elite Squad", 5000, 100] call forge_client_org_fnc_create;
|
|
||||||
```
|
|
||||||
|
|
||||||
### Managing Members
|
|
||||||
|
|
||||||
```sqf
|
|
||||||
// Add a member to your organization
|
|
||||||
["76561198012345678", "John Doe"] call forge_client_org_fnc_addMember;
|
["76561198012345678", "John Doe"] call forge_client_org_fnc_addMember;
|
||||||
|
|
||||||
// Remove a member from your organization
|
// Add funds
|
||||||
["76561198012345678"] call forge_client_org_fnc_removeMember;
|
|
||||||
|
|
||||||
// Leave an organization (for members)
|
|
||||||
[] call forge_client_org_fnc_leave;
|
|
||||||
```
|
|
||||||
|
|
||||||
### Managing Assets
|
|
||||||
|
|
||||||
```sqf
|
|
||||||
// Add a vehicle to organization assets
|
|
||||||
["vehicle", "B_MRAP_01_F"] call forge_client_org_fnc_addAsset;
|
|
||||||
|
|
||||||
// Add a vehicle with custom properties
|
|
||||||
private _properties = createHashMap;
|
|
||||||
_properties set ["color", "red"];
|
|
||||||
_properties set ["plate", "ORG-001"];
|
|
||||||
["vehicle", "B_MRAP_01_F", _properties] call forge_client_org_fnc_addAsset;
|
|
||||||
|
|
||||||
// Remove an asset from the organization
|
|
||||||
["vehicle", "B_MRAP_01_F_1234567890"] call forge_client_org_fnc_removeAsset;
|
|
||||||
```
|
|
||||||
|
|
||||||
### Financial Operations
|
|
||||||
|
|
||||||
```sqf
|
|
||||||
// Add funds to organization account
|
|
||||||
[1000] call forge_client_org_fnc_addFunds;
|
[1000] call forge_client_org_fnc_addFunds;
|
||||||
|
|
||||||
// Remove funds from organization account
|
// Add reputation
|
||||||
[-500] call forge_client_org_fnc_addFunds;
|
|
||||||
```
|
|
||||||
|
|
||||||
### Reputation Management
|
|
||||||
|
|
||||||
```sqf
|
|
||||||
// Increase organization reputation
|
|
||||||
[10] call forge_client_org_fnc_addReputation;
|
[10] call forge_client_org_fnc_addReputation;
|
||||||
|
|
||||||
// Decrease organization reputation
|
// Add an asset
|
||||||
[-5] call forge_client_org_fnc_addReputation;
|
["vehicle", "B_MRAP_01_F"] call forge_client_org_fnc_addAsset;
|
||||||
```
|
```
|
||||||
|
|
||||||
### Disbanding an Organization
|
## Integration
|
||||||
|
The organization module integrates with other Forge client systems:
|
||||||
|
1. **Bank System**
|
||||||
|
- Organization accounts
|
||||||
|
- Transaction processing
|
||||||
|
- Balance management
|
||||||
|
- Financial reporting
|
||||||
|
|
||||||
```sqf
|
2. **Vehicle System**
|
||||||
// Permanently delete the organization (owner only)
|
- Organization vehicles
|
||||||
[] call forge_client_org_fnc_disband;
|
- Vehicle registration
|
||||||
|
- Maintenance tracking
|
||||||
|
- Usage logging
|
||||||
|
|
||||||
|
3. **Property System**
|
||||||
|
- Organization properties
|
||||||
|
- Property management
|
||||||
|
- Value tracking
|
||||||
|
- Usage rights
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
```
|
```
|
||||||
|
|
||||||
## Technical Architecture
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
The module is built around a central organization store interface that provides a clean API for all organization operations. This interface handles data validation, database persistence, and user feedback.
|
## Technical Details
|
||||||
|
- Real-time data synchronization
|
||||||
### Core Components
|
- Secure data management
|
||||||
|
- Comprehensive validation
|
||||||
- **Organization Store**: Central interface for all organization operations
|
- Error handling
|
||||||
- **Database Integration**: Persistent storage using ArmaDragonflyClient
|
- User feedback
|
||||||
- **User Notifications**: Visual feedback system for all operations
|
- Cross-module integration
|
||||||
- **Data Validation**: Comprehensive input validation to ensure data integrity
|
- Event system integration
|
||||||
|
- State management
|
||||||
### Data Structure
|
- Database persistence
|
||||||
|
- Transaction logging
|
||||||
Organizations are stored as structured hashmaps with the following key components:
|
- Asset tracking
|
||||||
|
- Member management
|
||||||
- **Basic Information**: ID, name, owner, creation date
|
|
||||||
- **Members**: List of members with roles and join dates
|
|
||||||
- **Assets**: Categorized inventory of organization-owned assets
|
|
||||||
- **Finances**: Current funds and transaction history
|
|
||||||
- **Reputation**: Current reputation score and history
|
|
||||||
- **Logs**: Comprehensive activity logs for auditing
|
|
||||||
|
|
||||||
## Integration with Other Systems
|
|
||||||
|
|
||||||
The organization module is designed to integrate with other game systems:
|
|
||||||
|
|
||||||
- **Vehicle Garage**: Register organization-owned vehicles
|
|
||||||
- **Property System**: Manage organization-owned buildings and territories
|
|
||||||
- **Mission System**: Organization-specific missions and objectives
|
|
||||||
- **Economy System**: Organization financial operations and investments
|
|
||||||
|
|
||||||
## Developer Notes
|
|
||||||
|
|
||||||
- All organization operations are performed through the organization store interface
|
|
||||||
- The store is initialized automatically when needed via `verifyOrgStore`
|
|
||||||
- Database operations are asynchronous and use callback functions
|
|
||||||
- User feedback is provided through the notification system
|
|
||||||
- Error handling is comprehensive with appropriate user feedback
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
*Developed by J. Schmidt*
|
|
140
addons/phone/README.md
Normal file
140
addons/phone/README.md
Normal file
@ -0,0 +1,140 @@
|
|||||||
|
# Forge Phone Module
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The Phone module provides a comprehensive mobile phone system for the Forge client. It includes features for messaging, email, contacts management, and a modern user interface with various applications.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Communication
|
||||||
|
1. **Messaging System**
|
||||||
|
- Send and receive text messages
|
||||||
|
- Message history
|
||||||
|
- Offline message support
|
||||||
|
- Message notifications
|
||||||
|
- Contact-based messaging
|
||||||
|
|
||||||
|
2. **Email System**
|
||||||
|
- Send and receive emails
|
||||||
|
- Email history
|
||||||
|
- Offline email support
|
||||||
|
- Email notifications
|
||||||
|
- Contact-based emailing
|
||||||
|
|
||||||
|
3. **Contact Management**
|
||||||
|
- Add and remove contacts
|
||||||
|
- Contact details (name, phone, email)
|
||||||
|
- Contact list organization
|
||||||
|
- Quick contact actions
|
||||||
|
- Contact search
|
||||||
|
|
||||||
|
### User Interface
|
||||||
|
1. **Phone Interface**
|
||||||
|
- Modern mobile phone design
|
||||||
|
- Home screen with app icons
|
||||||
|
- App navigation
|
||||||
|
- Status bar with time
|
||||||
|
- Interactive controls
|
||||||
|
|
||||||
|
2. **Applications**
|
||||||
|
- Messages app
|
||||||
|
- Email app
|
||||||
|
- Contacts app
|
||||||
|
- Camera app
|
||||||
|
- Photos app
|
||||||
|
- Settings app
|
||||||
|
- Safari browser
|
||||||
|
|
||||||
|
3. **Controls**
|
||||||
|
- Touch-based interaction
|
||||||
|
- Button feedback
|
||||||
|
- Visual indicators
|
||||||
|
- Smooth transitions
|
||||||
|
- Intuitive navigation
|
||||||
|
|
||||||
|
### System Features
|
||||||
|
1. **Phone Management**
|
||||||
|
- Phone initialization
|
||||||
|
- Action binding
|
||||||
|
- Variable management
|
||||||
|
- State persistence
|
||||||
|
- Profile saving
|
||||||
|
|
||||||
|
2. **Data Management**
|
||||||
|
- Contact storage
|
||||||
|
- Message history
|
||||||
|
- Email storage
|
||||||
|
- Profile data
|
||||||
|
- Settings persistence
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
To use the phone module:
|
||||||
|
```sqf
|
||||||
|
// Initialize phone
|
||||||
|
[] call forge_client_phone_fnc_initPhone;
|
||||||
|
|
||||||
|
// Add a contact
|
||||||
|
[cursorObject] call forge_client_phone_fnc_addContact;
|
||||||
|
|
||||||
|
// Send a message
|
||||||
|
["1234567890", "Hello World"] call forge_client_phone_fnc_sendMsg;
|
||||||
|
|
||||||
|
// Send an email
|
||||||
|
["recipient@spearnet.mil", "Subject", "Message"] call forge_client_phone_fnc_sendEmail;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Integration
|
||||||
|
The phone module integrates with other Forge client systems:
|
||||||
|
1. **Player System**
|
||||||
|
- Player identification
|
||||||
|
- Phone number assignment
|
||||||
|
- Email assignment
|
||||||
|
- Profile management
|
||||||
|
|
||||||
|
2. **Database System**
|
||||||
|
- Message storage
|
||||||
|
- Contact persistence
|
||||||
|
- Email storage
|
||||||
|
- Profile data
|
||||||
|
|
||||||
|
3. **Notification System**
|
||||||
|
- Message alerts
|
||||||
|
- Email notifications
|
||||||
|
- System notifications
|
||||||
|
- Status updates
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Real-time messaging
|
||||||
|
- Secure data management
|
||||||
|
- Contact synchronization
|
||||||
|
- Message persistence
|
||||||
|
- Email handling
|
||||||
|
- UI responsiveness
|
||||||
|
- Cross-module integration
|
||||||
|
- Event system integration
|
||||||
|
- State management
|
||||||
|
- Profile persistence
|
||||||
|
- Notification system
|
||||||
|
- Input validation
|
133
addons/player/README.md
Normal file
133
addons/player/README.md
Normal file
@ -0,0 +1,133 @@
|
|||||||
|
# Forge Player Module
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The Player module provides a comprehensive system for managing player data, persistence, and state in the Forge client. It includes features for player initialization, data management, and integration with other systems.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
- ArmaDragonflyClient
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Player Management
|
||||||
|
1. **Initialization**
|
||||||
|
- First-time player setup
|
||||||
|
- Data loading from database
|
||||||
|
- Default values assignment
|
||||||
|
- State initialization
|
||||||
|
- Profile creation
|
||||||
|
|
||||||
|
2. **Data Persistence**
|
||||||
|
- Automatic data saving
|
||||||
|
- Periodic state synchronization
|
||||||
|
- Position and direction tracking
|
||||||
|
- Loadout persistence
|
||||||
|
- Equipment state management
|
||||||
|
|
||||||
|
3. **State Management**
|
||||||
|
- Player position tracking
|
||||||
|
- Direction tracking
|
||||||
|
- Stance management
|
||||||
|
- Weapon holstering
|
||||||
|
- Current weapon tracking
|
||||||
|
|
||||||
|
### Data Management
|
||||||
|
1. **Player Data**
|
||||||
|
- Armory unlocks
|
||||||
|
- Garage unlocks
|
||||||
|
- Locker contents
|
||||||
|
- Vehicle inventory
|
||||||
|
- Financial information
|
||||||
|
- Contact details
|
||||||
|
- Organization membership
|
||||||
|
- Player statistics
|
||||||
|
- Equipment loadouts
|
||||||
|
- Position and state
|
||||||
|
|
||||||
|
2. **Profile Data**
|
||||||
|
- Email address
|
||||||
|
- Phone number
|
||||||
|
- Paygrade
|
||||||
|
- Organization
|
||||||
|
- Reputation
|
||||||
|
- Custom settings
|
||||||
|
- Preferences
|
||||||
|
|
||||||
|
3. **Save System**
|
||||||
|
- Automatic saving
|
||||||
|
- Periodic backups
|
||||||
|
- Data validation
|
||||||
|
- Error recovery
|
||||||
|
- State verification
|
||||||
|
|
||||||
|
### Integration
|
||||||
|
1. **Database System**
|
||||||
|
- Data persistence
|
||||||
|
- State synchronization
|
||||||
|
- Profile management
|
||||||
|
- Error handling
|
||||||
|
- Data validation
|
||||||
|
|
||||||
|
2. **Organization System**
|
||||||
|
- Member management
|
||||||
|
- Role assignment
|
||||||
|
- Organization tracking
|
||||||
|
- Asset management
|
||||||
|
- Financial integration
|
||||||
|
|
||||||
|
3. **Financial System**
|
||||||
|
- Cash management
|
||||||
|
- Bank integration
|
||||||
|
- Transaction tracking
|
||||||
|
- Paygrade system
|
||||||
|
- Financial persistence
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
To use the player module:
|
||||||
|
```sqf
|
||||||
|
// Initialize player
|
||||||
|
[] call forge_client_init_fnc_initPlayer;
|
||||||
|
|
||||||
|
// Load player data
|
||||||
|
[] call forge_client_init_fnc_playerDBLoad;
|
||||||
|
|
||||||
|
// Save player data
|
||||||
|
[] call forge_client_init_fnc_playerDBSave;
|
||||||
|
|
||||||
|
// Handle player load
|
||||||
|
[_data] call forge_client_init_fnc_handlePlayerLoad;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Real-time data synchronization
|
||||||
|
- Secure data management
|
||||||
|
- Comprehensive validation
|
||||||
|
- Error handling
|
||||||
|
- State persistence
|
||||||
|
- Profile management
|
||||||
|
- Cross-module integration
|
||||||
|
- Event system integration
|
||||||
|
- Data versioning
|
||||||
|
- Backup support
|
||||||
|
- Transaction logging
|
||||||
|
- Data integrity checks
|
@ -1,7 +1,7 @@
|
|||||||
# Forge Service Module
|
# Forge Service Module
|
||||||
|
|
||||||
## Overview
|
## 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.
|
The Service module provides a comprehensive vehicle service system for the Forge client. It includes features for vehicle repair, refueling, rearming, and general maintenance, with integration into the organization system for cost management.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- forge_client_main
|
- forge_client_main
|
||||||
@ -16,36 +16,116 @@ The Service module provides a comprehensive vehicle service system for the Forge
|
|||||||
### Service System
|
### Service System
|
||||||
1. **Service Initialization** (`fnc_initService.sqf`)
|
1. **Service Initialization** (`fnc_initService.sqf`)
|
||||||
- Initializes the service system
|
- Initializes the service system
|
||||||
- Sets up necessary configurations and service points
|
- Sets up service points and triggers
|
||||||
|
- Configures fuel pump locations
|
||||||
|
- Manages service area detection
|
||||||
|
|
||||||
2. **Vehicle Maintenance**
|
2. **Vehicle Maintenance**
|
||||||
- **Repair** (`fnc_repair.sqf`)
|
- **Repair** (`fnc_repair.sqf`)
|
||||||
- Handles vehicle repair operations
|
- Handles vehicle repair operations
|
||||||
|
- Calculates repair costs based on damage
|
||||||
|
- Manages labor hours and parts costs
|
||||||
|
- Provides repair progress feedback
|
||||||
|
- Integrates with organization funds
|
||||||
|
|
||||||
- **Refuel** (`fnc_refuel.sqf`)
|
- **Refuel** (`fnc_refuel.sqf`)
|
||||||
- Manages vehicle refueling
|
- Manages vehicle refueling
|
||||||
|
- Calculates fuel costs
|
||||||
|
- Provides real-time refueling progress
|
||||||
|
- Handles fuel pump interactions
|
||||||
|
- Integrates with organization funds
|
||||||
|
|
||||||
- **Rearm** (`fnc_rearm.sqf`)
|
- **Rearm** (`fnc_rearm.sqf`)
|
||||||
- Handles vehicle rearming
|
- Handles vehicle rearming
|
||||||
- **Fuel** (`fnc_fuel.sqf`)
|
- Manages magazine reloading
|
||||||
- Manages fuel system operations
|
- Processes turret systems
|
||||||
|
- Calculates rearm costs
|
||||||
|
- Integrates with organization funds
|
||||||
|
|
||||||
3. **Vehicle Service** (`fnc_vehicle.sqf`)
|
3. **Vehicle Service** (`fnc_vehicle.sqf`)
|
||||||
- Comprehensive vehicle service management
|
- Comprehensive vehicle service management
|
||||||
- Coordinates different service operations
|
- Coordinates different service operations
|
||||||
|
- Handles cost calculations
|
||||||
|
- Manages service notifications
|
||||||
|
- Integrates with organization system
|
||||||
|
|
||||||
|
### Cost Management
|
||||||
|
1. **Cost Calculation**
|
||||||
|
- Repair costs (labor and parts)
|
||||||
|
- Fuel costs (based on amount needed)
|
||||||
|
- Rearm costs (per magazine)
|
||||||
|
- Total service costs
|
||||||
|
- Organization fund integration
|
||||||
|
|
||||||
|
2. **Organization Integration**
|
||||||
|
- Fund verification
|
||||||
|
- Cost deduction
|
||||||
|
- Transaction logging
|
||||||
|
- Balance updates
|
||||||
|
- Service authorization
|
||||||
|
|
||||||
|
### Service Points
|
||||||
|
1. **Fuel Stations**
|
||||||
|
- Automatic detection
|
||||||
|
- Service area setup
|
||||||
|
- Trigger management
|
||||||
|
- Vehicle detection
|
||||||
|
- Service activation
|
||||||
|
|
||||||
|
2. **Service Areas**
|
||||||
|
- Area definition
|
||||||
|
- Trigger configuration
|
||||||
|
- Vehicle validation
|
||||||
|
- Service coordination
|
||||||
|
- Status monitoring
|
||||||
|
|
||||||
## Event Handlers
|
## Event Handlers
|
||||||
The module uses several event handlers for initialization and execution:
|
The module uses several event handlers for initialization and execution:
|
||||||
- `XEH_preInit.sqf`: Pre-initialization setup
|
- `XEH_preInit.sqf`: Pre-initialization setup
|
||||||
- `XEH_postInit.sqf`: Post-initialization tasks
|
- `XEH_postInit.sqf`: Post-initialization tasks
|
||||||
- `XEH_preStart.sqf`: Pre-start configuration
|
- `XEH_preStart.sqf`: Pre-start configuration
|
||||||
- `XEH_postInit_client.sqf`: Client-specific post-initialization
|
|
||||||
- `XEH_preInit_server.sqf`: Server-specific pre-initialization
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
To use the service module:
|
To use the service module:
|
||||||
1. Ensure the module is properly loaded in your mission
|
```sqf
|
||||||
2. Access service points through the provided functions
|
// Initialize service system
|
||||||
3. Perform vehicle maintenance using the appropriate functions
|
[] call forge_client_service_fnc_initService;
|
||||||
4. Monitor vehicle status and service operations
|
|
||||||
|
// Service a vehicle
|
||||||
|
[vehicle, "LAND"] call forge_client_service_fnc_vehicle;
|
||||||
|
|
||||||
|
// Repair a vehicle
|
||||||
|
[vehicle, "B_APC_Tracked_01_CRV_F"] call forge_client_service_fnc_repair;
|
||||||
|
|
||||||
|
// Refuel a vehicle
|
||||||
|
[vehicle, "B_APC_Tracked_01_CRV_F"] call forge_client_service_fnc_refuel;
|
||||||
|
|
||||||
|
// Rearm a vehicle
|
||||||
|
[vehicle, "B_APC_Tracked_01_CRV_F"] call forge_client_service_fnc_rearm;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Integration
|
||||||
|
The service module integrates with other Forge client systems:
|
||||||
|
1. **Organization System**
|
||||||
|
- Fund management
|
||||||
|
- Cost tracking
|
||||||
|
- Transaction processing
|
||||||
|
- Service authorization
|
||||||
|
- Balance updates
|
||||||
|
|
||||||
|
2. **Vehicle System**
|
||||||
|
- Vehicle state tracking
|
||||||
|
- Damage monitoring
|
||||||
|
- Fuel management
|
||||||
|
- Armament status
|
||||||
|
- Service history
|
||||||
|
|
||||||
|
3. **Notification System**
|
||||||
|
- Service progress updates
|
||||||
|
- Cost notifications
|
||||||
|
- Status messages
|
||||||
|
- Error reporting
|
||||||
|
- Completion alerts
|
||||||
|
|
||||||
## Debugging
|
## Debugging
|
||||||
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
@ -54,4 +134,18 @@ Debug mode can be enabled by uncommenting the following in `script_component.hpp
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Version Information
|
## Version Information
|
||||||
Version information is managed through the main Forge client system configuration.
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Real-time service processing
|
||||||
|
- Cost calculation system
|
||||||
|
- Organization fund integration
|
||||||
|
- Service point management
|
||||||
|
- Vehicle state tracking
|
||||||
|
- Progress monitoring
|
||||||
|
- Error handling
|
||||||
|
- Transaction logging
|
||||||
|
- Service validation
|
||||||
|
- Resource management
|
||||||
|
- Cross-module integration
|
||||||
|
- Event system integration
|
@ -1,7 +1,7 @@
|
|||||||
# Forge Store Module
|
# Forge Store Module
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The Store module provides a comprehensive shopping system for the Forge client. It includes features for purchasing items, vehicles, and managing store operations.
|
The Store module provides a comprehensive shopping system for the Forge client. It includes features for purchasing items, vehicles, and equipment, with support for multiple payment methods and integration with the organization system.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- forge_client_main
|
- forge_client_main
|
||||||
@ -16,40 +16,146 @@ The Store module provides a comprehensive shopping system for the Forge client.
|
|||||||
### Store System
|
### Store System
|
||||||
1. **Store Initialization** (`fnc_initStore.sqf`)
|
1. **Store Initialization** (`fnc_initStore.sqf`)
|
||||||
- Initializes the store system
|
- Initializes the store system
|
||||||
- Sets up necessary configurations and product catalog
|
- Sets up store locations and configurations
|
||||||
|
- Manages store types and categories
|
||||||
|
- Configures payment methods
|
||||||
|
- Handles product catalog
|
||||||
|
|
||||||
2. **Store Interface**
|
2. **Store Interface**
|
||||||
- **Open Store** (`fnc_openStore.sqf`)
|
- **Open Store** (`fnc_openStore.sqf`)
|
||||||
- Opens the store user interface
|
- Opens the store user interface
|
||||||
|
- Displays store name and categories
|
||||||
|
- Manages payment method selection
|
||||||
|
- Handles product filtering
|
||||||
|
|
||||||
- **Select Product** (`fnc_selectProduct.sqf`)
|
- **Select Product** (`fnc_selectProduct.sqf`)
|
||||||
- Handles product selection
|
- Handles product selection
|
||||||
|
- Manages product categories
|
||||||
|
- Processes product data
|
||||||
|
- Coordinates purchase flow
|
||||||
|
|
||||||
- **Change Filter** (`fnc_changeFilter.sqf`)
|
- **Change Filter** (`fnc_changeFilter.sqf`)
|
||||||
- Manages product filtering
|
- Manages product filtering
|
||||||
|
- Updates product display
|
||||||
|
- Handles category switching
|
||||||
|
- Maintains filter state
|
||||||
|
|
||||||
- **Change Payment** (`fnc_changePayment.sqf`)
|
- **Change Payment** (`fnc_changePayment.sqf`)
|
||||||
- Handles payment method selection
|
- Handles payment method selection
|
||||||
|
- Manages payment options
|
||||||
|
- Updates payment interface
|
||||||
|
- Validates payment methods
|
||||||
|
|
||||||
3. **Purchase Management**
|
3. **Purchase Management**
|
||||||
- **Handle Purchase** (`fnc_handlePurchase.sqf`)
|
- **Handle Purchase** (`fnc_handlePurchase.sqf`)
|
||||||
- Processes purchase transactions
|
- Processes purchase transactions
|
||||||
|
- Validates payment methods
|
||||||
|
- Manages organization funds
|
||||||
|
- Handles transaction logging
|
||||||
|
- Provides purchase feedback
|
||||||
|
|
||||||
- **Buy Item** (`fnc_buyItem.sqf`)
|
- **Buy Item** (`fnc_buyItem.sqf`)
|
||||||
- Handles item purchases
|
- Handles item purchases
|
||||||
|
- Manages locker integration
|
||||||
|
- Processes item delivery
|
||||||
|
- Updates inventory
|
||||||
|
- Provides purchase confirmation
|
||||||
|
|
||||||
- **Buy Vehicle** (`fnc_buyVehicle.sqf`)
|
- **Buy Vehicle** (`fnc_buyVehicle.sqf`)
|
||||||
- Manages vehicle purchases
|
- Manages vehicle purchases
|
||||||
|
- Handles garage integration
|
||||||
|
- Processes vehicle delivery
|
||||||
|
- Updates garage inventory
|
||||||
|
- Provides purchase confirmation
|
||||||
|
|
||||||
|
### Product Categories
|
||||||
|
1. **Equipment**
|
||||||
|
- Vests
|
||||||
|
- Headwear
|
||||||
|
- Facewear
|
||||||
|
- HMD (Night Vision)
|
||||||
|
- Backpacks
|
||||||
|
- Uniforms
|
||||||
|
|
||||||
|
2. **Vehicles**
|
||||||
|
- Wheeled vehicles
|
||||||
|
- Tracked vehicles
|
||||||
|
- Aircraft
|
||||||
|
- Watercraft
|
||||||
|
- Static weapons
|
||||||
|
|
||||||
|
3. **Supplies**
|
||||||
|
- Medical supplies
|
||||||
|
- Ammunition
|
||||||
|
- Food rations
|
||||||
|
- Repair kits
|
||||||
|
- Other consumables
|
||||||
|
|
||||||
|
### Payment System
|
||||||
|
1. **Payment Methods**
|
||||||
|
- Personal funds
|
||||||
|
- Organization funds
|
||||||
|
- Mission funds
|
||||||
|
- Custom payment types
|
||||||
|
|
||||||
|
2. **Transaction Management**
|
||||||
|
- Payment validation
|
||||||
|
- Fund verification
|
||||||
|
- Balance updates
|
||||||
|
- Transaction logging
|
||||||
|
- Purchase confirmation
|
||||||
|
|
||||||
## Event Handlers
|
## Event Handlers
|
||||||
The module uses several event handlers for initialization and execution:
|
The module uses several event handlers for initialization and execution:
|
||||||
- `XEH_preInit.sqf`: Pre-initialization setup
|
- `XEH_preInit.sqf`: Pre-initialization setup
|
||||||
- `XEH_postInit.sqf`: Post-initialization tasks
|
- `XEH_postInit.sqf`: Post-initialization tasks
|
||||||
- `XEH_preStart.sqf`: Pre-start configuration
|
- `XEH_preStart.sqf`: Pre-start configuration
|
||||||
- `XEH_postInit_client.sqf`: Client-specific post-initialization
|
|
||||||
- `XEH_preInit_server.sqf`: Server-specific pre-initialization
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
To use the store module:
|
To use the store module:
|
||||||
1. Ensure the module is properly loaded in your mission
|
```sqf
|
||||||
2. Access the store through the provided UI
|
// Initialize store system
|
||||||
3. Browse and filter products
|
[] call forge_client_store_fnc_initStore;
|
||||||
4. Make purchases using the appropriate functions
|
|
||||||
|
// Open store interface
|
||||||
|
[storeObject] call forge_client_store_fnc_openStore;
|
||||||
|
|
||||||
|
// Buy an item
|
||||||
|
["arifle_MX_F", 1000, "weapon", "weapon"] call forge_client_store_fnc_buyItem;
|
||||||
|
|
||||||
|
// Buy a vehicle
|
||||||
|
["B_APC_Tracked_01_rcws_F", 5000, "tank"] call forge_client_store_fnc_buyVehicle;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Integration
|
||||||
|
The store module integrates with other Forge client systems:
|
||||||
|
1. **Organization System**
|
||||||
|
- Fund management
|
||||||
|
- Purchase authorization
|
||||||
|
- Transaction processing
|
||||||
|
- Balance updates
|
||||||
|
- Purchase history
|
||||||
|
|
||||||
|
2. **Locker System**
|
||||||
|
- Item storage
|
||||||
|
- Equipment management
|
||||||
|
- Inventory updates
|
||||||
|
- Item delivery
|
||||||
|
- Storage validation
|
||||||
|
|
||||||
|
3. **Garage System**
|
||||||
|
- Vehicle storage
|
||||||
|
- Vehicle management
|
||||||
|
- Purchase delivery
|
||||||
|
- Inventory updates
|
||||||
|
- Vehicle validation
|
||||||
|
|
||||||
|
4. **Notification System**
|
||||||
|
- Purchase confirmations
|
||||||
|
- Error messages
|
||||||
|
- Transaction updates
|
||||||
|
- Status notifications
|
||||||
|
- System alerts
|
||||||
|
|
||||||
## Debugging
|
## Debugging
|
||||||
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
@ -58,4 +164,19 @@ Debug mode can be enabled by uncommenting the following in `script_component.hpp
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Version Information
|
## Version Information
|
||||||
Version information is managed through the main Forge client system configuration.
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Real-time transaction processing
|
||||||
|
- Multi-payment system support
|
||||||
|
- Product catalog management
|
||||||
|
- Category filtering system
|
||||||
|
- Payment validation
|
||||||
|
- Transaction logging
|
||||||
|
- Purchase verification
|
||||||
|
- Inventory management
|
||||||
|
- Cross-module integration
|
||||||
|
- Event system integration
|
||||||
|
- UI state management
|
||||||
|
- Error handling
|
||||||
|
- Resource management
|
186
addons/task/README.md
Normal file
186
addons/task/README.md
Normal file
@ -0,0 +1,186 @@
|
|||||||
|
# Forge Task Module
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The Task module provides a comprehensive mission and objective system for the Forge client. It includes features for creating, managing, and tracking various types of tasks, with support for rewards, penalties, and mission completion conditions.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- forge_client_main
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
- J. Schmidt
|
||||||
|
- Creedcoder
|
||||||
|
- IDSolutions
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Task Types
|
||||||
|
1. **Attack Tasks** (`fnc_attack.sqf`)
|
||||||
|
- Eliminate specific targets
|
||||||
|
- Time-based objectives
|
||||||
|
- Target escape prevention
|
||||||
|
- Success/failure conditions
|
||||||
|
- Reward system integration
|
||||||
|
|
||||||
|
2. **Defend Tasks** (`fnc_defend.sqf`)
|
||||||
|
- Hold designated zones
|
||||||
|
- Wave-based enemy attacks
|
||||||
|
- Minimum force requirements
|
||||||
|
- Time-based objectives
|
||||||
|
- Zone control monitoring
|
||||||
|
|
||||||
|
3. **Hostage Tasks** (`fnc_hostage.sqf`)
|
||||||
|
- Rescue hostages
|
||||||
|
- Extraction zone management
|
||||||
|
- Hostage protection
|
||||||
|
- Time-based objectives
|
||||||
|
- CBRN zone support
|
||||||
|
|
||||||
|
4. **HVT Tasks** (`fnc_hvt.sqf`)
|
||||||
|
- Capture or eliminate HVTs
|
||||||
|
- Extraction requirements
|
||||||
|
- Target tracking
|
||||||
|
- Success/failure conditions
|
||||||
|
- Reward system integration
|
||||||
|
|
||||||
|
5. **Defuse Tasks** (`fnc_defuse.sqf`)
|
||||||
|
- Defuse explosive devices
|
||||||
|
- Time-based objectives
|
||||||
|
- Success/failure conditions
|
||||||
|
- Reward system integration
|
||||||
|
- Explosive entity management
|
||||||
|
|
||||||
|
6. **Delivery Tasks** (`fnc_delivery.sqf`)
|
||||||
|
- Transport objectives
|
||||||
|
- Route management
|
||||||
|
- Time-based delivery
|
||||||
|
- Success/failure conditions
|
||||||
|
- Reward system integration
|
||||||
|
|
||||||
|
### Task Management
|
||||||
|
1. **Task Configuration**
|
||||||
|
- Unique task IDs
|
||||||
|
- Success/failure limits
|
||||||
|
- Time limits
|
||||||
|
- Reward settings
|
||||||
|
- Mission end conditions
|
||||||
|
|
||||||
|
2. **Reward System** (`fnc_handleTaskRewards.sqf`)
|
||||||
|
- Company funds
|
||||||
|
- Reputation points
|
||||||
|
- Equipment rewards
|
||||||
|
- Supply rewards
|
||||||
|
- Weapon rewards
|
||||||
|
- Vehicle rewards
|
||||||
|
- Special rewards
|
||||||
|
|
||||||
|
3. **Task Tracking**
|
||||||
|
- Progress monitoring
|
||||||
|
- State management
|
||||||
|
- Objective tracking
|
||||||
|
- Time tracking
|
||||||
|
- Success/failure detection
|
||||||
|
|
||||||
|
### Module System
|
||||||
|
1. **Attack Module** (`fnc_attackModule.sqf`)
|
||||||
|
- Target configuration
|
||||||
|
- Success/failure settings
|
||||||
|
- Reward configuration
|
||||||
|
- Time limit settings
|
||||||
|
- Mission end conditions
|
||||||
|
|
||||||
|
2. **Defend Module** (`fnc_defendModule.sqf`)
|
||||||
|
- Zone configuration
|
||||||
|
- Wave settings
|
||||||
|
- Force requirements
|
||||||
|
- Reward configuration
|
||||||
|
- Mission end conditions
|
||||||
|
|
||||||
|
3. **Hostage Module** (`fnc_hostageModule.sqf`)
|
||||||
|
- Hostage configuration
|
||||||
|
- Extraction settings
|
||||||
|
- Time limit settings
|
||||||
|
- Reward configuration
|
||||||
|
- Mission end conditions
|
||||||
|
|
||||||
|
4. **HVT Module** (`fnc_hvtModule.sqf`)
|
||||||
|
- Target configuration
|
||||||
|
- Extraction settings
|
||||||
|
- Success/failure settings
|
||||||
|
- Reward configuration
|
||||||
|
- Mission end conditions
|
||||||
|
|
||||||
|
5. **Defuse Module** (`fnc_defuseModule.sqf`)
|
||||||
|
- Explosive configuration
|
||||||
|
- Time limit settings
|
||||||
|
- Success/failure settings
|
||||||
|
- Reward configuration
|
||||||
|
- Mission end conditions
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
To use the task module:
|
||||||
|
```sqf
|
||||||
|
// Create an attack task
|
||||||
|
["task_attack_1", 1, 2, 1500000, -75, 375, false, false] spawn forge_client_task_fnc_attack;
|
||||||
|
|
||||||
|
// Create a defend task
|
||||||
|
["task_defend_1", "defend_marker", 900, 500000, -100, 400, false, false, 3, 300, 1] spawn forge_client_task_fnc_defend;
|
||||||
|
|
||||||
|
// Create a hostage task
|
||||||
|
["task_hostage_1", 1, 2, "extract_marker", 1500000, -75, 500, [false, true], false, false] spawn forge_client_task_fnc_hostage;
|
||||||
|
|
||||||
|
// Create an HVT task
|
||||||
|
["task_hvt_1", 1, 2, "extract_marker", 1500000, -75, 500, false, false] spawn forge_client_task_fnc_hvt;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Integration
|
||||||
|
The task module integrates with other Forge client systems:
|
||||||
|
1. **Organization System**
|
||||||
|
- Fund management
|
||||||
|
- Reputation tracking
|
||||||
|
- Asset rewards
|
||||||
|
- Transaction processing
|
||||||
|
- Balance updates
|
||||||
|
|
||||||
|
2. **Notification System**
|
||||||
|
- Task assignments
|
||||||
|
- Progress updates
|
||||||
|
- Success/failure alerts
|
||||||
|
- Reward notifications
|
||||||
|
- Mission end notifications
|
||||||
|
|
||||||
|
3. **Mission System**
|
||||||
|
- Mission success/failure
|
||||||
|
- End conditions
|
||||||
|
- State management
|
||||||
|
- Progress tracking
|
||||||
|
- Objective management
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
Debug mode can be enabled by uncommenting the following in `script_component.hpp`:
|
||||||
|
```cpp
|
||||||
|
#define DEBUG_MODE_FULL
|
||||||
|
```
|
||||||
|
|
||||||
|
## Version Information
|
||||||
|
Version information is managed through the main Forge client system configuration.
|
||||||
|
|
||||||
|
## Technical Details
|
||||||
|
- Real-time task monitoring
|
||||||
|
- Multi-objective support
|
||||||
|
- Reward system integration
|
||||||
|
- State management
|
||||||
|
- Progress tracking
|
||||||
|
- Time management
|
||||||
|
- Cross-module integration
|
||||||
|
- Event system integration
|
||||||
|
- Notification handling
|
||||||
|
- Error management
|
||||||
|
- Resource management
|
||||||
|
- Mission control
|
||||||
|
- Objective validation
|
Loading…
x
Reference in New Issue
Block a user