onMapSingleClick

From Bohemia Interactive Community
Revision as of 19:56, 23 January 2013 by Master85 (talk | contribs) (see also cleanup, fixed note)
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 3 (localised in scope) variables:
  • _pos: Array - Clicked position
  • _units: Array - Units which were selected (via function keys) before opening the map (may be non-functional in Arma)
  • _shift, _alt Boolean - Whether <Shift> or <Alt> were 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)"

Syntax

Syntax:
onMapSingleClick command
Parameters:
command: String
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.

Additional Information

See also:
onGroupIconClickonDoubleClick

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.