BIS fnc taskCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Update CfgTaskDescriptions links)
Line 15: Line 15:
|p1= owner: [[Boolean]], [[Object]], [[Group]], [[Side]] or [[Array]] - Task owner(s) |= Parameter 1
|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
|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
|p3= details: [[Array]] or [[String]] - Task description in the format ["description", "title", "marker"] or [[Description.ext#CfgTaskDescriptions|CfgTaskDescriptions]] classname as string |= Parameter 3
|p4= destination: [[Object]], [[Array]] or [[String]] (default: [[objNull]]) - Task destination (object, position or marker) |= Parameter 4
|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
|p5= state: [[Boolean]], [[Number]] or [[String]] - Task state (or true to set as current) |= Parameter 5
Line 50: Line 50:
<dt class="note">[[User:Lou Montana|Lou Montana]]</dt>
<dt class="note">[[User:Lou Montana|Lou Montana]]</dt>
<dd class="note">
<dd class="note">
You can define a [[CfgTaskDescriptions]] part in [[description.ext]], such as:
You can define a [[Description.ext#CfgTaskDescriptions|CfgTaskDescriptions]] part in [[description.ext]], such as:
<code><nowiki>class CfgTaskDescriptions
<code><nowiki>class CfgTaskDescriptions
{
{

Revision as of 14:58, 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

Posted on February 2, 2018 - 13:15 (UTC)
Lou Montana
You can define a CfgTaskDescriptions part in description.ext, such as: class CfgTaskDescriptions { class myTask { title = $STR_MyTaskTitle; description = $STR_MyTaskDescription; }; }; This should allow tasks to be localised for every player in MP. You can use "myTask" as details parameter.