BIS fnc addRespawnInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Fix page)
m (changed "unit" to "soldier")
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.60


|1.60|Game version=
|gr1= Respawn


|eff= global |MP Effect=
|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]]. |DESCRIPTION=
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]]; |SYNTAX=
|s1= [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]]


|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]]
* [[Group]]
* [[Group]]
* [[Object]] |Parameter1=
* [[Object]]


|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)  
*** 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. |Parameter2=
*** 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]] |RETURNVALUE=
|r1= [[Array]] - format [target, id] used in [[BIS_fnc_removeRespawnInventory]]
____________________________________________________________________________________________
 
|x1= <code><nowiki>[</nowiki>[[west]], "WEST1"] [[call]] [[BIS_fnc_addRespawnInventory]];</code> |Example1=


|x2= <code>myRespawnInventory <nowiki>= [</nowiki>[[missionNamespace]], "ATSniper"] [[call]] [[BIS_fnc_addRespawnInventory]];</code> |Example2=
|x1= <sqf>[west, "WEST1"] call BIS_fnc_addRespawnInventory;</sqf>
____________________________________________________________________________________________


| [[Arma 3 Respawn]], [[BIS_fnc_removeRespawnInventory]], [[BIS_fnc_getRespawnInventories]] |SEEALSO=
|x2= <sqf>private _myRespawnInventory = [missionNamespace, "ATSniper"] call BIS_fnc_addRespawnInventory;</sqf>
 
|seealso= [[Arma 3: Respawn]] [[BIS_fnc_removeRespawnInventory]] [[BIS_fnc_getRespawnInventories]] [[BIS_fnc_setRespawnInventory]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Respawn|{{uc:addRespawnInventory}}]]
[[Category:Functions|{{uc:addRespawnInventory}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:addRespawnInventory}}]]

Latest revision as of 06:10, 6 September 2024

Arma 3 logo black.png1.60
GEGlobal
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 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:
[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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_addRespawnInventory&oldid=369448"