BIS fnc addRespawnInventory: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Respawn(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 9: Line 8:


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


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


| [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]]; |SYNTAX=
| [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]]; |SYNTAX=
Line 33: Line 30:


| [[Array]] - format [target, id] used in [[BIS_fnc_removeRespawnInventory]] |RETURNVALUE=
| [[Array]] - format [target, id] used in [[BIS_fnc_removeRespawnInventory]] |RETURNVALUE=
____________________________________________________________________________________________
   
   
|x1= <code><nowiki>[</nowiki>[[west]], "WEST1"] [[call]] [[BIS_fnc_addRespawnInventory]];</code> |Example1=
|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=
|x2= <code>myRespawnInventory <nowiki>= [</nowiki>[[missionNamespace]], "ATSniper"] [[call]] [[BIS_fnc_addRespawnInventory]];</code> |Example2=
____________________________________________________________________________________________


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

Revision as of 23:41, 16 January 2021

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:
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
    • 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_getRespawnInventoriesBIS_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

Notes

Bottom Section