client/addons/service/functions/fnc_vehicle.sqf
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

85 lines
2.7 KiB
Plaintext

#include "..\script_component.hpp"
/*
* Function: forge_client_service_fnc_vehicle
* Author: Creedcoder, J. Schmidt
*
* Description:
* Handles servicing of vehicles including rearmament, refueling, and repairs.
* Calculates and deducts service costs from the player's organization funds.
*
* Arguments:
* 0: Vehicle <OBJECT> - The vehicle to service
* 1: Vehicle Kind <STRING> - The type of vehicle to check ("LAND", "AIR", etc.)
*
* Return Value:
* None
*
* Example:
* [vehicle, "LAND"] call forge_client_service_fnc_vehicle;
*
* Notes:
* - Vehicle must be stationary (speed < 1)
* - Player must be the driver of the vehicle
* - Costs are automatically calculated and deducted
*
* Trigger Example:
* _trg = createTrigger ["EmptyDetector", getPos player];
* _trg setTriggerArea [5, 5, 0, false];
* _trg setTriggerActivation ["ANYPLAYER", "PRESENT", true];
* _trg setTriggerStatements [
* "call { {_x iskindof 'LAND' && speed _x < 1} count thisList > 0; };",
* "call { _handle = [(thisList select 0), 'LAND'] spawn forge_client_service_fnc_vehicle; };",
* ""
* ];
*
* Public: No
*/
params ["_veh", "_vehKind"];
private _store = missionNamespace getVariable ["FORGE_ORG_STORE_REG", createHashMap];
private _org = _store call ["getOrg", []];
if (_org isEqualTo nil) exitWith {
["You are not in an organization!", "warning", 3] call EFUNC(misc,notify);
};
private _orgFunds = _org get "funds";
private _veh = _this select 0;
private _vehType = getText (configFile >> "CfgVehicles" >> typeOf _veh >> "DisplayName");
private _rearmCost = 0;
private _refuelCost = 0;
private _repairCost = 0;
private _totalCost = 0;
if ((_veh isKindOf _vehKind) && (driver _veh == player)) exitWith {
_veh vehicleChat format ["Servicing %1... Please Stand By...", _vehType];
uiSleep 3;
_rearmCost = [_veh, _vehType] call FUNC(rearm);
_refuelCost = [_veh, _vehType] call FUNC(refuel);
_repairCost = [_veh, _vehType] call FUNC(repair);
_totalCost = (_rearmCost + _repairCost + _refuelCost);
private _formattedRearmCost = (_rearmCost) call EFUNC(misc,formatNumber);
private _formattedRefuelCost = (_refuelCost) call EFUNC(misc,formatNumber);
private _formattedRepairCost = (_RepairCost) call EFUNC(misc,formatNumber);
private _formattedTotalCost = (_totalCost) call EFUNC(misc,formatNumber);
_store call ["updateFunds", -_totalCost];
[format ["SERVICE COST:
<br/>Rearmament: $%1
<br/>Repairs: $%2
<br/>Refueling: $%3
<br/>Total: $%4
<br/>Billed to SOF PMC Group.",
_formattedRearmCost, _formattedRepairCost, _formattedRefuelCost, _formattedTotalCost], "blue-grey", 8] call EFUNC(misc,notify);
_veh vehicleChat format ["Service Completed for %1", _vehType];
};