Difference between revisions of "onMapSingleClick"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (redescriptioon, examples using { })
Line 10: Line 10:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Define action performed when user clicks in map.  
+
| Define action performed when user clicks in map by executing [[Code]].
  
Command receives:
+
the [[Code]] receives 3 (localised in scope) variables:
  
* _pos [[Array]] position
+
* _pos: [[Position]]. an [[Array]]
* _units [[Array]] selected units
+
* _units: [[Object#Units|Units]]. an [[Array]]
* _shift, _alt [[Boolean]] key state
+
* _shift, _alt [[Boolean]] key states
  
If click is processed, command should return [[true]].  
+
When click is processed, [[Code]] should ultimately return [[true]] back to the engine.  
  
Command is executed on every click, until Command is removed via '''onMapSingleClick''' "".|=  
+
The [[Code]] is executed on every click, until the '''Command''' is  
 +
*removed via '''onMapSingleClick''' {}, or
 +
*replaced by '''onMapSingleClick''' {SomeOtherCommand(s)}|=  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| '''onMapSingleClick''' "command" |= Syntax
+
| '''onMapSingleClick''' {[[Code]]} |= Syntax
  
|p1= "command": [[String]] |= Parameter 1
+
|p1=[[Code]]|= Parameter 1
  
 
| [[Nothing]] |= Return value
 
| [[Nothing]] |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
| x1 = <code>onMapSingleClick """SoldierWB"" [[createUnit]] [_pos, [[group]] [[player]]]"</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 <nowiki>{}"</nowiki></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 01:22, 5 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 {Code}
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