Arma 3: Task Framework Tutorial - Revision history

Lou Montana: Some wiki formatting

2023-09-11T08:03:31Z

Some wiki formatting

← Older revision		Revision as of 10:03, 11 September 2023
Line 42:		Line 42:

	<sqf>		<sqf>
			// hardcoded language
	_description = _description + "<br/><br/>UPDATE: an officer stole the documents; we got the GPS tracking, follow your HUD.";		_description = _description + "<br/><br/>UPDATE: an officer stole the documents; we got the GPS tracking, follow your HUD.";
	["taskID", [_description, _title, _waypoint]] call BIS_fnc_taskSetDescription;		["taskID", [_description, _title, _waypoint]] call BIS_fnc_taskSetDescription;

			// new description
			["taskID", ["STR_TaskDescription2", _title, _waypoint]] call BIS_fnc_taskSetDescription;
	</sqf>		</sqf>

Line 70:		Line 74:
	{{Feature\|informative\|"Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".}}		{{Feature\|informative\|"Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".}}

	==== ~~Check if~~ Multiple Tasks ~~Are All Completed~~ ====		==== Multiple Tasks Check ====
			<sqf>["taskID_0", "taskID_1", "taskID_2"] findIf { !(_x call BIS_fnc_taskCompleted) } == -1;</sqf>
	<sqf>["taskID_0", "taskID_1", "taskID_2"] findIf {!(_x call BIS_fnc_taskCompleted)} == -1</sqf>

	=== Get a Task's Status ===		=== Get a Task's Status ===

Lou Montana: Some wiki formatting

2023-03-13T20:43:58Z

Some wiki formatting

← Older revision		Revision as of 22:43, 13 March 2023
Line 21:		Line 21:
	</sqf>		</sqf>

	{{Feature \| ~~Informative~~ \| The '''"taskID"''' argument is the task's ID used for later references.<!--		{{Feature\|informative\|The '''"taskID"''' argument is the task's ID used for later references.<!--
	--> This string gets defined here on creation and must be unique for each task.<!--		--> This string gets defined here on creation and must be unique for each task.<!--
	--> It should be kept short for network economy.}}		--> It should be kept short for network economy.}}
Line 61:		Line 61:
	== How to Read a Task's Information ==		== How to Read a Task's Information ==

	=== Find if a ~~task~~ Exists ===		=== Find if a Task Exists ===

	<sqf>["taskID"] call BIS_fnc_taskExists;</sqf>		<sqf>["taskID"] call BIS_fnc_taskExists;</sqf>
Line 68:		Line 68:

	<sqf>"taskID" call BIS_fnc_taskCompleted;</sqf>		<sqf>"taskID" call BIS_fnc_taskCompleted;</sqf>
	{{Feature \| ~~Informative~~ \| "Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".}}		{{Feature\|informative\|"Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".}}

	==== Check if Multiple Tasks Are All Completed ====		==== Check if Multiple Tasks Are All Completed ====
Line 96:		Line 96:
	=== Get a Unit's Tasks ===		=== Get a Unit's Tasks ===

	<sqf>player call BIS_fnc_tasksUnit;</sqf>		<sqf>private _taskIDs = player call BIS_fnc_tasksUnit;</sqf>


	== Advanced ==		== Advanced ==

	{{Feature \| ~~Informative~~ \| All these details can be found in the [[Description.ext#Tasks\|Description.ext's Tasks chapter]].}}		{{Feature\|informative\|All these details can be found in the [[Description.ext#Tasks\|Description.ext's Tasks chapter]].}}

	=== Define a Task in Mission Config ===		=== Define a Task in Mission Config ===

Lou Montana: Some wiki formatting

2023-03-13T20:42:26Z

Some wiki formatting

Show changes

Lou Montana: Some wiki formatting

2022-07-22T15:28:52Z

Some wiki formatting

← Older revision		Revision as of 17:28, 22 July 2022
Line 13:		Line 13:
	=== Create a task ===		=== Create a task ===

	[[private]] _title = "Get the documents";		<sqf>
	[[private]] _description = "Enter the house to find the documents. Hurry, as the enemy is on its way.";		private _title = "Get the documents";
	[[private]] _waypoint = "House";		private _description = "Enter the house to find the documents. Hurry, as the enemy is on its way.";
			private _waypoint = "House";
	~~[[private]] _myTask = [groupOfPlayers, <span style="color: purple; font-weight: bold">"taskID"</span>, [_description, _title, _waypoint], objDocuments, [[true]]] [[call]] [[BIS_fnc_taskCreate]]~~;

	{{Feature \| Informative \| The ~~<span style{{=}}"color: purple; font-weight: bold">~~"taskID"~~</span>~~ argument is the task's ID used for later references.<!--		private _myTask = [groupOfPlayers, "taskID", [_description, _title, _waypoint], objDocuments, true] call BIS_fnc_taskCreate;
			</sqf>

			{{Feature \| Informative \| The '''"taskID"''' argument is the task's ID used for later references.<!--
	--> This string gets defined here on creation and must be unique for each task.<!--		--> This string gets defined here on creation and must be unique for each task.<!--
	--> It should be kept short for network economy.}}		--> It should be kept short for network economy.}}
Line 25:		Line 27:
	=== Assign a task ===		=== Assign a task ===

	<~~span style="color: purple; font-weight: bold"~~>"taskID"</~~span~~> ~~[[call]] [[BIS_fnc_taskSetCurrent]];~~		<sqf>"taskID" call BIS_fnc_taskSetCurrent;</sqf>
	{{Feature \| Informative \| This step is optional here as we used [[true]] as the fifth argument of the [[BIS_fnc_taskCreate]] call, making it the current task.}}		{{Feature \| Informative \| This step is optional here as we used [[true]] as the fifth argument of the [[BIS_fnc_taskCreate]] call, making it the current task.}}

	=== Set a task's type ===		=== Set a task's type ===

	[<~~span style="color: purple; font-weight: bold"~~>"taskID"~~</span>~~, "attack"] [[call~~]] [[~~BIS_fnc_taskSetType]];		<sqf>["taskID", "attack"] call BIS_fnc_taskSetType;</sqf>

	{{Feature \| Informative \| This could have been set in the task creation call as the eighth argument. See [[BIS_fnc_taskCreate]]'s ''type'' parameter.}}		{{Feature \| Informative \| This could have been set in the task creation call as the eighth argument. See [[BIS_fnc_taskCreate]]'s ''type'' parameter.}}

	=== Set a task's visibility ===		=== Set a task's visibility ===

	[<~~span style="color: purple; font-weight: bold"~~>"taskID"~~</span>~~, [[true]~~]] [[~~call~~]] [[~~BIS_fnc_taskSetAlwaysVisible]];		<sqf>["taskID", true] call BIS_fnc_taskSetAlwaysVisible;</sqf>

	=== Update a task's description ===		=== Update a task's description ===

	_description = _description + "~~<nowiki>~~<br/><br/~~></nowiki~~>UPDATE: an officer stole the documents; we got the GPS tracking, follow your HUD.";		<sqf>
	[~~<span style="color: purple; font-weight: bold">~~"taskID"~~</span>~~, [_description, _title, _waypoint]] [[call~~]] [[~~BIS_fnc_taskSetDescription]];		_description = _description + "<br/><br/>UPDATE: an officer stole the documents; we got the GPS tracking, follow your HUD.";
			["taskID", [_description, _title, _waypoint]] call BIS_fnc_taskSetDescription;
			</sqf>

	=== Update a task's waypoint position ===		=== Update a task's waypoint position ===

	[<~~span style="color: purple; font-weight: bold"~~>"taskID"~~</span>~~, [theOfficer, [[true]]~~]] [[~~call~~]] [[~~BIS_fnc_taskSetDestination]];		<sqf>["taskID", [theOfficer, true]] call BIS_fnc_taskSetDestination;</sqf>

	=== Update a task's status ===		=== Update a task's status ===

	[<~~span style="color: purple; font-weight: bold"~~>"taskID"~~</span>~~, "SUCCEEDED"] [[call~~]] [[~~BIS_fnc_taskSetState]];		<sqf>["taskID", "SUCCEEDED"] call BIS_fnc_taskSetState;</sqf>

	=== Delete a task ===		=== Delete a task ===

	[<~~span style="color: purple; font-weight: bold"~~>"taskID"~~</span>~~] [[call~~]] [[~~BIS_fnc_deleteTask]];		<sqf>["taskID"] call BIS_fnc_deleteTask;</sqf>


Line 60:		Line 63:
	=== Find if a task exists ===		=== Find if a task exists ===

	[<~~span style="color: purple; font-weight: bold"~~>"taskID"~~</span>~~] [[call~~]] [[~~BIS_fnc_taskExists]];		<sqf>["taskID"] call BIS_fnc_taskExists;</sqf>

	=== Find if a task is completed ===		=== Find if a task is completed ===

	<~~span style="color: purple; font-weight: bold"~~>"taskID"</~~span~~> ~~[[call]] [[BIS_fnc_taskCompleted]];~~		<sqf>"taskID" call BIS_fnc_taskCompleted;</sqf>
	{{Feature \| Informative \| "Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".}}		{{Feature \| Informative \| "Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".}}

	==== Check if multiple tasks are completed ====		==== Check if multiple tasks are all completed ====

	[ <~~span style="color: purple; font-weight: bold"~~>"taskID_0"~~</span>~~, ~~<span style="color: purple; font-weight: bold">~~"taskID_1"~~</span>~~, ~~<span style="color: purple; font-weight: bold">~~"taskID_2"~~</span>~~] [[findIf]] {!(_x [[call~~]] [[~~BIS_fnc_taskCompleted]])} == -1		<sqf>["taskID_0", "taskID_1", "taskID_2"] findIf {!(_x call BIS_fnc_taskCompleted)} == -1</sqf>

	=== Get a task's status ===		=== Get a task's status ===

	<~~span style="color: purple; font-weight: bold"~~>"taskID"</~~span~~> ~~[[call]] [[BIS_fnc_taskState]];~~		<sqf>"taskID" call BIS_fnc_taskState;</sqf>

	=== Get a task's type ===		=== Get a task's type ===

	<~~span style="color: purple; font-weight: bold"~~>"taskID"</~~span~~> ~~[[call]] [[BIS_fnc_taskType]];~~		<sqf>"taskID" call BIS_fnc_taskType;</sqf>

	=== Get a task's visibility ===		=== Get a task's visibility ===

	<~~span style="color: purple; font-weight: bold"~~>"taskID"</~~span~~> ~~[[call]] [[BIS_fnc_taskAlwaysVisible]];~~		<sqf>"taskID" call BIS_fnc_taskAlwaysVisible;</sqf>

	=== Get a task's description ===		=== Get a task's description ===

	<~~span style="color: purple; font-weight: bold"~~>"taskID"</~~span~~> ~~[[call]] [[BIS_fnc_taskDescription]];~~		<sqf>"taskID" call BIS_fnc_taskDescription;</sqf>

	=== Get a task's destination ===		=== Get a task's destination ===

	<~~span style="color: purple; font-weight: bold"~~>"taskID"</~~span~~> ~~[[call]] [[BIS_fnc_taskDestination]];~~		<sqf>"taskID" call BIS_fnc_taskDestination;</sqf>

	=== Get a unit's tasks ===		=== Get a unit's tasks ===

	[[player~~]] [[~~call~~]] [[~~BIS_fnc_tasksUnit]];		<sqf>player call BIS_fnc_tasksUnit;</sqf>

R3vo: /* Find if a task is completed */

2021-06-27T09:55:24Z

Find if a task is completed

← Older revision		Revision as of 11:55, 27 June 2021
Line 66:		Line 66:
	<span style="color: purple; font-weight: bold">"taskID"</span> [[call]] [[BIS_fnc_taskCompleted]];		<span style="color: purple; font-weight: bold">"taskID"</span> [[call]] [[BIS_fnc_taskCompleted]];
	{{Feature \| Informative \| "Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".}}		{{Feature \| Informative \| "Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".}}

			==== Check if multiple tasks are completed ====

			[ <span style="color: purple; font-weight: bold">"taskID_0"</span>, <span style="color: purple; font-weight: bold">"taskID_1"</span>, <span style="color: purple; font-weight: bold">"taskID_2"</span>] [[findIf]] {!(_x [[call]] [[BIS_fnc_taskCompleted]])} == -1

	=== Get a task's status ===		=== Get a task's status ===

Lou Montana: Text replacement - "\{\{( )Informative( )\|" to "{{$1Feature$2|$2Informative$2|"

2021-02-06T23:01:12Z

Text replacement - "\{\{( *)Informative( *)\|" to "{{$1Feature$2|$2Informative$2|"

← Older revision		Revision as of 01:01, 7 February 2021
Line 6:		Line 6:


	{{Informative \| For '''{{arma2}}'''<nowiki/>'s Task Tutorial, see [[Arma 2: Task Tutorial]].}}		{{Feature \| Informative \| For '''{{arma2}}'''<nowiki/>'s Task Tutorial, see [[Arma 2: Task Tutorial]].}}


Line 19:		Line 19:
	[[private]] _myTask = [groupOfPlayers, <span style="color: purple; font-weight: bold">"taskID"</span>, [_description, _title, _waypoint], objDocuments, [[true]]] [[call]] [[BIS_fnc_taskCreate]];		[[private]] _myTask = [groupOfPlayers, <span style="color: purple; font-weight: bold">"taskID"</span>, [_description, _title, _waypoint], objDocuments, [[true]]] [[call]] [[BIS_fnc_taskCreate]];

	{{Informative \| The <span style{{=}}"color: purple; font-weight: bold">"taskID"</span> argument is the task's ID used for later references.<!--		{{Feature \| Informative \| The <span style{{=}}"color: purple; font-weight: bold">"taskID"</span> argument is the task's ID used for later references.<!--
	--> This string gets defined here on creation and must be unique for each task.<!--		--> This string gets defined here on creation and must be unique for each task.<!--
	--> It should be kept short for network economy.}}		--> It should be kept short for network economy.}}
Line 26:		Line 26:

	<span style="color: purple; font-weight: bold">"taskID"</span> [[call]] [[BIS_fnc_taskSetCurrent]];		<span style="color: purple; font-weight: bold">"taskID"</span> [[call]] [[BIS_fnc_taskSetCurrent]];
	{{Informative \| This step is optional here as we used [[true]] as the fifth argument of the [[BIS_fnc_taskCreate]] call, making it the current task.}}		{{Feature \| Informative \| This step is optional here as we used [[true]] as the fifth argument of the [[BIS_fnc_taskCreate]] call, making it the current task.}}

	=== Set a task's type ===		=== Set a task's type ===
Line 32:		Line 32:
	[<span style="color: purple; font-weight: bold">"taskID"</span>, "attack"] [[call]] [[BIS_fnc_taskSetType]];		[<span style="color: purple; font-weight: bold">"taskID"</span>, "attack"] [[call]] [[BIS_fnc_taskSetType]];

	{{Informative \| This could have been set in the task creation call as the eighth argument. See [[BIS_fnc_taskCreate]]'s ''type'' parameter.}}		{{Feature \| Informative \| This could have been set in the task creation call as the eighth argument. See [[BIS_fnc_taskCreate]]'s ''type'' parameter.}}

	=== Set a task's visibility ===		=== Set a task's visibility ===
Line 65:		Line 65:

	<span style="color: purple; font-weight: bold">"taskID"</span> [[call]] [[BIS_fnc_taskCompleted]];		<span style="color: purple; font-weight: bold">"taskID"</span> [[call]] [[BIS_fnc_taskCompleted]];
	{{Informative \| "Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".}}		{{Feature \| Informative \| "Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".}}

	=== Get a task's status ===		=== Get a task's status ===
Line 94:		Line 94:
	== Advanced ==		== Advanced ==

	{{Informative \| All these details can be found in the [[Description.ext#Tasks\|Description.ext's Tasks chapter]].}}		{{Feature \| Informative \| All these details can be found in the [[Description.ext#Tasks\|Description.ext's Tasks chapter]].}}

	=== Define a task in mission config ===		=== Define a task in mission config ===

R3vo: category

2021-01-02T11:20:44Z

Lou Montana: Text replacement - "[[Arma 3 Task Framework" to "[[Arma 3: Task Framework"

2020-12-31T21:27:18Z

Text replacement - "[[Arma 3 Task Framework" to "[[Arma 3: Task Framework"

← Older revision		Revision as of 23:27, 31 December 2020
Line 2:		Line 2:
	== Basics ==		== Basics ==

	Tasks are a group's objectives. {{arma3}} introduced the '''[[Arma 3 Task Framework]]''' to work with tasks with ease.<br>		Tasks are a group's objectives. {{arma3}} introduced the '''[[Arma 3: Task Framework]]''' to work with tasks with ease.<br>
	The '''Task Framework''' functions have a '''global''' effect.		The '''Task Framework''' functions have a '''global''' effect.

Line 153:		Line 153:
	== See also ==		== See also ==

	* [[Arma 3 Task Framework]]		* [[Arma 3: Task Framework]]
	* [[:Category:Function_Group:_Tasks\|Tasks Functions]]		* [[:Category:Function_Group:_Tasks\|Tasks Functions]]
	* [[:Category:Command Group: Briefing\|Briefing Commands]]		* [[:Category:Command Group: Briefing\|Briefing Commands]]

Lou Montana: Lou Montana moved page Arma 3 Task Framework Tutorial to Arma 3: Task Framework Tutorial: Text replacement - "^Arma 3 " to "Arma 3: "

2020-12-30T00:18:10Z

Lou Montana moved page Arma 3 Task Framework Tutorial to Arma 3: Task Framework Tutorial: Text replacement - "^Arma 3 " to "Arma 3: "

← Older revision	Revision as of 02:18, 30 December 2020
(No difference)

Lou Montana: Text replacement - "{{SideTOC}}" to "{{TOC|side}}"

2020-12-29T02:17:52Z

Text replacement - "{{SideTOC}}" to "{{TOC|side}}"

← Older revision		Revision as of 04:17, 29 December 2020
Line 1:		Line 1:
	{{~~SideTOC~~}}		{{TOC\|side}}
	== Basics ==		== Basics ==

← Older revision		Revision as of 13:20, 2 January 2021
Line 158:		Line 158:


	[[Category:Scripting ~~Topics]]~~		[[Category:Arma Scripting Tutorials]]
	~~{{GameCategory\|arma3\|Editing}}~~
	~~[[Category:Arma 3:~~ Tutorials]]

Arma 3: Task Framework Tutorial - Revision history

Lou Montana: Some wiki formatting

Lou Montana: Some wiki formatting

Lou Montana: Some wiki formatting

Lou Montana: Some wiki formatting

R3vo: /* Find if a task is completed */

Lou Montana: Text replacement - "\{\{( *)Informative( *)\|" to "{{$1Feature$2|$2Informative$2|"

R3vo: category

Lou Montana: Text replacement - "[[Arma 3 Task Framework" to "[[Arma 3: Task Framework"

Lou Montana: Lou Montana moved page Arma 3 Task Framework Tutorial to Arma 3: Task Framework Tutorial: Text replacement - "^Arma 3 " to "Arma 3: "

Lou Montana: Text replacement - "{{SideTOC}}" to "{{TOC|side}}"

Lou Montana: Text replacement - "\{\{( )Informative( )\|" to "{{$1Feature$2|$2Informative$2|"