unregisterTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name" to "|Game name=")
(see also)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Unregister a task type. |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. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


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


|p3= |PARAMETER3=  
|p3= |PARAMETER3=  


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




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


____________________________________________________________________________________________
____________________________________________________________________________________________


| [[:Category:Command Group: Briefing]] |SEEALSO=  
| [[registeredTasks]],[[registeredTasks]], [[sendTask]], [[createTask]], [[currentTasks]] |SEEALSO=  


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  
Line 44: Line 44:
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Briefing|{{uc:{{PAGENAME}}}}]]

Revision as of 20:56, 15 September 2019

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

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

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