onMapSingleClick

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Operation Flashpoint: Resistance version 1.85
  

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint: Resistance
Version:
1.85

Description

Description:
Define action performed when user clicks in map by executing command string. the string receives 5 (localised in scope) variables:
  • _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
In Arma 3 the code should return true only if you wish to override default engine handling of the mouse click on map (see example #4)
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. The code is executed on every click, until the Command is
  • removed via onMapSingleClick "", or
  • replaced by onMapSingleClick "SomeOtherCommand(s)"
i Since Arma 3 v1.57 a stackable version of this EH is available: MapSingleClick
Arma 3 logo black.png In order to keep compatibility between official and community content the functions BIS_fnc_addStackedEventHandler and BIS_fnc_removeStackedEventHandler should be used instead.

Syntax

Syntax:
onMapSingleClick command
Parameters:
command: String or Code
Return Value:
Nothing

Alternative Syntax

Syntax:
params onMapSingleClick command
Parameters:
params: Anything
command: String or Code
Return Value:
Nothing

Examples

Example 1:
onMapSingleClick "'SoldierWB' createUnit [_pos, group player]; true"; ArmA: Creates a soldier unit at the position clicked.
Example 2:
onMapSingleClick "grp1 move _pos; onMapSingleClick ''; true"; ArmA: Orders "grp1" to move to position clicked. Disables further map-click actions.
Example 3:
onMapSingleClick "'SoldierWB' createUnit [_pos, group player]; true"; OFP: In OFP single quotes cannot be used for string definition, so two double-quotes have to be used instead.
Example 4:
//The following code will disable Shift+click waypoint marker creation onMapSingleClick {_shift};
Example 5:
//Pass params to onMapSingleClick code player onMapSingleClick {hint ("Hello " + name _this)}; //Hello KK
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

Multiplayer:
-
See also:
onGroupIconClick

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Posted on 8 July, 2009
General Barron
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.

Notes

Bottom Section

Posted on April 1, 2016 - 00:25 (UTC)
Killzone Kid
_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.