taskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)?\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
m (Some wiki formatting)
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|gr1= Briefing |GROUP1=
|game2= arma2oa
|version2= 1.50


|game3= tkoh
|version3= 1.00


|game4= arma3
|version4= 0.50


|1.00|Game version=
|gr1= Briefing
____________________________________________________________________________________________


| 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
|DESCRIPTION=
____________________________________________________________________________________________


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


|p1= task: [[Task]] - the task you want to query|PARAMETER1=
|r1= [[String]] - current state of task - can be one of:
* "None"
* "Created"
* "Assigned"
* "Succeeded"
* "Failed"
* "Canceled"


| [[String]] - current state of task|RETURNVALUE=
|x1= <sqf>
tskSomeTask = player createSimpleTask ["NewTask"];
hint format["Taskstate: %1", taskState tskSomeTask];
</sqf>


 
|seealso= [[Tasks]] [[createSimpleTask]] [[removeSimpleTask]] [[setSimpleTaskDescription]] [[setSimpleTaskDestination]] [[setTaskResult]] [[setTaskState]]
|x1= <code>tskSomeTask <nowiki>=</nowiki> player createSimpleTask ["NewTask"];
hint format["Taskstate: %1", taskState tskSomeTask];</code>|EXAMPLE1=
 
____________________________________________________________________________________________
 
| [[Tasks]], [[createSimpleTask]], [[removeSimpleTask]], [[setSimpleTaskDescription]], [[setSimpleTaskDestination]], [[setTaskResult]], [[setTaskState]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Briefing|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:30, 13 May 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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
Retrieved from "https://community.bistudio.com/wiki?title=taskState&oldid=320998"