setTaskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. ArmA2 classification)
 
m (template:command argument fix)
(18 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Command|= Comments
____________________________________________________________________________________________


| arma2 |= Game name
|1.00|= Game version
____________________________________________________________________________________________
| Set the state of a given task.
State value may be one of:
*"None"
*"Created"
*"Assigned"
*"Succeeded"
*"Failed"
*"Canceled"
|DESCRIPTION=
____________________________________________________________________________________________
| task '''setTaskState''' state |SYNTAX=
|p1= task: [[Task]] |PARAMETER1=
|p2= state: [[String]] |PARAMETER2=
|p3= |PARAMETER3=
| [[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:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{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}}}}]]

Revision as of 15:48, 7 April 2019

Hover & click on the images for description

Description

Description:
Set the state of a given task. State value may be one of:
  • "None"
  • "Created"
  • "Assigned"
  • "Succeeded"
  • "Failed"
  • "Canceled"
Groups:
Uncategorised

Syntax

Syntax:
task setTaskState state
Parameters:
task: Task
state: String
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

Notes

Bottom Section