BIS fnc setIdentity: Difference between revisions

Latest revision as of 15:18, 23 June 2025

1.00

GAGlobal GEGlobal

Hover & click on the images for description

Description

Description:

Sets the unit's identity.

ⓘ

When executed on server, the identity will be JIP compatible.
Before 1.92, this function was SEServer.

Execution:

call

Groups:

Object Manipulation

Syntax

Syntax:: [object, face, speaker, pitch, callsign, name, glasses] call BIS_fnc_setIdentity
Parameters:: object: Object
: face: String - (Optional, default "") face from CfgFaces
: speaker: String - (Optional, default "") speaker from CfgVoice
: pitch: String - (Optional, default -1) speaker pitch (1 is normal pitch, 2 = chipmunk, 0.5 = Darth Vader, etc)
: callsign: String - (Optional, default "") callsign
since 1.92: name: String - (Optional, default "") unit name
since 1.92: glasses: String - (Optional, default nil) glasses from CfgGlasses - use "" to remove glasses
Return Value:: Boolean

Examples

Example 1:: [player, "Kerry", "Male01ENGB", 1.05, "Big Daddy"] call BIS_fnc_setIdentity;
Example 2:: [bob, nil, nil, 1.6, nil, "Miki Maus", "G_Shades_Black"] call BIS_fnc_setIdentity;

Additional Information

See also:: BIS_fnc_setUnitInsignia setFace setIdentity setSpeaker face

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Object Manipulation
-|1.00|= Game version
+|arg= global
-____________________________________________________________________________________________
+|eff= global
-| <pre>/*
+|descr= Sets the unit's identity.
-	Author: Karel Moricky
+{{Feature|informative|
+* When executed on server, the identity will be [[Multiplayer Scripting#Join In Progress|JIP]] compatible.
+* Before {{GVI|arma3|1.92}}, this function was {{Icon|serverExec|32}}.
+}}
-	Description:
+|s1= [object, face, speaker, pitch, callsign, name, glasses] call [[BIS_fnc_setIdentity]]
-	Set unit identity. To be used together with BIS_fnc_MP, because identity related commands are local.
-	When executed on server, the identity will be JIP compatible.
-	Parameter(s):
+|p1= object: [[Object]]
-: OBJECT
-(Optional): STRING - face from CfgFaces
-(Optional): STRING - speaker from CfgVoice
-(Optional): NUMBER - speaker pitch (1 is unchanged pitch)
-(Optional): STRING - callsign
-	Returns:
+|p2= face: [[String]] - (Optional, default "") face from {{Link|Arma 3: CfgIdentities#Faces|CfgFaces}}
-	BOOL
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|p3= speaker: [[String]] - (Optional, default "") speaker from {{Link|Arma 3: CfgIdentities#Speakers|CfgVoice}}
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_setIdentity]]; --> |= Syntax
+|p4= pitch: [[String]] - (Optional, default -1) speaker pitch (1 is normal pitch, 2 = chipmunk, 0.5 = Darth Vader, etc)
-|p1= |= Parameter 1
-| |= Return value
+|p5= callsign: [[String]] - (Optional, default "") callsign
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|p6= name: [[String]] - (Optional, default "") unit name
-____________________________________________________________________________________________
+|p6since= arma3 1.92
-| |= See also
+|p7= glasses: [[String]] - (Optional, default [[nil]]) glasses from {{Link|Arma 3: CfgGlasses|CfgGlasses}} - use "" to remove glasses
+|p7since= arma3 1.92
-}}
+|r1= [[Boolean]]
-<h3 style="display:none">Notes</h3>
+|x1= <sqf>[player, "Kerry", "Male01ENGB", 1.05, "Big Daddy"] call BIS_fnc_setIdentity;</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x2= <sqf>[bob, nil, nil, 1.6, nil, "Miki Maus", "G_Shades_Black"] call BIS_fnc_setIdentity;</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso=  [[BIS_fnc_setUnitInsignia]] [[setFace]] [[setIdentity]] [[setSpeaker]] [[face]]
-[[Category:Function Group: Objects|{{uc:setIdentity}}]]
+}}
-[[Category:Functions|{{uc:setIdentity}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:setIdentity}}]]