BIS fnc taskSetDestination: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
m (Text replacement - "|arg= global|eff= global" to "|arg= global |eff= global")
 
(4 intermediate revisions by the same user not shown)
Line 6: Line 6:
|gr1= Tasks
|gr1= Tasks


|arg= global|eff= global
|arg= global
|eff= global


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


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


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


|p2= destination: [[Object]], [[Array]], [[Position]] or [[String]] - Task destination
|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
* [[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
* [[Array]] format [object, forceRealPosition]:
*[[Position]]: Task will be on given positon
** object: [[Object]] - same as above
*[[String]]: Marker name. Task will be at markers current position (Won't update if marker was moved)
** 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)


|r1= [[String]] - Task ID
|r1= [[String]] - task ID


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


|seealso=  [[Arma 3: Task Framework]]
|seealso=  [[Arma 3: Task Framework]]
}}
}}

Latest revision as of 01:28, 11 September 2023

Arma 3 logo black.png1.00
GAGlobalGEGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskSetDestination&oldid=347338"