BIS fnc removeRespawnInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(43 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Respawn


|1.00|= Game version
|eff= global
____________________________________________________________________________________________


| <pre>/*
|descr= Remove a respawn inventory added by [[BIS_fnc_addRespawnInventory]].


Description:
|s1= [target, id] call [[BIS_fnc_removeRespawnInventory]]
Remove a respawn inventory


Parameter(s):
|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]]
0:
NAMESPACE
SIDE
GROUP
OBJECT
1: NUMBER - id or class from CfgInventories of CfgVehicles
(both parameters were returned by BIS_fnc_addRespawnInventory)


Returns:
|p2= id: [[Number]]
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|r1= [[Boolean]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_removeRespawnInventory]]; --> |= Syntax
|x1= <sqf>[west, 1] call BIS_fnc_removeRespawnInventory;</sqf>


|p1= |= Parameter 1
|x2= <sqf>
private _myRespawnInventory = [missionNamespace,"ATSniper"] call BIS_fnc_addRespawnInventory;
_myRespawnInventory call BIS_fnc_removeRespawnInventory;
</sqf>


| |= Return value
|seealso= [[Arma 3: Respawn]] [[BIS_fnc_addRespawnInventory]] [[BIS_fnc_getRespawnInventories]] [[BIS_fnc_setRespawnInventory]]
____________________________________________________________________________________________
}}
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


{{Note
|user= Krzmbrzl00
|timestamp= 20160701172900
|text= To remove all inventories that are currently available you can use the following:<br>
<sqf>
{
[missionNamespace, _x] call BIS_fnc_removeRespawnInventory;
} forEach ([missionNamespace, true] call BIS_fnc_getRespawnInventories;
</sqf>
If all available inventories are removed, the default inventory for the current unit (as it would be placed in the editor) will be added automatically.
}}
}}
<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: Respawn|{{uc:removeRespawnInventory}}]]
[[Category:Functions|{{uc:removeRespawnInventory}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeRespawnInventory}}]]

Latest revision as of 12:42, 13 July 2022

Hover & click on the images for description

Description

Description:
Remove a respawn inventory added by BIS_fnc_addRespawnInventory.
Execution:
call
Groups:
Respawn

Syntax

Syntax:
[target, id] call BIS_fnc_removeRespawnInventory
Parameters:
target: Namespace, Side, Group or Object
id: Number
Return Value:
Boolean

Examples

Example 1:
[west, 1] call BIS_fnc_removeRespawnInventory;
Example 2:
private _myRespawnInventory = [missionNamespace,"ATSniper"] call BIS_fnc_addRespawnInventory; _myRespawnInventory call BIS_fnc_removeRespawnInventory;

Additional Information

See also:
Arma 3: Respawn BIS_fnc_addRespawnInventory BIS_fnc_getRespawnInventories BIS_fnc_setRespawnInventory

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
Krzmbrzl00 - c
Posted on Jul 01, 2016 - 17:29 (UTC)
To remove all inventories that are currently available you can use the following:
If all available inventories are removed, the default inventory for the current unit (as it would be placed in the editor) will be added automatically.