BIS fnc addRespawnInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Arma 3 " to "[[Arma 3: ")
m (Added CfgVehicles reference. Function does state within code: 1: STRING - CfgRespawnInventory or CfgVehicles class)
Line 9: Line 9:


|descr= Add a respawn inventory for [[Arma 3: Respawn#MenuInventory|respawn menu]].<br>
|descr= Add a respawn inventory for [[Arma 3: Respawn#MenuInventory|respawn menu]].<br>
Available loadouts are defined in [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]].
Available loadouts are defined in [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]]. Or you may use an existing CfgVehicles soldier class as reference.


|s1= [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]]
|s1= [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]]
Line 22: Line 22:
* [[String]] - [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]] class
* [[String]] - [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]] class
* [[Array]] - format [class, number, limit]
* [[Array]] - format [class, number, limit]
** class: [[String]] - [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]] class
** class: [[String]] - [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]] class or [[CfgVehicles]] unit class
** number: [[Number]] - Number of players who can use this inventory (-1 = no limit, default)
** 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)  
** limit: [[Number]] - Limit for role assigned to given loadout (-1 = no limit, default)  

Revision as of 06:08, 6 September 2024

Hover & click on the images for description

Description

Description:
Add a respawn inventory for respawn menu.
Available loadouts are defined in CfgRespawnInventory. Or you may use an existing CfgVehicles soldier class as reference.
Execution:
call
Groups:
Respawn

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 or CfgVehicles unit 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:
private _myRespawnInventory = [missionNamespace, "ATSniper"] call BIS_fnc_addRespawnInventory;

Additional Information

See also:
Arma 3: Respawn BIS_fnc_removeRespawnInventory BIS_fnc_getRespawnInventories BIS_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