Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add CBA_fnc_binocularMagazine #325

Merged
merged 6 commits into from
May 15, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions addons/common/CfgFunctions.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@ class CfgFunctions {
F_FILEPATH(dropWeapon);
F_FILEPATH(dropMagazine);
F_FILEPATH(dropItem);
F_FILEPATH(binocularMagazine);
F_FILEPATH(addBinocularMagazine);
F_FILEPATH(removeBinocularMagazine);
};

class Cargo {
Expand Down
40 changes: 40 additions & 0 deletions addons/common/fnc_addBinocularMagazine.sqf
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/* ----------------------------------------------------------------------------
Function: CBA_fnc_addBinocularMagazine

Description:
Adds a magazine to the units rangefinder.

Note that this breaks the unique magazine ids due to the usage of setUnitLoadout.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add an empty line after the first sentence. The first sentence can(*) then be used to generate a description field for CfgFunctions entries.

(*) The old Ruby script that does this needs updating, but with the Description: paragraph in this form, automation is possible.


Parameters:
_unit - A unit <OBJECT>
_magazine - The magazine to add <STRING>
_ammo - Ammo count of the magazine (optional, default: full magazine) <NUMBER>

Returns:
None

Examples:
(begin example)
player addWeapon "Laserdesignator";
[player, "Laserbatteries"] call CBA_fnc_addBinocularMagazine;
(end)

Author:
commy2
---------------------------------------------------------------------------- */
#include "script_component.hpp"
SCRIPT(addBinocularMagazine);

params [["_unit", objNull, [objNull]], ["_magazine", "", [""]], ["_ammo", nil, [0]]];

if (!local _unit) exitWith {};

if (isNil "_ammo") then {
_ammo = getNumber (configFile >> "CfgMagazines" >> _magazine >> "count");
};

private _loadout = getUnitLoadout _unit;
(_loadout select 8) set [4, [_magazine, _ammo]];

_unit setUnitLoadout _loadout;
36 changes: 36 additions & 0 deletions addons/common/fnc_binocularMagazine.sqf
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/* ----------------------------------------------------------------------------
Function: CBA_fnc_binocularMagazine

Description:
Returns the magazine of the units rangefinder.

Parameters:
_unit - A unit <OBJECT>

Returns:
Magazine of the units binocular <STRING>

Examples:
(begin example)
player call CBA_fnc_binocularMagazine
(end)

Author:
commy2
---------------------------------------------------------------------------- */
#include "script_component.hpp"
SCRIPT(binocularMagazine);

params [["_unit", objNull, [objNull]]];

private _binocular = binocular _unit;
private _magazine = "";

{
if ((_x select 0) isEqualTo _binocular) exitWith {
// note: if there is no magazine, _x(4,0) will be nil
_magazine = (_x select 4) param [0, ""];
};
} forEach weaponsitems _unit;

_magazine
35 changes: 35 additions & 0 deletions addons/common/fnc_removeBinocularMagazine.sqf
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/* ----------------------------------------------------------------------------
Function: CBA_fnc_removeBinocularMagazine

Description:
Removes the magazine of the units rangefinder.

Parameters:
_unit - A unit <OBJECT>

Returns:
None

Examples:
(begin example)
player call CBA_fnc_removeBinocularMagazine
(end)

Author:
commy2
---------------------------------------------------------------------------- */
#include "script_component.hpp"
SCRIPT(removeBinocularMagazine);

params [["_unit", objNull, [objNull]]];

if (!local _unit) exitWith {};

private _binocular = binocular _unit;
private _selectBinocular = currentWeapon _unit isEqualTo _binocular;

_unit addWeapon _binocular;

if (_selectBinocular) then {
_unit selectWeapon _binocular;
};