createDiaryRecord

From Bohemia Interactive Community
Revision as of 13:51, 23 June 2023 by Lou Montana (talk | contribs) (Remove syntaxhighlight spoiler hack)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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.
  • Arma 3 logo black.png2.10 title: String - tooltip to show on mouse over image
  • Arma 3 logo black.png2.10 src: String - alternative to 'image'
Arma 3
Maximum width supported seems to be 370 pixels as a wider image 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 src="picture.paa" width="128" height="64" title="this is an image" />
font
<font color="#FF00FF" size="16" face="LucidaConsoleB">Hello there</font>
br N/A
Line 1<br />Line 2
marker
<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
<log subject="Hello">Get to the "Hello" subject</log>
<log subject="Hello" record="Record0">Go to the first record added to "Hello"</log>
gear
<gear unit="123456">Open unit 123456's gear</gear>
teamSwitch
<teamSwitch unit="123456">Switch to unit 123456</teamSwitch>
kick
<kick unit="123456">Kick player unit 123456</kick>
ban
<ban unit="123456">ban player unit 123456</ban>
mute
<mute unit="123456">mute player unit 123456</mute>
voteadmin
<voteadmin unit="123456">vote admin unit 123456</voteadmin>
votekick
<votekick unit="123456">vote kick player unit 123456</votekick>
currentTask
<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, textInfo, task, taskState, showTitle]
Parameters:
player: Object
subject: String
textInfo: String or Array of Strings - can be:
task: Task - (Optional, default taskNull)
taskState: String - (Optional, default "NONE") changes the state of the given task. Can be one of:
  • "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:
player createDiaryRecord ["Diary", ["Intel", "Enemy base is on grid <marker name='enemyBase'>161170</marker>"]]
Example 2:
player createDiaryRecord ["Diary", "Information gathered.<br /><img image='wellDone_ca.paa' />"]
Example 3:
player createDiaryRecord ["Diary", ["Title", "Description"], taskNull, "", false];
Example 4:
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:
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<br />Line2<br /><br />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
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
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
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).