createDiaryRecord: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Command " to "{{RV|type=command ")
No edit summary
Line 85: Line 85:
|p4= task: (optional): [[Task]]
|p4= task: (optional): [[Task]]


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


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


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


|p21= unitName: [[Object]] |PARAMETER21=
|p21= unitName: [[Object]] |PARAMETER21=
Line 103: Line 103:
|p25= task: (optional): [[Task]]|PARAMETER25=
|p25= task: (optional): [[Task]]|PARAMETER25=


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


|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=

Revision as of 15:10, 24 January 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
Briefing

Syntax

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

Alternative Syntax

Syntax:
unitName createDiaryRecord [subject, [title, text], task, taskState, 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 "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED"
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:
See also needed

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 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.