Difference between revisions of "onMapSingleClick"

From Bohemia Interactive Community
Jump to navigation Jump to search
(quotes are hard... ;))
(OFP strings)
Line 32: Line 32:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
| x1 = <code>'''onMapSingleClick "'''<nowiki>'</nowiki>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  
+
'''ArmA:''' Creates a soldier unit at the position clicked.|= Example 1  
  
 
| x2 = <code>'''onMapSingleClick "'''_grp1 [[move]] _pos; onMapSingleClick <nowiki>''</nowiki>; 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
+
'''ArmA:''' Orders "_grp1" to move to position clicked. Disables further map-click actions.| = Example 2
 +
 
 +
| x3 = <code>'''onMapSingleClick "'''""SoldierWB"" [[createUnit]] [_pos, [[group]] [[player]]]; true;'''"'''</code>
 +
'''OFP:''' In OFP single quotes cannot be used for string definition, so two double-quotes have to be used instead. |= Example 1
 +
 
 +
 
 
|  |= See also
 
|  |= See also
  
Line 43: Line 48:
 
<dl class="command_description">
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
 
+
In OFP
 
<!-- Note Section END -->
 
<!-- Note Section END -->
 
</dl>
 
</dl>

Revision as of 09:26, 9 January 2008

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:
code:String
Return Value:
Nothing

Examples

Example 1:
onMapSingleClick "'SoldierWB' createUnit [_pos, group player]; true;" ArmA: Creates a soldier unit at the position clicked.
Example 2:
onMapSingleClick "_grp1 move _pos; onMapSingleClick ''; true;" ArmA: Orders "_grp1" to move to position clicked. Disables further map-click actions.
Example 3:
onMapSingleClick """SoldierWB"" createUnit [_pos, group player]; true;" OFP: In OFP single quotes cannot be used for string definition, so two double-quotes have to be used instead.

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

In OFP