Jacob Schmidt 69f8f037df
All checks were successful
Build / Build (push) Successful in 28s
refactor: Remove tasks.json and update documentation in store functions
This commit removes the `tasks.json` file from the `.vscode` directory. Additionally, it enhances the documentation in `fnc_buyItem.sqf` and `fnc_buyVehicle.sqf` by providing clearer descriptions of item and vehicle types. The `fnc_handlePurchase.sqf` has also been updated to improve variable scoping for better code clarity.
2025-04-19 11:12:53 -05:00
..

Player Organization Module

Overview

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.

Features

  • Organization Creation & Management: Create and disband organizations with customizable names
  • Member Management: Add, remove, and manage organization members with different roles
  • Asset Tracking: Register and manage organization-owned assets (vehicles, buildings, etc.)
  • Financial System: Track organization funds with deposit and withdrawal capabilities
  • Reputation System: Manage organization reputation that can influence gameplay mechanics
  • Database Integration: Persistent storage using ArmaDragonflyClient for reliable data management
  • User-Friendly Notifications: Visual feedback for all organization operations

Usage

Creating an Organization

// Create a new organization with default funds and reputation
[getPlayerUID player, "My Organization"] call forge_client_org_fnc_create;

// Create an organization with custom initial funds and reputation
[getPlayerUID player, "Elite Squad", 5000, 100] call forge_client_org_fnc_create;

Managing Members

// Add a member to your organization
["76561198012345678", "John Doe"] call forge_client_org_fnc_addMember;

// Remove a member from your organization
["76561198012345678"] call forge_client_org_fnc_removeMember;

// Leave an organization (for members)
[] call forge_client_org_fnc_leave;

Managing Assets

// 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

// Add funds to organization account
[1000] call forge_client_org_fnc_addFunds;

// Remove funds from organization account
[-500] call forge_client_org_fnc_addFunds;

Reputation Management

// Increase organization reputation
[10] call forge_client_org_fnc_addReputation;

// Decrease organization reputation
[-5] call forge_client_org_fnc_addReputation;

Disbanding an Organization

// Permanently delete the organization (owner only)
[] call forge_client_org_fnc_disband;

Technical Architecture

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.

Core Components

  • Organization Store: Central interface for all organization operations
  • Database Integration: Persistent storage using ArmaDragonflyClient
  • User Notifications: Visual feedback system for all operations
  • Data Validation: Comprehensive input validation to ensure data integrity

Data Structure

Organizations are stored as structured hashmaps with the following key components:

  • 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