BIS fnc setUnitInsignia: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Added Arma 3 version number for multiplayer locality note)
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Object Manipulation |GROUP1=")
(39 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.00|= Game version
|1.24|Game version=
____________________________________________________________________________________________


| <pre>/*
|gr1 = Object Manipulation |GROUP1=


Description:
|arg= global |MParg= Arguments in MP
Set unit inisgnia (e.g., should insignia on soldiers)


Parameter(s):
|eff= global |MPeff= Effects in MP
0: OBJECT
____________________________________________________________________________________________
2: STRING - CfgUnitInsignia class


Returns:
| 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.
BOOL - true if insignia was set
{{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. |DESCRIPTION=
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_setUnitInsignia]]; --> |= Syntax
| [target, className] call [[BIS_fnc_setUnitInsignia]] |SYNTAX=


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


| |= Return value
| [[Boolean]] - Returns [[true]] if successful. |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| |= See also
| [[Arma 3 Unit Insignia]], [[BIS_fnc_getUnitInsignia]] |SEEALSO=


}}
}}
<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on August 9, 2016 2300
 
<dt class="note>[[User:Pierre MGI|Pierre MGI]]
<!-- Note Section END -->
<dd class="note">In [[Arma 3 Unit Insignia]], you can read:
{{quote|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.<br>
This function calls [[setObjectTextureGlobal]], which is a broken command in MP (see feedback tracker) August 2016.
</dl>
</dl>


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Strategic|{{uc:setUnitInsignia}}]]
[[Category:Functions|{{uc:setUnitInsignia}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setUnitInsignia}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 28, 2014 - 12:58 (UTC)</dd>
<dt class="note">[[User:Sxp2hiiigh|Sxp2hiiigh]]</dt>
<dd class="note">
Multiplayer locality (As of Arma 3 v1.24):
<br />- Effects of this function are local, it must be executed on all machines.
<br />- Insignias are gone after respawn, they have to be reapplied afterwards (On all machines again).
<br /><br />
This would apply insignia "111thID" to player unit on all machines (incl. Join In Progress):
<pre>[[player, "111thID"], "BIS_fnc_setUnitInsignia", nil, true, true] call BIS_fnc_MP;</pre>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 18:46, 10 October 2020

Arma 3 logo black.png1.24
GAGlobalGEGlobal
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

Notes

Posted on August 9, 2016 2300
Pierre MGI
In Arma 3 Unit Insignia, you can read: Template:quote 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.

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_setUnitInsignia&oldid=166343"