BIS fnc taskSetDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(26 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= Set a task description. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}
Description:
Set a task's description.
Parameters:
0: STRING - Task name
1: ARRAY - Task description in the format ["description", "title", "marker"]
Returns:
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|s1= [taskId, [taskDescription, taskTitle, taskMarker]] call [[BIS_fnc_taskSetDescription]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_taskSetDescription]]; --> |= Syntax
|p1= taskId: [[String]]


|p1= |= Parameter 1
|p2= taskDescription: [[String]]


| |= Return value
|p3= taskTitle: [[String]]
____________________________________________________________________________________________


|x1= <code></code> |=
|p4= taskMarker: [[String]]
____________________________________________________________________________________________


| |= See also
|r1= [[Boolean]]


|x1= <sqf>[
"tsk_destroyAA",
[
"You should plant Satchels under those Shilkas! Good luck.",
"Destroy the Shilkas",
"Shilkas"
]
] call BIS_fnc_taskSetDescription;</sqf>
|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:taskSetDescription}}]]
[[Category:Functions|{{uc:taskSetDescription}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskSetDescription}}]]

Latest revision as of 01:24, 2 February 2024

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

Description

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

Syntax

Syntax:
[taskId, [taskDescription, taskTitle, taskMarker]] call BIS_fnc_taskSetDescription
Parameters:
taskId: String
taskDescription: String
taskTitle: String
taskMarker: String
Return Value:
Boolean

Examples

Example 1:
[ "tsk_destroyAA", [ "You should plant Satchels under those Shilkas! Good luck.", "Destroy the Shilkas", "Shilkas" ] ] call BIS_fnc_taskSetDescription;

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_taskSetDescription&oldid=352043"