BIS fnc hasItem: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name" to "|Game name=")
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|Comments=
|game1= arma3
____________________________________________________________________________________________
|version1= 1.94


| arma3 |Game name=
|gr1= Inventory


|1.94|Game version=
|descr= Returns [[true]] if object contains given item in inventory / cargo storage.
____________________________________________________________________________________________
{{Feature | important | This function performs a deep search of inventory / cargo storage, thus is not suitable for per-frame execution.}}


| Returns [[true]] if object contains given item in inventory / cargo storage.<br><br>
|s1= [object, item, searchCrew] call [[BIS_fnc_hasItem]]
{{Important | This function performs a deep search of inventory / cargo storage, thus is not suitable for per-frame execution}} |DESCRIPTION=
____________________________________________________________________________________________


| [object, item, searchCrew] call '''BIS_fnc_hasItem'''; |SYNTAX=
|p1= object: [[Object]] or [[Group]] - unit, vehicle, container or group of units (since v1.95)


|p1=[object, item, searchCrew]: [[Array]]|PARAMETER1=
|p2= item: [[String]] - item to find
|p2= object: [[Object]] - unit, vehicle or other container |PARAMETER2=
|p3= item: [[String]] - item to find |PARAMETER3=
|p4= searchCrew (Optional): [[Boolean]] - [[true]] to search vehicle crew as well if object is a vehicle. Default - [[false]] |PARAMETER4=


| [[Boolean]] - [[true]] if has item |RETURNVALUE=
|p3= searchCrew: [[Boolean]] - (Optional, default [[false]]) [[true]] to search vehicle crew as well if object is a vehicle
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[[player]], "ItemMap"] [[call]] [[BIS_fnc_hasItem]];</code> |=
|r1= [[Boolean]] - [[true]] if has item
|x2= <code>[tank, "FirstAidKit", [[true]]] [[call]] [[BIS_fnc_hasItem]];</code> |=
____________________________________________________________________________________________


| |SEEALSO=
|x1= <sqf>[player, "ItemMap"] call BIS_fnc_hasItem;</sqf>


|x2= <sqf>[tank, "FirstAidKit", true] call BIS_fnc_hasItem;</sqf>
|seealso=
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Inventory|{{uc:hasItem}}]]
[[Category:Functions|{{uc:hasItem}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:hasItem}}]]

Latest revision as of 17:00, 13 July 2022

Hover & click on the images for description

Description

Description:
Returns true if object contains given item in inventory / cargo storage.
This function performs a deep search of inventory / cargo storage, thus is not suitable for per-frame execution.
Execution:
call
Groups:
Inventory

Syntax

Syntax:
[object, item, searchCrew] call BIS_fnc_hasItem
Parameters:
object: Object or Group - unit, vehicle, container or group of units (since v1.95)
item: String - item to find
searchCrew: Boolean - (Optional, default false) true to search vehicle crew as well if object is a vehicle
Return Value:
Boolean - true if has item

Examples

Example 1:
[player, "ItemMap"] call BIS_fnc_hasItem;
Example 2:
[tank, "FirstAidKit", true] call BIS_fnc_hasItem;

Additional Information

See also:
See also needed

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note