createDiaryRecord
Jump to navigation
Jump to search
Description
- Description:
-
Creates a Diary entry. Supported tags and their parameters:
Tag Options Example img <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 - 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 <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 <currentTask id="my_task">get to my_task task</currentTask>
- 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 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:
- Example 3:
- Example 4:
- Example 5:
- Example 6:
- Example 7:
- Example 8:
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
- 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.
- 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.
- 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).