BIS fnc taskSetDestination: Difference between revisions

From Bohemia Interactive Community
(Updated function description)
m (pf)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________
| arma3 |Game name=


{{Function|= Comments
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| Set a task's destination. |Description=
 
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| [taskName, destination] call [[BIS_fnc_taskSetDestination]] |Syntax=
Description:
Set a task's destination.


Parameters:
|p1= taskName: [[String]] |Parameter 1=
0: STRING - task name
1: OBJECT or ARRAY or STRING - task destination
OBJECT - task will be displayed on the object if player knows about it,
otherwise it will be on estimated position or even hidden
[OBJECT,true] - task will be on exact object position,
even if player doesn't know about the object
[X,Y,Z] - position - task will be on given positon
STRING - marker name - task will be at markers current position
(position not updated if marker moves)


Returns:
|p2= destination: [[Object]], [[Array]], [[Position]] or [[String]] -  Task destination
STRING - Task ID
*[[Object]]: Task will be displayed on the object if player knows about it, otherwise it will be on estimated position or even hidden
*/
*[ [[Object]], [[true]] ]: Task will be on exact object position, even if player doesn't know about the object
*[[Position]]: Task will be on given positon
*[[String]]: Marker name. Task will be at markers current position (Won't update if marker was moved) |Parameter 2=


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [[String]] - Task ID |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_taskSetDestination]]; --> |= Syntax
|x1= ["BIS_task_01",[1337,1337,0]] [[call]] [[BIS_fnc_taskSetDestination]];|Example 1=


|p1= |= Parameter 1
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=
| [[:Category:Function Group: Tasks|Task Functions]], [[Arma 3 Tasks Overhaul]] |See also=
____________________________________________________________________________________________
 
| |= See also
 
}}
}}


Revision as of 00:25, 20 June 2018

Arma 3 logo black.png 1.00
Hover & click on the images for description

Description

Description:
Set a task's destination.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[taskName, destination] call BIS_fnc_taskSetDestination
Parameters:
taskName: String
destination: Object, Array, Position or String - Task destination
  • Object: Task will be displayed on the object if player knows about it, otherwise it will be on estimated position or even hidden
  • [ Object, true ]: Task will be on exact object position, even if player doesn't know about the object
  • Position: Task will be on given positon
  • String: Marker name. Task will be at markers current position (Won't update if marker was moved)
Return Value:
String - Task ID

Examples

Example 1:
["BIS_task_01",[1337,1337,0]] call BIS_fnc_taskSetDestination;

Additional Information

See also:
Task FunctionsArma 3 Tasks Overhaul

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskSetDestination&oldid=108534"