BIS fnc cancelMarker: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *M([a-z ])" to "$1 - m$2")
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


|game1= arma3
|game1= arma3
|version1= 1.78
|version1= 1.78


Line 13: Line 12:
|descr= Cancels a marker by a red 'X' marker. Also sets its variable to "Canceled" to [[true]].
|descr= Cancels a marker by a red 'X' marker. Also sets its variable to "Canceled" to [[true]].


|s1= [marker, duration, fadeTime, sizeMultiplier, angleOffset] [[spawn]] [[BIS_fnc_cancelMarker]]
|s1= [marker, duration, fadeTime, sizeMultiplier, angleOffset] spawn [[BIS_fnc_cancelMarker]]


|p1= marker: [[String]] - Marker
|p1= marker: [[String]] - marker


|p2= duration: [[Number]] - (Optional, default 1) Duration of canceling in seconds
|p2= duration: [[Number]] - (Optional, default 1) duration of canceling in seconds


|p3= fadeTime: [[Number]] - (Optional, default -1) Time in seconds after which cancel marker fades. If value is <0 then marker won't fade out and will be deleted after duration
|p3= fadeTime: [[Number]] - (Optional, default -1) time in seconds after which cancel marker fades. If value is <0 then marker won't fade out and will be deleted after duration


|p4= sizeMultiplier: [[Number]] - (Optional, default 1) Multiplier for a size of the 'cancel' marker compared to the original
|p4= sizeMultiplier: [[Number]] - (Optional, default 1) multiplier for a size of the 'cancel' marker compared to the original


|p5= angleOffset: [[Number]] - (Optional, default 45) Angle offset from the original marker
|p5= angleOffset: [[Number]] - (Optional, default 45) angle offset from the original marker


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>["BIS_marker",2,1.5,75] [[spawn]] [[BIS_fnc_cancelMarker]];</code>
|x1= <sqf>["BIS_marker",2,1.5,75] spawn BIS_fnc_cancelMarker;</sqf>


|exec= spawn
|exec= spawn


|seealso= [[BIS_fnc_blinkMarker]] [[BIS_fnc_colorMarker]] [[BIS_fnc_changeColorMarker]] [[BIS_fnc_getMarkers]] [[BIS_fnc_getMarkerState]]
|seealso= [[BIS_fnc_blinkMarker]] [[BIS_fnc_colorMarker]] [[BIS_fnc_changeColorMarker]] [[BIS_fnc_getMarkers]] [[BIS_fnc_getMarkerState]]
}}
}}
[[Category:Functions|{{uc:cancelMarker}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:cancelMarker}}]]

Latest revision as of 15:39, 8 November 2023

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

Description

Description:
Cancels a marker by a red 'X' marker. Also sets its variable to "Canceled" to true.
Execution:
spawn
Groups:
Map and Markers

Syntax

Syntax:
[marker, duration, fadeTime, sizeMultiplier, angleOffset] spawn BIS_fnc_cancelMarker
Parameters:
marker: String - marker
duration: Number - (Optional, default 1) duration of canceling in seconds
fadeTime: Number - (Optional, default -1) time in seconds after which cancel marker fades. If value is <0 then marker won't fade out and will be deleted after duration
sizeMultiplier: Number - (Optional, default 1) multiplier for a size of the 'cancel' marker compared to the original
angleOffset: Number - (Optional, default 45) angle offset from the original marker
Return Value:
Nothing

Examples

Example 1:
["BIS_marker",2,1.5,75] spawn BIS_fnc_cancelMarker;

Additional Information

See also:
BIS_fnc_blinkMarker BIS_fnc_colorMarker BIS_fnc_changeColorMarker BIS_fnc_getMarkers BIS_fnc_getMarkerState

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_cancelMarker&oldid=348835"