BIS fnc taskSetDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page refactor)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Set a task description. For easy task manipulation, use the [[Arma 3 Task Framework]]. |= Description
____________________________________________________________________________________________
Description:
 
Set a task's description.
| [ taskId, [ taskDescription, taskTitle, taskMarker ] ] call [[BIS_fnc_taskSetDescription]] |= Syntax
 
Parameters:
|p1= taskId: [[String]]|= Parameter 1
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
|p2= taskDescription: [[String]]|= Parameter 2
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_taskSetDescription]]; --> |= Syntax
|p3= taskTitle: [[String]]|= Parameter 3


|p1= |= Parameter 1
|p4= taskMarker: [[String]]|= Parameter 4


| |= Return value
| [[Boolean]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[
"tsk_destroyAA",
[
"You should plant Satchels under those Shilkas! Good luck.",
"Destroy the Shilkas",
"Shilkas"
]
] [[call]] [[BIS_fnc_taskSetDescription]];</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[BIS_fnc_taskCreate]], [[BIS_fnc_setTask]], [[Arma_3_Task_Framework|Task Framework]], [[Arma_3_Tasks_Overhaul|Tasks Overhaul]] |= See also


}}
}}

Revision as of 20:30, 25 March 2018


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

Description

Description:
Set a task description. For easy task manipulation, use the Arma 3 Task Framework.
Execution:
call
Groups:
Uncategorised

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:
BIS_fnc_taskCreateBIS_fnc_setTaskTask FrameworkTasks Overhaul

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskSetDescription&oldid=106274"