Difference between revisions of "ctrlMapCursor"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Improved formatting, added information about the custom cursor, fixed 1st example.)
Line 7: Line 7:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Changes default cursor texture ("Track",Move,Array,Scroll) to,custom one. To restore default texture,write empty string. If new,texture does not exist,default cursor texture is used. |= Description
+
| Changes the default the cursor that appears when interacting with a map control to a custom one.
 +
 
 +
Use an empty string to restore the default cursor.
 +
If the specified cursor does not exist, the default is used and no error is produced.
 +
 
 +
The cursor texture is one of the following and is '''case sensitive''':
 +
* Track
 +
* Move
 +
* Array
 +
* Scroll
 +
 
 +
Custom cursor is the name of a config entry from ''CfgWrapperUI / Cursors''. |= Description
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| control '''ctrlMapCursor''' texture names |= Syntax
+
| control '''ctrlMapCursor''' [cursorTexture, customCursor] |= Syntax
  
|p1= control: [[Control]] - |= PARAMETER1  
+
|p1= control: [[Control]] - Map control |= PARAMETER1  
  
|p2= texture names: [[Array]] - |= PARAMETER2  
+
|p2= cursorTexture: [[String]] - Cursor texture name |= PARAMETER2  
  
|p3= |= PARAMETER3  
+
|p3= customCursor: [[String]] - Cursor class name |= PARAMETER3  
  
 
| Nothing |= RETURNVALUE  
 
| Nothing |= RETURNVALUE  
  
  
|x1= <code>ctrlMapCursor ["Track",customCursor]</code>|= EXAMPLE1  
+
|x1= <code>_map ctrlMapCursor ["Track", _customCursor]</code>|= EXAMPLE1  
  
 
|x2= <code>uiNamespace setVariable ["_map",(findDisplay 12) displayCtrl 51];
 
|x2= <code>uiNamespace setVariable ["_map",(findDisplay 12) displayCtrl 51];

Revision as of 03:26, 28 December 2012

Hover & click on the images for description

Description

Description:
Changes the default the cursor that appears when interacting with a map control to a custom one. Use an empty string to restore the default cursor. If the specified cursor does not exist, the default is used and no error is produced. The cursor texture is one of the following and is case sensitive:
  • Track
  • Move
  • Array
  • Scroll
Custom cursor is the name of a config entry from CfgWrapperUI / Cursors.
Groups:
Uncategorised

Syntax

Syntax:
control ctrlMapCursor [cursorTexture, customCursor]
Parameters:
control: Control - Map control
cursorTexture: String - Cursor texture name
customCursor: String - Cursor class name
Return Value:
Nothing

Examples

Example 1:
_map ctrlMapCursor ["Track", _customCursor]
Example 2:
uiNamespace setVariable ["_map",(findDisplay 12) displayCtrl 51]; (uiNamespace getVariable "_map") ctrlMapCursor ["Track","HC_overFriendly"];

Additional Information

See also:
See also needed

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

Notes

Bottom Section