BIS fnc getMarkerState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Function|= Comments | arma3 |Game name= |1.78|Game version= <!---|arg= local |Multiplayer Arguments=---> <!---|eff= local |Multiplayer Effects=---> | <pre>/* Author:...")
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.78


|1.78|Game version=
|gr1= Map and Markers


<!---|arg= local |Multiplayer Arguments=--->
|descr= Returns the state of a marker.


<!---|eff= local |Multiplayer Effects=--->
|s1= [marker] call [[BIS_fnc_getMarkerState]]


| <pre>/*
|p1= marker: [[String]] - marker
Author:
BIS


Description:
|r1= [[String]] - returns state of the marker. "Shown", "Hidden", "Canceled", "Default", if marker does not exist, [[nil]] is returned
Retun the state of a marker - Shown, Hidden, Canceled or Default


Parameters:
|x1= <sqf>private _state = ["BIS_marker_1"] call BIS_fnc_getMarkerState;</sqf>
Select 0 - STRING: Marker


Returns:
|seealso= [[BIS_fnc_blinkMarker]] [[BIS_fnc_changeColorMarker]] [[BIS_fnc_getMarkers]] [[BIS_fnc_colorMarker]]
STRING - marker's state. If marker doesn't exist or the state is unknown, nil is returned
 
Example:
_state = "BIS_marker" call BIS_fnc_getMarkerState;
 
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=
 
|[] call [[BIS_fnc_getMarkerState]]|Syntax=
 
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
 
|Datatype - description|Return value=
 
|x1= <code></code>|Example 1=
 
|exec= call |Execution=
 
| |See also=
}}
}}
[[Category:Function Group: Map|{{uc:getMarkerState}}]]
[[Category:Functions|{{uc:getMarkerState}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getMarkerState}}]]

Latest revision as of 15:47, 8 November 2023

Arma 3 logo black.png1.78
Hover & click on the images for description

Description

Description:
Returns the state of a marker.
Execution:
call
Groups:
Map and Markers

Syntax

Syntax:
[marker] call BIS_fnc_getMarkerState
Parameters:
marker: String - marker
Return Value:
String - returns state of the marker. "Shown", "Hidden", "Canceled", "Default", if marker does not exist, nil is returned

Examples

Example 1:
private _state = ["BIS_marker_1"] call BIS_fnc_getMarkerState;

Additional Information

See also:
BIS_fnc_blinkMarker BIS_fnc_changeColorMarker BIS_fnc_getMarkers BIS_fnc_colorMarker

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=BIS_fnc_getMarkerState&oldid=349025"