createDiaryRecord: Difference between revisions

From Bohemia Interactive Community
No edit summary
m (Some wiki formatting)
Line 33: Line 33:
* ''title'': [[String]] - tooltip to show on mouse over image (Since Arma 3 v2.10)
* ''title'': [[String]] - tooltip to show on mouse over image (Since Arma 3 v2.10)
* ''src'': [[String]] - alternative to 'image' (Since Arma 3 v2.10)
* ''src'': [[String]] - alternative to 'image' (Since Arma 3 v2.10)
{{Feature|arma3|Maximum width supported seems to be 370 pixel. An image wider that this will be cut off. Height should be calculated with the aspect ratio of the image. {{ic|height {{=}} 370; ratio {{=}} 16/9; height {{=}} width / ratio;}}}}
{{Feature|arma3|Maximum width supported seems to be 370 pixel. An image wider that this will be cut off. Height should be calculated with the aspect ratio of the image. {{hl|height {{=}} 370; ratio {{=}} 16/9; height {{=}} width / ratio;}}}}
| <syntaxhighlight lang="html"><img image="picture.paa" width="128" height="64" /></syntaxhighlight><br>Since Arma 3 v2.10 :<br><syntaxhighlight lang="html"><img title="this is image" src="picture.paa" width="128" height="64" /></syntaxhighlight>
| <syntaxhighlight lang="html"><img image="picture.paa" width="128" height="64" /></syntaxhighlight><br>Since Arma 3 v2.10 :<br><syntaxhighlight lang="html"><img title="this is image" src="picture.paa" width="128" height="64" /></syntaxhighlight>
|-
|-
Line 124: Line 124:
|p3= text: [[String]]
|p3= text: [[String]]


|p4= task: [[Task]] - (Optional, default {{ic|[[taskNull]]}})
|p4= task: [[Task]] - (Optional, default [[taskNull]])


|p5= taskState: [[String]] (Optional, default {{ic|?}}) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"
|p5= taskState: [[String]] (Optional, default {{hl|?}}) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"


|p6= showTitle: [[Boolean]] (Optional, default {{ic|[[true]]}}) - Whether or not to show title in the description section as well
|p6= showTitle: [[Boolean]] (Optional, default [[true]]) - Whether or not to show title in the description section as well
|p6since= arma3 1.96
|p6since= arma3 1.96


Line 146: Line 146:
|p25since= arma3 2.10
|p25since= arma3 2.10


|p26= task: [[Task]] - (Optional, default {{ic|[[taskNull]]}})
|p26= task: [[Task]] - (Optional, default [[taskNull]])


|p27= taskState: [[String]] (Optional, default {{ic|?}}) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"
|p27= taskState: [[String]] (Optional, default {{hl|?}}) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"


|p28= showTitle: [[Boolean]] (Optional, default {{ic|[[true]]}}) - Whether or not to show title in the description section as well
|p28= showTitle: [[Boolean]] (Optional, default [[true]]) - Whether or not to show title in the description section as well
|p28since= arma3 1.96
|p28since= arma3 1.96


Line 174: Line 174:
}}
}}


<dl class="command_description">
{{Note
|user= Tankbuster
|timestamp= 20170324201100
|text= When adding multiple diary records, be aware that they appear in reverse order. ie the first one you add will appear last and the last one you add will be first.
}}


<dt></dt>
{{Note
<dd class="notedate">Posted on March 24, 2017 - 20:11 (UTC)</dd>
|user= R3vo
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
|timestamp= 20190622162800
<dd class="note">
|text= It seems that the '''task''' parameter has no effect in {{arma3}} because the task entry in the briefing menu is created when the task itself was created.
When adding multiple diary records, be aware that they appear in reverse order. ie the first one you add will appear last and the last one you add will be first.
}}
</dd>
 
<dt><dt>
<dd class="notedate">Posted on June 22, 2019 - 16:28 (UTC)</dd>
<dt class="note">[[User:R3vo|R3vo]]</dt>
<dd class="note">
It seems that the '''task''' parameter has no effect in {{arma3}} because the task entry in the briefing menu is created when the task itself was created.
</dd>
 
</dl>

Revision as of 16:41, 26 July 2022

Hover & click on the images for description

Description

Description:

Creates a diary entry. Supported tags and their parameters:

If the createDiaryRecord command fails, it returns a null record. Before Arma 3 v2.00, isNull did not work with the diary record type and diaryRecordNull did not exist. In order to verify a null record, it is possible to create a variable and compare against it:
Copy
private _recordNull = objNull createDiaryRecord []; private _createdRecord = player createDiaryRecord ["Diary", ["Title", "Description"]]; if (_createdRecord isEqualTo _recordNull) then { hint "Failed"; };
Groups:
Briefing

Syntax

Syntax:
player createDiaryRecord [subject, text, task, taskState, showTitle]
Parameters:
player: Object
subject: String
text: String
task: Task - (Optional, default taskNull)
taskState: String (Optional, default ?) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"
since Arma 3 logo black.png1.96
showTitle: Boolean (Optional, default true) - Whether or not to show title in the description section as well
Return Value:
Diary Record

Alternative Syntax

Syntax:
player createDiaryRecord [subject, [title, text, icon], task, taskState, showTitle]
Parameters:
player : Object
subject: String
title: String
text: String
since Arma 3 logo black.png2.10
icon: String - (Optional) icon to show next to the title
task: Task - (Optional, default taskNull)
taskState: String (Optional, default ?) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"
since Arma 3 logo black.png1.96
showTitle: Boolean (Optional, default true) - Whether or not to show title in the description section as well
Return Value:
Diary Record

Examples

Example 1:
Copy
player createDiaryRecord ["Diary", ["Intel", "Enemy base is on grid <marker name='enemyBase'>161170</marker>"]]
Example 2:
Copy
player createDiaryRecord ["Diary", "Information gathered.<br />&lt;img image='wellDone_ca.paa' /&gt;"]
Example 3:
Copy
player createDiaryRecord ["Diary", ["No Title", "description"], taskNull, "", false];
Example 4:
Copy
player createDiaryRecord ["Diary", ["Font tag","<font color='#7FFF00' size='30' face='TahomaB'>This will changed text size, colour and font</font>"], taskNull, "",false];
Example 5:
Copy
player createDiaryRecord ["Diary", ["Image", "<img image='\A3\Ui_F_Curator\Data\Logos\arma3_curator_artwork.jpg' width='500' height='800'/>"], taskNull, "", false];
Example 6:
Copy
player createDiaryRecord ["Diary", ["Linebreak","Line1<br></br>Line2<br></br><br></br>Line4"], taskNull, "", false];
Example 7:
Copy
player createDiaryRecord ["Diary", ["Execute","<execute expression='hint ""Some code"";'>Some text</execute>"], taskNull, "", false];
Example 8:
Copy
player createDiaryRecord ["Diary", ["ExecuteClose", "<executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose>"], taskNull, "", false];

Additional Information

See also:
allDiaryRecords processDiaryLink createDiaryLink createDiarySubject diarySubjectExists setDiaryRecordText removeDiaryRecord

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
Tankbuster - c
Posted on Mar 24, 2017 - 20:11 (UTC)
When adding multiple diary records, be aware that they appear in reverse order. ie the first one you add will appear last and the last one you add will be first.
R3vo - c
Posted on Jun 22, 2019 - 16:28 (UTC)
It seems that the task parameter has no effect in Arma 3 because the task entry in the briefing menu is created when the task itself was created.