BIS fnc taskSetDescription: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "^ \{\{(Command|Function)" to "{{$1")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= Tasks |GROUP1=
|gr1= Tasks


|arg= global|Multiplayer Arguments=
|arg= global|Multiplayer Arguments=
Line 11: Line 11:
|eff= global|Multiplayer Effects=
|eff= global|Multiplayer Effects=


| Set a task description. {{Informative| See [[Arma 3: Task Framework]] for more information.}} |DESCRIPTION=
| Set a task description. {{Informative| See [[Arma 3: Task Framework]] for more information.}}


| [ taskId, [ taskDescription, taskTitle, taskMarker ] ] call [[BIS_fnc_taskSetDescription]] |SYNTAX=
| [ 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=
| [[Boolean]]


|x1= <code>[
|x1= <code>[
Line 32: Line 32:
"Shilkas"
"Shilkas"
]
]
] [[call]] [[BIS_fnc_taskSetDescription]];</code> |EXAMPLE1=
] [[call]] [[BIS_fnc_taskSetDescription]];</code>


| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]] |SEEALSO=
| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]


}}
}}

Revision as of 00:45, 18 January 2021

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:
Task Functions 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

Bottom Section