BIS fnc getMarkerState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (infobox to template)
m (page filled)
Line 1: Line 1:
{{Function|= Comments
{{Function


| arma3 |Game name=
|game1= arma3


|1.78|Game version=
|version1= 1.78


<!---|arg= local |Multiplayer Arguments=--->
<!--|exec= server|=-->


<!---|eff= local |Multiplayer Effects=--->
<!--|arg= local-->


| <pre>/*
<!--|eff= local-->
Author:
BIS


Description:
|descr= Returns the state of a marker.
Retun the state of a marker - Shown, Hidden, Canceled or Default


Parameters:
||s1= [marker] call [[BIS_fnc_getMarkerState]]|=Syntax
Select 0 - STRING: Marker


Returns:
|p1= marker: [[String]] - Marker
STRING - marker's state. If marker doesn't exist or the state is unknown, nil is returned


Example:
|r1= [[String]] - Returns state of the marker. "Shown", "Hidden", "Canceled", "Default", if marker does not exist, [[nil]] is returned
_state = "BIS_marker" call BIS_fnc_getMarkerState;


*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=
|x1= <code>_state = ["BIS_marker_1"] [[call]] [[BIS_fnc_getMarkerState]];</code>


|[] call [[BIS_fnc_getMarkerState]]|Syntax=
|exec= call


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|seealso= [[BIS_fnc_blinkMarker]] [[BIS_fnc_changeColorMarker]] [[BIS_fnc_getMarkers]] [[BIS_fnc_getMarkerState]] [[BIS_fnc_colorMarker]]


|Datatype - description|Return value=
|x1= <code></code>|Example 1=
|exec= call |Execution=
| |See also=
}}
}}



Revision as of 20:08, 6 January 2020

Hover & click on the images for description

Description

Description:
Returns the state of a marker.
Execution:
call
Groups:
Uncategorised

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:
_state = ["BIS_marker_1"] call BIS_fnc_getMarkerState;

Additional Information

See also:
BIS_fnc_blinkMarker BIS_fnc_changeColorMarker BIS_fnc_getMarkers BIS_fnc_getMarkerState 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