BIS fnc removeRespawnInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.60


|0.74|= Game version
|gr1= Respawn


|eff= global |=
|eff= global
____________________________________________________________________________________________


| Remove a respawn inventory added by [[BIS_fnc_addRespawnInventory]]. |DESCRIPTION=
|descr= Remove a respawn inventory added by [[BIS_fnc_addRespawnInventory]].
____________________________________________________________________________________________


| [target,id] call [[BIS_fnc_removeRespawnInventory]]; |SYNTAX=
|s1= [target, id] call [[BIS_fnc_removeRespawnInventory]]


|p1= '''target''': [[Namespace]] or [[Side]] or [[Group]] or [[Object]]|=
|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]]
|p2= '''id''': [[Number]]|=


| [[Boolean]] |RETURNVALUE=
|p2= id: [[Number]]
____________________________________________________________________________________________
 
|x1= <code><nowiki>[</nowiki>[[west]], 1] [[call]] [[BIS_fnc_removeRespawnInventory]];</code> |=


|x2= <code>myRespawnInventory = <nowiki>[</nowiki>[[missionNamespace]],"ATSniper"] [[call]] [[BIS_fnc_addRespawnInventory]];
|r1= [[Boolean]]
myRespawnInventory [[call]] [[BIS_fnc_removeRespawnInventory]];
</code> |=
____________________________________________________________________________________________


| [[BIS_fnc_addRespawnInventory]], [[BIS_fnc_getRespawnInventories]], [[Arma 3 Respawn]] |SEEALSO=
|x1= <sqf>[west, 1] call BIS_fnc_removeRespawnInventory;</sqf>


|x2= <sqf>
private _myRespawnInventory = [missionNamespace,"ATSniper"] call BIS_fnc_addRespawnInventory;
_myRespawnInventory call BIS_fnc_removeRespawnInventory;
</sqf>
|seealso= [[Arma 3: Respawn]] [[BIS_fnc_addRespawnInventory]] [[BIS_fnc_getRespawnInventories]] [[BIS_fnc_setRespawnInventory]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Krzmbrzl00
<!-- Note Section BEGIN -->
|timestamp= 20160701172900
 
|text= To remove all inventories that are currently available you can use the following:<br>
<!-- Note Section END -->
<sqf>
</dl>
{
 
[missionNamespace, _x] call BIS_fnc_removeRespawnInventory;
<h3 style="display:none">Bottom Section</h3>
} forEach ([missionNamespace, true] call BIS_fnc_getRespawnInventories;
[[Category:Function Group: Respawn|{{uc:removeRespawnInventory}}]]
</sqf>
[[Category:Functions|{{uc:removeRespawnInventory}}]]
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.
[[Category:{{Name|arma3}}: Functions|{{uc:removeRespawnInventory}}]]
}}
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 1, 2016 - 12:48 (UTC)</dd>
<dt class="note">[[User:Krzmbrzl00|Krzmbrzl00]]</dt>
<dd class="note">
(ArmA 1.60)<br>
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 -->
 
<!-- 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>{
    [ missionNamespace, _x] call [[BIS_fnc_removeRespawnInventory]];
} forEach ([missionNamespace, true] call [[BIS_fnc_getRespawnInventories]];
</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 12:42, 13 July 2022

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:
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:
{ [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=327903"