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


|1.00|Game version=
|1.00


|gr1= Briefing |GROUP1=
|gr1= Briefing


| Unregisters a task type from given agent. The task type is the name given in <tt>CfgTasks</tt> classes in <tt>name</tt> property. Also available from [[registeredTasks]] array. |DESCRIPTION=
| Unregisters a task type from given agent. The task type is the name given in <tt>CfgTasks</tt> classes in <tt>name</tt> property. Also available from [[registeredTasks]] array.


| teamMember '''unregisterTask''' name |SYNTAX=
| teamMember '''unregisterTask''' name


|p1= teamMember: [[Team Member]] - [[teamMember]] [[agent]] |PARAMETER1=
|p1= teamMember: [[Team Member]] - [[teamMember]] [[agent]]


|p2= name: [[String]] - name of the task |PARAMETER2=
|p2= name: [[String]] - name of the task


|p3= |PARAMETER3=  
|p3=


| [[Boolean]] - [[true]] on success |RETURNVALUE=
| [[Boolean]] - [[true]] on success




|x1= <code>[[teamMember]] _agent [[unregisterTask]] ([[registeredTasks]] [[select]] 0);</code>|EXAMPLE1=
|x1= <code>[[teamMember]] _agent [[unregisterTask]] ([[registeredTasks]] [[select]] 0);</code>




| [[registerTask]],[[registeredTasks]], [[sendTask]], [[createTask]], [[currentTasks]], [[taskCompleted]] |SEEALSO=
| [[registerTask]],[[registeredTasks]], [[sendTask]], [[createTask]], [[currentTasks]], [[taskCompleted]]


| |MPBEHAVIOUR=
|
}}
}}



Revision as of 11:43, 18 January 2021

Hover & click on the images for description

Description

Description:
Unregisters a task type from given agent. The task type is the name given in CfgTasks classes in name property. Also available from registeredTasks array.
Groups:
Briefing

Syntax

Syntax:
teamMember unregisterTask name
Parameters:
teamMember: Team Member - teamMember agent
name: String - name of the task
Return Value:
Boolean - true on success

Examples

Example 1:
teamMember _agent unregisterTask (registeredTasks select 0);

Additional Information

See also:
registerTaskregisteredTaskssendTaskcreateTaskcurrentTaskstaskCompleted

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