setTaskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *S([a-z ])" to "$1 - s$2")
 
(24 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
____________________________________________________________________________________________


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


State value may be one of:
|s1= task [[setTaskState]] state
 
|p1= task: [[Task]]
 
|p2= state: [[String]] - state value may be one of:
*"None"
*"None"
*"Created"
*"Created"
Line 20: Line 28:
*"Failed"
*"Failed"
*"Canceled"
*"Canceled"
|DESCRIPTION=
____________________________________________________________________________________________
| task '''setTaskState''' state |SYNTAX=


|p1= task: [[Task]] |PARAMETER1=
|r1= [[Nothing]]


|p2= state: [[String]] |PARAMETER2=  
|x1= <sqf>_tskKillSpongebob setTaskState "Succeeded";</sqf>


|p3= |PARAMETER3=
|seealso= [[Tasks]] [[createSimpleTask]] [[removeSimpleTask]] [[setSimpleTaskDescription]] [[setSimpleTaskDestination]] [[setTaskResult]] [[taskState]]
 
| [[Nothing]]|RETURNVALUE=
 
 
|x1= <code>_tskKillSpongebob [[setTaskState]] "Succeeded";</code>|EXAMPLE1=
 
____________________________________________________________________________________________
 
| [[Tasks]], [[createSimpleTask]], [[removeSimpleTask]], [[setSimpleTaskDescription]], [[setSimpleTaskDestination]], [[setTaskResult]], [[taskState]] |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>
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
{{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 15:49, 8 November 2023

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:
Tasks createSimpleTask removeSimpleTask setSimpleTaskDescription setSimpleTaskDestination setTaskResult taskState

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