taskDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)?\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
m (Some wiki formatting)
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


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


|gr1= Briefing |GROUP1=
|game2= arma2oa
|version2= 1.50


|game3= tkoh
|version3= 1.00


|game4= arma3
|version4= 0.50


|1.00|Game version=
|gr1= Briefing
____________________________________________________________________________________________


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


| '''taskDescription''' task |SYNTAX=
|s1= [[taskDescription]] task


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


|p2= |PARAMETER2=  
|r1= [[Array]]


|p3= |PARAMETER3=  
|x1= <sqf>_taskDescArray = taskDescription _task;</sqf>


| [[Array]]  |RETURNVALUE=  
|seealso= [[setSimpleTaskDescription]] [[createSimpleTask]]
 
 
|x1= <code>_taskDescArray <nowiki>=</nowiki> [[taskDescription]] _task;</code>|EXAMPLE1=
 
____________________________________________________________________________________________
 
| [[setSimpleTaskDescription]], [[createSimpleTask]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= Tajin
<!-- Note Section BEGIN -->
|timestamp= 20141114194800
 
|text= Be careful if you want to use this to retrieve the title of a task.
<!-- Note Section END -->
</dl>
 
<h3 style='display:none'>Bottom Section</h3>
 
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Briefing|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on November 14, 2014 - 19:48 (UTC)</dd>
<dt class="note">[[User:Tajin|Tajin]]</dt>
<dd class="note">
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>
If the task has no description set, then "taskDescription" will only return an array of empty Strings.<br>
<br>
Therefore always use [[setSimpleTaskDescription]] directly after creating a new task, even if you set the Description to "".
Therefor always use setSimpleTaskDescription directly after creating a new task, even if you set the Description to "".
}}
</dd>
</dl>
<!-- DISCONTINUE Notes -->

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 "".