setWaypointDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (template:command argument fix)
(17 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|SETWAYPOINTDESCRIPTION]]
{{Command|= Comments
[[Category:Scripting Commands OFP Elite |SETWAYPOINTDESCRIPTION]]
____________________________________________________________________________________________
[[Category:Scripting Commands ArmA|SETWAYPOINTDESCRIPTION]]


| arma |= Game name


<h2 style="color:#000066">'''''waypoint'' setWaypointDescription ''text'''''</h2>
|1.00|= 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]] - format [[Waypoint]] |PARAMETER1=


'''text:''' [[String]]
|p2= text: [[String]] |PARAMETER2=


'''Type of returned value:'''
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code>[_grp, 2] [[setWaypointDescription]] "Move here.";</code> |EXAMPLE1=
____________________________________________________________________________________________


[[Nothing]]
| [[waypoints]], [[deleteWaypoint]], [[copyWaypoints]], [[setCurrentWaypoint]], [[setWaypointBehaviour]], [[setWaypointCombatMode]], [[setWaypointCompletionRadius]], [[setWaypointFormation]], [[setWaypointHousePosition]], [[setWaypointPosition]], [[setWaypointScript]], [[setWaypointSpeed]], [[setWaypointStatements]], [[setWaypointTimeout]], [[setWaypointType]], [[setWaypointVisible]], [[waypointAttachVehicle]], [[waypointAttachedVehicle]], [[setWaypointLoiterRadius]], [[waypointLoiterRadius]], [[addWaypoint]], [[setWaypointLoiterType]], [[waypointSpeed]] |SEEALSO=


'''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]]
 
[[Category:Command_Group:_Waypoints|{{uc:{{PAGENAME}}}}]]
[grp, 2] '''setWaypointDescription''' "Move here."
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 15: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