setWaypointDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (duplicated)
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| waypoint '''setWaypointDescription''' text |= Syntax
| waypoint '''setWaypointDescription''' text |SYNTAX=


|p1= waypoint: [[Array]] - format [[Waypoint]] |= Parameter 1
|p1= waypoint: [[Array]] - format [[Waypoint]] |PARAMETER1=


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


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[_grp, 2] [[setWaypointDescription]] "Move here.";</code> |= Example 1
|x1= <code>[_grp, 2] [[setWaypointDescription]] "Move here.";</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[waypoints]], [[deleteWaypoint]], [[copyWaypoints]], [[setCurrentWaypoint]], [[setWaypointBehaviour]], [[setWaypointCombatMode]], [[setWaypointCompletionRadius]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointStatements]], [[setWaypointTimeout]], [[setWaypointType]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[addWaypoint]], [[setWaypointLoiterType]], [[waypointSpeed]] |= 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]] |SEEALSO=


}}
}}

Revision as of 14:48, 7 April 2019

-wrong parameter ("Arma") defined!-1.00
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 - format Waypoint
text: String
Return Value:
Nothing

Examples

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

Additional Information

See also:
waypointsdeleteWaypointcopyWaypointssetCurrentWaypointsetWaypointBehavioursetWaypointCombatModesetWaypointCompletionRadiussetWaypointFormationsetWaypointHousePositionsetWaypointPositionsetWaypointScriptsetWaypointSpeedsetWaypointStatementssetWaypointTimeoutsetWaypointTypesetWaypointVisiblewaypointAttachVehiclewaypointAttachedVehiclesetWaypointLoiterRadiuswaypointLoiterRadiusaddWaypointsetWaypointLoiterTypewaypointSpeed

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