BIS fnc taskSetDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(24 intermediate revisions by 2 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


| Set a task description. For easy task manipulation, use the [[Arma 3 Task Framework]]. |DESCRIPTION=
|descr= Set a task description. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}
____________________________________________________________________________________________


| [ taskId, [ taskDescription, taskTitle, taskMarker ] ] call [[BIS_fnc_taskSetDescription]] |SYNTAX=
|s1= [taskId, [taskDescription, taskTitle, taskMarker]] call [[BIS_fnc_taskSetDescription]]


|p1= taskId: [[String]]|PARAMETER1=
|p1= taskId: [[String]]


|p2= taskDescription: [[String]]|PARAMETER2=
|p2= taskDescription: [[String]]


|p3= taskTitle: [[String]]|PARAMETER3=
|p3= taskTitle: [[String]]


|p4= taskMarker: [[String]]|PARAMETER4=
|p4= taskMarker: [[String]]


| [[Boolean]] |RETURNVALUE=
|r1= [[Boolean]]
____________________________________________________________________________________________


|x1= <code>[
|x1= <sqf>[
"tsk_destroyAA",
"tsk_destroyAA",
[
[
Line 31: Line 30:
"Shilkas"
"Shilkas"
]
]
] [[call]] [[BIS_fnc_taskSetDescription]];</code> |EXAMPLE1=
] call BIS_fnc_taskSetDescription;</sqf>
____________________________________________________________________________________________
 
| [[BIS_fnc_taskCreate]], [[BIS_fnc_setTask]], [[Arma_3_Task_Framework|Task Framework]], [[Arma_3_Tasks_Overhaul|Tasks Overhaul]] |SEEALSO=


|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"