client/addons/locker/functions/fnc_fetchPlayer.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

131 lines
5.2 KiB
Plaintext

#include "..\script_component.hpp"
/*
* Function: forge_client_locker_fnc_fetchPlayer
* Author: IDSolutions
*
* [Description]
* Fetches the player's gear.
*
* Arguments:
* N/A
*
* Return Value:
* N/A
*
* Examples:
* [] call forge_client_locker_fnc_fetchPlayer;
*
* Public: Yes
*/
private _display = findDisplay IDD_LOCKERDIALOG;
private _itemList = _display displayCtrl IDC_PLAYEREQUIPMENTLIST;
private _data = [];
_data pushBack ["backpack", backpack player];
_data pushBack ["facewear", goggles player];
_data pushBack ["headgear", headgear player];
_data pushBack ["hmd", hmd player];
_data pushBack ["uniform", uniform player];
_data pushBack ["vest", vest player];
_data pushBack ["weapon", primaryWeapon player];
_data pushBack ["weapon", secondaryWeapon player];
_data pushBack ["weapon", handgunWeapon player];
{
_data pushBack ["item", _x];
} forEach (assignedItems player + items player);
{
private _magClass = _x select 0;
private _ammoCount = _x select 1;
private _magLocation = _x select 4;
private _ammoFull = getNumber (configFile >> "CfgMagazines" >> _magClass >> "count");
if (_magLocation in ["Uniform", "Vest", "Backpack"]) then {
_data pushBack ["magazine", [_magClass, _ammoCount, _ammoFull, _magLocation]];
};
} forEach (magazinesAmmoFull player);
_data = _data select { !(_x in [["backpack", ""], ["facewear", ""], ["headgear", ""], ["hmd", ""], ["item", ""], ["magazine", ""], ["uniform", ""], ["vest", ""], ["weapon", ""]]) };
{
_x params ["_itemType", "_item"];
private _index = -1;
switch (_itemType) do {
case "backpack": {
private _displayName = getText (configFile >> "CfgVehicles" >> _item >> "displayName");
private _picture = getText (configFile >> "CfgVehicles" >> _item >> "picture");
_index = _itemList lbAdd _displayName;
_itemList lbSetData [_index, str [_itemType, _item]];
_itemList lbSetPicture [_index, _picture];
};
case "facewear": {
private _displayName = getText (configFile >> "CfgGlasses" >> _item >> "displayName");
private _picture = getText (configFile >> "CfgGlasses" >> _item >> "picture");
_index = _itemList lbAdd _displayName;
_itemList lbSetData [_index, str [_itemType, _item]];
_itemList lbSetPicture [_index, _picture];
};
case "headgear": {
private _displayName = getText (configFile >> "CfgWeapons" >> _item >> "displayName");
private _picture = getText (configFile >> "CfgWeapons" >> _item >> "picture");
_index = _itemList lbAdd _displayName;
_itemList lbSetData [_index, str [_itemType, _item]];
_itemList lbSetPicture [_index, _picture];
};
case "hmd": {
private _displayName = getText (configFile >> "CfgWeapons" >> _item >> "displayName");
private _picture = getText (configFile >> "CfgWeapons" >> _item >> "picture");
_index = _itemList lbAdd _displayName;
_itemList lbSetData [_index, str [_itemType, _item]];
_itemList lbSetPicture [_index, _picture];
};
case "item": {
private _displayName = getText (configFile >> "CfgWeapons" >> _item >> "displayName");
private _picture = getText (configFile >> "CfgWeapons" >> _item >> "picture");
_index = _itemList lbAdd _displayName;
_itemList lbSetData [_index, str [_itemType, _item]];
_itemList lbSetPicture [_index, _picture];
};
case "magazine": {
private _displayName = format ["%1 (%2/%3) [%4]", getText (configFile >> "CfgMagazines" >> (_item select 0) >> "displayName"), (_item select 1), (_item select 2), (_item select 3)];
private _picture = getText (configFile >> "CfgMagazines" >> (_item select 0) >> "picture");
_index = _itemList lbAdd _displayName;
_itemList lbSetData [_index, str [_itemType, _item]];
_itemList lbSetPicture [_index, _picture];
};
case "uniform": {
private _displayName = getText (configFile >> "CfgWeapons" >> _item >> "displayName");
private _picture = getText (configFile >> "CfgWeapons" >> _item >> "picture");
_index = _itemList lbAdd _displayName;
_itemList lbSetData [_index, str [_itemType, _item]];
_itemList lbSetPicture [_index, _picture];
};
case "vest": {
private _displayName = getText (configFile >> "CfgWeapons" >> _item >> "displayName");
private _picture = getText (configFile >> "CfgWeapons" >> _item >> "picture");
_index = _itemList lbAdd _displayName;
_itemList lbSetData [_index, str [_itemType, _item]];
_itemList lbSetPicture [_index, _picture];
};
case "weapon": {
private _displayName = getText (configFile >> "CfgWeapons" >> _item >> "displayName");
private _picture = getText (configFile >> "CfgWeapons" >> _item >> "picture");
_index = _itemList lbAdd _displayName;
_itemList lbSetData [_index, str [_itemType, _item]];
_itemList lbSetPicture [_index, _picture];
};
};
} forEach _data;