BIS fnc markerParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(44 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| tkoh |= Game name
|game1= tkoh
|version1= 1.00


|1.00|= Game version
|game2= arma3
____________________________________________________________________________________________
|version2= 0.50


| Returns marker params in format compatible with [[BIS_fnc_markerCreate]]. |DESCRIPTION=
|gr1= Map and Markers
____________________________________________________________________________________________


| varName call '''BIS_fnc_markerParams''' |SYNTAX=
|descr= Returns marker params in format compatible with [[BIS_fnc_markerCreate]].


|p1= varName: [[String]] - Variable name of the marker |PARAMETER1=
|s1= varName call [[BIS_fnc_markerParams]]


| [[Array]] - Marker parameters
|p1= varName: [[String]] - variable name of the marker
*0: [[Array]] with [[String]] - Variable name of the marker
*1: [[Array]] - Position of the marker
*2: [[Array]] - Size
*3: [[String]] - Colour
*4: [[String]] - Type
*5: [[String]] - Brush
*6: [[String]] - Shape
*7: [[Number]] - Alpha
*8: [[String]] - Name of the marker|RETURNVALUE=


____________________________________________________________________________________________
|r1= [[Array]] - marker parameters in format [varName, pos, size, colour, type, brush, shape, alpha, name] where:
* varName: [[Array]] with [[String]] - variable name
* pos: [[Array]] format [[Position]] - position (see [[setMarkerPos]])
* size: [[Array]] of [[Number]]s in format [x, y] (see [[setMarkerSize]])
* colour: [[String]] - colour (see [[setMarkerColor]])
* type: [[String]] - type (see [[setMarkerType]])
* brush: [[String]] - brush (see [[setMarkerBrush]])
* shape: [[String]] - shape (see [[setMarkerShape]])
* alpha: [[Number]] - transparency (see [[setMarkerAlpha]])
* text: [[String]] - text (see [[setMarkerText]])


|x1= <code>_params = "marker_1" [[call]] '''BIS_fnc_markerParams''';</code>|EXAMPLE1=
|x1= <sqf>private _params = "marker_1" call BIS_fnc_markerParams;</sqf>
____________________________________________________________________________________________


| [[BIS_fnc_markerCreate]] |SEEALSO=
|x2= <sqf>
("marker_1" call BIS_fnc_markerParams) params ["_nameArray", "_position", "_size", "_colour", "_type", "_brush", "_shape", "_alpha", "_text"];
_position params ["_posX", "_posY"];
_nameArray params ["_marker"];
_size params ["_a", "_b"];
</sqf>
 
|seealso= [[BIS_fnc_markerCreate]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Map|{{uc:markerParams}}]]
[[Category:Functions|{{uc:markerParams}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:markerParams}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:markerParams}}]]

Latest revision as of 01:53, 4 April 2024

Hover & click on the images for description

Description

Description:
Returns marker params in format compatible with BIS_fnc_markerCreate.
Execution:
call
Groups:
Map and Markers

Syntax

Syntax:
varName call BIS_fnc_markerParams
Parameters:
varName: String - variable name of the marker
Return Value:
Array - marker parameters in format [varName, pos, size, colour, type, brush, shape, alpha, name] where:

Examples

Example 1:
private _params = "marker_1" call BIS_fnc_markerParams;
Example 2:
("marker_1" call BIS_fnc_markerParams) params ["_nameArray", "_position", "_size", "_colour", "_type", "_brush", "_shape", "_alpha", "_text"]; _position params ["_posX", "_posY"]; _nameArray params ["_marker"]; _size params ["_a", "_b"];

Additional Information

See also:
BIS_fnc_markerCreate

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