Difference between revisions of "BIS fnc cancelMarker"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (infobox to template)
m (filled page)
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= global
  
| <pre>/*
+
|eff= global
Author: BIS
 
  
Description:
+
|descr= Cancels a marker by a red 'X' marker. Also sets its variable to "Canceled" to [[true]].
Cancels a marker by a red 'X'' marker. Also sets its varible to "Canceled" to true.
 
  
Parameters:
+
|s1= [marker, duration, fadeTime, sizeMultiplier, angleOffset] [[spawn]] [[BIS_fnc_cancelMarker]]
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:
+
|p1= marker: [[String]] - Marker
Nothing
 
  
Examples:
+
|p2= duration: [[Number]] - (Optional, default 1) Duration of canceling in seconds
_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>{{placeholder}}<!-- Remove this after fill-in --> |Description=
 
  
|[] call [[BIS_fnc_cancelMarker]]|Syntax=
+
|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
  
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
+
|p4= sizeMultiplier: [[Number]] - (Optional, default 1) Multiplier for a size of the 'cancel' marker compared to the original
  
|Datatype - description|Return value=
+
|p5= angleOffset: [[Number]] - (Optional, default 45) Angle offset from the original marker
  
|x1= <code></code>|Example 1=
+
|r1= [[Nothing]]
  
|exec= call |Execution=
+
|x1= <code>["BIS_marker",2,1.5,75] [[spawn]] [[BIS_fnc_cancelMarker]];</code>
 +
 
 +
|exec= spawn
 +
 
 +
|seealso= [[BIS_fnc_blinkMarker]] [[BIS_fnc_colorMarker]] [[BIS_fnc_changeColorMarker]] [[BIS_fnc_getMarkers]] [[BIS_fnc_getMarkerState]]
  
| |See also=
 
 
}}
 
}}
  

Revision as of 18:45, 6 January 2020

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:
Uncategorised

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