createDiaryRecord: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Link\|https:\/\/en\.wikipedia\.org\/([^w][^i])" to "Link|https://en.wikipedia.org/wiki/$1")
m (Added missing semicolons to examples)
 
(2 intermediate revisions by one other user not shown)
Line 19: Line 19:
|arg= local
|arg= local


|descr= <syntaxhighlight lang="html"></syntaxhighlight><!-- needed for spoiler to have it -->
|descr= Creates a [[Diary]] entry. Supported tags and their parameters: <spoiler>
Creates a [[Diary|diary]] entry. Supported tags and their parameters: <spoiler>
{| class="wikitable sortable valign-top"
{| class="wikitable sortable"
! Tag
! Tag
! class="unsortable" | Options
! class="unsortable" | Options
Line 31: Line 30:
* ''width'': [[Number]] - image width in pixels.
* ''width'': [[Number]] - image width in pixels.
* ''height'': [[Number]] - image height in pixels.
* ''height'': [[Number]] - image height in pixels.
* ''title'': [[String]] - tooltip to show on mouse over image (Since Arma 3 v2.10)
* {{GVI|arma3|2.10|size= 0.75}} ''title'': [[String]] - tooltip to show on mouse over image
* ''src'': [[String]] - alternative to 'image' (Since Arma 3 v2.10)
* {{GVI|arma3|2.10|size= 0.75}} ''src'': [[String]] - alternative to 'image'
{{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;}}}}
{{Feature|arma3|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. {{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 {{arma3}} v2.10:
<syntaxhighlight lang="html"><img src="picture.paa" width="128" height="64" title="this is an image" /></syntaxhighlight>
|-
|-
| font
| font
Line 45: Line 48:
| br
| br
| {{n/a}}
| {{n/a}}
| <syntaxhighlight lang="html">Line 1<br/>Line 2</syntaxhighlight>
| <syntaxhighlight lang="html">Line 1<br />Line 2</syntaxhighlight>
|-
|-
| marker
| marker
Line 110: Line 113:
| <syntaxhighlight lang="html"><currentTask id="my_task">get to my_task task</currentTask></syntaxhighlight>
| <syntaxhighlight lang="html"><currentTask id="my_task">get to my_task task</currentTask></syntaxhighlight>
|}</spoiler>
|}</spoiler>
{{Feature | Informative | If the [[createDiaryRecord]] command fails, it returns a null record. Before {{arma3}} 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:
{{Feature|informative|
<sqf>private _recordNull = objNull createDiaryRecord [];
If the [[createDiaryRecord]] command fails, it returns a null record.
Before {{arma3}} 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:
<sqf>
private _recordNull = objNull createDiaryRecord [];
private _createdRecord = player createDiaryRecord ["Diary", ["Title", "Description"]];
private _createdRecord = player createDiaryRecord ["Diary", ["Title", "Description"]];
if (_createdRecord isEqualTo _recordNull) then { hint "Failed"; };</sqf>
if (_createdRecord isEqualTo _recordNull) then { hint "Failed"; };
</sqf>
}}
}}


|s1= player [[createDiaryRecord]] [subject, text, task, taskState, showTitle]
|s1= player [[createDiaryRecord]] [subject, textInfo, task, taskState, showTitle]


|p1= player: [[Object]]
|p1= player: [[Object]]
Line 122: Line 130:
|p2= subject: [[String]]
|p2= subject: [[String]]


|p3= text: [[String]]
|p3= textInfo: [[String]] or [[Array]] of [[String]]s - can be:
* [[String]] - the record's content - its title will be empty
* [[Array]] of [[String]]s - format [title, text, icon]:
** title: [[String]]
** text: [[String]]
** {{GVI|arma3|2.10|size= 0.75}} icon: [[String]] - (Optional) icon to show next to the title


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


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


|p6= showTitle: [[Boolean]] (Optional, default [[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


|r1= [[Diary Record]]
|r1= [[Diary Record]]


|s2= player [[createDiaryRecord]] [subject, [title, text, icon], task, taskState, showTitle]
|x1= <sqf>player createDiaryRecord ["Diary", ["Intel", "Enemy base is on grid <marker name='enemyBase'>161170</marker>"]];</sqf>
 
|p21= player : [[Object]]
 
|p22= subject: [[String]]
 
|p23= title: [[String]]
 
|p24= text: [[String]]
 
|p25= icon: [[String]] - (Optional) icon to show next to the title
|p25since= arma3 2.10
 
|p26= task: [[Task]] - (Optional, default [[taskNull]])
 
|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 [[true]]) - Whether or not to show title in the description section as well
|p28since= arma3 1.96
 
|r2= [[Diary Record]]
 
|x1= <sqf>player createDiaryRecord ["Diary", ["Intel", "Enemy base is on grid <marker name='enemyBase'>161170</marker>"]]</sqf>


|x2= <sqf>player createDiaryRecord ["Diary", "Information gathered.<br /><img image='wellDone_ca.paa' />"]</sqf>
|x2= <sqf>player createDiaryRecord ["Diary", "Information gathered.<br /><img image='wellDone_ca.paa' />"];</sqf>


|x3= <sqf>player createDiaryRecord ["Diary", ["No Title", "description"], taskNull, "", false];</sqf>
|x3= <sqf>player createDiaryRecord ["Diary", ["Title", "Description"], taskNull, "", false];</sqf>


|x4= <sqf>player createDiaryRecord ["Diary", ["Font tag","<font color='#7FFF00' size='30' face='TahomaB'>This will changed text size, colour and font</font>"], taskNull, "",false];</sqf>
|x4= <sqf>
player createDiaryRecord [
"Diary",
["Font tag", "<font color='#7FFF00' size='30' face='TahomaB'>This will changed text size, colour and font</font>"],
taskNull,
"",
false
];
</sqf>


|x5= <sqf>player createDiaryRecord ["Diary", ["Image", "<img image='\A3\Ui_F_Curator\Data\Logos\arma3_curator_artwork.jpg' width='500' height='800'/>"], taskNull, "", false];</sqf>
|x5= <sqf>
player createDiaryRecord [
"Diary",
["Image", "<img image='\A3\Ui_F_Curator\Data\Logos\arma3_curator_artwork.jpg' width='500' height='800' />"],
taskNull,
"",
false
];
</sqf>


|x6= <sqf>player createDiaryRecord ["Diary", ["Linebreak","Line1<br></br>Line2<br></br><br></br>Line4"], taskNull, "", false];</sqf>
|x6= <sqf>player createDiaryRecord ["Diary", ["Linebreak", "Line1<br />Line2<br /><br />Line4"], taskNull, "", false];</sqf>


|x7= <sqf>player createDiaryRecord ["Diary", ["Execute","<execute expression='hint ""Some code"";'>Some text</execute>"], taskNull, "", false];</sqf>
|x7= <sqf>player createDiaryRecord ["Diary", ["Execute","<execute expression='hint ""Some code"";'>Some text</execute>"], taskNull, "", false];</sqf>

Latest revision as of 18:08, 2 December 2024

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, 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:
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", ["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 />Line2<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).