taskState: 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> <h3 style='display:none'>Bottom Section</h3>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|gr1= Briefing |GROUP1=
|gr1= Briefing






|1.00|Game version=
|1.00


| Returns the current state of a task.  
| Returns the current state of a task.  
Line 18: Line 18:
* Failed
* Failed
* Canceled
* Canceled
|DESCRIPTION=


| '''taskState'''  task |SYNTAX=


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


| [[String]] - current state of task|RETURNVALUE=
|p1= task: [[Task]] - the task you want to query
 
| [[String]] - current state of task




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




| [[Tasks]], [[createSimpleTask]], [[removeSimpleTask]], [[setSimpleTaskDescription]], [[setSimpleTaskDestination]], [[setTaskResult]], [[setTaskState]] |SEEALSO=
| [[Tasks]], [[createSimpleTask]], [[removeSimpleTask]], [[setSimpleTaskDescription]], [[setSimpleTaskDestination]], [[setTaskResult]], [[setTaskState]]


| |MPBEHAVIOUR=
|
}}
}}



Revision as of 12:26, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns the current state of a task. Possible return values are:
  • None
  • Created
  • Assigned
  • Succeeded
  • Failed
  • Canceled
Groups:
Briefing

Syntax

Syntax:
taskState task
Parameters:
task: Task - the task you want to query
Return Value:
String - current state of task

Examples

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

Additional Information

See also:
TaskscreateSimpleTaskremoveSimpleTasksetSimpleTaskDescriptionsetSimpleTaskDestinationsetTaskResultsetTaskState

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