client/addons/interaction/functions/fnc_initInteraction.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

103 lines
2.7 KiB
Plaintext

#include "..\script_component.hpp"
/*
* Function: forge_client_interaction_fnc_initInteraction
* Author: IDSolutions
*
* [Description]
* Initialize player interaction.
*
* Arguments:
* N/A
*
* Return Value:
* N/A
*
* Examples:
* [] spawn forge_client_interaction_fnc_initInteraction;
*
* Public: Yes
*/
FORGE_Team_Coord = "TEAM_COORD" call BFUNC(getParamValue);
FORGE_VA_Enable = "VA_ENABLE" call BFUNC(getParamValue);
FORGE_InteractionButtons = [1600, 1601, 1602, 1603, 1604, 1605, 1606, 1607, 1608];
FORGE_InteractionItems = [
[
["isPlayer cursorObject", "(player distance cursorObject) <= 5"],
["Give Cash", "[cursorObject] spawn forge_client_money_fnc_giveCash"]
],
[
["isPlayer cursorObject", "(player distance cursorObject) <= 5"],
["Add Contact", "[cursorObject] call forge_client_phone_fnc_addContact"]
],
[
["!(isNil {
cursorObject getVariable 'isBank'
})", "(player distance cursorObject) <= 5"],
["Access ATM", "[cursorObject] spawn forge_client_bank_fnc_openBank"]
],
[
["!(isNil {
cursorObject getVariable 'isCPOF'
})", "(player distance cursorObject) <= 5 && (getPlayerUID player) in companyShareholders"],
["Access CPOF", "[cursorObject] spawn forge_client_admin_fnc_openAdmin"]
],
[
["!(isNil {
cursorObject getVariable 'isCash'
})", "(player distance cursorObject) <= 5"],
["Take Cash", "[cursorObject] spawn forge_client_money_fnc_takeCash"]
],
[
["!(isNil {
cursorObject getVariable 'isLocker'
})", "(player distance cursorObject) <= 5"],
["Open Locker", "[cursorObject] spawn forge_client_locker_fnc_openLocker"]
],
[
["!(isNil {
cursorObject getVariable 'isStore'
})", "(player distance cursorObject) <= 5"],
["Access the Store", "[cursorObject] spawn forge_client_store_fnc_openStore"]
]
];
if (FORGE_Team_Coord == 1) then {
FORGE_InteractionItems append [
[
["!(isNil {
cursorObject getVariable 'isGarage'
})", "(player distance cursorObject) <= 5 && (getPlayerUID player) in companyShareholders"],
["Open Company Garage", "[cursorObject] spawn forge_client_garage_fnc_openGarage"]
]
];
} else {
FORGE_InteractionItems append [
[
["!(isNil {
cursorObject getVariable 'isGarage'
})", "(player distance cursorObject) <= 5"],
["Open Garage", "[cursorObject] spawn forge_client_garage_fnc_openGarage"]
]
];
};
if (FORGE_VA_Enable == 1) then {
FORGE_InteractionItems append [
[
["!(isNil {
cursorObject getVariable 'isLocker'
})", "(player distance cursorObject) <= 5"],
["Virtual Armory", "[] spawn forge_client_arsenal_fnc_openArmory"]
],
[
["!(isNil {
cursorObject getVariable 'isGarage'
})", "(player distance cursorObject) <= 5"],
["Virtual Garage", "[cursorObject] spawn forge_client_arsenal_fnc_openGarage"]
]
];
};