BIS fnc taskSetDestination: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= Tasks |GROUP1=
|gr1= Tasks


|arg= global|Multiplayer Arguments=
|arg= global|Multiplayer Arguments=
Line 11: Line 11:
|eff= global|Multiplayer Effects=
|eff= global|Multiplayer Effects=


| Set a task's destination. {{Informative| See [[Arma 3: Task Framework]] for more information.}}|Description=
| Set a task's destination. {{Informative| See [[Arma 3: Task Framework]] for more information.}}


| [taskName, destination] call [[BIS_fnc_taskSetDestination]] |Syntax=
| [taskName, destination] call [[BIS_fnc_taskSetDestination]]


|p1= taskName: [[String]] |Parameter 1=
|p1= taskName: [[String]]


|p2= destination: [[Object]], [[Array]], [[Position]] or [[String]] -  Task destination
|p2= destination: [[Object]], [[Array]], [[Position]] or [[String]] -  Task destination
Line 21: Line 21:
*[ [[Object]], [[true]] ]: Task will be on exact object position, even if player doesn't know about the object
*[ [[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
*[[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=
*[[String]]: Marker name. Task will be at markers current position (Won't update if marker was moved)


| [[String]] - Task ID |Return value=
| [[String]] - Task ID


|x1= <code>["BIS_task_01",[1337,1337,0]] [[call]] [[BIS_fnc_taskSetDestination]];</code>|Example 1=
|x1= <code>["BIS_task_01",[1337,1337,0]] [[call]] [[BIS_fnc_taskSetDestination]];</code>




| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]] |See also=
| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]
}}
}}



Revision as of 00:44, 18 January 2021

Hover & click on the images for description

Description

Description:
Set a task's destination.
See Arma 3: Task Framework for more information.
Execution:
call
Groups:
Tasks

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 Functions Arma 3: Task Framework

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

Bottom Section