taskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. classification)
m (Some wiki formatting)
 
(46 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


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


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Returns the current state of a task.  
|game3= tkoh
|version3= 1.00


'''Possible return values are:'''
|game4= arma3
* None
|version4= 0.50
* Created
* Assigned
* Succeeded
* Failed
* Canceled
|= Description
____________________________________________________________________________________________


| [[String]] <nowiki>=</nowiki> '''taskState'''  [[Task]] |= Syntax
|gr1= Briefing


|p1= [[Task]] - the task you want to query|= PARAMETER1
|descr= Returns the current state of a task.


| [[String]] - current state of task|= RETURNVALUE
|s1= [[taskState]] task


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


|x1= <code>currentTask <nowiki>=</nowiki> player createSimpleTask "NewTask";
|r1= [[String]] - current state of task - can be one of:
TaskStateString <nowiki>=</nowiki> taskState currentTask;
* "None"
hint format["Taskstate: %1",TaskStateString];</code>|= EXAMPLE1
* "Created"
* "Assigned"
* "Succeeded"
* "Failed"
* "Canceled"


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


| [[createSimpleTask]] |= SEEALSO
|seealso= [[Tasks]] [[createSimpleTask]] [[removeSimpleTask]] [[setSimpleTaskDescription]] [[setSimpleTaskDestination]] [[setTaskResult]] [[setTaskState]]
 
|  |= 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>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{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"