createDiaryRecord: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "")
(43 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |= Game name
| arma2 |Game name=


|1.00|= Game version
|gr1= Briefing |GROUP1=


|eff= local|= Effects in MP
 
 
|1.00|Game version=
 
|eff= local |Multiplayer Effects=
____________________________________________________________________________________________
 
| Creates a diary entry. Supported tags and their parameters: <spoiler>
{{{!}} class{{=}}"bikitable sortable"
! Tag
!class{{=}}"unsortable" {{!}} 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]] - [http://en.wikipedia.org/wiki/HTML_color HTML color] in format #aarrggbb or #rrggbb
* ''size'': [[Number]] - font height in pixels.
* ''face'': [[String]] - font type (class from CfgFontFamilies)
{{!}}-
{{!}} br
{{!}} {{n/a}}
{{!}}-
{{!}} marker
{{!}}
* ''name'': [[String]] - marker name
{{!}}-
{{!}} execute
{{!}}
* ''expression'': [[String]] - executed code
{{!}}-
{{!}} executeClose
{{!}}
* ''expression'': [[String]] - executed code, diary is closed afterwards
{{!}}-
{{!}} [[createDiaryLink|log]]
{{!}}
* ''subject'': [[String]] - [[createDiarySubject|subject]] name.
* ''record'': [[String]] - record name (e.g. "Record6" or "Unit1059524")
{{!}}-
{{!}} gear
{{!}}
* ''unit'': [[Number]] - unit ID
{{!}}-
{{!}} teamSwitch
{{!}}
* ''unit'': [[Number]] - unit ID
{{!}}-
{{!}} kick
{{!}}
* ''id'': [[Number]] - unit ID
{{!}}-
{{!}} ban
{{!}}
* ''id'': [[Number]] - unit ID
{{!}}-
{{!}} mute
{{!}}
* ''id'': [[Number]] - unit ID
{{!}}-
{{!}} currentTask
{{!}}
* ''id'': [[Number]] - task ID
{{!}}}</spoiler>
{{Informative | 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 <nowiki>=</nowiki> [[objNull]] [[createDiaryRecord]] [];
[[if]] ([[player]] [[createDiaryRecord]] ["Diary", ["title", "description"]] [[isEqualTo]] _nullRecord) [[then]] { [[hint]] "Failed" };
}} |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| creates a diary entry.
| unitName [[createDiaryRecord]] [subject, text, task, taskState, showTitle] |SYNTAX=
 
|p1= unitName: [[Object]] |PARAMETER1=
 
|p2= subject: [[String]] |PARAMETER2=


Supported tags and their parameters:
|p3= text: [[String]] |PARAMETER3=
* '''<All>'''
 
** ''image'': [[String]] - path to image. When present, any element with it will be displayed as image.
|p4= task: (optional): [[Task]] |PARAMETER4=
** ''width'': [[Number]] - image width in pixels.
 
** ''height'': [[Number]] - image height in pixels.
|p5= taskState: (optional): [[String]] - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED"|PARAMETER5=
* '''font'''
 
** ''color'': [[String]] - [http://en.wikipedia.org/wiki/HTML_color HTML color] in format #aarrggbb or #rrggbb
|p6= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3|1.96}} |PARAMETER6=
** ''size'': [[Number]] - font height in pixels.
 
** ''face'': [[String]] - font type (class from CfgFontFamilies)
| [[Diary Record]] |RETURNVALUE=
* '''br'''
* '''marker'''
** ''name'': [[String]] - marker name
* '''execute'''
** ''expression'': [[String]] - executed code
* '''executeClose'''
** ''expression'': [[String]] - executed code, diary is closed afterwards
* '''[[createDiaryLink|log]]'''
** ''subject'': [[String]] - [[createDiarySubject|subject]] name.
** ''record'': [[String]] - record name (e.g. "Record6" or "Unit1059524")
* '''gear'''
** ''unit'': [[Number]] - unit ID
* '''teamSwitch'''
** ''unit'': [[Number]] - unit ID
* '''kick'''
** ''id'': [[Number]] - player ID
* '''ban'''
** ''id'': [[Number]] - player ID
* '''mute'''
** ''id'': [[Number]] - player ID
* '''currentTask'''
** ''id'': [[Number]] - task ID
|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


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


|p1= unitName: [[Object]] |= PARAMETER1
|p21= unitName: [[Object]] |PARAMETER21=
|p2= [subject, text, task, state]: [[Array]] |= PARAMETER2
|p3= subject: [[String]] |=PARAMETER3
|p4= text: [[String]] |=PARAMETER4
|p5= task: (optional): [[Task]] |=PARAMETER5
|p6= state: (optional): [[String]] |=PARAMETER6
| [[String]] |=RETURNVALUE


|p22= subject: [[String]] |PARAMETER22=


|s2= unitName '''createDiaryRecord''' [subject, [title, text], task, state] |=Syntax
|p23= title: [[String]] |PARAMETER23=
|p21= unitName: [[Object]] |=PARAMETER1
|p22= [subject, [title, text], task, state]: [[Array]] |=PARAMETER2
|p23= subject: [[String]] |=PARAMETER3
|p24= [title, text]: [[Array]] |=PARAMETER4
|p25= title: [[String]] |=PARAMETER5
|p26= text: [[String]] |=PARAMETER6
|p27= task: (optional): [[Task]] |=PARAMETER7
|p28= state: (optional):[[String]] |=PARAMETER8


|r2= [[String]] |= RETURNVALUE
|p24= text: [[String]] |PARAMETER24=


|p25= task: (optional): [[Task]]|PARAMETER25=


|x1= <code>[[player]] [[createDiaryRecord]] ["Diary", ["Intel", "Enemy base is on grid <nowiki><marker name='enemyBase'>161170</marker></nowiki>"]]</code>|= EXAMPLE1
|p26= taskState: (optional): [[String]] - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED" |PARAMETER26=
|x2= <code>[[player]] [[createDiaryRecord]] ["Diary", "Information gathered.<nowiki><br />&lt;img image='wellDone_ca.paa' /&gt;</nowiki>"]</code>|= EXAMPLE2


|p27= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3|1.96}} |PARAMETER27=
|r2= [[Diary Record]] |RETURNVALUE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


|  |= MPBEHAVIOUR
|x2= <code>[[player]] [[createDiaryRecord]] ["Diary", "Information gathered.<nowiki><br />&lt;img image='wellDone_ca.paa' /&gt;</nowiki>"]</code>|EXAMPLE2=
____________________________________________________________________________________________
 
|x3= <code>[[player]] [[createDiaryRecord]] ["Diary", ["No Title", "description"], [[taskNull]], "", [[false]]];</code>|EXAMPLE3=
 
|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=
 
|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=
 
|x6= <code>[[player]] [[createDiaryRecord]] ["Diary", ["Linebreak","<nowiki>Line1<br></br>Line2<br></br><br></br>Line4</nowiki>"], [[taskNull]], "", [[false]]];</code>|EXAMPLE6=
 
|x7= <code>[[player]] [[createDiaryRecord]] ["Diary", ["Execute","<nowiki><execute expression='hint ""Some code"";'>Some text</execute></nowiki>"], [[taskNull]], "", [[false]]];</code>|EXAMPLE7=
 
|x8= <code>[[player]] [[createDiaryRecord]] ["Diary", ["ExecuteClose", "<nowiki><executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose></nowiki>"], [[taskNull]], "", [[false]]];</code>|EXAMPLE8=
 
| [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]], [[setDiaryRecordText]], [[removeDiaryRecord]] |SEEALSO=
 
|  |MPBEHAVIOUR=
}}
}}


<h3 style='display:none'>Notes</h3>
<h3 style='display:none'>Bottom Section</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on  14:54, 15 January 2011‎</dd>
<dt class="note">[[User:Alwarren|Alwarren]]</dt>
<dd class="note">
To insert a link into a diary record that executes code instead of jumping to a marker, use the tag
<execute expression="''Code to execute''">Text</execute>
<!-- Note Section END -->
</dl>


<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Briefing|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
<!-- CONTINUE Notes -->
Line 106: Line 150:
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.
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.
</dd>
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on May 21, 2018 - 08:21 (UTC)</dd>
<dd class="notedate">Posted on May 21, 2018 - 08:21 (UTC)</dd>
<dt class="note">[[User:Kalthramis|Kalthramis]]</dt>
<dt class="note">[[User:Kalthramis|Kalthramis]]</dt>
<dd class="note">
<dd class="note">
To add an entry under the 'Briefing' subject, which is available by default, use "Diary" as the subject.  
To add an entry under the 'Briefing' subject, which is available by default, use "Diary" as the subject.  
</dd>
<dd class="notedate">Posted on June 22, 2019 - 16:28 (UTC)</dd>
<dt class="note">[[User:R3vo|R3vo]]</dt>
<dd class="note">
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.
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 12:19, 25 September 2020

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.