onMapSingleClick

From Bohemia Interactive Community
Revision as of 00:08, 28 June 2014 by Killzone Kid (talk | contribs) (examples formatting)
Jump to navigation Jump to search
Introduced with Operation Flashpoint: Resistance version 1.851.85
Hover & click on the images for descriptions

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
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)"
Arma 3 logo black.png
In order to keep compatability between official and community content the functions BIS_fnc_addStackedEventHandler and BIS_fnc_removeStackedEventHandler should be used instead.

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

Additional Information

See also:
onGroupIconClickonDoubleClick
Groups:
Uncategorised

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

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