setWaypointDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(80 intermediate revisions by 11 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|R]]
{{RV|type=command
[[Category:Scripting Commands ArmA|R]]


<new command not populated>
|game1= ofpe
|version1= 1.00


|game2= arma1
|version2= 1.00


<h2 style="color:#000066">''''' setWaypointDescription '''''</h2>
|game3= arma2
|version3= 1.00


|game4= arma2oa
|version4= 1.50


'''Operand types:'''
|game5= tkoh
|version5= 1.00


'''Type of returned value:'''
|game6= arma3
|version6= 0.50


'''Compatibility:'''
|gr1= Waypoints


'''Description:'''
|descr= Sets the description shown in the HUD while the waypoint is active.


|s1= waypoint [[setWaypointDescription]] text


'''Example:'''
|p1= waypoint: [[Array]] - format [[Waypoint]]
 
|p2= text: [[String]]
 
|r1= [[Nothing]]
 
|x1= <sqf>[_grp, 2] setWaypointDescription "Move here.";</sqf>
 
|seealso= [[waypoints]] [[deleteWaypoint]] [[copyWaypoints]] [[setCurrentWaypoint]] [[setWaypointBehaviour]] [[setWaypointCombatMode]] [[setWaypointCompletionRadius]] [[setWaypointFormation]] [[setWaypointHousePosition]] [[setWaypointPosition]] [[setWaypointScript]] [[setWaypointSpeed]] [[setWaypointStatements]] [[setWaypointTimeout]] [[setWaypointType]] [[setWaypointVisible]] [[waypointAttachVehicle]] [[waypointAttachedVehicle]] [[setWaypointLoiterRadius]] [[waypointLoiterRadius]] [[addWaypoint]] [[setWaypointLoiterType]] [[waypointSpeed]]
}}

Latest revision as of 11:24, 13 May 2022

Hover & click on the images for description

Description

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

Syntax

Syntax:
waypoint setWaypointDescription text
Parameters:
waypoint: Array - format Waypoint
text: String
Return Value:
Nothing

Examples

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

Additional Information

See also:
waypoints deleteWaypoint copyWaypoints setCurrentWaypoint setWaypointBehaviour setWaypointCombatMode setWaypointCompletionRadius setWaypointFormation setWaypointHousePosition setWaypointPosition setWaypointScript setWaypointSpeed setWaypointStatements setWaypointTimeout setWaypointType setWaypointVisible waypointAttachVehicle waypointAttachedVehicle setWaypointLoiterRadius waypointLoiterRadius addWaypoint setWaypointLoiterType waypointSpeed

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