Jacob Schmidt 44625a8677
All checks were successful
Build / Build (push) Successful in 27s
feat: Refactor and document client-side functions
This commit refactors and adds documentation to several client-side functions across various addons, including:

- **Task Addon:** Added function headers and descriptions to task-related functions (fnc_destroy, fnc_attack, fnc_defuse, fnc_hostage, fnc_makeIED, fnc_hvt, fnc_heartBeat, fnc_makeTarget, fnc_makeHVT, fnc_makeHostage, fnc_makeObject, fnc_makeShooter, fnc_attackModule, fnc_destroyModule, fnc_hvtModule, fnc_hostageModule, fnc_defuseModule, fnc_protectedModule, fnc_hostagesModule, fnc_explosivesModule, fnc_shootersModule).
- **Org Addon:** Updated author and added function headers/descriptions to organization-related functions (fnc_initOrgStore, fnc_requestServerDB, fnc_addAsset, fnc_addReputation, fnc_create, fnc_removeAsset, fnc_addFunds, fnc_leave, fnc_addMember, fnc_disband, fnc_verifyOrgStore, fnc_handleOrgLoad).
- **Garage Addon:** Added function headers and descriptions to garage-related functions (fnc_openGarage, fnc_fetchNearby, fnc_initGarage, fnc_fetchGarage, fnc_storeVehicle).
- **Locker Addon:** Added function headers and descriptions to locker-related functions (fnc_openLocker, fnc_fetchPlayer, fnc_initLocker, fnc_fetchLocker).
- **Phone Addon:** Added function headers, descriptions, and examples to phone-related functions (fnc_initAction, fnc_showEmail, fnc_showMessage, fnc_delEmail, fnc_delMsg, fnc_showMessageInput, fnc_addContact, fnc_initPhone, fnc_addMsg, fnc_addEmail, fnc_newEmail, fnc_initVar, fnc_addOfflineEmail, fnc_addOfflineMsg, fnc_sendMsg, fnc_sendEmail, fnc_showContact, fnc_newMsg, fnc_dateToHhMm, fnc_initAddAction, fnc_openPhone, fnc_viewSettings, fnc_viewMessages, fnc_viewContacts, fnc_viewEmail, fnc_showDialpad, fnc_showSafari).
- **Admin Addon:** Added function headers and descriptions to admin-related functions (fnc_adminMessage, fnc_printAddonName, fnc_initAdmin, fnc_openAdmin, fnc_adminPromote).
- **Store Addon:** Added function headers and descriptions to store-related functions (fnc_openStore, fnc_initStore, fnc_selectProduct, fnc_changeFilter, fnc_changePayment, fnc_handlePurchase).
- **Medical Addon:** Added function headers, descriptions, and examples to medical-related functions (fnc_saveDroppedWeapons, fnc_moveInventory, fnc_onRespawn, fnc_onKilled, fnc_initMedical, fnc_deductMedicalCost, fnc_heartBeat).
- **Misc Addon:** Added function headers, descriptions, and examples to misc-related functions (fnc_formatNumber, fnc_isAssignableBinocular, fnc_isWeaponType, fnc_cargoToPairs, fnc_serializeString, fnc_deserializeString, fnc_getSystemTime).
- **Init Addon:** Updated author and removed unnecessary copyright information from init-related functions (fnc_initPlayer, fnc_playerDBSave, fnc_playerSaveLoop, fnc_playerDBLoad, fnc_handlePlayerLoad).
- **Money Addon:** Removed unnecessary copyright information from money-related functions (fnc_takeCash, fnc_giveCash, fnc_giveCashSubmit).
- **Interaction Addon:** Removed unnecessary copyright information from interaction-related functions (fnc_initInteraction, fnc_openInteraction, fnc_interactionAction).
- **Ambient Addon:** Removed unnecessary copyright information from ambient-related functions (fnc_ambientSound).
- **Arsenal Addon:** Added function headers, descriptions, and examples to arsenal-related functions (fnc_openArmory, fnc_saveUnlocks, fnc_updateUnlocks, fnc_openGarage, fnc_addGarageVehicle, fnc_addVirtualVehicles, fnc_addVirtualVehicles).
- **Dialogue Addon:** Added function headers and descriptions to dialogue-related functions (fnc_selectAI, fnc_selectDialogue).
- **Service Addon:** Added function headers and descriptions to service-related functions (fnc_initService).
- **Bank Addon:** Added function headers and descriptions to bank-related functions (fnc_initBank, fnc_refresh, fnc_openBank).

These changes improve code readability, maintainability, and provide better context for developers working with these functions. The author field was updated to `IDSolutions` where appropriate.
2025-04-05 16:12:32 -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