createDiaryRecord: Difference between revisions
Jump to navigation
Jump to search
m (note formate) |
(split up different syntax -> increase readability + added Parameter) |
||
| Line 43: | Line 43: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| unitName '''createDiaryRecord''' | | unitName '''createDiaryRecord''' [subject, text, task, state] |= Syntax | ||
|p1= unitName: [[Object]] |= PARAMETER1 | |p1= unitName: [[Object]] |= PARAMETER1 | ||
|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 | |||
| | |s2= unitName '''createDiaryRecord''' [subject, [title, text], task, state] |=Syntax | ||
|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 | ||
Revision as of 16:39, 4 May 2015
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:
- String
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:
- String
Examples
- Example 1:
player createDiaryRecord ["Diary", ["Intel", "Enemy base is on grid <marker name="enemyBase">161170</marker>"]]- Example 2:
player createDiaryRecord ["Diary", "Informations 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>