createDiaryRecord: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(page formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2
 
|version1= 1.00
 
|game2= arma2oa
 
|version2= 1.51
 
|game3= tkoh
 
|version3= 1.00
 
|game4= arma3
 
|version4= 0.50


|gr1= Briefing
|gr1= Briefing


|1.00
|eff= local


|eff= local
|arg= local


| Creates a diary entry. Supported tags and their parameters: <spoiler>
|descr= Creates a [[Diary|diary]] entry. Supported tags and their parameters: <spoiler>
{{{!}} class{{=}}"wikitable sortable"
{{{!}} class{{=}}"wikitable sortable"
! Tag
! Tag
Line 75: Line 89:
}}
}}


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


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


|p2= subject: [[String]]
|p2= subject: [[String]]
Line 83: Line 97:
|p3= text: [[String]]
|p3= text: [[String]]


|p4= task: (optional): [[Task]]
|p4= task: (Optional, default {{ic|[[taskNull]]}}) - [[Task]]


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


|p6= showTitle (Optional): [[Boolean]] - Whether or not to show title in the description section as well. Default: [[true]] {{GVI|arma3|1.96}}
|p6= showTitle: [[Boolean]] (Optional, default {{ic|[[true]]}}) - Whether or not to show title in the description section as well {{Since|arma3|1.96|yes}}


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


|s2= unitName [[createDiaryRecord]] [subject, [title, text], task, taskState, showTitle]
|s2= player [[createDiaryRecord]] [subject, [title, text], task, taskState, showTitle]


|p21= unitName: [[Object]]
|p21= player : [[Object]]


|p22= subject: [[String]]
|p22= subject: [[String]]
Line 101: Line 115:
|p24= text: [[String]]
|p24= text: [[String]]


|p25= task: (optional): [[Task]]
|p25= task: (Optional, default {{ic|[[taskNull]]}}) - [[Task]]


|p26= taskState: (optional): [[String]] - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"
|p26= taskState: [[String]] (Optional, default {{ic|?}}) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"


|p27= showTitle (Optional): [[Boolean]] - Whether or not to show title in the description section as well. Default: [[true]] {{GVI|arma3|1.96}}
|p27= showTitle: [[Boolean]] (Optional, default {{ic|[[true]]}}) - Whether or not to show title in the description section as well {{Since|arma3|1.96|yes}}


|r2= [[Diary Record]]
|r2= [[Diary Record]]
Line 125: Line 139:
|x8= <code>[[player]] [[createDiaryRecord]] ["Diary", ["ExecuteClose", "<nowiki><executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose></nowiki>"], [[taskNull]], "", [[false]]];</code>
|x8= <code>[[player]] [[createDiaryRecord]] ["Diary", ["ExecuteClose", "<nowiki><executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose></nowiki>"], [[taskNull]], "", [[false]]];</code>


|seealso= [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]], [[setDiaryRecordText]], [[removeDiaryRecord]]
|seealso= [[processDiaryLink]] [[createDiaryLink]] [[createDiarySubject]] [[diarySubjectExists]] [[setDiaryRecordText]] [[removeDiaryRecord]]
}}
}}


{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]


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


Line 150: Line 154:
<dt class="note">[[User:R3vo|R3vo]]</dt>
<dt class="note">[[User:R3vo|R3vo]]</dt>
<dd class="note">
<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.
It seems that the '''task''' parameter has no effect in {{arma3}} 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 10:42, 4 March 2021

Logo A2.png1.00A2 OA Logo.png1.51tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalLELocal
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:
player createDiaryRecord [subject, text, task, taskState, showTitle]
Parameters:
player: Object
subject: String
text: String
task: (Optional, default taskNull) - Task
taskState: String (Optional, default ?) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"
showTitle: Boolean (Optional, default true) - Whether or not to show title in the description section as well Template:Since
Return Value:
Diary Record

Alternative Syntax

Syntax:
player createDiaryRecord [subject, [title, text], task, taskState, showTitle]
Parameters:
player : Object
subject: String
title: String
text: String
task: (Optional, default taskNull) - Task
taskState: String (Optional, default ?) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"
showTitle: Boolean (Optional, default true) - Whether or not to show title in the description section as well Template:Since
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:
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 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 June 22, 2019 - 16:28 (UTC)
R3vo
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.
Retrieved from "https://community.bistudio.com/wiki?title=createDiaryRecord&oldid=250574"