createDiaryRecord: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|gr1= Briefing |GROUP1=
|gr1= Briefing






|1.00|Game version=
|1.00


|eff= local |Multiplayer Effects=
|eff= local


| Creates a diary entry. Supported tags and their parameters: <spoiler>
| Creates a diary entry. Supported tags and their parameters: <spoiler>
Line 75: Line 75:
  [[private]] _nullRecord <nowiki>=</nowiki> [[objNull]] [[createDiaryRecord]] [];
  [[private]] _nullRecord <nowiki>=</nowiki> [[objNull]] [[createDiaryRecord]] [];
  [[if]] ([[player]] [[createDiaryRecord]] ["Diary", ["title", "description"]] [[isEqualTo]] _nullRecord) [[then]] { [[hint]] "Failed" };
  [[if]] ([[player]] [[createDiaryRecord]] ["Diary", ["title", "description"]] [[isEqualTo]] _nullRecord) [[then]] { [[hint]] "Failed" };
}} |DESCRIPTION=
}}


| unitName [[createDiaryRecord]] [subject, text, task, taskState, showTitle] |SYNTAX=
| unitName [[createDiaryRecord]] [subject, text, task, taskState, showTitle]


|p1= unitName: [[Object]] |PARAMETER1=
|p1= unitName: [[Object]]


|p2= subject: [[String]] |PARAMETER2=
|p2= subject: [[String]]


|p3= text: [[String]] |PARAMETER3=
|p3= text: [[String]]


|p4= task: (optional): [[Task]] |PARAMETER4=
|p4= task: (optional): [[Task]]


|p5= taskState: (optional): [[String]] - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED"|PARAMETER5=
|p5= taskState: (optional): [[String]] - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED"


|p6= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3|1.96}} |PARAMETER6=
|p6= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3|1.96}}


| [[Diary Record]] |RETURNVALUE=
| [[Diary Record]]


|s2= unitName [[createDiaryRecord]] [subject, [title, text], task, stateState, showTitle] |SYNTAX2=
|s2= unitName [[createDiaryRecord]] [subject, [title, text], task, stateState, showTitle]


|p21= unitName: [[Object]] |PARAMETER21=
|p21= unitName: [[Object]] |PARAMETER21=
Line 109: Line 109:
|p27= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3|1.96}} |PARAMETER27=
|p27= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3|1.96}} |PARAMETER27=


|r2= [[Diary Record]] |RETURNVALUE2=
|r2= [[Diary Record]]


|x1= <code>[[player]] [[createDiaryRecord]] ["Diary", ["Intel", "Enemy base is on grid <nowiki><marker name='enemyBase'>161170</marker></nowiki>"]]</code>|EXAMPLE1=
|x1= <code>[[player]] [[createDiaryRecord]] ["Diary", ["Intel", "Enemy base is on grid <nowiki><marker name='enemyBase'>161170</marker></nowiki>"]]</code>


|x2= <code>[[player]] [[createDiaryRecord]] ["Diary", "Information gathered.<nowiki><br />&lt;img image='wellDone_ca.paa' /&gt;</nowiki>"]</code>|EXAMPLE2=
|x2= <code>[[player]] [[createDiaryRecord]] ["Diary", "Information gathered.<nowiki><br />&lt;img image='wellDone_ca.paa' /&gt;</nowiki>"]</code>


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


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


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


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


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


|x8= <code>[[player]] [[createDiaryRecord]] ["Diary", ["ExecuteClose", "<nowiki><executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose></nowiki>"], [[taskNull]], "", [[false]]];</code>|EXAMPLE8=
|x8= <code>[[player]] [[createDiaryRecord]] ["Diary", ["ExecuteClose", "<nowiki><executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose></nowiki>"], [[taskNull]], "", [[false]]];</code>


| [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]], [[setDiaryRecordText]], [[removeDiaryRecord]] |SEEALSO=
| [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]], [[setDiaryRecordText]], [[removeDiaryRecord]]


|  |MPBEHAVIOUR=
|  |MPBEHAVIOUR=

Revision as of 00:13, 18 January 2021

Logo A2.png1.00
LELocal
Hover & click on the images for description

Description

Description:
Creates a diary entry. Supported tags and their parameters:
Tag Options
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.
font
  • color: String - HTML color in format #aarrggbb or #rrggbb
  • size: Number - font height in pixels.
  • face: String - font type (class from CfgFontFamilies)
br N/A
marker
execute
  • expression: String - executed code
executeClose
  • expression: String - executed code, diary is closed afterwards
log
gear
teamSwitch
kick
ban
mute
currentTask
↑ Back to spoiler's top
ⓘ
If createDiaryRecord command fails, it returns null record, but since there is no null record unary command, you can make a variable and compare against it. 
private _nullRecord = objNull createDiaryRecord [];
if (player createDiaryRecord ["Diary", ["title", "description"]] isEqualTo _nullRecord) then { hint "Failed" };
Groups:
Briefing

Syntax

Syntax:
unitName createDiaryRecord [subject, text, task, taskState, showTitle]
Parameters:
unitName: Object
subject: String
text: String
task: (optional): Task
taskState: (optional): String - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED"
showTitle (Optional): Boolean - Title visibility. Default: true Arma 3 logo black.png1.96
Return Value:
Diary Record

Alternative Syntax

Syntax:
unitName createDiaryRecord [subject, [title, text], task, stateState, showTitle]
Parameters:
unitName: Object
subject: String
title: String
text: String
task: (optional): Task
taskState: (optional): String - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED"
showTitle (Optional): Boolean - Title visibility. Default: true Arma 3 logo black.png1.96
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", ["No 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></br>Line2<br></br><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:
processDiaryLinkcreateDiaryLinkcreateDiarySubjectdiarySubjectExistssetDiaryRecordTextremoveDiaryRecord

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

Bottom Section

Posted on March 24, 2017 - 20:11 (UTC)
Tankbuster
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 May 21, 2018 - 08:21 (UTC)
Kalthramis
To add an entry under the 'Briefing' subject, which is available by default, use "Diary" as the subject.
Posted on June 22, 2019 - 16:28 (UTC)
R3vo
It seems that the task parameter has no effect because the task entry in the briefing menu is created when the task itself was created.
Retrieved from "https://community.bistudio.com/wiki?title=createDiaryRecord&oldid=204198"