setMarkerColor: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
 
(85 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|S]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97|S]]
[[Category:Scripting Commands OFP 1.46|S]]
[[Category:Scripting Commands ArmA|S]]


back to [[Scripting_Reference#S|COMREF]]
|game1= ofp
|version1= 1.21


<h2 style="color:#000066">'''''marker'' setMarkerColor ''color'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''marker:''' [[String]]
|game5= arma2oa
|version5= 1.50


'''color:''' [[String]]
|game6= tkoh
|version6= 1.00


'''Type of returned value:'''
|game7= arma3
|version7= 0.50


[[Nothing]]
|gr1= Markers


'''Compatibility:'''
|eff= global


Added in version '''1.21'''
|descr= Set marker's colour. {{arma3}}'s marker colour names and their corresponding RGBA values can be found here: [[Arma 3: CfgMarkerColors]].
{{Feature|informative|
'''Multiplayer optimisation:''' Global marker commands always broadcast the ''entire'' marker state over the network.
As such, the number of network messages exchanged when creating or editing a marker can be reduced by performing all but the last operation using local marker commands, then using a global marker command for the last change (and subsequent global broadcast of all changes applied to the marker).
}}


'''Description:'''
|s1= markerName [[setMarkerColor]] colour


Set '''marker color'''.
|p1= markerName: [[String]]
'''Color''' is one of:


* '''"Default"'''
|p2= colour: [[String]]
* '''"ColorBlack"'''
* {{hl|{{Link|Arma 3: CfgMarkerColors|CfgMarkerColors}}}}'s class name
* '''"ColorRed"'''
* {{GVI|arma3|2.20|size= 0.75}} direct colour definition in one of the following formats (values in range 0..1):
* '''"ColorRedAlpha"'''
** "#(r,g,b)" (e.g {{hl|"#(1,0,1)"}}, {{hl|#FF00FF}} equivalent)
* '''"ColorGreen"'''
** "#(r,g,b,a)" (e.g {{hl|"#(0.678,0.749,0.514,0.5)"}}, {{hl|#ADBF8380}} equivalent). Alpha 'a' in this format is independent of [[markerAlpha]]
* '''"ColorGreenAlpha"'''
* '''"ColorBlue"'''
* '''"ColorYellow"'''
* '''"ColorWhite"'''


|r1= [[Nothing]]


'''Example:'''
|x1= <sqf>"MarkerOne" setMarkerColor "ColorBlack";</sqf>


"MarkerOne" '''setMarkerColor''' '''"ColorBlack"'''
|x2= <sqf>"MarkerOne" setMarkerColor "#(1,0,0,1)"; // red color - since {{arma3}} v2.20</sqf>
 
|seealso= [[setMarkerColorLocal]] [[markerColor]] [[getMarkerColor]] [[setMarkerBrush]] [[createMarker]] [[setMarkerDir]] [[setMarkerPos]] [[setMarkerShape]] [[setMarkerSize]] [[setMarkerText]] [[setMarkerType]] [[setMarkerAlpha]]
}}

Latest revision as of 13:42, 29 October 2024

Hover & click on the images for description

Description

Description:
Set marker's colour. Arma 3's marker colour names and their corresponding RGBA values can be found here: Arma 3: CfgMarkerColors.
Multiplayer optimisation: Global marker commands always broadcast the entire marker state over the network. As such, the number of network messages exchanged when creating or editing a marker can be reduced by performing all but the last operation using local marker commands, then using a global marker command for the last change (and subsequent global broadcast of all changes applied to the marker).
Groups:
Markers

Syntax

Syntax:
markerName setMarkerColor colour
Parameters:
markerName: String
colour: String
  • CfgMarkerColors's class name
  • Arma 3 logo black.png2.20 direct colour definition in one of the following formats (values in range 0..1):
    • "#(r,g,b)" (e.g "#(1,0,1)", #FF00FF equivalent)
    • "#(r,g,b,a)" (e.g "#(0.678,0.749,0.514,0.5)", #ADBF8380 equivalent). Alpha 'a' in this format is independent of markerAlpha
Return Value:
Nothing

Examples

Example 1:
"MarkerOne" setMarkerColor "ColorBlack";
Example 2:
"MarkerOne" setMarkerColor "#(1,0,0,1)"; // red color - since Arma 3 v2.20

Additional Information

See also:
setMarkerColorLocal markerColor getMarkerColor setMarkerBrush createMarker setMarkerDir setMarkerPos setMarkerShape setMarkerSize setMarkerText setMarkerType setMarkerAlpha

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