ACE3/addons/cargo/functions/fnc_startLoadIn.sqf

/*
 * Author: Glowbal
 * Start load item.
 *
 * Arguments:
 * 0: Player <OBJECT>
 * 1: Object <OBJECT>
 *
 * Return value:
 * Load ProgressBar Started <BOOL>
 *
 * Example:
 * [player, cursorTarget] call ace_cargo_fnc_startLoadIn
 *
 * Public: No
 */
#include "script_component.hpp"

params ["_player", "_object"];
TRACE_2("params",_player,_object);

private _vehicle = [_player] call FUNC(findNearestVehicle);

if ((isNull _vehicle) || {_vehicle isKindOf "Cargo_Base_F"}) then {
    {
        if ([_object, _x] call FUNC(canLoadItemIn)) exitWith {_vehicle = _x};
    } forEach (nearestObjects [_player, ["Cargo_base_F", "Land_PaperBox_closed_F"], MAX_LOAD_DISTANCE]);
};

if (isNull _vehicle) exitWith {
    TRACE_3("Could not find vehicle",_player,_object,_vehicle);
    false
};

private _return = false;
// Start progress bar
if ([_object, _vehicle] call FUNC(canLoadItemIn)) then {
    private _size = [_object] call FUNC(getSizeItem);

    [
        5 * _size,
        [_object,_vehicle],
        {["LoadCargo", _this select 0] call CBA_fnc_localEvent},
        {},
        localize LSTRING(LoadingItem)
    ] call EFUNC(common,progressBar);
    _return = true;
} else {
    private _displayName = getText (configFile >> "CfgVehicles" >> typeOf _object >> "displayName");

    ["displayTextStructured", [[LSTRING(LoadingFailed), _displayName], 3.0]] call CBA_fnc_localEvent;
};

_return
Initial load in cargo module 2015-08-10 21:07:47 +00:00			`/*`
			`* Author: Glowbal`
Cleaned function headers 2015-08-16 20:41:35 +00:00			`* Start load item.`
Initial load in cargo module 2015-08-10 21:07:47 +00:00			`*`
			`* Arguments:`
Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00			`* 0: Player <OBJECT>`
			`* 1: Object <OBJECT>`
Initial load in cargo module 2015-08-10 21:07:47 +00:00			`*`
			`* Return value:`
Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00			`* Load ProgressBar Started <BOOL>`
Initial load in cargo module 2015-08-10 21:07:47 +00:00			`*`
Cleaned function headers 2015-08-16 20:41:35 +00:00			`* Example:`
Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00			`* [player, cursorTarget] call ace_cargo_fnc_startLoadIn`
Cleaned function headers 2015-08-16 20:41:35 +00:00			`*`
Initial load in cargo module 2015-08-10 21:07:47 +00:00			`* Public: No`
			`*/`
			`#include "script_component.hpp"`

			`params ["_player", "_object"];`
Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00			`TRACE_2("params",_player,_object);`
Initial load in cargo module 2015-08-10 21:07:47 +00:00
Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00			`private _vehicle = [_player] call FUNC(findNearestVehicle);`
Initial load in cargo module 2015-08-10 21:07:47 +00:00
Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00			`if ((isNull _vehicle) \|\| {_vehicle isKindOf "Cargo_Base_F"}) then {`
Added load in cargo containers 2015-08-14 20:01:14 +00:00			`{`
Add support for virtual cargo Allows cargo objects to be added via classname and reduces simulation/synchronization overhead. Objects become physical upon unloading and cannot be re-made virtual, only scripts can add such virtual objects. Also separates the player feedback from the loading/unloading code and adds a progress bar. 2015-09-27 16:19:40 +00:00			`if ([_object, _x] call FUNC(canLoadItemIn)) exitWith {_vehicle = _x};`
fix forEach capitalization 2015-11-30 16:23:48 +00:00			`} forEach (nearestObjects [_player, ["Cargo_base_F", "Land_PaperBox_closed_F"], MAX_LOAD_DISTANCE]);`
Added load in cargo containers 2015-08-14 20:01:14 +00:00			`};`

Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00			`if (isNull _vehicle) exitWith {`
			`TRACE_3("Could not find vehicle",_player,_object,_vehicle);`
			`false`
			`};`
Removed semi-colons from return statements, command capitalization 2015-08-16 20:48:52 +00:00
Improve underwater cargo unloading 2016-01-27 20:56:25 +00:00			`private _return = false;`
Add support for virtual cargo Allows cargo objects to be added via classname and reduces simulation/synchronization overhead. Objects become physical upon unloading and cannot be re-made virtual, only scripts can add such virtual objects. Also separates the player feedback from the loading/unloading code and adds a progress bar. 2015-09-27 16:19:40 +00:00			`// Start progress bar`
			`if ([_object, _vehicle] call FUNC(canLoadItemIn)) then {`
Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00			`private _size = [_object] call FUNC(getSizeItem);`
Add support for virtual cargo Allows cargo objects to be added via classname and reduces simulation/synchronization overhead. Objects become physical upon unloading and cannot be re-made virtual, only scripts can add such virtual objects. Also separates the player feedback from the loading/unloading code and adds a progress bar. 2015-09-27 16:19:40 +00:00
Reimplement old parameter syntax for (Un)LoadCargo events 2016-02-23 23:24:51 +00:00			`[`
			`5 * _size,`
			`[_object,_vehicle],`
Replace ACE event system calls with CBA counterparts Regex used: \[(.+?),(.+?),(.+?)\]\s+call\s+E?FUNC\((common,)?(target\|object)Event\) [$1,$3,$2] call CBA_fnc_targetEvent E?FUNC\((common,)?(server\|global\|local)Event\) CBA_fnc_$2Event E?FUNC\((common,)?(add\|remove)EventHandler\) CBA_fnc_$2EventHandler 2016-05-22 15:29:05 +00:00			`{["LoadCargo", _this select 0] call CBA_fnc_localEvent},`
Reimplement old parameter syntax for (Un)LoadCargo events 2016-02-23 23:24:51 +00:00			`{},`
			`localize LSTRING(LoadingItem)`
			`] call EFUNC(common,progressBar);`
Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00			`_return = true;`
Add support for virtual cargo Allows cargo objects to be added via classname and reduces simulation/synchronization overhead. Objects become physical upon unloading and cannot be re-made virtual, only scripts can add such virtual objects. Also separates the player feedback from the loading/unloading code and adds a progress bar. 2015-09-27 16:19:40 +00:00			`} else {`
Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00			`private _displayName = getText (configFile >> "CfgVehicles" >> typeOf _object >> "displayName");`
Add support for virtual cargo Allows cargo objects to be added via classname and reduces simulation/synchronization overhead. Objects become physical upon unloading and cannot be re-made virtual, only scripts can add such virtual objects. Also separates the player feedback from the loading/unloading code and adds a progress bar. 2015-09-27 16:19:40 +00:00
Replace ACE event system calls with CBA counterparts Regex used: \[(.+?),(.+?),(.+?)\]\s+call\s+E?FUNC\((common,)?(target\|object)Event\) [$1,$3,$2] call CBA_fnc_targetEvent E?FUNC\((common,)?(server\|global\|local)Event\) CBA_fnc_$2Event E?FUNC\((common,)?(add\|remove)EventHandler\) CBA_fnc_$2EventHandler 2016-05-22 15:29:05 +00:00			`["displayTextStructured", [[LSTRING(LoadingFailed), _displayName], 3.0]] call CBA_fnc_localEvent;`
Add support for virtual cargo Allows cargo objects to be added via classname and reduces simulation/synchronization overhead. Objects become physical upon unloading and cannot be re-made virtual, only scripts can add such virtual objects. Also separates the player feedback from the loading/unloading code and adds a progress bar. 2015-09-27 16:19:40 +00:00			`};`
Cargo Cleanup, Add makeLoadable 2016-01-19 03:53:48 +00:00
			`_return`