BIS fnc taskSetDestination: Difference between revisions

Latest revision as of 01:28, 11 September 2023

1.00

GAGlobal GEGlobal

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
Array format [object, forceRealPosition]:
- object: Object - same as above
- forceRealPosition: Boolean - whether or not the task will be on exact object position even if the player does not 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:: 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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.00
-|1.00|Game version=
+|gr1= Tasks
-|gr1= Tasks |GROUP1=
+|arg= global
+|eff= global
-|arg= global|Multiplayer Arguments=
+|descr= Set a task's destination. {{Feature|informative|See [[Arma 3: Task Framework]] for more information.}}
-|eff= global|Multiplayer Effects=
+|s1= [taskName, destination] call [[BIS_fnc_taskSetDestination]]
-____________________________________________________________________________________________
-| Set a task's destination. {{Informative| See [[Arma 3 Task Framework]] for more information.}}|Description=
+|p1= taskName: [[String]]
-____________________________________________________________________________________________
-| [taskName, destination] call [[BIS_fnc_taskSetDestination]] |Syntax=
+|p2= 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
+* [[Array]] format [object, forceRealPosition]:
+** object: [[Object]] - same as above
+** forceRealPosition: [[Boolean]] - whether or not the task will be on exact object position even if the player does not 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)
-|p1= taskName: [[String]] |Parameter 1=
+|r1= [[String]] - task ID
-|p2= destination: [[Object]], [[Array]], [[Position]] or [[String]] -  Task destination
+|x1= <sqf>["BIS_task_01", [1337, 1337, 0]] call BIS_fnc_taskSetDestination;</sqf>
-*[[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=
-| [[String]] - Task ID |Return value=
+|seealso=  [[Arma 3: Task Framework]]
-____________________________________________________________________________________________
-|x1= <code>["BIS_task_01",[1337,1337,0]] [[call]] [[BIS_fnc_taskSetDestination]];</code>|Example 1=
-____________________________________________________________________________________________
-| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3 Task Framework]]  |See also=
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Tasks|{{uc:taskSetDestination}}]]
-[[Category:Functions|{{uc:taskSetDestination}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:taskSetDestination}}]]