BIS fnc removeRespawnInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Fix page)
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________


{{Function|= Comments
| arma3 |Game name=
____________________________________________________________________________________________


| arma3 |= Game name
|1.60|Game version=


|1.00|= Game version
|eff= global |MP Effect=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


Parameter(s):
|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]] |Parameter 1=
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]] |Parameter 2=
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
 
|x1= <code><nowiki>[</nowiki>[[west]], 1] [[call]] [[BIS_fnc_removeRespawnInventory]];</code> |Example 1=


| <!-- [] call [[BIS_fnc_removeRespawnInventory]]; --> |= Syntax
|x2= <code>[[private]] _myRespawnInventory = <nowiki>[</nowiki>[[missionNamespace]],"ATSniper"] [[call]] [[BIS_fnc_addRespawnInventory]];
 
_myRespawnInventory [[call]] [[BIS_fnc_removeRespawnInventory]];</code> |Example 2=
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=
| [[Arma 3 Respawn]], [[BIS_fnc_addRespawnInventory]], [[BIS_fnc_getRespawnInventories]], [[BIS_fnc_setRespawnInventory]] |SEEALSO=
____________________________________________________________________________________________
 
| |= See also
 
}}
}}


Line 54: Line 41:
[[Category:Functions|{{uc:removeRespawnInventory}}]]
[[Category:Functions|{{uc:removeRespawnInventory}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeRespawnInventory}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeRespawnInventory}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 1, 2016 - 17:29 (UTC)</dd>
<dt class="note">[[User:Krzmbrzl00|Krzmbrzl00]]</dt>
<dd class="note">
To remove all inventories that are currently available you can use the following:<br>
<code>{
<nowiki>[</nowiki>[[missionNamespace]], [[_x]]] [[call]] [[BIS_fnc_removeRespawnInventory]];
} [[forEach]] (<nowiki>[</nowiki>[[missionNamespace]], [[true]]] [[call]] [[BIS_fnc_getRespawnInventories]];</code>
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.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 21:58, 27 July 2019

Arma 3 logo black.png1.60
GEGlobal
Hover & click on the images for description

Description

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

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 RespawnBIS_fnc_addRespawnInventoryBIS_fnc_getRespawnInventoriesBIS_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

Notes

Bottom Section

Posted on July 1, 2016 - 17:29 (UTC)
Krzmbrzl00
To remove all inventories that are currently available you can use the following:
{ [missionNamespace, _x] call BIS_fnc_removeRespawnInventory; } forEach ([missionNamespace, true] call BIS_fnc_getRespawnInventories; 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.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_removeRespawnInventory&oldid=125174"