createDiaryRecord: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (return type) |
m (template:command argument fix) |
||
| Line 47: | Line 47: | ||
| unitName '''createDiaryRecord''' [subject, text, task, state] |= Syntax | | unitName '''createDiaryRecord''' [subject, text, task, state] |= Syntax | ||
|p1= unitName: [[Object]] |= | |p1= unitName: [[Object]] |PARAMETER1= | ||
|p2= [subject, text, task, state]: [[Array]] |= | |p2= [subject, text, task, state]: [[Array]] |PARAMETER2= | ||
|p3= subject: [[String]] |= | |p3= subject: [[String]] |PARAMETER3= | ||
|p4= text: [[String]] |= | |p4= text: [[String]] |PARAMETER4= | ||
|p5= task: (optional): [[Task]] |= | |p5= task: (optional): [[Task]] |PARAMETER5= | ||
|p6= state: (optional): [[String]] |= | |p6= state: (optional): [[String]] |PARAMETER6= | ||
| [[Diary Record]] |= | | [[Diary Record]] |RETURNVALUE= | ||
|s2= unitName '''createDiaryRecord''' [subject, [title, text], task, state] |=Syntax | |s2= unitName '''createDiaryRecord''' [subject, [title, text], task, state] |=Syntax | ||
|p21= unitName: [[Object]] |= | |p21= unitName: [[Object]] |PARAMETER1= | ||
|p22= [subject, [title, text], task, state]: [[Array]] |= | |p22= [subject, [title, text], task, state]: [[Array]] |PARAMETER2= | ||
|p23= subject: [[String]] |= | |p23= subject: [[String]] |PARAMETER3= | ||
|p24= [title, text]: [[Array]] |= | |p24= [title, text]: [[Array]] |PARAMETER4= | ||
|p25= title: [[String]] |= | |p25= title: [[String]] |PARAMETER5= | ||
|p26= text: [[String]] |= | |p26= text: [[String]] |PARAMETER6= | ||
|p27= task: (optional): [[Task]] |= | |p27= task: (optional): [[Task]] |PARAMETER7= | ||
|p28= state: (optional):[[String]] |= | |p28= state: (optional):[[String]] |PARAMETER8= | ||
|r2= [[Diary Record]] |= | |r2= [[Diary Record]] |RETURNVALUE= | ||
|x1= <code>[[player]] [[createDiaryRecord]] ["Diary", ["Intel", "Enemy base is on grid <nowiki><marker name='enemyBase'>161170</marker></nowiki>"]]</code>|= | |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>|= | |x2= <code>[[player]] [[createDiaryRecord]] ["Diary", "Information gathered.<nowiki><br /><img image='wellDone_ca.paa' /></nowiki>"]</code>|EXAMPLE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]] |= | | [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]] |SEEALSO= | ||
| |= | | |MPBEHAVIOUR= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
}} | }} | ||
Revision as of 10:30, 7 April 2019
Description
- Description:
- creates a diary entry.
Supported tags and their parameters:
- <All>
- 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 - player ID
- ban
- id: Number - player ID
- mute
- id: Number - player ID
- currentTask
- id: Number - task ID
- Groups:
- Uncategorised
Syntax
- Syntax:
- unitName createDiaryRecord [subject, text, task, state]
- Parameters:
- unitName: Object
- [subject, text, task, state]: Array
- subject: String
- text: String
- task: (optional): Task
- state: (optional): String
- Return Value:
- Diary Record
Alternative Syntax
- Syntax:
- unitName createDiaryRecord [subject, [title, text], task, state]
- Parameters:
- unitName: Object
- [subject, [title, text], task, state]: Array
- subject: String
- [title, text]: Array
- title: String
- text: String
- task: (optional): Task
- state: (optional):String
- 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' />"]
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
Notes
- Posted on 14:54, 15 January 2011
- Alwarren
- 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>
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.
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