taskDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(clarify desc, return value.)
m (Some wiki formatting)
 
(46 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Returns the sub-parts of the task description. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| [[Array]] <nowiki>=</nowiki> '''taskDescription''' task |= Syntax
|game4= arma3
|version4= 0.50


|p1= task: [[Task]] |= PARAMETER1
|gr1= Briefing


|p2= |= PARAMETER2
|descr= Returns the sub-parts of the task description. The returned Array is in format [Task description, Task title, Task waypoint description].


|p3= |= PARAMETER3
|s1= [[taskDescription]] task


| [[Array]]: [Task description, Task title, Task waypoint description] |= RETURNVALUE
|p1= task: [[Task]]


|r1= [[Array]]


|x1= <code>_taskDescArray <nowiki>=</nowiki> taskDescription _task;</code>|= EXAMPLE1
|x1= <sqf>_taskDescArray = taskDescription _task;</sqf>


____________________________________________________________________________________________
|seealso= [[setSimpleTaskDescription]] [[createSimpleTask]]
}}


| [[setSimpleTaskDescription]], [[createSimpleTask]] |= SEEALSO
{{Note
 
|user= Tajin
|  |= MPBEHAVIOUR
|timestamp= 20141114194800
____________________________________________________________________________________________
|text= Be careful if you want to use this to retrieve the title of a task.
If the task has no description set, then "taskDescription" will only return an array of empty Strings.<br>
Therefore always use [[setSimpleTaskDescription]] directly after creating a new task, even if you set the Description to "".
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Briefing|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:23, 13 May 2022

Hover & click on the images for description

Description

Description:
Returns the sub-parts of the task description. The returned Array is in format [Task description, Task title, Task waypoint description].
Groups:
Briefing

Syntax

Syntax:
taskDescription task
Parameters:
task: Task
Return Value:
Array

Examples

Example 1:
_taskDescArray = taskDescription _task;

Additional Information

See also:
setSimpleTaskDescription createSimpleTask

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
Tajin - c
Posted on Nov 14, 2014 - 19:48 (UTC)
Be careful if you want to use this to retrieve the title of a task. If the task has no description set, then "taskDescription" will only return an array of empty Strings.
Therefore always use setSimpleTaskDescription directly after creating a new task, even if you set the Description to "".