createDiaryRecord: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Some useful info added)
Line 9: Line 9:
| creates a diary entry.
| creates a diary entry.


You can set up some html, like :
Supported tags and their parameters:
*'''<nowiki>&lt;br /&gt;</nowiki>''' - insert a linebreak
* '''<All>'''
*'''<nowiki>&lt;marker name="markername"&gt;link&lt;/marker&gt;</nowiki>''' - place a link to a marker
** ''image'': [[String]] - path to image. When present, any element with it will be displayed as image.
*'''<nowiki>&lt;img image="picture.paa" /&gt;</nowiki>''' - put an image. |= Description
** ''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
|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 29: Line 57:




|x1= <code>player createDiaryRecord ["Diary", ["My title", "Informations gathered"]]</code>|= EXAMPLE1  
|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", "Informations gathered"]</code>|= EXAMPLE2  
|x2= <code>player createDiaryRecord ["Diary", "Informations gathered.<nowiki><br />&lt;img image="wellDone_ca.paa" /&gt;</nowiki>"]</code>|= EXAMPLE2  


____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 22:01, 1 May 2012

Hover & click on the images for description

Description

Description:
creates a diary entry. Supported tags and their parameters:
  • <All>
    • 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
  • marker
  • execute
    • expression: String - executed code
  • executeClose
    • expression: String - executed code, diary is closed afterwards
  • log
  • gear
  • teamSwitch
  • kick
  • ban
  • mute
  • currentTask
Groups:
Uncategorised

Syntax

Syntax:
unitName createDiaryRecord parameters
Parameters:
unitName: Object
parameters: Array.
can be [subject, text(, task(, state))]
or [subject, [title, text](, task(, state))]
Return Value:
text: 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

See also:
createDiarySubject

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

I haven't seen this mentioned elsewhere: In order 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