Differences

This shows you the differences between two versions of the page.

--- function_library:fnc_regear [2020/06/20 06:06]
Skeet created
+++ function_library:fnc_regear [2020/06/20 06:25] (current)
Skeet
@@ Line 1: / Line 1: @@
 === cbb_framework_gear_fnc_regear ===
 \\
-Description: Regears given player object with class from set
+Locality: TODO!
+Description: Regears player object with class from set
 Syntax: [object, class, set, ignoreCache] call cbb_framework_gear_fnc_regear
@@ Line 7: / Line 10: @@
 Parameters: [object, class, set, ignoreCache] [[https://community.bistudio.com/wiki/Array|Array]]
-object: [[https://community.bistudio.com/wiki/Object|Object]]
+object: [[https://community.bistudio.com/wiki/Object|Object]] (optional, default: player)
-class: [[https://community.bistudio.com/wiki/String|String]] of [[arma_editing:missions:framework:gear|Class]]
+class: [[https://community.bistudio.com/wiki/String|String]] of [[arma_editing:missions:framework:gear|Class]] (optional, default: nil)
-set:[[https://community.bistudio.com/wiki/String|String]] of [[arma_editing:missions:framework:gear|Set]]
+set:[[https://community.bistudio.com/wiki/String|String]] of [[arma_editing:missions:framework:gear|Set]] (optional, default: nil)
-ignoreCache: TODO - ask Theo
+ignoreCache: TODO - ask Theo (optional, default: false)
 Return Value: [[https://community.bistudio.com/wiki/Boolean|Bool]] - returns true if successful
-Example: <code cpp>[player, "Medic", "rhs_usmc"] call cbb_framework_gear_fnc_regear</code>
+Example 1: <code cpp>[player, "Medic", "rhs_usmc"] call cbb_framework_gear_fnc_regear //Regear player as 'medic' from set 'rhs_usmc'</code>
+Example 2: <code cpp>[] call cbb_framework_gear_fnc_regear //Regear player with gear already set in loadout config</code>