BIS fnc setUnitInsignia: Difference between revisions
Jump to navigation
Jump to search
m (cleaned notes) |
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Object Manipulation |GROUP1=") |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 6: | Line 5: | ||
|1.24|Game version= | |1.24|Game version= | ||
|gr1 = Object Manipulation |GROUP1= | |||
|arg= global |MParg= Arguments in MP | |arg= global |MParg= Arguments in MP | ||
| Line 12: | Line 13: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| 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. ''' | | 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. | ||
See [[ | {{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= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [target , className] call [[BIS_fnc_setUnitInsignia]] |SYNTAX= | | [target, className] call [[BIS_fnc_setUnitInsignia]] |SYNTAX= | ||
|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 |PARAMETER1= | ||
|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. |PARAMETER2= | ||
| [[Boolean]] - Returns [[true]] if successful. |RETURNVALUE= | | [[Boolean]] - Returns [[true]] if successful. |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= Place insignia: <code><nowiki | |x1= Place insignia: <code>[<nowiki/>[[player]], "111thID"] [[call]] [[BIS_fnc_setUnitInsignia]];</code> |EXAMPLE1= | ||
|x2= Remove insignia: <code><nowiki | |x2= Remove insignia: <code>[<nowiki/>[[player]], ""] [[call]] [[BIS_fnc_setUnitInsignia]];</code> |EXAMPLE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 34: | Line 36: | ||
<h3 style="display:none">Notes</h3> | <h3 style="display:none">Notes</h3> | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<dd class="notedate">Posted on August 9, 2016 2300 | <dd class="notedate">Posted on August 9, 2016 2300 | ||
<dt class="note> | <dt class="note>[[User:Pierre MGI|Pierre MGI]] | ||
<dd class="note">In | <dd class="note">In [[Arma 3 Unit Insignia]], you can read: | ||
{{quote|You can add a new insignia in Config.cpp and Description.ext.}} | {{quote|You can add a new insignia in Config.cpp and Description.ext.}} | ||
If it | 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> | Config.cpp (addon) is more reliable. Description.ext, in this case, should be used for SP mission only.<br> | ||
This function calls | 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> | ||
Revision as of 18:46, 10 October 2020
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. 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
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.