createDiaryRecord: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "|PARAMETER4= |p25=" to "|PARAMETER24= |p25=") |
Lou Montana (talk | contribs) |
||
Line 6: | Line 6: | ||
|1.00|Game version= | |1.00|Game version= | ||
|eff= local|Multiplayer Effects= | |eff= local |Multiplayer Effects= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Creates a diary entry. | | Creates a diary entry. Supported tags and their parameters: <spoiler> | ||
{{{!}} class{{=}}"bikitable sortable" | |||
Supported tags and their parameters: | ! 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 | |||
{{!}} - | |||
{{!}}- | |||
{{!}} 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. | {{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]] []; | [[private]] _nullRecord <nowiki>=</nowiki> [[objNull]] [[createDiaryRecord]] []; | ||
[[if]] ([[player]] [[createDiaryRecord]] [" | [[if]] ([[player]] [[createDiaryRecord]] ["Diary", ["title", "description"]] [[isEqualTo]] _nullRecord) [[then]] { [[hint]] "Failed" }; | ||
}} |DESCRIPTION= | }} |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| unitName | | unitName [[createDiaryRecord]] [subject, text, task, taskState, showTitle] |SYNTAX= | ||
|p1= unitName: [[Object]] |PARAMETER1= | |p1= unitName: [[Object]] |PARAMETER1= | ||
|p2= | |||
|p3= | |p2= subject: [[String]] |PARAMETER2= | ||
|p4 | |||
|p3= text: [[String]] |PARAMETER3= | |||
| | |||
| | |p4= task: (optional): [[Task]] |PARAMETER4= | ||
|p5= taskState: (optional): [[String]] - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED"|PARAMETER5= | |||
|p6= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3|dev}} |PARAMETER6= | |||
| [[Diary Record]] |RETURNVALUE= | | [[Diary Record]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | |||
|s2= unitName [[createDiaryRecord]] [subject, [title, text], task, stateState, showTitle] |SYNTAX2= | |||
| | |p21= unitName: [[Object]] |PARAMETER21= | ||
| | |p22= subject: [[String]] |PARAMETER22= | ||
| | |||
| | |p23= title: [[String]] |PARAMETER23= | ||
|p24= text: [[String]] |PARAMETER24= | |||
|p25= task: (optional): [[Task]]|PARAMETER25= | |||
|p26= taskState: (optional): [[String]] - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED" |PARAMETER26= | |||
|p27= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3|dev}} |PARAMETER27= | |||
|r2= [[Diary Record]] |RETURNVALUE2= | |||
____________________________________________________________________________________________ | |||
|x1= <code>[[player]] [[createDiaryRecord]] ["Diary", ["Intel", "Enemy base is on grid <nowiki><marker name='enemyBase'>161170</marker></nowiki>"]]</code>|EXAMPLE1= | |||
|x2= <code>[[player]] [[createDiaryRecord]] ["Diary", "Information gathered.<nowiki><br /><img image='wellDone_ca.paa' /></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= | |||
|x8= <code>[[player]] [[createDiaryRecord]] ["Diary",["ExecuteClose","<nowiki><executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose></nowiki>"],[[taskNull]],"",[[false]]];</code>|EXAMPLE8= | |||
| [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]] |SEEALSO= | | [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]] |SEEALSO= | ||
| |MPBEHAVIOUR= | | |MPBEHAVIOUR= | ||
}} | }} | ||
Revision as of 19:45, 3 September 2019
Description
- Description:
- Creates a diary entry. Supported tags and their parameters:
Tag Options img font - color: String - HTML color in format #aarrggbb or #rrggbb
- size: Number - font height in pixels.
- face: String - font type (class from CfgFontFamilies)
br - marker - name: String - marker name
execute - expression: String - executed code
executeClose - expression: String - executed code, diary is closed afterwards
log 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
- Groups:
- Uncategorised
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 DEV
- 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 DEV
- 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
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.
Categories:
- Scripting Commands
- Introduced with Arma 2 version 1.00
- Arma 2: New Scripting Commands
- Arma 2: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands: Local Effect
- ArmA 2: New Scripting Commands List
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters
- Command Group: Briefing