setSimpleTaskCustomData: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
mNo edit summary
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<!-- setSimpleTaskCustomData -->
{{RV|type=command
{{Command|=
____________________________________________________________________________________________


| A3 |= Game
|game1= arma3
|version1= 1.58


|1.58|= Game Version (number surrounded by NO SPACES)
|gr1= Briefing


____________________________________________________________________________________________
|descr= Set custom data for the task. Tooltip will be drawn in task list on the right side. Description will be drawn in task description panel on the bottom.


| Set custom data for the task. Tooltip will be drawn in task list on the right side. Description will be drawn in task description panel on the bottom. |= Description
|s1= task [[setSimpleTaskCustomData]] [iconPath, tooltip, description]
____________________________________________________________________________________________


| task '''setSimpleTaskCustomData''' [IconPath, tooltip, description] |= Syntax
|p1= task: [[Task]] - task the custom data are being added to


|p1= task: [[Task]] - task the custom data are being added to |= Parameter 1
|p2= iconPath: [[String]] - icon path


|p2= iconPath: [[String]] - icon path |= Parameter 2
|p3= tooltip: [[String]] - text displayed next to the icon; max. 3 charactersc


|p3= tooltip: [[String]] - text displayed next to the icon; max. 3 charactersc |= Parameter 3
|p4= description: [[String]] - text displayed on the task description panel; html format


|p4= description: [[String]] - text displayed on the task description panel; html format |= Parameter 4
|r1= [[Nothing]]


| Nothing |= Return Value
|x1= <sqf>_task setSimpleTaskCustomData ["\A3\Ui_f\data\IGUI\Cfg\simpleTasks\letters\h_ca.paa", "This is the tooltip", "This is the description"];</sqf>


____________________________________________________________________________________________
|seealso= [[taskCustomData]] [[setSimpleTaskType]] [[taskType]] [[Arma 3: Task Framework#Task Overhaul|Tasks Overhaul]]
 
| [[taskCustomData]], [[setSimpleTaskType]], [[taskType]], [[Arma_3_Tasks_Overhaul|Tasks Overhaul]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">'''[[User:User Name|]]'''</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 04:11, 27 November 2023

Hover & click on the images for description

Description

Description:
Set custom data for the task. Tooltip will be drawn in task list on the right side. Description will be drawn in task description panel on the bottom.
Groups:
Briefing

Syntax

Syntax:
task setSimpleTaskCustomData [iconPath, tooltip, description]
Parameters:
task: Task - task the custom data are being added to
iconPath: String - icon path
tooltip: String - text displayed next to the icon; max. 3 charactersc
description: String - text displayed on the task description panel; html format
Return Value:
Nothing

Examples

Example 1:
_task setSimpleTaskCustomData ["\A3\Ui_f\data\IGUI\Cfg\simpleTasks\letters\h_ca.paa", "This is the tooltip", "This is the description"];

Additional Information

See also:
taskCustomData setSimpleTaskType taskType Tasks 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