ctrlMapCursor: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Improved formatting, added information about the custom cursor, fixed 1st example.)
m (Some wiki formatting)
(62 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Changes the default the cursor that appears when interacting with a map control to a custom one.
|game3= tkoh
|version3= 1.00


Use an empty string to restore the default cursor.
|game4= arma3
If the specified cursor does not exist, the default is used and no error is produced.
|version4= 0.50


The cursor texture is one of the following and is '''case sensitive''':
|gr1= GUI Control - Map
 
|descr= Changes the default cursor that appears when interacting with a map control to a custom one. Use an empty string to restore the default cursor.
{{Feature|important|Before {{arma3}}, if the specified cursor does not exist the default is used and no error is produced.<br>
In {{arma3}}, this would result in the following error: <tt>"No entry 'bin\config.bin/CfgWrapperUI/Cursors'"</tt>.
}}
The cursor is the name of a config entry from ''CfgWrapperUI / Cursors''. This command has the following specifics:
* When used on the Main Map ({{ic|[[findDisplay]] 12 [[displayCtrl]] 51}}), it is possible to override multiple default cursors. For example, while leaving default "Arrow" intact, it is possible to just override "Scroll" with e.g "Wait" (See {{HashLink|#Example 3}})
* When used on a custom map, for example user made Mini Map, there is only one single cursor "" for everything, therefore only this cursor can be overridden (see {{HashLink|#Example 4}} on how to override it)
Some possible class names (See [[ctrlMapCursor/cursors]] for the whole list):
{{Columns|4|
* Arrow
* Track
* Track
* Move
* Move
* Array
* Scroll
* Scroll
* Rotate
* Track3D
* Move3D
* Rotate3D
* Raise3D
* Wait
* HC_move
* HC_overFriendly
* HC_overEnemy
* HC_overMission
* HC_unsel
}}


Custom cursor is the name of a config entry from ''CfgWrapperUI / Cursors''. |= Description
|s1= control [[ctrlMapCursor]] [defaultCursor, newCursor]
____________________________________________________________________________________________


| control '''ctrlMapCursor''' [cursorTexture, customCursor] |= Syntax
|p1= control: [[Control]] - Map control


|p1= control: [[Control]] - Map control |= PARAMETER1
|p2= defaultCursor: [[String]] - cursor class name, '''case-sensitive'''


|p2= cursorTexture: [[String]] - Cursor texture name |= PARAMETER2
|p3= newCursor: [[String]] - cursor class name, '''case-sensitive'''


|p3= customCursor: [[String]] - Cursor class name |= PARAMETER3
|r1= [[Nothing]]


| Nothing |= RETURNVALUE
|x1= <code>_map [[ctrlMapCursor]] ["Track", "Arrow"];</code>


|x2= <code>[[uiNamespace]] [[setVariable]] ["_map", [[findDisplay]] 12 [[displayCtrl]] 51];
([[uiNamespace]] [[getVariable]] "_map") [[ctrlMapCursor]] ["Track", "HC_overFriendly"];</code>


|x1= <code>_map ctrlMapCursor ["Track", _customCursor]</code>|= EXAMPLE1
|x3= <code>[[findDisplay]] 12 [[displayCtrl]] 51 [[ctrlMapCursor]] ["Scroll", "Wait"];</code>


|x2= <code>uiNamespace setVariable ["_map",(findDisplay 12) displayCtrl 51];
|x4= Cycle through all available cursors over custom map:
(uiNamespace getVariable "_map") ctrlMapCursor ["Track","HC_overFriendly"];</code>|= EXAMPLE1
<code>[] [[spawn]]
{
[[disableSerialization]];
_map = [[findDisplay]] 46 [[createDisplay]] "RscCredits" [[ctrlCreate]] ["RscMapControl", -1];
_map [[ctrlSetPosition]] [0,0,1,1];
_map [[ctrlCommit]] 0;
{
_map [[ctrlMapCursor]] ["", [[configName]] _x]; //<-- the actual usage
[[hint]] [[format]] ["Current cursor: %1", [[configName]] _x];
[[sleep]] 1;
}
[[forEach]] ("true" [[configClasses]] ([[configFile]] >> "CfgWrapperUI" >> "Cursors"));
};</code>


____________________________________________________________________________________________
|seealso= [[setMousePosition]], [[getMousePosition]]
}}


| |= SEEALSO
{{Note
|user= Bull A
|timestamp= 20160208224300
|text= When using this command, the cursor will change for the whole display, resulting in visual glitches. Adding the onMouseMoving event handler can help solve this problem:
<code>_control [[ctrlAddEventHandler]] ["MouseMoving", {
[[params]] [
["_mapCtrl",[[controlNull]], [<nowiki/>[[controlNull]]]],
["_xPos",-1,[0]],
["_yPos",-1,[0]],
["_mouseIn", [[false]], [<nowiki/>[[true]]]]
];


| |= MPBEHAVIOUR
[[if]] (_mouseIn) [[then]] {
____________________________________________________________________________________________
{{cc|Mouse is in control area}}
_mapCtrl [[ctrlMapCursor]] ["", "Track"];
} [[else]] {
{{cc|Mouse is out of control area, goes back to arrow}}
_mapCtrl [[ctrlMapCursor]] ["", "Arrow"];
};
}];
</code>
}}
}}
<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:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 22:00, 21 September 2021

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Changes the default cursor that appears when interacting with a map control to a custom one. Use an empty string to restore the default cursor.
⚠
Before Arma 3, if the specified cursor does not exist the default is used and no error is produced.
In Arma 3, this would result in the following error: "No entry 'bin\config.bin/CfgWrapperUI/Cursors'".

The cursor is the name of a config entry from CfgWrapperUI / Cursors. This command has the following specifics:

  • When used on the Main Map (findDisplay 12 displayCtrl 51), it is possible to override multiple default cursors. For example, while leaving default "Arrow" intact, it is possible to just override "Scroll" with e.g "Wait" (See Example 3)
  • When used on a custom map, for example user made Mini Map, there is only one single cursor "" for everything, therefore only this cursor can be overridden (see Example 4 on how to override it)

Some possible class names (See ctrlMapCursor/cursors for the whole list):

  • Arrow
  • Track
  • Move
  • Scroll
  • Rotate
  • Track3D
  • Move3D
  • Rotate3D
  • Raise3D
  • Wait
  • HC_move
  • HC_overFriendly
  • HC_overEnemy
  • HC_overMission
  • HC_unsel
Groups:
GUI Control - Map

Syntax

Syntax:
control ctrlMapCursor [defaultCursor, newCursor]
Parameters:
control: Control - Map control
defaultCursor: String - cursor class name, case-sensitive
newCursor: String - cursor class name, case-sensitive
Return Value:
Nothing

Examples

Example 1:
_map ctrlMapCursor ["Track", "Arrow"];
Example 2:
uiNamespace setVariable ["_map", findDisplay 12 displayCtrl 51]; (uiNamespace getVariable "_map") ctrlMapCursor ["Track", "HC_overFriendly"];
Example 3:
findDisplay 12 displayCtrl 51 ctrlMapCursor ["Scroll", "Wait"];
Example 4:
Cycle through all available cursors over custom map: [] spawn { disableSerialization; _map = findDisplay 46 createDisplay "RscCredits" ctrlCreate ["RscMapControl", -1]; _map ctrlSetPosition [0,0,1,1]; _map ctrlCommit 0; { _map ctrlMapCursor ["", configName _x]; //<-- the actual usage hint format ["Current cursor: %1", configName _x]; sleep 1; } forEach ("true" configClasses (configFile >> "CfgWrapperUI" >> "Cursors")); };

Additional Information

See also:
setMousePositiongetMousePosition

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
Bull A - c
Posted on Feb 08, 2016 - 22:43 (UTC)
When using this command, the cursor will change for the whole display, resulting in visual glitches. Adding the onMouseMoving event handler can help solve this problem: _control ctrlAddEventHandler ["MouseMoving", { params [ ["_mapCtrl",controlNull, [controlNull]], ["_xPos",-1,[0]], ["_yPos",-1,[0]], ["_mouseIn", false, [true]] ]; if (_mouseIn) then { // Mouse is in control area _mapCtrl ctrlMapCursor ["", "Track"]; } else { // Mouse is out of control area, goes back to arrow _mapCtrl ctrlMapCursor ["", "Arrow"]; }; }];
Retrieved from "https://community.bistudio.com/wiki?title=ctrlMapCursor&oldid=293484"