setWaypointDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
[[Category:Scripting Commands|SETWAYPOINTDESCRIPTION]]
{{Command|= Comments
[[Category:Scripting Commands OFP Elite |SETWAYPOINTDESCRIPTION]]
____________________________________________________________________________________________
[[Category:Scripting Commands ArmA|SETWAYPOINTDESCRIPTION]]


| ofpr |= Game name


<h2 style="color:#000066">'''''waypoint'' setWaypointDescription ''text'''''</h2>
|1.86|= Game version
____________________________________________________________________________________________


| Sets the description shown in the HUD while the waypoint is active. |= Description
____________________________________________________________________________________________


'''Operand types:'''
| waypoint '''setWaypointDescription''' text |= Syntax


'''waypoint:''' [[Array]]
|p1= waypoint: [[Array]] |= Parameter 1


'''text:''' [[String]]
|p2= text: [[String]] |= Parameter 2


'''Type of returned value:'''
| [[Nothing]] |= Return value
____________________________________________________________________________________________
 
|x1= <pre>[grp, 2] setWaypointDescription "Move here."</pre> |= Example 1
____________________________________________________________________________________________


[[Nothing]]
|  |= See also


'''Compatibility:'''
}}


Version 1.86 required.
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


'''Description:'''
<!-- Note Section END -->
</dl>


Sets the description shown in the HUD while the waypoint is active.
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|SETWAYPOINTDESCRIPTION]]
 
[[Category:Scripting Commands OFP Elite |SETWAYPOINTDESCRIPTION]]
'''Example:'''
[[Category:Scripting Commands ArmA|SETWAYPOINTDESCRIPTION]]
 
[grp, 2] '''setWaypointDescription''' "Move here."

Revision as of 00:38, 2 August 2006

Hover & click on the images for description

Description

Description:
Sets the description shown in the HUD while the waypoint is active.
Groups:
Uncategorised

Syntax

Syntax:
waypoint setWaypointDescription text
Parameters:
waypoint: Array
text: String
Return Value:
Nothing

Examples

Example 1:
[grp, 2] setWaypointDescription "Move here."

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

Notes

Bottom Section