BIS fnc addRespawnInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (changed no limit value thanks to 3Mydlo3)
(Fix page)
Line 1: Line 1:
{{Function|= Comments
{{Function|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|0.74|= Game version
|1.60|Game version=


|eff= global |=
|eff= global |MP Effect=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Add a respawn inventory for [[Arma 3 Respawn#MenuInventory|respawn menu]].
| 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 ''CfgRespawnInventory'' in [[Description.ext]].
|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 18: Line 16:


|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]]|=
* [[Object]] |Parameter1=
|p2= '''inventoryParams''': [[Array]] or [[String]] - If [[String|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.''


| [[Array]] - format [target,id] (used in [[BIS_fnc_removeRespawnInventory]]) |RETURNVALUE=
|p2= '''inventoryParams''': [[Array]] or [[String]]
* [[String]] - [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]] class
* [[Array]] - format [class, number, limit]
** class: [[String]] - [[Description.ext#CfgRespawnInventory|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. |Parameter2=
 
| [[Array]] - format [target, id] used in [[BIS_fnc_removeRespawnInventory]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code><nowiki>[</nowiki>[[west]], "WEST1"] [[call]] [[BIS_fnc_addRespawnInventory]];</code> |=
|x1= <code><nowiki>[</nowiki>[[west]], "WEST1"] [[call]] [[BIS_fnc_addRespawnInventory]];</code> |Example1=


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


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


Revision as of 21:48, 27 July 2019

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.
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_getRespawnInventories

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_addRespawnInventory&oldid=125172"