BIS fnc getRespawnInventories: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *(arg|eff|mp|serverExec|gr[0-9]) *= *(.*) * *\|([^=]{12})" to "|$1=$2 |descr=$3")
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.60
|1.60


|gr1= Respawn
|gr1= Respawn
Line 9: Line 8:
|descr= Return respawn inventories available for the given target.
|descr= Return respawn inventories available for the given target.


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


|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]]
|p1= target: [[Namespace]], [[Side]], [[Group]] or [[Object]]
Line 17: Line 16:
|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


|r1=[[Array]] of [[String]]
|r1= [[Array]] of [[String]]


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


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


|seealso= [[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]]
}}
}}

Latest revision as of 17:00, 13 July 2022

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