BIS fnc setIdentity: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 2/7)
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )S([a-z])" to "$1s$3")
 
(33 intermediate revisions by 2 users not shown)
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= local


| <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.}}


Description:
|s1= [object, face, speaker, pitch, callsign] 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]]
0: OBJECT
1 (Optional): STRING - face from CfgFaces
2 (Optional): STRING - speaker from CfgVoice
3 (Optional): NUMBER - speaker pitch (1 is unchanged pitch)
4 (Optional): STRING - callsign


Returns:
|p2= face: [[String]] - (Optional, default "") face from CfgFaces
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p3= speaker: [[String]] - (Optional, default "") speaker from CfgVoice
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_setIdentity]]; --> |= Syntax
|p4= pitch: [[String]] - (Optional, default -1) speaker pitch (1 is unchanged pitch)
|p1= |= Parameter 1


| |= Return value
|p5= callsign: [[String]] - (Optional, default "") callsign
____________________________________________________________________________________________


|x1= <code></code> |=
|r1= [[Boolean]]
____________________________________________________________________________________________


| |= See also
|x1= <sqf>[player, "Kerry", "Male01ENGB", 1.05, "Big Daddy"] call BIS_fnc_setIdentity;</sqf>


|seealso=  [[BIS_fnc_setUnitInsignia]] [[setFace]] [[setIdentity]] [[setSpeaker]] [[face]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Objects|{{uc:setIdentity}}]]
[[Category:Functions|{{uc:setIdentity}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setIdentity}}]]

Latest revision as of 13:32, 8 November 2023

Hover & click on the images for description

Description

Description:
Sets the unit's identity.
When executed on server, the identity will be JIP compatible.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[object, face, speaker, pitch, callsign] 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 unchanged pitch)
callsign: String - (Optional, default "") callsign
Return Value:
Boolean

Examples

Example 1:
[player, "Kerry", "Male01ENGB", 1.05, "Big Daddy"] 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