createDiaryRecord

1.00

1.50

1.00

0.50

LALocal LELocal

Hover & click on the images for description

Description

Description:

Creates a diary entry. Supported tags and their parameters:

Tag	Options	Example
img	image: String - path to image. When present, any element with it will be displayed as image. width: Number - image width in pixels. height: Number - image height in pixels. title: String - tooltip to show on mouse over image (Since Arma 3 v2.10) src: String - alternative to 'image' (Since Arma 3 v2.10) 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. `height = 370; ratio = 16/9; height = width / ratio;`	<img image="picture.paa" width="128" height="64" /> Since Arma 3 v2.10 : <img title="this is image" src="picture.paa" width="128" height="64" />
font	color: String - HTML color in format #aarrggbb or #rrggbb size: Number - font height in pixels (default: 14) face: String - font type (see Fonts)	<font color="#FF00FF" size="16" face="LucidaConsoleB">Hello there</font>
br	N/A	Line 1<br/>Line 2
marker	name: String - marker name	<marker name="respawn_west">Respawn point</marker>
execute	expression: String - executed code	<execute expression="player setDamage 1">Die!</execute>
executeClose	expression: String - executed code, diary is closed afterwards	<executeClose expression="player setDamage 1">Die and close</executeClose>
log	subject: String - subject name. record: String - record ID (e.g. "Record6" or "Unit1059524")	<log subject="Hello">Get to the "Hello" subject</log> <log subject="Hello" record="Record0">Go to the first record added to "Hello"</log>
gear	unit: Number - unit ID	<gear unit="123456">Open unit 123456's gear</gear>
teamSwitch	unit: Number - unit ID	<teamSwitch unit="123456">Switch to unit 123456</teamSwitch>
kick	id: Number - unit ID	<kick unit="123456">Kick player unit 123456</kick>
ban	id: Number - unit ID	<ban unit="123456">ban player unit 123456</ban>
mute	id: Number - unit ID	<mute unit="123456">mute player unit 123456</mute>
voteadmin	id: Number - unit ID	<voteadmin unit="123456">vote admin unit 123456</voteadmin>
votekick	id: Number - unit ID	<votekick unit="123456">vote kick player unit 123456</votekick>
currentTask	id: Number - task ID action: String - 'n' or 's' (select)	<currentTask id="my_task">get to my_task task</currentTask>

↑ Back to spoiler's top

ⓘ

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:

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 1.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 2.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 1.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:: player createDiaryRecord ["Diary", ["Intel", "Enemy base is on grid <marker name='enemyBase'>161170</marker>"]]
Example 2:: player createDiaryRecord ["Diary", "Information gathered. <img image='wellDone_ca.paa' />"]
Example 3:: player createDiaryRecord ["Diary", ["No Title", "description"], taskNull, "", false];
Example 4:: player createDiaryRecord ["Diary", ["Font tag","This will changed text size, colour and font"], taskNull, "",false];
Example 5:: player createDiaryRecord ["Diary", ["Image", "<img image='\A3\Ui_F_Curator\Data\Logos\arma3_curator_artwork.jpg' width='500' height='800'/>"], taskNull, "", false];
Example 6:: player createDiaryRecord ["Diary", ["Linebreak","Line1 Line2 Line4"], taskNull, "", false];
Example 7:: player createDiaryRecord ["Diary", ["Execute","<execute expression='hint ""Some code"";'>Some text</execute>"], taskNull, "", false];
Example 8:: 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.

Honger - c: Posted on Oct 18, 2022 - 17:51 (UTC)
: <log>, as createDiaryLink, requires declaring both subject and ID of the record belonging to said subject. Otherwise generated text will not be clickable or might open a non-existing record (behaviour similar to clicking on map when viewing Diary).