taskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Some wiki formatting)
 
Line 17: Line 17:
|descr= Returns the current state of a task.  
|descr= Returns the current state of a task.  


'''Possible return values are:'''
|s1= [[taskState]] task
* None
* Created
* Assigned
* Succeeded
* Failed
* Canceled
 
|s1= [[taskState]] task


|p1= task: [[Task]] - the task you want to query
|p1= task: [[Task]] - the task you want to query


|r1= [[String]] - current state of task
|r1= [[String]] - current state of task - can be one of:
* "None"
* "Created"
* "Assigned"
* "Succeeded"
* "Failed"
* "Canceled"


|x1= <code>tskSomeTask <nowiki>=</nowiki> player createSimpleTask ["NewTask"];
|x1= <sqf>
hint format["Taskstate: %1", taskState tskSomeTask];</code>
tskSomeTask = player createSimpleTask ["NewTask"];
hint format["Taskstate: %1", taskState tskSomeTask];
</sqf>


|seealso= [[Tasks]] [[createSimpleTask]] [[removeSimpleTask]] [[setSimpleTaskDescription]] [[setSimpleTaskDestination]] [[setTaskResult]] [[setTaskState]]
|seealso= [[Tasks]] [[createSimpleTask]] [[removeSimpleTask]] [[setSimpleTaskDescription]] [[setSimpleTaskDestination]] [[setTaskResult]] [[setTaskState]]
}}
}}

Latest revision as of 11:30, 13 May 2022

Hover & click on the images for description

Description

Description:
Returns the current state of a task.
Groups:
Briefing

Syntax

Syntax:
taskState task
Parameters:
task: Task - the task you want to query
Return Value:
String - current state of task - can be one of:
  • "None"
  • "Created"
  • "Assigned"
  • "Succeeded"
  • "Failed"
  • "Canceled"

Examples

Example 1:
tskSomeTask = player createSimpleTask ["NewTask"]; hint format["Taskstate: %1", taskState tskSomeTask];

Additional Information

See also:
Tasks createSimpleTask removeSimpleTask setSimpleTaskDescription setSimpleTaskDestination setTaskResult setTaskState

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