BIS fnc addRespawnInventory: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[[cC]ategory:[fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "") |
Hypoxic125 (talk | contribs) m (changed "unit" to "soldier") |
||
(19 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma3 | |game1= arma3 | ||
|version1= 1.60 | |||
|1.60 | |||
|gr1= Respawn | |gr1= Respawn | ||
|eff= global | |eff= global | ||
| 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. | ||
| [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]] | |s1= [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]] | ||
|p1= target: Receiver of the respawn loadout | |p1= target: Receiver of the respawn loadout | ||
Line 21: | Line 20: | ||
|p2= inventoryParams: [[Array]] or [[String]] | |p2= inventoryParams: [[Array]] or [[String]] | ||
* [[String]] - [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]] class | * [[String]] - [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]] class or [[CfgVehicles]] soldier 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]] soldier 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) | ||
Line 29: | Line 28: | ||
*** 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. | ||
| [[Array]] - format [target, id] used in [[BIS_fnc_removeRespawnInventory]] | |r1= [[Array]] - format [target, id] used in [[BIS_fnc_removeRespawnInventory]] | ||
| | |x1= <sqf>[west, "WEST1"] call BIS_fnc_addRespawnInventory;</sqf> | ||
| [[Arma 3 Respawn]] | |x2= <sqf>private _myRespawnInventory = [missionNamespace, "ATSniper"] call BIS_fnc_addRespawnInventory;</sqf> | ||
|seealso= [[Arma 3: Respawn]] [[BIS_fnc_removeRespawnInventory]] [[BIS_fnc_getRespawnInventories]] [[BIS_fnc_setRespawnInventory]] | |||
}} | }} | ||
Latest revision as of 06:10, 6 September 2024
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
- Namespace - use missionNamespace to add the loadout to everyone
- Side
- Group
- Object
- inventoryParams: Array or String
- String - CfgRespawnInventory class or CfgVehicles soldier class
- Array - format [class, number, limit]
- class: String - CfgRespawnInventory class or CfgVehicles soldier 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:
- Example 2:
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