BIS fnc taskDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Tasks


|1.00|= Game version
|arg= global
____________________________________________________________________________________________
|eff= global


| <pre>/*
|descr= Return a task's description. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}
Description:
Return a task's description.
Parameters:
_this: STRING - Task name
Returns:
ARRAY -  task's description in the format ["description", "title", "marker"]
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|s1= taskName call [[BIS_fnc_taskDescription]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_taskDescription]]; --> |= Syntax
|p1= taskName: [[String]]


|p1= |= Parameter 1
|r1= [[Array]] - task's description in the format ["description", "title", "marker"]


| |= Return value
|x1= <sqf>"BIS_task_01" call BIS_fnc_taskDescription;</sqf>
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso=  [[Arma 3: Task Framework]]
}}
}}
<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:Function Group: Tasks|{{uc:taskDescription}}]]
[[Category:Functions|{{uc:taskDescription}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskDescription}}]]

Latest revision as of 01:25, 2 February 2024

Arma 3 logo black.png1.00
GAGlobalGEGlobal
Hover & click on the images for description

Description

Description:
Return a task's description.
ⓘ
See Arma 3: Task Framework for more information.
Execution:
call
Groups:
Tasks

Syntax

Syntax:
taskName call BIS_fnc_taskDescription
Parameters:
taskName: String
Return Value:
Array - task's description in the format ["description", "title", "marker"]

Examples

Example 1:
"BIS_task_01" call BIS_fnc_taskDescription;

Additional Information

See also:
Arma 3: Task Framework

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskDescription&oldid=352119"