BIS fnc taskCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed link to CfgTaskTypes)
m (Fix parameter 9 description and See also)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 14: Line 13:


|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 [[Description.ext#CfgTaskDescriptions|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
|p6= priority: [[Number]] - Task priority (when automatically selecting a new current task, higher priority is selected first) |= Parameter 6
|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
|p7= showNotification: [[Boolean]] (default: true) - Show notification |= Parameter 7
|p8= type: [[String]] - Task type as defined in the [[Description.ext#CfgTaskTypes| CfgTaskTypes]] |= Parameter 8
|p8= type: [[String]] - Task type as defined in the [[Description.ext#CfgTaskTypes| 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
 
|p9= shared: [[Boolean]] - (Optional, default [[false]]) always visible in 3D |= Parameter 9
 
| [[Boolean]] |= Return value
| [[Boolean]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 30: Line 38:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS fnc deleteTask]],[[BIS fnc setTask]],[[BIS fnc setTaskLocal]],[[BIS fnc sharedObjectives]],[[BIS fnc taskAlwaysVisible]],[[BIS fnc taskChildren]],[[BIS fnc taskCompleted]],[[BIS fnc taskCurrent]],[[BIS fnc taskDescription]],[[BIS fnc taskDestination]],[[BIS fnc taskExists]],[[BIS fnc taskHint]],[[BIS fnc taskParent]],[[BIS fnc taskReal]],[[BIS fnc taskSetAlwaysVisible]],[[BIS fnc taskSetCurrent]],[[BIS fnc taskSetDescription]],[[BIS fnc taskSetDestination]],[[BIS fnc taskSetState]],[[BIS fnc taskSetType]],[[BIS fnc taskState]],[[BIS fnc tasksUnit]],[[BIS fnc taskType]],[[BIS fnc taskTypeIcon]],[[BIS fnc taskVar]],[[Arma 3 Task Framework]],[[Arma 3 Tasks Overhaul]] |= See also
| [[BIS_fnc_deleteTask]],[[BIS_fnc_setTask]],[[BIS_fnc_setTaskLocal]],[[BIS_fnc_sharedObjectives]],[[BIS_fnc_taskAlwaysVisible]],[[BIS_fnc_taskChildren]],[[BIS_fnc_taskCompleted]],[[BIS_fnc_taskCurrent]],[[BIS_fnc_taskDescription]],[[BIS_fnc_taskDestination]],[[BIS_fnc_taskExists]],[[BIS_fnc_taskHint]],[[BIS_fnc_taskParent]],[[BIS_fnc_taskReal]],[[BIS_fnc_taskSetAlwaysVisible]],[[BIS_fnc_taskSetCurrent]],[[BIS_fnc_taskSetDescription]],[[BIS_fnc_taskSetDestination]],[[BIS_fnc_taskSetState]],[[BIS_fnc_taskSetType]],[[BIS_fnc_taskState]],[[BIS_fnc_tasksUnit]],[[BIS_fnc_taskType]],[[BIS_fnc_taskTypeIcon]],[[BIS_fnc_taskVar]],[[Arma 3 Task Framework]],[[Arma 3 Tasks Overhaul]] |= See also
}}
}}


Line 51: Line 59:
<dd class="note">
<dd class="note">
You can define a [[Description.ext#CfgTaskDescriptions|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
<syntaxhighlight lang="cpp">class CfgTaskDescriptions
{
{
  class myTask
class myTask
  {
{
      title = $STR_MyTaskTitle;
title = $STR_MyTaskTitle;
      description = $STR_MyTaskDescription;
description = $STR_MyTaskDescription;
  };
};
};</nowiki></code>
};</syntaxhighlight>
This should allow tasks to be localised for every player in MP.
This should allow tasks to be localised for every player in MP '''if created locally'''.
You can use "myTask" as '''details''' parameter.
You can use "myTask" as ''details'' parameter.
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 11:56, 14 May 2018

Arma 3 logo black.png1.00
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 - (Optional, default false) always visible in 3D
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_deleteTaskBIS_fnc_setTaskBIS_fnc_setTaskLocalBIS_fnc_sharedObjectivesBIS_fnc_taskAlwaysVisibleBIS_fnc_taskChildrenBIS_fnc_taskCompletedBIS_fnc_taskCurrentBIS_fnc_taskDescriptionBIS_fnc_taskDestinationBIS_fnc_taskExistsBIS_fnc_taskHintBIS_fnc_taskParentBIS_fnc_taskRealBIS_fnc_taskSetAlwaysVisibleBIS_fnc_taskSetCurrentBIS_fnc_taskSetDescriptionBIS_fnc_taskSetDestinationBIS_fnc_taskSetStateBIS_fnc_taskSetTypeBIS_fnc_taskStateBIS_fnc_tasksUnitBIS_fnc_taskTypeBIS_fnc_taskTypeIconBIS_fnc_taskVarArma 3 Task FrameworkArma 3 Tasks 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 if created locally. You can use "myTask" as details parameter.

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskCreate&oldid=107397"