setTaskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added return)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *S([a-z ])" to "$1 - s$2")
 
(36 intermediate revisions by 4 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


| Set the state of a given task.
|game3= tkoh
|version3= 1.00


State value may be one of:
|game4= arma3
*"Succeeded"
|version4= 0.50
*"Failed"
*"Canceled"
*"Created"
*"Assigned"
|= Description
____________________________________________________________________________________________


| task '''setTaskState''' state |= Syntax
|gr1= Briefing


|p1= task: [[Task]] |= PARAMETER1
|descr= Set the state of a given task.


|p2= state: [[String]] |= PARAMETER2
|s1= task [[setTaskState]] state


|p3= |= PARAMETER3
|p1= task: [[Task]]
 
| [[Nothing]]|= RETURNVALUE


|p2= state: [[String]] - state value may be one of:
*"None"
*"Created"
*"Assigned"
*"Succeeded"
*"Failed"
*"Canceled"


|x1= <code>_tskKillSpongebob setTaskState "Succeeded"</code>|= EXAMPLE1
|r1= [[Nothing]]


____________________________________________________________________________________________
|x1= <sqf>_tskKillSpongebob setTaskState "Succeeded";</sqf>


| [[Tasks]], [[createSimpleTask]], [[removeSimpleTask]], [[setSimpleTaskDescription]], [[setSimpleTaskDestination]], [[setTaskResult]], [[taskState]] |= SEEALSO
|seealso= [[Tasks]] [[createSimpleTask]] [[removeSimpleTask]] [[setSimpleTaskDescription]] [[setSimpleTaskDestination]] [[setTaskResult]] [[taskState]]
 
|  |= 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 Arma 3|{{uc:{{PAGENAME}}}}]]
[[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