BIS fnc markerParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "code>_([a-zA-Z0-9_]+) = " to "code>private _$1 = ")
m (Some wiki formatting)
 
(10 intermediate revisions by the same user not shown)
Line 13: Line 13:
|s1= varName call [[BIS_fnc_markerParams]]
|s1= varName call [[BIS_fnc_markerParams]]


|p1= varName: [[String]] - Variable name of the marker
|p1= varName: [[String]] - variable name of the marker


|r1= [[Array]] - Marker parameters
|r1= [[Array]] - marker parameters in format [varName, pos, size, colour, type, brush, shape, alpha, name] where:
*0: [[Array]] with [[String]] - Variable name of the marker
* varName: [[Array]] with [[String]] - variable name
*1: [[Array]] - Position of the marker
* pos: [[Array]] format [[Position]] - position (see [[setMarkerPos]])
*2: [[Array]] - Size
* size: [[Array]] of [[Number]]s in format [x, y] (see [[setMarkerSize]])
*3: [[String]] - Colour
* colour: [[String]] - colour (see [[setMarkerColor]])
*4: [[String]] - Type
* type: [[String]] - type (see [[setMarkerType]])
*5: [[String]] - Brush
* brush: [[String]] - brush (see [[setMarkerBrush]])
*6: [[String]] - Shape
* shape: [[String]] - shape (see [[setMarkerShape]])
*7: [[Number]] - Alpha
* alpha: [[Number]] - transparency (see [[setMarkerAlpha]])
*8: [[String]] - Name of the marker
* text: [[String]] - text (see [[setMarkerText]])


|x1= <code>[[private]] _params = "marker_1" [[call]] [[BIS_fnc_markerParams]];</code>
|x1= <sqf>private _params = "marker_1" call BIS_fnc_markerParams;</sqf>
 
|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]]
|seealso= [[BIS_fnc_markerCreate]]
}}
}}
||
<dl class="command_description">
<dt></dt>
<dd class="notedate">Posted on February 27, 2021 - 16:30 (UTC)</dd>
<dt class="note">[[User:7erra|7erra]]</dt>
<dd class="note">
Extract all marker information from marker_1 to variables:
<code>("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"];</code>
</dd>
</dl>

Latest revision as of 02: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