createDiaryRecord: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "\{\{Wikipedia *\| *([a-zA-Z0-9_#]+) *\| *([a-zA-Z0-9_ #]+) *\}\}" to "{{Link|https://en.wikipedia.org/$1|$2}}")
Line 38: Line 38:
| font
| font
|
|
* ''color'': [[String]] - {{Wikipedia|HTML_color|HTML color}} in format #aarrggbb or #rrggbb
* ''color'': [[String]] - {{Link|https://en.wikipedia.org/HTML_color|HTML color}} in format #aarrggbb or #rrggbb
* ''size'': [[Number]] - font height in pixels (default: 14)
* ''size'': [[Number]] - font height in pixels (default: 14)
* ''face'': [[String]] - font type (see [[FXY File Format#Available Fonts|Fonts]])
* ''face'': [[String]] - font type (see [[FXY File Format#Available Fonts|Fonts]])

Revision as of 23:02, 23 February 2023

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 /><img image='wellDone_ca.paa' />"]
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.
Honger - c
Posted on Oct 18, 2022 - 17:51 (UTC)
<log>, as ccreateDiaryLink, 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).