BIS fnc addRespawnInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Fix page)
Line 15: Line 15:
| [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]]; |SYNTAX=
| [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]]; |SYNTAX=


|p1= '''target''': Receiver of the respawn loadout
|p1= target: Receiver of the respawn loadout
* [[Namespace]] - use [[missionNamespace]] to add the loadout to everyone
* [[Namespace]] - use [[missionNamespace]] to add the loadout to everyone
* [[Side]]
* [[Side]]
Line 21: Line 21:
* [[Object]] |Parameter1=
* [[Object]] |Parameter1=


|p2= '''inventoryParams''': [[Array]] or [[String]]
|p2= inventoryParams: [[Array]] or [[String]]
* [[String]] - [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]] class
* [[String]] - [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]] class
* [[Array]] - format [class, number, limit]
* [[Array]] - format [class, number, limit]
Line 38: Line 38:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Arma 3 Respawn]], [[BIS_fnc_removeRespawnInventory]], [[BIS_fnc_getRespawnInventories]] |SEEALSO=
| [[Arma 3 Respawn]], [[BIS_fnc_removeRespawnInventory]], [[BIS_fnc_getRespawnInventories]], [[BIS_fnc_setRespawnInventory]] |SEEALSO=
}}
}}



Revision as of 20:53, 27 July 2019

Hover & click on the images for description

Description

Description:
Add a respawn inventory for respawn menu.
Available loadouts are defined in CfgRespawnInventory.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[target, inventoryParams] call BIS_fnc_addRespawnInventory;
Parameters:
target: Receiver of the respawn loadout
inventoryParams: Array or String
  • String - CfgRespawnInventory class
  • Array - format [class, number, limit]
    • class: String - CfgRespawnInventory class
    • number: Number - Number of players who can use this inventory (-1 = no limit, default)
    • limit: Number - Limit for role assigned to given loadout (-1 = no limit, default)
      • Only role or only loadout can be limited at one moment, if there is limit for both, then only role uses limit.
      • If the limit definition for role is called multiple times with different numbers, then the highest number is used.
Return Value:
Array - format [target, id] used in BIS_fnc_removeRespawnInventory

Examples

Example 1:
[west, "WEST1"] call BIS_fnc_addRespawnInventory;
Example 2:
myRespawnInventory = [missionNamespace, "ATSniper"] call BIS_fnc_addRespawnInventory;

Additional Information

See also:
Arma 3 RespawnBIS_fnc_removeRespawnInventoryBIS_fnc_getRespawnInventoriesBIS_fnc_setRespawnInventory

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