taskDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|gr1= Briefing |GROUP1=
|gr1= Briefing






|1.00|Game version=
|1.00


| Returns the sub-parts of the task description. The returned Array is in format [Task description, Task title, Task waypoint description].
| 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=


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


|p2= |PARAMETER2=  
|p1= task: [[Task]]


|p3= |PARAMETER3=  
|p2=


| [[Array]]  |RETURNVALUE=  
|p3=


| [[Array]]


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


|x1= <code>_taskDescArray <nowiki>=</nowiki> [[taskDescription]] _task;</code>


| [[setSimpleTaskDescription]], [[createSimpleTask]] |SEEALSO=


| |MPBEHAVIOUR=
| [[setSimpleTaskDescription]], [[createSimpleTask]]
 
|
}}
}}



Revision as of 11:24, 18 January 2021

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:
setSimpleTaskDescriptioncreateSimpleTask

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


Posted on November 14, 2014 - 19:48 (UTC)
Tajin
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.

Therefor always use setSimpleTaskDescription directly after creating a new task, even if you set the Description to "".