unitAddons: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Mods and Addons
____________________________________________________________________________________________


| Returns list with addons the unit belongs to. |DESCRIPTION=
|descr= Returns list with addons the unit belongs to.
____________________________________________________________________________________________


| '''unitAddons''' className |SYNTAX=
|s1= [[unitAddons]] className


|p1= className: [[String]] - class name of a unit/vehicle or object |PARAMETER1=
|p1= className: [[String]] - class name of a unit/vehicle or object


| [[Array]] - addon names |RETURNVALUE=
|r1= [[Array]] - addon names


|x1= <sqf>hint str unitAddons typeOf player; // ["A3_Characters_F_BLUFOR"]</sqf>


|x1= <code>[[hint]] [[str]] [[unitAddons]] [[typeOf]] [[player]]; //["A3_Characters_F_BLUFOR"]</code>|EXAMPLE1=
|seealso= [[activateAddons]]
}}


____________________________________________________________________________________________
{{Note
 
|user= ffur2007slx2_5
| [[activateAddons]] |SEEALSO=  
|timestamp= 20140331233800
 
|text= <nowiki/>
|  |MPBEHAVIOUR=  
# From {{arma3}} 1.14 <sqf>hint str ([player] call BIS_fnc_unitAddon) // same as unitAddons (typeOf player)</sqf>
____________________________________________________________________________________________
# To return the addon that a weapon belongs to, use [[BIS_fnc_weaponAddon]] instead. E.g. <sqf>(primaryWeapon player call BIS_fnc_weaponAddon); // return: "A3_Weapons_F_Rifles_Khaybar"</sqf>
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on Mar 31, 2014 - 23:38
<dt class="note">'''[[User:ffur2007slx2_5|ffur2007slx2_5]]'''<dd class="note">
1. (A3 1.14) Old BIS function [[BIS_fnc_unitAddon]] has been deprecated, please always use [[unitAddons]] instead.
<code>[[hint]] [[str]] ([player] [[call]] [[BIS_fnc_unitAddon]]) // same as [[unitAddons]] ([[typeOf]] [[player]])</code>
2. To return the addon that a weapon belongs to, use [[BIS_fnc_weaponAddon]] instead. E.g.
<code>
(([[primaryWeapon]] [[player]]) [[call]] [[BIS_fnc_weaponAddon]]); //return: "A3_Weapons_F_Rifles_Khaybar"
</code>
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 23:51, 13 May 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Returns list with addons the unit belongs to.
Groups:
Mods and Addons

Syntax

Syntax:
unitAddons className
Parameters:
className: String - class name of a unit/vehicle or object
Return Value:
Array - addon names

Examples

Example 1:
hint str unitAddons typeOf player; // ["A3_Characters_F_BLUFOR"]

Additional Information

See also:
activateAddons

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
ffur2007slx2_5 - c
Posted on Mar 31, 2014 - 23:38 (UTC)
  1. From Arma 3 1.14
    hint str ([player] call BIS_fnc_unitAddon) // same as unitAddons (typeOf player)
  2. To return the addon that a weapon belongs to, use BIS_fnc_weaponAddon instead. E.g.
    (primaryWeapon player call BIS_fnc_weaponAddon); // return: "A3_Weapons_F_Rifles_Khaybar"
Retrieved from "https://community.bistudio.com/wiki?title=unitAddons&oldid=341212"