BIS fnc taskSetDestination: Difference between revisions

Latest revision as of 02: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: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Tasks
-|1.00|= Game version
+|arg= global
-____________________________________________________________________________________________
+|eff= global
-| <pre>/*
+|descr= Set a task's destination. {{Feature|informative|See [[Arma 3: Task Framework]] for more information.}}
-	Description:
-	Set a task's destination.
-	Parameters:
+|s1= [taskName, destination] call [[BIS_fnc_taskSetDestination]]
-: STRING - task name
-: 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:
+|p1= taskName: [[String]]
-	STRING - Task ID
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|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)
-| <!-- [] call [[BIS_fnc_taskSetDestination]]; --> |= Syntax
+|r1= [[String]] - task ID
-|p1= |= Parameter 1
+|x1= <sqf>["BIS_task_01", [1337, 1337, 0]] call BIS_fnc_taskSetDestination;</sqf>
-| |= Return value
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso=  [[Arma 3: Task Framework]]
 }}
-<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}}]]