BIS fnc getRespawnInventories: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(Page formatting)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________


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


| arma3 |= Game name
| Return respawn inventories available for the given target. |DESCRIPTION=
 
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


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


Parameter(s):
|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]] |PARAMETER1=
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 |PARAMETER2=
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 |PARAMETER3=


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


| <!-- [] call [[BIS_fnc_getRespawnInventories]]; --> |SYNTAX=
|x1= <code>[[private]] _respawnInfo = <nowiki>[</nowiki>[[player]]] [[call]] [[BIS_fnc_getRespawnInventories]];</code> |Example 1=


|p1= |PARAMETER1=
|x2= <code>[[private]] _respawnInfo = <nowiki>[</nowiki>[[west]], [[true]], [[false]]] [[call]] [[BIS_fnc_getRespawnInventories]];</code> |Example 2=
 
| |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=
| [[Arma 3 Respawn]], [[BIS_fnc_addRespawnInventory]], [[BIS_fnc_removeRespawnInventory]], [[BIS_fnc_setRespawnInventory]], [[BIS_fnc_getRespawnMarkers]], [[BIS_fnc_getRespawnPositions]] |SEEALSO=
____________________________________________________________________________________________
 
| |SEEALSO=
 
}}
}}


Line 50: Line 40:
[[Category:Functions|{{uc:getRespawnInventories}}]]
[[Category:Functions|{{uc:getRespawnInventories}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getRespawnInventories}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getRespawnInventories}}]]
<!-- CONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 21:10, 27 July 2019

Hover & click on the images for description

Description

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

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

Notes

Bottom Section