BIS fnc markerParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(48 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| tkoh |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|gr1= Map and Markers
____________________________________________________________________________________________


| <pre>/*
|descr= Returns marker params in format compatible with [[BIS_fnc_markerCreate]].


Description:
|s1= varName call [[BIS_fnc_markerParams]]
Returns marker params in format compatible with BIS_fnc_markerCreate


Parameter(s):
|p1= varName: [[String]] - variable name of the marker
_this: STRING - marker name


Returns:
|r1= [[Array]] - marker parameters in format [varName, pos, size, colour, type, brush, shape, alpha, name] where:
ARRAY - marker params
* 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]])


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|x1= <sqf>private _params = "marker_1" call BIS_fnc_markerParams;</sqf>
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_markerParams]]; --> |= Syntax
|x2= <sqf>
 
("marker_1" call BIS_fnc_markerParams) params ["_nameArray", "_position", "_size", "_colour", "_type", "_brush", "_shape", "_alpha", "_text"];
|p1= |= Parameter 1
_position params ["_posX", "_posY"];
 
_nameArray params ["_marker"];
| |= Return value
_size params ["_a", "_b"];
____________________________________________________________________________________________
</sqf>
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


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