Difference between revisions of "onMapSingleClick"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fixed one more code link.)
(false and other types clarified.)
Line 18: Line 18:
 
* _shift, _alt [[Boolean]] key states
 
* _shift, _alt [[Boolean]] key states
  
When click is processed, code should ultimately return [[true]] back to the engine.  
+
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  
 
The code is executed on every click, until the '''Command''' is  

Revision as of 10:53, 7 September 2007

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

Syntax

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

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

Notes