BIS fnc setUnitInsignia: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ :\\\-\/|()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3


|1.24
|version1= 1.24


|gr1 = Object Manipulation
|gr1= Object Manipulation


|arg= global |MParg= Arguments in MP
|arg= global


|eff= global |MPeff= Effects in MP
|eff= global


| Sets unit insignia (e.g., shoulder insignia on soldiers). See [[Arma 3 Unit Insignia]] for more details. This function is global and should work from any client.
|descr= Sets unit insignia (e.g., shoulder insignia on soldiers). See [[Arma 3 Unit Insignia]] for more details. This function is global and should work from any client.
{{Feature | Warning | This function must '''not''' be [[remoteExec]]uted.}}
{{Feature | Warning | This function must '''not''' be [[remoteExec]]uted.}}
See [[Arma 3 Unit Insignia#Official Insignias | Arma 3 Unit Insignia]] for a list of all official insignias.
See [[Arma 3 Unit Insignia#Official Insignias | Arma 3 Unit Insignia]] for a list of all official insignias.


| [target, className] call [[BIS_fnc_setUnitInsignia]]
|s1= [target, className] call [[BIS_fnc_setUnitInsignia]]


|p1= target: [[Object]] - unit to which the insignia is going to be attached
|p1= target: [[Object]] - unit to which the insignia is going to be attached
|p2= class: [[String]] - CfgUnitInsignia class name to use. Use an empty string to remove the current insignia.
|p2= class: [[String]] - CfgUnitInsignia class name to use. Use an empty string to remove the current insignia.


| [[Boolean]] - Returns [[true]] if successful.
|r1= [[Boolean]] - Returns [[true]] if successful.


|x1= Place insignia: <code>[<nowiki/>[[player]], "111thID"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
|x1= Place insignia: <code>[<nowiki/>[[player]], "111thID"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>

Revision as of 12:48, 20 February 2021

Hover & click on the images for description

Description

Description:
Sets unit insignia (e.g., shoulder insignia on soldiers). See Arma 3 Unit Insignia for more details. This function is global and should work from any client.
This function must not be remoteExecuted.
See Arma 3 Unit Insignia for a list of all official insignias.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[target, className] call BIS_fnc_setUnitInsignia
Parameters:
target: Object - unit to which the insignia is going to be attached
class: String - CfgUnitInsignia class name to use. Use an empty string to remove the current insignia.
Return Value:
Boolean - Returns true if successful.

Examples

Example 1:
Place insignia: [player, "111thID"] call BIS_fnc_setUnitInsignia;
Example 2:
Remove insignia: [player, ""] call BIS_fnc_setUnitInsignia;

Additional Information

See also:
Arma 3 Unit InsigniaBIS_fnc_getUnitInsignia

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
Posted on August 9, 2016 2300
Pierre MGI
In Arma 3 Unit Insignia, you can read:
«
« You can add a new insignia in Config.cpp and Description.ext. »

If it is possible to add a cfgUnitInsignia class in a description.ext, please note that the path of the texture differs for server and client in MP environment. Config.cpp (addon) is more reliable. Description.ext, in this case, should be used for SP mission only.
This function calls setObjectTextureGlobal, which is a broken command in MP (see feedback tracker) August 2016.