setTaskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|gr1= Briefing |GROUP1=
|gr1= Briefing






|1.00|Game version=
|1.00


| Set the state of a given task.
| Set the state of a given task.
Line 18: Line 18:
*"Failed"
*"Failed"
*"Canceled"
*"Canceled"
|DESCRIPTION=


| task '''setTaskState''' state |SYNTAX=


|p1= task: [[Task]] |PARAMETER1=
| task '''setTaskState''' state


|p2= state: [[String]] |PARAMETER2=
|p1= task: [[Task]]


|p3= |PARAMETER3=  
|p2= state: [[String]]


| [[Nothing]]|RETURNVALUE=  
|p3=


| [[Nothing]]


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


|x1= <code>_tskKillSpongebob [[setTaskState]] "Succeeded";</code>


| [[Tasks]], [[createSimpleTask]], [[removeSimpleTask]], [[setSimpleTaskDescription]], [[setSimpleTaskDestination]], [[setTaskResult]], [[taskState]] |SEEALSO=


| |MPBEHAVIOUR=
| [[Tasks]], [[createSimpleTask]], [[removeSimpleTask]], [[setSimpleTaskDescription]], [[setSimpleTaskDestination]], [[setTaskResult]], [[taskState]]
 
|
}}
}}



Revision as of 12:08, 18 January 2021

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:
Briefing

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