onMapSingleClick: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Lou Montana (talk | contribs) m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2") |
||
(122 intermediate revisions by 22 users not shown) | |||
Line 1: | Line 1: | ||
{{RV|type=command | |||
|game1= ofp | |||
|version1= 1.85 | |||
|game2= ofpe | |||
|version2= 1.00 | |||
|game3= arma1 | |||
|version3= 1.00 | |||
|game4= arma2 | |||
|version4= 1.00 | |||
|game5= arma2oa | |||
|version5= 1.50 | |||
|game6= tkoh | |||
|version6= 1.00 | |||
|game7= arma3 | |||
|version7= 0.50 | |||
|gr1= Map | |||
|gr2= Event Handlers | |||
''' | |descr= Defines the action performed when user clicks in map by executing command string. The code is executed on every click, until the '''command''' is | ||
* removed via <sqf inline>onMapSingleClick ""</sqf>, or | |||
* replaced by <sqf inline>onMapSingleClick "SomeOtherCommand(s)"</sqf> | |||
In {{arma3}} the code should return [[true]] only if you wish to override default engine handling of the mouse click on map (see {{Link|#Example 4}}).<br> | |||
For older games, when click is processed, code should ultimately return [[true]] back to the engine. If [[false]] is returned, default processing by the game engine is done. | |||
Return value of any other type (including [[Nothing]]) is an error. In such case default processing by the game engine is done, and error message may be displayed. | |||
''' | {{Feature|arma3|Since {{GVI|arma3|1.58}} the stackable [[Arma 3: Mission Event Handlers#MapSingleClick|MapSingleClick]] Mission Event Handler is available and should be used instead.}} | ||
|s1= [[onMapSingleClick]] command | |||
|p1= command: [[String]] or [[Code]] - code executed on click. The following variables are available: | |||
* _pos: [[Array]] - Clicked position | |||
* _units: [[Array]] - Units which were selected (via function keys) '''before''' opening the map (''may be non-functional in Arma'') | |||
* _shift: [[Boolean]] - Whether {{Controls|Shift}} was pressed when clicking on the map | |||
* _alt: [[Boolean]] - Whether {{Controls|Alt}} was pressed when clicking on the map | |||
|r1= [[Nothing]] | |||
|s2= params [[onMapSingleClick]] command | |||
|p21= params: [[Anything]] | |||
|p22= command: [[String]] or [[Code]] - code executed on click. The following variables are available: | |||
* _this: [[Anything]] - Params passed to onMapSingleClick | |||
* _pos: [[Array]] - Clicked position | |||
* _units: [[Array]] - Units which were selected (via function keys) '''before''' opening the map (''may be non-functional in Arma'') | |||
* _shift: [[Boolean]] - Whether {{Controls|Shift}} was pressed when clicking on the map | |||
* _alt: [[Boolean]] - Whether {{Controls|Alt}} was pressed when clicking on the map | |||
|r2= [[Nothing]] | |||
|x1= '''{{arma1}}:''' Creates a soldier unit at the position clicked: | |||
<sqf>onMapSingleClick "'SoldierWB' createUnit [_pos, group player]; true";</sqf> | |||
|x2= '''{{arma1}}:''' Orders "grp1" to move to position clicked. Disables further map-click actions: | |||
<sqf>onMapSingleClick "grp1 move _pos; onMapSingleClick ''; true";</sqf> | |||
|x3= '''{{ofp}}:''' Single quotes cannot be used for string definition, so two double-quotes have to be used instead: | |||
<sqf>onMapSingleClick "'SoldierWB' createUnit [_pos, group player]; true";</sqf> | |||
|x4= <sqf> | |||
// The following code will disable Shift+click waypoint marker creation | |||
onMapSingleClick {_shift}; | |||
</sqf> | |||
|x5= <sqf> | |||
// Pass params to onMapSingleClick code | |||
player onMapSingleClick { hint ("Hello " + name _this) }; // Hello KK | |||
</sqf> | |||
|x6= <sqf> | |||
// Pass params to onMapSingleClick code -and- disable Shift+click waypoint marker creation | |||
player onMapSingleClick "hint (""Hello "" + name _this); _shift"; // Hello KK | |||
</sqf> | |||
|seealso= [[onGroupIconClick]] | |||
}} | |||
{{Note | |||
|user= General Barron | |||
|timestamp= 20090708022500 | |||
|text= See my [http://www.ofpec.com/editors-depot/index.php?action{{=}}details&id{{=}}292&game{{=}}ArmA Multiple OnMapSingleClick] script to allow you to add multiple events to the onMapSingleClick event. Some minor editing of the scripts would be required to use them in Arma. | |||
}} | |||
{{Note | |||
|user= Killzone_Kid | |||
|timestamp= 20160401002500 | |||
|text= {{hl|_units}} param is supposed to return what [[groupSelectedUnits]] returns. Player must be [[leader]] and some [[units]] in the [[group]] must be selected on the group bar. However selected units are connected with group orders menu, which interferes with map click. In other words, when you click on the main map, the map gets focus and group orders menu closes, deselecting any selected unit, so {{hl|_units}} is [] pretty much all the time. | |||
}} |
Latest revision as of 13:59, 8 November 2023
Description
- Description:
- Defines the action performed when user clicks in map by executing command string. The code is executed on every click, until the command is
- removed via onMapSingleClick "", or
- replaced by onMapSingleClick "SomeOtherCommand(s)"
For older games, when click is processed, code should ultimately return true back to the engine. If false is returned, default processing by the game engine is done. Return value of any other type (including Nothing) is an error. In such case default processing by the game engine is done, and error message may be displayed. - Groups:
- MapEvent Handlers
Syntax
- Syntax:
- onMapSingleClick command
- Parameters:
- command: String or Code - code executed on click. The following variables are available:
- Return Value:
- Nothing
Alternative Syntax
- Syntax:
- params onMapSingleClick command
- Parameters:
- params: Anything
- command: String or Code - code executed on click. The following variables are available:
- _this: Anything - Params passed to onMapSingleClick
- _pos: Array - Clicked position
- _units: Array - Units which were selected (via function keys) before opening the map (may be non-functional in Arma)
- _shift: Boolean - Whether ⇧ Shift was pressed when clicking on the map
- _alt: Boolean - Whether Alt was pressed when clicking on the map
- Return Value:
- Nothing
Examples
- Example 1:
- Armed Assault: Creates a soldier unit at the position clicked:
onMapSingleClick "'SoldierWB' createUnit [_pos, group player]; true";
- Example 2:
- Armed Assault: Orders "grp1" to move to position clicked. Disables further map-click actions:
onMapSingleClick "grp1 move _pos; onMapSingleClick ''; true";
- Example 3:
- Operation Flashpoint: Single quotes cannot be used for string definition, so two double-quotes have to be used instead:
onMapSingleClick "'SoldierWB' createUnit [_pos, group player]; true";
- Example 4:
- // The following code will disable Shift+click waypoint marker creation onMapSingleClick {_shift};
- Example 5:
- Example 6:
- // Pass params to onMapSingleClick code -and- disable Shift+click waypoint marker creation player onMapSingleClick "hint (""Hello "" + name _this); _shift"; // Hello KK
Additional Information
- See also:
- onGroupIconClick
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
- Posted on Jul 08, 2009 - 02:25 (UTC)
- See my Multiple OnMapSingleClick script to allow you to add multiple events to the onMapSingleClick event. Some minor editing of the scripts would be required to use them in Arma.
- Posted on Apr 01, 2016 - 00:25 (UTC)
- _units param is supposed to return what groupSelectedUnits returns. Player must be leader and some units in the group must be selected on the group bar. However selected units are connected with group orders menu, which interferes with map click. In other words, when you click on the main map, the map gets focus and group orders menu closes, deselecting any selected unit, so _units is [] pretty much all the time.
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.85
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Map
- Command Group: Event Handlers