BIS fnc getRespawnInventories: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Respawn(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


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


|1.60|Game version=
|gr1= Respawn


|gr1= Respawn |GROUP1=
|descr= Return respawn inventories available for the given target.
____________________________________________________________________________________________


| Return respawn inventories available for the given target. |DESCRIPTION=
|s1= [target, showDisabled, returnAllInfo] call [[BIS_fnc_getRespawnInventories]]
____________________________________________________________________________________________


| [target, showDisabled, returnAllInfo] call [[BIS_fnc_getRespawnInventories]] |SYNTAX=
|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]]


|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]] |PARAMETER1=
|p2= showDisabled: [[Boolean]] - (Optional, default [[false]]) [[true]] to show even inventories disabled by curator


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


|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=
|r1= [[Array]] of [[String]]


| [[Array]] of [[String]] |RETURNVALUE=
|x1= <sqf>private _respawnInfo = [player] call BIS_fnc_getRespawnInventories;</sqf>
____________________________________________________________________________________________


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


|x2= <code>[[private]] _respawnInfo = [<nowiki/>[[west]], [[true]], [[false]]] [[call]] [[BIS_fnc_getRespawnInventories]];</code> |Example 2=
|seealso= [[Arma 3: Respawn]] [[BIS_fnc_addRespawnInventory]] [[BIS_fnc_removeRespawnInventory]] [[BIS_fnc_setRespawnInventory]] [[BIS_fnc_getRespawnMarkers]] [[BIS_fnc_getRespawnPositions]]
____________________________________________________________________________________________
 
| [[Arma 3 Respawn]], [[BIS_fnc_addRespawnInventory]], [[BIS_fnc_removeRespawnInventory]], [[BIS_fnc_setRespawnInventory]], [[BIS_fnc_getRespawnMarkers]], [[BIS_fnc_getRespawnPositions]] |SEEALSO=
}}
}}
<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:Functions|{{uc:getRespawnInventories}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getRespawnInventories}}]]

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"