BIS fnc taskCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix parameter 9 description and See also)
m (Fix parameter 9 name)
Line 10: Line 10:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [owner, nameOrParent, details, destination, state, priority, showNotification, type, shared] call [[BIS_fnc_taskCreate]] |= Syntax
| [owner, nameOrParent, details, destination, state, priority, showNotification, type, visibleIn3D] call [[BIS_fnc_taskCreate]] |= Syntax


|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
Line 28: Line 28:
|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]] - (Optional, default [[false]]) always visible in 3D |= Parameter 9
|p9= visibleIn3D: [[Boolean]] - (Optional, default [[false]]) always visible in 3D |= Parameter 9


| [[Boolean]] |= Return value
| [[Boolean]] |= Return value

Revision as of 12:10, 14 May 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, visibleIn3D] 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
visibleIn3D: 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.