Difference between revisions of "onMapSingleClick"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (redescriptioon, examples using { })
(String is required.)
Line 10: Line 10:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Define action performed when user clicks in map by executing [[Code]].
+
| Define action performed when user clicks in map by executing code.
  
the [[Code]] receives 3 (localised in scope) variables:
+
the code receives 3 (localised in scope) variables:
  
 
* _pos: [[Position]]. an [[Array]]
 
* _pos: [[Position]]. an [[Array]]
Line 20: Line 20:
 
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.  
  
The [[Code]] is executed on every click, until the '''Command''' is  
+
The code is executed on every click, until the '''Command''' is  
*removed via '''onMapSingleClick''' {}, or
+
*removed via '''onMapSingleClick''' "", or
*replaced by '''onMapSingleClick''' {SomeOtherCommand(s)}|=  
+
*replaced by '''onMapSingleClick''' "SomeOtherCommand(s)"|=  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| '''onMapSingleClick''' {[[Code]]} |= Syntax
+
| '''onMapSingleClick''' string |= Syntax
  
 
|p1=[[Code]]:  |= Parameter 1
 
|p1=[[Code]]:  |= Parameter 1
Line 31: Line 31:
 
| [[Nothing]] |= Return value
 
| [[Nothing]] |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
| x1 = <code>onMapSingleClick {"SoldierWB" [[createUnit]] [_pos, [[group]] [[player]]];true;}</code>
+
| x1 = <code>onMapSingleClick """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 {};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 09:46, 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. The code is executed on every click, until the Command is
  • removed via onMapSingleClick "", or
  • replaced by onMapSingleClick "SomeOtherCommand(s)"

Syntax

Syntax:
onMapSingleClick string
Parameters:
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. Use the Talk page or the Forums for discussions.

Notes