BIS fnc setUnitInsignia: Difference between revisions
Jump to navigation
Jump to search
m (note format) |
Lou Montana (talk | contribs) m (Text replacement - "|= |x2=" to "|Example1= |x2=") |
||
(30 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
{{Function|= | {{Function|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| arma3 | | | arma3 |Game name= | ||
|1. | |1.24|Game version= | ||
| | |arg= global |MParg= Arguments in MP | ||
|eff= global |MPeff= Effects in MP | |||
____________________________________________________________________________________________ | |||
| 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. '''Do not remote execute'''|DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [target , className] call [[BIS_fnc_setUnitInsignia]] |SYNTAX= | ||
|p1= |= | |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. |= | |||
| |= | | [[Boolean]] - Returns [[true]] if successful. |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code></code> |= | |x1= Place insignia: <code><nowiki>[</nowiki>[[player]], "111thID"] [[call]] [[BIS_fnc_setUnitInsignia]];</code> |Example1= | ||
|x2= Remove insignia: <code><nowiki>[</nowiki>[[player]], ""] [[call]] [[BIS_fnc_setUnitInsignia]];</code> |= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| |= | | [[Arma 3 Unit Insignia]], [[BIS_fnc_getUnitInsignia]] |SEEALSO= | ||
}} | }} | ||
Line 41: | Line 35: | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
<dd class="notedate">Posted on July | |||
<dt class="note>'''[[User: | |||
<dd class="note"> | <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. | ||
<br> | {| class="wikitable sortable" | ||
<code>[[ [[ | ! 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> | |||
<br/> | |||
<dd class="notedate">Posted on August 9, 2016 2300 | |||
<dt class="note>'''[[User:Pierre MGI|Pierre MGI]]''' | |||
<dd class="note">In https://community.bistudio.com/wiki/Arma_3_Unit_Insignia, you can read:<br/> | |||
<quote>You can add a new insignia in Config.cpp and Description.ext.</quote><br/> | |||
If it's 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 the setObjectTextureGlobal, which is a broken command in MP (see feedback tracker) August 2016. | |||
<!-- Note Section END --> | <!-- Note Section END --> | ||
</dl> | </dl> | ||
Line 58: | Line 127: | ||
<!-- CONTINUE Notes --> | <!-- CONTINUE Notes --> | ||
<!-- DISCONTINUE Notes --> | <!-- DISCONTINUE Notes --> |
Revision as of 12:51, 3 September 2019
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. Do not remote execute
- Execution:
- call
- Groups:
- Uncategorised
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
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 July 29, 2014 1500
- ffur2007slx2_5
- (A3 1.24)Predefined textures that can be used directly in game.
Img Code Note [this,"111thID"] call BIS_fnc_setUnitInsignia;
NATO division which dispatched one brigade to liberate Altis in Episode 3 - Win. [this,"BI"] call BIS_fnc_setUnitInsignia;
Bohemia Interactive glyph [this,"Curator"] call BIS_fnc_setUnitInsignia;
Zeus eye [this,"GryffinRegiment"] call BIS_fnc_setUnitInsignia;
CSAT regiment that occupied Altis in episodes 2 and 3 of the Arma 3 campaign. [this,"MANW"] call BIS_fnc_setUnitInsignia;
Make Arma Not War competition logo [this,"TFAegis"] call BIS_fnc_setUnitInsignia;
Combined force of NATO and AAF which operated on Stratis and Altis at the beginning of Episode 1 and in the Bootcamp campaign.
- Posted on September 29, 2014 1500
- BrotherhoodOfHam
- There are two ways of removing an insignia when placed.
The first way would be to run this function on the unit:
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, ""]; };
[player] call fnc_removeUnitInsignia
The second way would be to create an empty cfgUnitInsignia class in the description.ext:
class CfgUnitInsignia { class empty { author = ""; displayName = ""; texture = ""; }; };
And then run it the normal way:[player, "empty"] call BIS_fnc_setUnitInsignia
- Posted on August 9, 2016 2300
- Pierre MGI
- In https://community.bistudio.com/wiki/Arma_3_Unit_Insignia, you can read:
<quote>You can add a new insignia in Config.cpp and Description.ext.</quote>
If it's 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 the setObjectTextureGlobal, which is a broken command in MP (see feedback tracker) August 2016.
Bottom Section