onMapSingleClick

1.85

Hover & click on the images for description

Description

Description:

Define action performed when user clicks in map by executing command string. the string receives 3 (localised in scope) variables:

• _pos: Position. an Array
• _units: Units. an Array
• _shift, _alt Boolean key states

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)"

Groups:

Uncategorised

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:

onDoubleClick (VBS2)

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

Notes

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. --General Barron 02:25, 8 July 2009 (CEST)