markerShape: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:ArmA 2: New Scripting Commands List\|{{uc:{{PAGENAME}}}}\]\]\s*" to "")
No edit summary
 
(38 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|1.00|Game version=
|version1= 1.00
|arg= global|Multiplayer Arguments=
____________________________________________________________________________________________


| Gets the marker shape. See [[setMarkerShape]] for a list of strings that can be returned. Possible return values:
|game2= arma2oa
* <tt>"ICON"</tt>
|version2= 1.50
* <tt>"RECTANGLE"</tt>
* <tt>"ELLIPSE"</tt>
* <tt>"POLYLINE"</tt>
* <tt>"ERROR"</tt> |DESCRIPTION=
____________________________________________________________________________________________


| '''markerShape''' name |SYNTAX=
|game3= tkoh
|version3= 1.00


|p1= name: [[String]] -  |PARAMETER1=  
|game4= arma3
|version4= 0.50


|p2= |PARAMETER2=  
|gr1= Markers


|p3= |PARAMETER3=  
|arg= global


| [[String]] |RETURNVALUE=  
|descr= Returns the shape of given marker.


|s1= [[markerShape]]  name


|x1= <code>[[if]] ('''markerShape''' "Marker1" == "RECTANGLE") [[then]] {[[hint]] "Marker1 is a rectangle!"}</code>|EXAMPLE1=
|p1= name: [[String]] - name of the marker


____________________________________________________________________________________________
|r1= [[String]] - shape of given marker. Can be return:
* {{hl|"ICON"}}
* {{hl|"RECTANGLE"}}
* {{hl|"ELLIPSE"}}
* {{GVI|arma3|1.60|size= 0.75}} {{hl|"POLYLINE"}} (Hand drawn markers)
* {{GVI|arma3|2.20|size= 0.75}} {{hl|"TRIANGLE"}}
* {{GVI|arma3|2.20|size= 0.75}} {{hl|"PENTAGON"}}
* {{GVI|arma3|2.20|size= 0.75}} {{hl|"HEXAGON"}}
* {{GVI|arma3|2.20|size= 0.75}} {{hl|"HEPTAGON"}}
* {{GVI|arma3|2.20|size= 0.75}} {{hl|"OCTAGON"}}
* {{GVI|arma3|2.20|size= 0.75}} {{hl|"NONAGON"}}
* {{GVI|arma3|2.20|size= 0.75}} {{hl|"DECAGON"}}


| [[setMarkerShape]], [[setMarkerShapeLocal]] |SEEALSO=  
|x1= <sqf>if (markerShape "Marker1" == "RECTANGLE") then { hint "Marker1 is a rectangle!" };</sqf>


| |MPBEHAVIOUR=  
|seealso= [[setMarkerShape]] [[setMarkerShapeLocal]]
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Markers|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on May 30, 2016 - 19:33 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
Free hand drawn markers return "POLYLINE"
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 20:52, 1 November 2024

Hover & click on the images for description

Description

Description:
Returns the shape of given marker.
Groups:
Markers

Syntax

Syntax:
markerShape name
Parameters:
name: String - name of the marker
Return Value:
String - shape of given marker. Can be return:
  • "ICON"
  • "RECTANGLE"
  • "ELLIPSE"
  • Arma 3 logo black.png1.60 "POLYLINE" (Hand drawn markers)
  • Arma 3 logo black.png2.20 "TRIANGLE"
  • Arma 3 logo black.png2.20 "PENTAGON"
  • Arma 3 logo black.png2.20 "HEXAGON"
  • Arma 3 logo black.png2.20 "HEPTAGON"
  • Arma 3 logo black.png2.20 "OCTAGON"
  • Arma 3 logo black.png2.20 "NONAGON"
  • Arma 3 logo black.png2.20 "DECAGON"

Examples

Example 1:
if (markerShape "Marker1" == "RECTANGLE") then { hint "Marker1 is a rectangle!" };

Additional Information

See also:
setMarkerShape setMarkerShapeLocal

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