getUnitTrait: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
|arma3|= Game name
|1.58|= Game version
|arg= global |=
| Gets the current value of a trait of the given unit.
<br /><br />
For the default values please visit [[setUnitTrait]].


|= Description
|game1= arma3
|unit '''getUnitTrait''' skillName |= Syntax
|version1= 1.58
|p1= Unit: [[Object]] |= Parameter 1
 
|p2= skillName: [[String]] - Name of the skill |= Parameter 1
|arg= global
| [[Bool]] or [[Scalar]] - Value of the trait <br/> [[Nothing]] if unit is empty vehicle |RETURNVALUE=
 
|x1= <code>[[player]] [[getUnitTrait]] "Medic";</code>|EXAMPLE1=  
|gr1= Object Manipulation
| [[setUnitTrait]]|SEEALSO=
 
|  |MPBEHAVIOUR=
|descr= Gets the current value of a trait of the given unit.
}}
{{Feature|informative|For the default values see {{Link|setUnitTrait}}.}}
 
|s1= unit [[getUnitTrait]] skillName
 
|p1= unit: [[Object]]
 
|p2= skillName: [[String]] - name of the skill


<h3 style='display:none'>Bottom Section</h3>
|r1=
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
* [[Boolean]] or [[Number]] - trait's value
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
* [[Nothing]] - if ''unit'' is invalid, e.g an empty vehicle
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]


<h3 style='display:none'>Notes</h3>
|x1= <sqf>player getUnitTrait "Medic";</sqf>
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- END Note Section -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[setUnitTrait]] [[getAllUnitTraits]]
}}

Latest revision as of 10:46, 8 November 2023

Hover & click on the images for description

Description

Description:
Gets the current value of a trait of the given unit.
For the default values see setUnitTrait.
Groups:
Object Manipulation

Syntax

Syntax:
unit getUnitTrait skillName
Parameters:
unit: Object
skillName: String - name of the skill
Return Value:

Examples

Example 1:
player getUnitTrait "Medic";

Additional Information

See also:
setUnitTrait getAllUnitTraits

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