BIS fnc getRespawnInventories: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.60|Game version=
|1.60


|gr1= Respawn |GROUP1=
|gr1= Respawn


| Return respawn inventories available for the given target. |DESCRIPTION=
| Return respawn inventories available for the given target.


| [target, showDisabled, returnAllInfo] call [[BIS_fnc_getRespawnInventories]] |SYNTAX=
| [target, showDisabled, returnAllInfo] call [[BIS_fnc_getRespawnInventories]]


|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]] |PARAMETER1=
|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]]


|p2= showDisabled: [[Boolean]] - (Optional, default [[false]]) [[true]] to show even inventories disabled by curator |PARAMETER2=
|p2= showDisabled: [[Boolean]] - (Optional, default [[false]]) [[true]] to show even inventories disabled by curator


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


| [[Array]] of [[String]] |RETURNVALUE=
| [[Array]] of [[String]]


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


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


| [[Arma 3 Respawn]], [[BIS_fnc_addRespawnInventory]], [[BIS_fnc_removeRespawnInventory]], [[BIS_fnc_setRespawnInventory]], [[BIS_fnc_getRespawnMarkers]], [[BIS_fnc_getRespawnPositions]] |SEEALSO=
| [[Arma 3 Respawn]], [[BIS_fnc_addRespawnInventory]], [[BIS_fnc_removeRespawnInventory]], [[BIS_fnc_setRespawnInventory]], [[BIS_fnc_getRespawnMarkers]], [[BIS_fnc_getRespawnPositions]]
}}
}}



Revision as of 23:59, 17 January 2021

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


Bottom Section