BIS fnc invString: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Inventory |GROUP1=")
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1 = Inventory |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


|Returns inventory contents of given vehicle (unit).
|game4= arma3
|version4= 0.50
Note: for vehicles it returns mounted gun and its ammo, not cargo weapons and ammo.|Description=
____________________________________________________________________________________________


| [object] call [[BIS_fnc_invString]] |Syntax=
|gr1= Inventory


|p1=object: [[Object]] |Parameter 1=
|descr=Returns inventory contents of given vehicle (unit).
Note: for vehicles it returns mounted gun and its ammo, not cargo weapons and ammo.


| [[Array]] - Weapons and magazines|Return value=
|s1= [object] call [[BIS_fnc_invString]]


____________________________________________________________________________________________
|p1=object: [[Object]]


|x1= <code>[ [[player]] ] [[call]] [[BIS_fnc_invString]];</code>|Example 1=
|r1= [[Array]] - weapons and magazines


____________________________________________________________________________________________
|x1= <sqf>[player] call BIS_fnc_invString;</sqf>


| [[BIS_fnc_invRemove]], [[BIS_fnc_invCodeToArray]], [[BIS_fnc_invSlots]], [[BIS_fnc_invSlotsEmpty]], [[BIS_fnc_invSlotType]], [[BIS_fnc_invAdd]] |See also=
|seealso= [[BIS_fnc_invRemove]] [[BIS_fnc_invCodeToArray]] [[BIS_fnc_invSlots]] [[BIS_fnc_invSlotsEmpty]] [[BIS_fnc_invSlotType]] [[BIS_fnc_invAdd]]
}}
}}
<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:invString}}]]
[[Category:Functions|{{uc:invString}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:invString}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:invString}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:invString}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:invString}}]]

Latest revision as of 17:27, 8 November 2023

Hover & click on the images for description

Description

Description:
Returns inventory contents of given vehicle (unit). Note: for vehicles it returns mounted gun and its ammo, not cargo weapons and ammo.
Execution:
call
Groups:
Inventory

Syntax

Syntax:
[object] call BIS_fnc_invString
Parameters:
object: Object
Return Value:
Array - weapons and magazines

Examples

Example 1:
[player] call BIS_fnc_invString;

Additional Information

See also:
BIS_fnc_invRemove BIS_fnc_invCodeToArray BIS_fnc_invSlots BIS_fnc_invSlotsEmpty BIS_fnc_invSlotType BIS_fnc_invAdd

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