BIS fnc addRespawnInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (changed no limit value thanks to 3Mydlo3)
Line 24: Line 24:
|p2= '''inventoryParams''': [[Array]] or [[String]] - If [[String|string]] then ''CfgRespawnInventory'' class if array then:
|p2= '''inventoryParams''': [[Array]] or [[String]] - If [[String|string]] then ''CfgRespawnInventory'' class if array then:
*0: [[String]] - ''CfgRespawnInventory'' class
*0: [[String]] - ''CfgRespawnInventory'' class
*1: [[Number]] - Number of players who can use this inventory (0 = no limit)
*1: [[Number]] - Number of players who can use this inventory (-1 = no limit, default)
*2: [[Number]] - Limit for role assigned to given loadout (0 = no limit)  
*2: [[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.''
**''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.''
**''If the limit definition for role is called multiple times with different numbers, then the highest number is used.''

Revision as of 19:59, 19 April 2019

Hover & click on the images for description

Description

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

Syntax

Syntax:
[target, inventoryParams] call BIS_fnc_addRespawnInventory;
Parameters:
target: Receiver of the respawn loadout
Namespace - use missionNamespace to add the loadout to everyone
Side
Group
Object
inventoryParams: Array or String - If string then CfgRespawnInventory class if array then:
  • 0: String - CfgRespawnInventory class
  • 1: Number - Number of players who can use this inventory (-1 = no limit, default)
  • 2: 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_removeRespawnInventory

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