setMarkerText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (formatted notes)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(53 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= ofpe
|version1= 1.00


|1.00|= Game version
|game2= arma1
|version2= 1.00


|eff= global |= Effects in MP
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| Sets the text label of an existing marker. |= Description
|game4= arma2oa
____________________________________________________________________________________________
|version4= 1.50


| markerName '''setMarkerText''' text |= Syntax
|game5= tkoh
|version5= 1.00


|p1= markerName: [[String]] |= Parameter 1
|game6= arma3
|version6= 0.50


|p2= text: [[String]] |= Parameter 2
|gr1= Markers


|eff= global


| [[Nothing]] |= Return value
|descr= Sets the text label of an existing marker.
____________________________________________________________________________________________
{{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).}}
 
|x1= <code>"Marker1" [[setMarkerText]] "You are here.";</code> |= Example 1
____________________________________________________________________________________________


|mp= setMarkerText is global.  All other setMarker commands seem to be Local.|=
|s1= markerName [[setMarkerText]] text


|[[setMarkerBrush]], [[setMarkerColor]], [[setMarkerDir]], [[setMarkerPos]], [[setMarkerShape]], [[setMarkerSize]], [[setMarkerType]], [[setMarkerAlpha]]
|p1= markerName: [[String]]
|= See also
}}


<h3 style="display:none">Notes</h3>
|p2= text: [[String]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<dt class="note">Unknown
|r1= [[Nothing]]
<dd class="note">[[createMarker]] is GLOBAL in multiplayer, so all markers created with it exist for all clients. But they are not visible. Almost all setMarker commands can then be used for different effects on LOCAL clients.<br>
'''BUT''' if you use the [[setMarkerText]] command, then the marker will become visible to all clients since the command is GLOBAL.


<!-- Note Section END -->
|x1= <sqf>"Marker1" setMarkerText "You are here.";</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[setMarkerBrush]] [[setMarkerColor]] [[setMarkerDir]] [[setMarkerPos]] [[setMarkerShape]] [[setMarkerSize]] [[setMarkerType]] [[setMarkerAlpha]]
[[Category:Scripting Commands|SETMARKERTEXT]]
}}
[[Category:Scripting Commands OFP Elite |SETMARKERTEXT]]
[[Category:Scripting Commands ArmA|SETMARKERTEXT]]
[[Category:Command Group: Markers|SETMARKERTEXT]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 01:25, 2 February 2024

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GEGlobal
Hover & click on the images for description

Description

Description:
Sets the text label of an existing marker.
ⓘ
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 setMarkerText text
Parameters:
markerName: String
text: String
Return Value:
Nothing

Examples

Example 1:
"Marker1" setMarkerText "You are here.";

Additional Information

See also:
setMarkerBrush setMarkerColor setMarkerDir setMarkerPos setMarkerShape setMarkerSize 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
Retrieved from "https://community.bistudio.com/wiki?title=setMarkerText&oldid=352116"