onMapSingleClick: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(quotes are hard... ;))
Line 31: Line 31:
| [[Nothing]] |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
| x1 = <code>onMapSingleClick """SoldierWB" [[createUnit]] [_pos, [[group]] [[player]]];true;""</code>
| x1 = <code>'''onMapSingleClick "'''<nowiki>'</nowiki>SoldierWB' [[createUnit]] [_pos, [[group]] [[player]]]; true;'''"'''</code>
Creates a soldier unit at the position clicked. |= Example 1  
Creates a soldier unit at the position clicked. |= Example 1  


| x2 = <code>onMapSingleClick ""_grp1 [[move]] _pos; onMapSingleClick {};true;""</code>
| x2 = <code>'''onMapSingleClick "'''_grp1 [[move]] _pos; onMapSingleClick <nowiki>''</nowiki>; true;'''"'''</code>
Orders "_grp1" to move to position clicked. Disables further map-click actions. | = Example 2
Orders "_grp1" to move to position clicked. Disables further map-click actions. | = Example 2
|  |= See also
|  |= See also

Revision as of 08:15, 9 January 2008


Hover & click on the images for description

Description

Description:
Define action performed when user clicks in map by executing code. the code receives 3 (localised in scope) variables: 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 code
Parameters:
code:String
Return Value:
Nothing

Examples

Example 1:
onMapSingleClick "'SoldierWB' createUnit [_pos, group player]; true;" Creates a soldier unit at the position clicked.
Example 2:
onMapSingleClick "_grp1 move _pos; onMapSingleClick ''; true;" Orders "_grp1" to move to position clicked. Disables further map-click actions.

Additional Information

See also:
See also needed

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