BIS fnc taskCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Removed Task Enhancements link, duplicate with Tasks Overhaul (redirection))
(Page format)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Create a task. |= Description
 
Description:
Create a task.
 
Parameters:
0: BOOL or OBJECT or GROUP or SIDE or ARRAY - Task owner(s)
1: STRING or ARRAY - Task name or array in the format [task name, parent task name]
2: ARRAY or STRING - Task description in the format ["description", "title", "marker"] or CfgTaskDescriptions class
3: OBJECT or ARRAY or STRING - Task destination
4: BOOL or NUMBER or STRING - Task state (or true to set as current)
5: NUMBER - Task priority (when automatically selecting a new current task, higher priority is selected first)
6: BOOL - Show notification (default: true)
7: STRING - Task type as defined in the CfgTaskTypes
8: BOOL - Should the task being shared (default: false), if set to true, the assigned players are being counted
 
Returns:
BOOL
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_taskCreate]]; --> |= Syntax
| [owner, nameOrParent, details, destination, state, priority, showNotification, type, shared] call [[BIS_fnc_taskCreate]] |= Syntax
 
|p1= |= Parameter 1


| |= Return value
|p1= owner: [[Boolean]], [[Object]], [[Group]], [[Side]] or [[Array]] - Task owner(s) |= Parameter 1
|p2= nameOrParent: [[String]] or [[Array]] - Task name or array in the format [task name, parent task name] |= Parameter 2
|p3= details: [[Array]] or [[String]] - Task description in the format ["description", "title", "marker"] or CfgTaskDescriptions classname as string |= Parameter 3
|p4= destination: [[Object]], [[Array]] or [[String]] (default: [[objNull]]) - Task destination (object, position or marker) |= Parameter 4
|p5= state: [[Boolean]], [[Number]] or [[String]] - Task state (or true to set as current) |= Parameter 5
|p6= priority: [[Number]] - Task priority (when automatically selecting a new current task, higher priority is selected first) |= Parameter 6
|p7= showNotification: [[Boolean]] (default: true) - Show notification |= Parameter 7
|p8= type: [[String]] - Task type as defined in the [[CfgTaskTypes]] |= Parameter 8
|p9= shared: [[Boolean]] (default: false) - Should the task being shared, if set to true, the assigned players are being counted |= Parameter 9
| [[Boolean]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 14:07, 2 February 2018


Hover & click on the images for description

Description

Description:
Create a task.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[owner, nameOrParent, details, destination, state, priority, showNotification, type, shared] call BIS_fnc_taskCreate
Parameters:
owner: Boolean, Object, Group, Side or Array - Task owner(s)
nameOrParent: String or Array - Task name or array in the format [task name, parent task name]
details: Array or String - Task description in the format ["description", "title", "marker"] or CfgTaskDescriptions classname as string
destination: Object, Array or String (default: objNull) - Task destination (object, position or marker)
state: Boolean, Number or String - Task state (or true to set as current)
priority: Number - Task priority (when automatically selecting a new current task, higher priority is selected first)
showNotification: Boolean (default: true) - Show notification
type: String - Task type as defined in the CfgTaskTypes
shared: Boolean (default: false) - Should the task being shared, if set to true, the assigned players are being counted
Return Value:
Boolean

Examples

Example 1:
[civilian,["task1"],["Do this and you get a cookie","Earn Cookie","cookiemarker"],[0,0,0],1,2,true] call BIS_fnc_taskCreate
Example 2:
[west,["task2"],["Good luck finding this cookie","Find Cookie","cookiemarker2"],objNull,1,3,true] call BIS_fnc_taskCreate //Task without a map location

Additional Information

See also:
BIS_fnc_setTaskTask FrameworkTasks Overhaul

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