onMapSingleClick: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
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]]. | ||
the [[Code]] receives 3 (localised in scope) variables: | |||
* _pos [[Array]] | * _pos: [[Position]]. an [[Array]] | ||
* _units [[Array]] | * _units: [[Object#Units|Units]]. an [[Array]] | ||
* _shift, _alt [[Boolean]] key | * _shift, _alt [[Boolean]] key states | ||
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)}|= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''onMapSingleClick''' | | '''onMapSingleClick''' {[[Code]]} |= Syntax | ||
|p1= | |p1=[[Code]]: |= Parameter 1 | ||
| [[Nothing]] |= Return value | | [[Nothing]] |= Return value | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| x1 = <code>onMapSingleClick | | 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 | | 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
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)}
- Groups:
- Uncategorised
Syntax
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