setTaskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2
 
|version1= 1.00
 
|game2= arma2oa
 
|version2= 1.51
 
|game3= tkoh
 
|version3= 1.00
 
|game4= arma3
 
|version4= 0.50


|gr1= Briefing
|gr1= Briefing


|1.00
|descr= Set the state of a given task.


| Set the state of a given task.
|s1= task '''setTaskState''' state


State value may be one of:
|p1= task: [[Task]]
 
|p2= state: [[String]] - State value may be one of:
*"None"
*"None"
*"Created"
*"Created"
Line 17: Line 33:
*"Canceled"
*"Canceled"


| task '''setTaskState''' state
|r1= [[Nothing]]
 
|p1= task: [[Task]]
 
|p2= state: [[String]]
 
| [[Nothing]]


|x1= <code>_tskKillSpongebob [[setTaskState]] "Succeeded";</code>
|x1= <code>_tskKillSpongebob [[setTaskState]] "Succeeded";</code>
Line 29: Line 39:
|seealso= [[Tasks]], [[createSimpleTask]], [[removeSimpleTask]], [[setSimpleTaskDescription]], [[setSimpleTaskDestination]], [[setTaskResult]], [[taskState]]
|seealso= [[Tasks]], [[createSimpleTask]], [[removeSimpleTask]], [[setSimpleTaskDescription]], [[setSimpleTaskDestination]], [[setTaskResult]], [[taskState]]
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 00:52, 29 March 2021

Hover & click on the images for description

Description

Description:
Set the state of a given task.
Groups:
Briefing

Syntax

Syntax:
task setTaskState state
Parameters:
task: Task
state: String - State value may be one of:
  • "None"
  • "Created"
  • "Assigned"
  • "Succeeded"
  • "Failed"
  • "Canceled"
Return Value:
Nothing

Examples

Example 1:
_tskKillSpongebob setTaskState "Succeeded";

Additional Information

See also:
TaskscreateSimpleTaskremoveSimpleTasksetSimpleTaskDescriptionsetSimpleTaskDestinationsetTaskResulttaskState

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