BIS fnc taskDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Tasks(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Tasks


|gr1= Tasks |GROUP1=
|arg= global
|eff= global


|arg= global|Multiplayer Arguments=
|descr= Return a task's description. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}


|eff= global|Multiplayer Effects=
|s1= taskName call [[BIS_fnc_taskDescription]]
____________________________________________________________________________________________


| Return a task's description. {{Informative| See [[Arma 3 Task Framework]] for more information.}}|Description=
|p1= taskName: [[String]]
____________________________________________________________________________________________


| taskName call [[BIS_fnc_taskDescription]] |Syntax=
|r1= [[Array]] - task's description in the format ["description", "title", "marker"]


|p1= taskName: [[String]] |Parameter 1=
|x1= <sqf>"BIS_task_01" call BIS_fnc_taskDescription;</sqf>


| [[Array]] - Task's description in the format ["description", "title", "marker"] |Return value=
|seealso= [[Arma 3: Task Framework]]
____________________________________________________________________________________________
 
|x1= <code>"BIS_task_01" [[call]] [[BIS_fnc_taskDescription]];</code>|Example 1=
 
____________________________________________________________________________________________
 
| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3 Task Framework]] |See also=
}}
}}
<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:Functions|{{uc:taskDescription}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskDescription}}]]

Latest revision as of 00:25, 2 February 2024

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