BIS fnc setUnitInsignia: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Object Manipulation |GROUP1=")
(30 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________


{{Function|= Comments
| arma3 |Game name=
____________________________________________________________________________________________


| arma3 |= Game name
|1.24|Game version=


|1.24|= Game version
|gr1 = Object Manipulation |GROUP1=


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


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


| <pre>/*
| 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.
 
{{Warning | This function must '''not''' be [[remoteExec]]uted.}}
Description:
See [[Arma 3 Unit Insignia#Official Insignias | Arma 3 Unit Insignia]] for a list of all official insignias. |DESCRIPTION=
Set unit inisgnia (e.g., should insignia on soldiers)
____________________________________________________________________________________________


Parameter(s):
| [target, className] call [[BIS_fnc_setUnitInsignia]] |SYNTAX=
0: OBJECT
2: STRING - CfgUnitInsignia class


Returns:
|p1= target: [[Object]] - unit to which the insignia is going to be attached |PARAMETER1=
BOOL - true if insignia was set
|p2= class: [[String]] - CfgUnitInsignia class name to use. Use an empty string to remove the current insignia. |PARAMETER2=
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [[Boolean]] - Returns [[true]] if successful. |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


|p1= |= Parameter 1
|x2= Remove insignia: <code>[<nowiki/>[[player]], ""] [[call]] [[BIS_fnc_setUnitInsignia]];</code> |EXAMPLE2=
 
| [[Boolean]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=
| [[Arma 3 Unit Insignia]], [[BIS_fnc_getUnitInsignia]] |SEEALSO=
____________________________________________________________________________________________
 
| [[Arma 3 Unit Insignia]], [[BIS_fnc_getUnitInsignia]] |= See also


}}
}}
<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
<dd class="notedate">Posted on July 28, 2014 - 12:58 (UTC)
<dt class="note>[[User:Pierre MGI|Pierre MGI]]
<dt class="note>'''[[User:Sxp2hiiigh|Sxp2hiiigh]]'''
<dd class="note">In [[Arma 3 Unit Insignia]], you can read:
<dd class="note">Multiplayer locality (As of Arma 3 v1.24):
{{quote|You can add a new insignia in Config.cpp and Description.ext.}}
<br>Effect of this function is global, it should be executed consistently for JIP otherwise insignias are gone after respawn, so they have to be reapplied afterwards (On all machines again).
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.
<br>
Config.cpp (addon) is more reliable. Description.ext, in this case, should be used for SP mission only.<br>
This would apply insignia "111thID" to player unit on all machines (incl. Join In Progress):
This function calls [[setObjectTextureGlobal]], which is a broken command in MP (see feedback tracker) August 2016.
<code>[[ [[player]], "111thID"], "[[BIS_fnc_setUnitInsignia]]", nil, [[true]], [[true]]] [[call]] [[BIS_fnc_MP]];</code>
 
<dd class="notedate">Posted on July 29, 2014 1500
<dt class="note>'''[[User:ffur2007slx2_5|ffur2007slx2_5]]'''
<dd class="note">(A3 1.24)Predefined textures that can be used directly in game.
{| class="wikitable sortable"
 
! Img
! Code
! Note
 
|-
| [[File:111thID ca.png|50px]]
| <code>[this,"111thID"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| NATO division which dispatched one brigade to liberate Altis in Episode 3 - Win.
 
|-
| [[File:bi ca.png|50px]]
| <code>[this,"BI"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| [[Bohemia Interactive]] glyph
 
|-
| [[File:curator ca.png|50px]]
| <code>[this,"Curator"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| [[Zeus]] eye
 
|-
| [[File:gryffinRegiment ca.png|50px]]
| <code>[this,"GryffinRegiment"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| CSAT regiment that occupied Altis in episodes 2 and 3 of the Arma 3 campaign.
 
|-
| [[File:manw ca.png|50px]]
| <code>[this,"MANW"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| Make Arma Not War competition logo
 
|-
| [[File:TFAegis ca.png|50px]]
| <code>[this,"TFAegis"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| Combined force of NATO and AAF which operated on Stratis and Altis at the beginning of Episode 1 and in the Bootcamp campaign.
 
|}
 
 
<dd class="notedate">Posted on September 29, 2014 1500
<dt class="note>'''[[User:BrotherhoodOfHam|BrotherhoodOfHam]]'''
<dd class="note">There are two ways of removing an insignia when placed.<br/>
The first way would be to run this function on the unit:
<br/>
<code>fnc_removeUnitInsignia =
{
_unit = _this [[select]] 0;
_index = -1;
{
if (_x == "insignia") [[exitwith]] {_index = _foreachindex;};
} foreach getarray (configfile >> "CfgVehicles" >> [[gettext]] ( [[configfile]] >> "CfgWeapons" >> [[uniform]] _unit >> "ItemInfo" >> "uniformClass") >> "hiddenSelections");
_unit [[setObjectTextureGlobal]] [_index, ""];
};
</code>
<code>[player] [[call]] fnc_removeUnitInsignia</code>
<br/>
The second way would be to create an empty cfgUnitInsignia class in the description.ext:
<br/>
<code>class CfgUnitInsignia
{
class empty
{
author = "";
displayName = "";
texture = "";
};
};</code>
And then run it the normal way:
<code>[player, "empty"] [[call]] [[BIS_fnc_setUnitInsignia]]</code>
 
<!-- Note Section END -->
</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 -->
<!-- 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"