BIS fnc addRespawnInventory: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|1.60 | |1.60 | ||
|gr1= Respawn | |gr1= Respawn | ||
|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]]. | Available loadouts are defined in [[Description.ext#CfgRespawnInventory|CfgRespawnInventory]]. | ||
| [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]]; | | [target, inventoryParams] call [[BIS_fnc_addRespawnInventory]]; | ||
|p1= target: Receiver of the respawn loadout | |p1= target: Receiver of the respawn loadout | ||
| Line 18: | Line 18: | ||
* [[Side]] | * [[Side]] | ||
* [[Group]] | * [[Group]] | ||
* [[Object]] | * [[Object]] | ||
|p2= inventoryParams: [[Array]] or [[String]] | |p2= inventoryParams: [[Array]] or [[String]] | ||
| Line 27: | Line 27: | ||
** 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. | *** 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]] | | [[Array]] - format [target, id] used in [[BIS_fnc_removeRespawnInventory]] | ||
|x1= <code><nowiki>[</nowiki>[[west]], "WEST1"] [[call]] [[BIS_fnc_addRespawnInventory]];</code> | |x1= <code><nowiki>[</nowiki>[[west]], "WEST1"] [[call]] [[BIS_fnc_addRespawnInventory]];</code> | ||
|x2= <code>myRespawnInventory <nowiki>= [</nowiki>[[missionNamespace]], "ATSniper"] [[call]] [[BIS_fnc_addRespawnInventory]];</code> | |x2= <code>myRespawnInventory <nowiki>= [</nowiki>[[missionNamespace]], "ATSniper"] [[call]] [[BIS_fnc_addRespawnInventory]];</code> | ||
| [[Arma 3 Respawn]], [[BIS_fnc_removeRespawnInventory]], [[BIS_fnc_getRespawnInventories]], [[BIS_fnc_setRespawnInventory]] | | [[Arma 3 Respawn]], [[BIS_fnc_removeRespawnInventory]], [[BIS_fnc_getRespawnInventories]], [[BIS_fnc_setRespawnInventory]] | ||
}} | }} | ||
Revision as of 22:36, 17 January 2021
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
- Namespace - use missionNamespace to add the loadout to everyone
- Side
- Group
- Object
- 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