setMarkerColor: Difference between revisions

Latest revision as of 13:42, 29 October 2024

1.21

1.00

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
2.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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| ofp |= Game name
+|game1= ofp
+|version1= 1.21
-|1.21|= Game version
+|game2= ofpe
-____________________________________________________________________________________________
+|version2= 1.00
-| Set marker color. Color is one of:
+|game3= arma1
-* "Default"
+|version3= 1.00
-* "ColorBlack"
-* "ColorGrey"
-* "ColorRed"
-* "ColorRedAlpha" (Arma 2 only)
-* "ColorGreen"
-* "ColorGreenAlpha" (Arma 2 only)
-* "ColorBlue"
-* "ColorYellow"
-* "ColorOrange"
-* "ColorWhite"
-* "ColorPink"
-* "ColorBrown"
-* "ColorKhaki"
-* "ColorWEST"
-* "ColorEAST"
-* "ColorGUER"
-* "ColorCIV"
-* "ColorUNKNOWN"
-* "Color1_FD_F" (Light red)
-* "Color2_FD_F" (Light khaki)
-* "Color3_FD_F" (Light orange)
-* "Color4_FD_F" (Light blue)
-Arma 3
+|game4= arma2
-* "ColorBLUFOR"
+|version4= 1.00
-* "ColorCivilian"
-* "ColorIndependent"
-* "ColorOPFOR"
-|= Description
-____________________________________________________________________________________________
-| markerName '''setMarkerColor''' color |= Syntax
+|game5= arma2oa
+|version5= 1.50
-|p1= markerName: [[String]] |= Parameter 1
+|game6= tkoh
+|version6= 1.00
-|p2= color: [[String]] |= Parameter 2
+|game7= arma3
+|version7= 0.50
-| [[Nothing]] |= Return value
+|gr1= Markers
-____________________________________________________________________________________________
-|x1= <code>"MarkerOne" [[setMarkerColor]] "ColorBlack";</code> |= Example 1
-____________________________________________________________________________________________
-|[[setMarkerBrush]], [[createMarker]], [[setMarkerDir]], [[setMarkerPos]], [[setMarkerShape]], [[setMarkerSize]], [[setMarkerText]], [[setMarkerType]], [[setMarkerAlpha]] |= See also
+|eff= global
+|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).
 }}
-<h3 style="display:none">Notes</h3>
+|s1= markerName [[setMarkerColor]] colour
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|p1= markerName: [[String]]
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|p2= colour: [[String]]
-[[Category:Scripting Commands|SETMARKERCOLOR]]
+* {{hl|{{Link|Arma 3: CfgMarkerColors|CfgMarkerColors}}}}'s class name
-[[Category:Scripting Commands OFP 1.96|SETMARKERCOLOR]]
+* {{GVI|arma3|2.20|size= 0.75}} direct colour definition in one of the following formats (values in range 0..1):
-[[Category:Scripting Commands OFP 1.46|SETMARKERCOLOR]]
+** "#(r,g,b)" (e.g {{hl|"#(1,0,1)"}}, {{hl|#FF00FF}} equivalent)
-[[Category:Scripting Commands ArmA|SETMARKERCOLOR]]
+** "#(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]]
-[[Category:Command Group: Markers|SETMARKERCOLOR]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+|r1= [[Nothing]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
+|x1= <sqf>"MarkerOne" setMarkerColor "ColorBlack";</sqf>
+|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]]
+}}