Difference between revisions of "BIS fnc cancelMarker"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (rollback)
m (Text replacement - "<code> *(\^+\]) +\[\[spawn\]\] +\[\[(BIS_fnc_[a-zA-Z0-9_]+)\]\];? *<\/code>" to "<sqf>$1 spawn $2;</sqf>")
 
(12 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=--->
+
|arg= global
  
<!---|eff= local |Multiplayer Effects=--->
+
|eff= global
  
| <pre>/*
+
|descr= Cancels a marker by a red 'X' marker. Also sets its variable to "Canceled" to [[true]].
Author: BIS
 
  
Description:
+
|s1= [marker, duration, fadeTime, sizeMultiplier, angleOffset] spawn [[BIS_fnc_cancelMarker]]
Cancels a marker by a red 'X'' marker. Also sets its varible to "Canceled" to true.
 
  
Parameters:
+
|p1= marker: [[String]] - Marker
Select 0 - STRING: Marker
 
Select 1 (OPTIONAL) - NUMBER: Duration of calceling, default is 1
 
Select 2 (OPTIONAL) - NUMBER: After how long should the X fade out
 
Select 3 (OPTIONAL) - NUMBER: Multiplier for a size of the 'cancel' marker compared to the original, default is 1
 
Select 4 (OPTIONAL) - NUMBER: Angle offset from the original marker, default is 45
 
  
Returns:
+
|p2= duration: [[Number]] - (Optional, default 1) Duration of canceling in seconds
Nothing
 
  
Examples:
+
|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
_cancel = ["BIS_marker"] spawn BIS_fnc_cancelMarker;
 
_cancel = ["BIS_marker",2] spawn BIS_fnc_cancelMarker;
 
_cancel = ["BIS_marker",2,1.5] spawn BIS_fnc_cancelMarker;
 
_cancel = ["BIS_marker",2,1.5,75] spawn BIS_fnc_cancelMarker;
 
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=
 
  
|[] call [[BIS_fnc_cancelMarker]]|Syntax=
+
|p4= sizeMultiplier: [[Number]] - (Optional, default 1) Multiplier for a size of the 'cancel' marker compared to the original
  
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
+
|p5= angleOffset: [[Number]] - (Optional, default 45) Angle offset from the original marker
  
|Datatype - description|Return value=
+
|r1= [[Nothing]]
  
|x1= <code></code>|Example 1=
+
|x1= <sqf>["BIS_marker",2,1.5,75] spawn BIS_fnc_cancelMarker;</sqf>
  
|exec= call |Execution=
+
|exec= spawn
  
| |See also=
+
|seealso= [[BIS_fnc_blinkMarker]] [[BIS_fnc_colorMarker]] [[BIS_fnc_changeColorMarker]] [[BIS_fnc_getMarkers]] [[BIS_fnc_getMarkerState]]
 
}}
 
}}
 
[[Category:Function Group: Map|{{uc:cancelMarker}}]]
 
[[Category:Functions|{{uc:cancelMarker}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:cancelMarker}}]]
 

Latest revision as of 19:04, 5 May 2022

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