BIS fnc getRespawnInventories: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(34 intermediate revisions by 4 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
|descr= Return respawn inventories available for the given target.
____________________________________________________________________________________________


| <pre>/*
|s1= [target, showDisabled, returnAllInfo] call [[BIS_fnc_getRespawnInventories]]
Description:
Return respawn inventories available for the given unit


Parameter(s):
|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]]
0: OBJECT, GROUP, SIDE or NAMESPACE
1 (Optional): BOOL - true to show even inventories disabled by curator
2 (Optional): BOOL - true to return namespace, inventory and role limits (used in the new respawn screen) instead of inventories itself


Returns:
|p2= showDisabled: [[Boolean]] - (Optional, default [[false]]) [[true]] to show even inventories disabled by curator
ARRAY (of Strings)
*/


|p3= returnAllInfo: [[Boolean]] - (Optional, default [[false]]) [[true]] to return namespace, inventory and role limits (used in the new respawn screen), [[false]] to return only inventories


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


| <!-- [] call [[BIS_fnc_getRespawnInventories]]; --> |= Syntax
|x1= <sqf>private _respawnInfo = [player] call BIS_fnc_getRespawnInventories;</sqf>


|p1= |= Parameter 1
|x2= <sqf>private _respawnInfo = [west, true, false] call BIS_fnc_getRespawnInventories;</sqf>
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[Arma 3: Respawn]] [[BIS_fnc_addRespawnInventory]] [[BIS_fnc_removeRespawnInventory]] [[BIS_fnc_setRespawnInventory]] [[BIS_fnc_getRespawnMarkers]] [[BIS_fnc_getRespawnPositions]]
}}
}}
<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:getRespawnInventories}}]]
[[Category:Functions|{{uc:getRespawnInventories}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getRespawnInventories}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 1, 2016 - 12:41 (UTC)</dd>
<dt class="note">[[User:Krzmbrzl00|Krzmbrzl00]]</dt>
<dd class="note">
(ArmA 1.60)<br>
This function seems to work only for engine inventories (e.g. the ones automatically added because of the current unit loadout).<br>
The ones added via [[BIS_fnc_addRespawnInventory]] are not returned by this function.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 17:00, 13 July 2022

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

Description

Description:
Return respawn inventories available for the given target.
Execution:
call
Groups:
Respawn

Syntax

Syntax:
[target, showDisabled, returnAllInfo] call BIS_fnc_getRespawnInventories
Parameters:
target: Namespace, Side, Group or Object
showDisabled: Boolean - (Optional, default false) true to show even inventories disabled by curator
returnAllInfo: Boolean - (Optional, default false) true to return namespace, inventory and role limits (used in the new respawn screen), false to return only inventories
Return Value:
Array of String

Examples

Example 1:
private _respawnInfo = [player] call BIS_fnc_getRespawnInventories;
Example 2:
private _respawnInfo = [west, true, false] call BIS_fnc_getRespawnInventories;

Additional Information

See also:
Arma 3: Respawn BIS_fnc_addRespawnInventory BIS_fnc_removeRespawnInventory BIS_fnc_setRespawnInventory BIS_fnc_getRespawnMarkers BIS_fnc_getRespawnPositions

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_getRespawnInventories&oldid=328380"