createDiaryRecord: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>") |
Lou Montana (talk | contribs) m (Remove syntaxhighlight spoiler hack) |
||
(14 intermediate revisions by 4 users not shown) | |||
Line 19: | Line 19: | ||
|arg= local | |arg= local | ||
|descr= | |descr= Creates a [[Diary]] entry. Supported tags and their parameters: <spoiler> | ||
Creates a [[Diary | {| class="wikitable sortable valign-top" | ||
{| class="wikitable sortable" | |||
! Tag | ! Tag | ||
! class="unsortable" | Options | ! class="unsortable" | Options | ||
Line 31: | Line 30: | ||
* ''width'': [[Number]] - image width in pixels. | * ''width'': [[Number]] - image width in pixels. | ||
* ''height'': [[Number]] - image height in pixels. | * ''height'': [[Number]] - image height in pixels. | ||
{{Feature|arma3|Maximum width supported seems to be 370 | * {{GVI|arma3|2.10|size= 0.75}} ''title'': [[String]] - tooltip to show on mouse over image | ||
| <syntaxhighlight lang="html"><img image="picture.paa" width="128" height="64" /></syntaxhighlight> | * {{GVI|arma3|2.10|size= 0.75}} ''src'': [[String]] - alternative to 'image' | ||
{{Feature|arma3|Maximum width supported seems to be '''370''' pixels as a wider image will be cut off. Height should be calculated with the aspect ratio of the image. {{hl|height {{=}} 370; ratio {{=}} 16/9; height {{=}} width / ratio;}}}} | |||
| | |||
<syntaxhighlight lang="html"><img image="picture.paa" width="128" height="64" /></syntaxhighlight> | |||
<br> | |||
Since {{arma3}} v2.10: | |||
<syntaxhighlight lang="html"><img src="picture.paa" width="128" height="64" title="this is an image" /></syntaxhighlight> | |||
|- | |- | ||
| font | | font | ||
| | | | ||
* ''color'': [[String]] - {{ | * ''color'': [[String]] - {{Link|https://en.wikipedia.org/wiki/HTML_color|HTML color}} in format #aarrggbb or #rrggbb | ||
* ''size'': [[Number]] - font height in pixels | * ''size'': [[Number]] - font height in pixels (default: 14) | ||
* ''face'': [[String]] - font type (see [[FXY File Format#Available Fonts|Fonts]]) | * ''face'': [[String]] - font type (see [[FXY File Format#Available Fonts|Fonts]]) | ||
| <syntaxhighlight lang="html"><font color="#FF00FF" size="16" face="LucidaConsoleB">Hello there</font></syntaxhighlight> | | <syntaxhighlight lang="html"><font color="#FF00FF" size="16" face="LucidaConsoleB">Hello there</font></syntaxhighlight> | ||
Line 43: | Line 48: | ||
| br | | br | ||
| {{n/a}} | | {{n/a}} | ||
| <syntaxhighlight lang="html">Line 1<br/>Line 2</syntaxhighlight> | | <syntaxhighlight lang="html">Line 1<br />Line 2</syntaxhighlight> | ||
|- | |- | ||
| marker | | marker | ||
Line 63: | Line 68: | ||
| | | | ||
* ''subject'': [[String]] - [[createDiarySubject|subject]] name. | * ''subject'': [[String]] - [[createDiarySubject|subject]] name. | ||
* ''record'': [[String]] - record | * ''record'': [[String]] - record ID (e.g. "Record6" or "Unit1059524") | ||
| <syntaxhighlight lang="html"><log subject="Hello">Get to the Hello subject</log></syntaxhighlight> | | <syntaxhighlight lang="html"><log subject="Hello">Get to the "Hello" subject</log></syntaxhighlight> | ||
<syntaxhighlight lang="html"><log record=" | <syntaxhighlight lang="html"><log subject="Hello" record="Record0">Go to the first record added to "Hello"</log></syntaxhighlight> | ||
|- | |- | ||
| gear | | gear | ||
Line 91: | Line 96: | ||
* ''id'': [[Number]] - unit ID | * ''id'': [[Number]] - unit ID | ||
| <syntaxhighlight lang="html"><mute unit="123456">mute player unit 123456</mute></syntaxhighlight> | | <syntaxhighlight lang="html"><mute unit="123456">mute player unit 123456</mute></syntaxhighlight> | ||
|- | |||
| voteadmin | |||
| | |||
* ''id'': [[Number]] - unit ID | |||
| <syntaxhighlight lang="html"><voteadmin unit="123456">vote admin unit 123456</voteadmin></syntaxhighlight> | |||
|- | |||
| votekick | |||
| | |||
* ''id'': [[Number]] - unit ID | |||
| <syntaxhighlight lang="html"><votekick unit="123456">vote kick player unit 123456</votekick></syntaxhighlight> | |||
|- | |- | ||
| currentTask | | currentTask | ||
| | | | ||
* ''id'': [[Number]] - task ID | * ''id'': [[Number]] - task ID | ||
* ''action'': [[String]] - 'n' or 's' (select) | |||
| <syntaxhighlight lang="html"><currentTask id="my_task">get to my_task task</currentTask></syntaxhighlight> | | <syntaxhighlight lang="html"><currentTask id="my_task">get to my_task task</currentTask></syntaxhighlight> | ||
|}</spoiler> | |}</spoiler> | ||
{{Feature | | {{Feature|informative| | ||
< | If the [[createDiaryRecord]] command fails, it returns a null record. | ||
private _createdRecord | Before {{arma3}} v2.00, [[isNull]] did not work with the diary record type and [[diaryRecordNull]] did not exist. | ||
In order to verify a null record, it is possible to create a variable and compare against it: | |||
<sqf> | |||
private _recordNull = objNull createDiaryRecord []; | |||
private _createdRecord = player createDiaryRecord ["Diary", ["Title", "Description"]]; | |||
if (_createdRecord isEqualTo _recordNull) then { hint "Failed"; }; | |||
</sqf> | |||
}} | }} | ||
|s1= player [[createDiaryRecord]] [subject, | |s1= player [[createDiaryRecord]] [subject, textInfo, task, taskState, showTitle] | ||
|p1= player: [[Object]] | |p1= player: [[Object]] | ||
Line 108: | Line 130: | ||
|p2= subject: [[String]] | |p2= subject: [[String]] | ||
|p3= text: [[String]] | |p3= textInfo: [[String]] or [[Array]] of [[String]]s - can be: | ||
* [[String]] - the record's content - its title will be empty | |||
* [[Array]] of [[String]]s - format [title, text, icon]: | |||
** title: [[String]] | |||
** text: [[String]] | |||
** {{GVI|arma3|2.10|size= 0.75}} icon: [[String]] - (Optional) icon to show next to the title | |||
|p4= task: [[Task]] - (Optional, default | |p4= task: [[Task]] - (Optional, default [[taskNull]]) | ||
|p5= taskState: [[String]] (Optional, default {{ | |p5= taskState: [[String]] - (Optional, default {{hl|"NONE"}}) changes the state of the given task. Can be one of: | ||
{{Columns|3| | |||
* {{hl|"NONE"}} | |||
* {{hl|"CREATED"}} | |||
* {{hl|"ASSIGNED"}} | |||
* {{hl|"SUCCEEDED"}} | |||
* {{hl|"FAILED"}} | |||
* {{hl|"CANCELED"}} | |||
}} | |||
|p6= showTitle: [[Boolean]] (Optional, default | |p6= showTitle: [[Boolean]] - (Optional, default [[true]]) whether or not to show title in the description section as well | ||
|p6since= arma3 1.96 | |p6since= arma3 1.96 | ||
|r1= [[Diary Record]] | |r1= [[Diary Record]] | ||
| | |x1= <sqf>player createDiaryRecord ["Diary", ["Intel", "Enemy base is on grid <marker name='enemyBase'>161170</marker>"]]</sqf> | ||
| | |x2= <sqf>player createDiaryRecord ["Diary", "Information gathered.<br /><img image='wellDone_ca.paa' />"]</sqf> | ||
| | |x3= <sqf>player createDiaryRecord ["Diary", ["Title", "Description"], taskNull, "", false];</sqf> | ||
| | |x4= <sqf> | ||
player createDiaryRecord [ | |||
"Diary", | |||
["Font tag", "<font color='#7FFF00' size='30' face='TahomaB'>This will changed text size, colour and font</font>"], | |||
taskNull, | |||
"", | |||
false | |||
]; | |||
</sqf> | |||
| | |x5= <sqf> | ||
player createDiaryRecord [ | |||
"Diary", | |||
["Image", "<img image='\A3\Ui_F_Curator\Data\Logos\arma3_curator_artwork.jpg' width='500' height='800' />"], | |||
taskNull, | |||
"", | |||
false | |||
]; | |||
</sqf> | |||
| | |x6= <sqf>player createDiaryRecord ["Diary", ["Linebreak", "Line1<br />Line2<br /><br />Line4"], taskNull, "", false];</sqf> | ||
| | |x7= <sqf>player createDiaryRecord ["Diary", ["Execute","<execute expression='hint ""Some code"";'>Some text</execute>"], taskNull, "", false];</sqf> | ||
| | |x8= <sqf>player createDiaryRecord ["Diary", ["ExecuteClose", "<executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose>"], taskNull, "", false];</sqf> | ||
| | |seealso= [[allDiaryRecords]] [[processDiaryLink]] [[createDiaryLink]] [[createDiarySubject]] [[diarySubjectExists]] [[setDiaryRecordText]] [[removeDiaryRecord]] | ||
}} | |||
| | {{Note | ||
|user= Tankbuster | |||
|timestamp= 20170324201100 | |||
|text= 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. | |||
}} | |||
| | {{Note | ||
|user= R3vo | |||
|timestamp= 20190622162800 | |||
|text= It seems that the '''task''' parameter has no effect in {{arma3}} because the task entry in the briefing menu is created when the task itself was created. | |||
}} | |||
| | {{Note | ||
|user= Honger | |||
| | |timestamp= 20221018175112 | ||
|text= <nowiki><log></nowiki>, as <sqf inline>createDiaryLink</sqf>, requires declaring '''both''' subject and ID of the record belonging to said subject. Otherwise generated text will not be clickable or might open a non-existing record (behaviour similar to clicking on map when viewing Diary). | |||
}} | }} | ||
Latest revision as of 13:51, 23 June 2023
Description
- Description:
- Creates a Diary entry. Supported tags and their parameters:
Tag Options Example img <img image="picture.paa" width="128" height="64" />
Since Arma 3 v2.10:<img src="picture.paa" width="128" height="64" title="this is an image" />
font - color: String - HTML color in format #aarrggbb or #rrggbb
- size: Number - font height in pixels (default: 14)
- face: String - font type (see Fonts)
<font color="#FF00FF" size="16" face="LucidaConsoleB">Hello there</font>
br N/A Line 1<br />Line 2
marker - name: String - marker name
<marker name="respawn_west">Respawn point</marker>
execute - expression: String - executed code
<execute expression="player setDamage 1">Die!</execute>
executeClose - expression: String - executed code, diary is closed afterwards
<executeClose expression="player setDamage 1">Die and close</executeClose>
log <log subject="Hello">Get to the "Hello" subject</log>
<log subject="Hello" record="Record0">Go to the first record added to "Hello"</log>
gear - unit: Number - unit ID
<gear unit="123456">Open unit 123456's gear</gear>
teamSwitch - unit: Number - unit ID
<teamSwitch unit="123456">Switch to unit 123456</teamSwitch>
kick - id: Number - unit ID
<kick unit="123456">Kick player unit 123456</kick>
ban - id: Number - unit ID
<ban unit="123456">ban player unit 123456</ban>
mute - id: Number - unit ID
<mute unit="123456">mute player unit 123456</mute>
voteadmin - id: Number - unit ID
<voteadmin unit="123456">vote admin unit 123456</voteadmin>
votekick - id: Number - unit ID
<votekick unit="123456">vote kick player unit 123456</votekick>
currentTask <currentTask id="my_task">get to my_task task</currentTask>
- Groups:
- Briefing
Syntax
- Syntax:
- player createDiaryRecord [subject, textInfo, task, taskState, showTitle]
- Parameters:
- player: Object
- subject: String
- textInfo: String or Array of Strings - can be:
- task: Task - (Optional, default taskNull)
- taskState: String - (Optional, default "NONE") changes the state of the given task. Can be one of:
- "NONE"
- "CREATED"
- "ASSIGNED"
- "SUCCEEDED"
- "FAILED"
- "CANCELED"
- since 1.96
- showTitle: Boolean - (Optional, default true) whether or not to show title in the description section as well
- Return Value:
- Diary Record
Examples
- Example 1:
- player createDiaryRecord ["Diary", ["Intel", "Enemy base is on grid <marker name='enemyBase'>161170</marker>"]]
- Example 2:
- Example 3:
- Example 4:
- Example 5:
- Example 6:
- Example 7:
- Example 8:
Additional Information
- See also:
- allDiaryRecords processDiaryLink createDiaryLink createDiarySubject diarySubjectExists setDiaryRecordText removeDiaryRecord
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 Mar 24, 2017 - 20:11 (UTC)
- 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 Jun 22, 2019 - 16:28 (UTC)
- It seems that the task parameter has no effect in Arma 3 because the task entry in the briefing menu is created when the task itself was created.
- Posted on Oct 18, 2022 - 17:51 (UTC)
- <log>, as createDiaryLink, requires declaring both subject and ID of the record belonging to said subject. Otherwise generated text will not be clickable or might open a non-existing record (behaviour similar to clicking on map when viewing Diary).