createDiaryRecord: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "") |
Killzone Kid (talk | contribs) No edit summary |
||
(31 intermediate revisions by 4 users not shown) | |||
Line 2: | Line 2: | ||
|game1= arma2 | |game1= arma2 | ||
|version1= 1.00 | |version1= 1.00 | ||
|game2= arma2oa | |game2= arma2oa | ||
|version2= 1.50 | |||
|version2= 1. | |||
|game3= tkoh | |game3= tkoh | ||
|version3= 1.00 | |version3= 1.00 | ||
|game4= arma3 | |game4= arma3 | ||
|version4= 0.50 | |version4= 0.50 | ||
Line 23: | Line 19: | ||
|arg= local | |arg= local | ||
|descr= Creates a [[Diary|diary]] entry. Supported tags and their parameters: <spoiler> | |descr= <syntaxhighlight lang="html"></syntaxhighlight><!-- needed for spoiler to have it --> | ||
{ | Creates a [[Diary|diary]] entry. Supported tags and their parameters: <spoiler> | ||
{| class="wikitable sortable" | |||
! Tag | ! Tag | ||
!class | ! class="unsortable" | Options | ||
! class="unsortable" | Example | |||
|- | |||
| img | |||
| | |||
* ''image'': [[String]] - path to image. When present, any element with it will be displayed as image. | * ''image'': [[String]] - path to image. When present, any element with it will be displayed as image. | ||
* ''width'': [[Number]] - image width in pixels. | * ''width'': [[Number]] - image width in pixels. | ||
* ''height'': [[Number]] - image height in pixels. | * ''height'': [[Number]] - image height in pixels. | ||
{{ | * ''title'': [[String]] - tooltip to show on mouse over image (Since Arma 3 v2.10) | ||
{{ | * ''src'': [[String]] - alternative to 'image' (Since Arma 3 v2.10) | ||
{{ | {{Feature|arma3|Maximum width supported seems to be 370 pixel. An image wider that this will be cut off. Height should be calculated with the aspect ratio of the image. {{ic|height {{=}} 370; ratio {{=}} 16/9; height {{=}} width / ratio;}}}} | ||
* ''color'': [[String]] - | | <syntaxhighlight lang="html"><img image="picture.paa" width="128" height="64" /></syntaxhighlight><br>Since Arma 3 v2.10 :<br><syntaxhighlight lang="html"><img title="this is image" src="picture.paa" width="128" height="64" /></syntaxhighlight> | ||
|- | |||
| font | |||
| | |||
* ''color'': [[String]] - {{Wikipedia|HTML_color|HTML color}} in format #aarrggbb or #rrggbb | |||
* ''size'': [[Number]] - font height in pixels. | * ''size'': [[Number]] - font height in pixels. | ||
* ''face'': [[String]] - font type ( | * ''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> | |||
|- | |||
| br | |||
| {{n/a}} | |||
| <syntaxhighlight lang="html">Line 1<br/>Line 2</syntaxhighlight> | |||
|- | |||
| marker | |||
| | |||
* ''name'': [[String]] - marker name | * ''name'': [[String]] - marker name | ||
| <syntaxhighlight lang="html"><marker name="respawn_west">Respawn point</marker></syntaxhighlight> | |||
|- | |||
| execute | |||
| | |||
* ''expression'': [[String]] - executed code | * ''expression'': [[String]] - executed code | ||
| <syntaxhighlight lang="html"><execute expression="player setDamage 1">Die!</execute></syntaxhighlight> | |||
|- | |||
| executeClose | |||
| | |||
* ''expression'': [[String]] - executed code, diary is closed afterwards | * ''expression'': [[String]] - executed code, diary is closed afterwards | ||
| <syntaxhighlight lang="html"><executeClose expression="player setDamage 1">Die and close</executeClose></syntaxhighlight> | |||
|- | |||
| [[createDiaryLink|log]] | |||
| | |||
* ''subject'': [[String]] - [[createDiarySubject|subject]] name. | * ''subject'': [[String]] - [[createDiarySubject|subject]] name. | ||
* ''record'': [[String]] - record name (e.g. "Record6" or "Unit1059524") | * ''record'': [[String]] - record name (e.g. "Record6" or "Unit1059524") | ||
| <syntaxhighlight lang="html"><log subject="Hello">Get to the Hello subject</log></syntaxhighlight> | |||
<syntaxhighlight lang="html"><log record="ABCD">Get to the ABC record</log></syntaxhighlight> | |||
|- | |||
| gear | |||
| | |||
* ''unit'': [[Number]] - unit ID | * ''unit'': [[Number]] - unit ID | ||
| <syntaxhighlight lang="html"><gear unit="123456">Open unit 123456's gear</gear></syntaxhighlight> | |||
|- | |||
| teamSwitch | |||
| | |||
* ''unit'': [[Number]] - unit ID | * ''unit'': [[Number]] - unit ID | ||
| <syntaxhighlight lang="html"><teamSwitch unit="123456">Switch to unit 123456</teamSwitch></syntaxhighlight> | |||
|- | |||
| kick | |||
| | |||
* ''id'': [[Number]] - unit ID | * ''id'': [[Number]] - unit ID | ||
| <syntaxhighlight lang="html"><kick unit="123456">Kick player unit 123456</kick></syntaxhighlight> | |||
|- | |||
| ban | |||
| | |||
* ''id'': [[Number]] - unit ID | * ''id'': [[Number]] - unit ID | ||
| <syntaxhighlight lang="html"><ban unit="123456">ban player unit 123456</ban></syntaxhighlight> | |||
|- | |||
| mute | |||
| | |||
* ''id'': [[Number]] - unit ID | * ''id'': [[Number]] - unit ID | ||
| <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 | |||
| | |||
* ''id'': [[Number]] - task ID | * ''id'': [[Number]] - task ID | ||
* ''action'': [[String]] - 'n' or 's' (select) | |||
{{Feature | Informative | If the [[createDiaryRecord]] command fails, it returns a null record. | | <syntaxhighlight lang="html"><currentTask id="my_task">get to my_task task</currentTask></syntaxhighlight> | ||
< | |}</spoiler> | ||
{{Feature | Informative | If the [[createDiaryRecord]] command fails, it returns a null record. 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> | |||
}} | }} | ||
Line 97: | Line 124: | ||
|p3= text: [[String]] | |p3= text: [[String]] | ||
|p4= task: (Optional, default {{ic|[[taskNull]]}}) | |p4= task: [[Task]] - (Optional, default {{ic|[[taskNull]]}}) | ||
|p5= taskState: [[String]] (Optional, default {{ic|?}}) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED" | |p5= taskState: [[String]] (Optional, default {{ic|?}}) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED" | ||
|p6= showTitle: [[Boolean]] (Optional, default {{ic|[[true]]}}) - Whether or not to show title in the description section as well | |p6= showTitle: [[Boolean]] (Optional, default {{ic|[[true]]}}) - Whether or not to show title in the description section as well | ||
|p6since= arma3 1.96 | |||
|r1= [[Diary Record]] | |r1= [[Diary Record]] | ||
|s2= player [[createDiaryRecord]] [subject, [title, text], task, taskState, showTitle] | |s2= player [[createDiaryRecord]] [subject, [title, text, icon], task, taskState, showTitle] | ||
|p21= player : [[Object]] | |p21= player : [[Object]] | ||
Line 115: | Line 143: | ||
|p24= text: [[String]] | |p24= text: [[String]] | ||
|p25= | |p25= icon: [[String]] - (Optional) icon to show next to the title | ||
|p25since= arma3 2.10 | |||
|p26= | |p26= task: [[Task]] - (Optional, default {{ic|[[taskNull]]}}) | ||
|p27= showTitle: [[Boolean]] (Optional, default {{ic|[[true]]}}) - Whether or not to show title in the description section as well | |p27= taskState: [[String]] (Optional, default {{ic|?}}) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED" | ||
|p28= showTitle: [[Boolean]] (Optional, default {{ic|[[true]]}}) - Whether or not to show title in the description section as well | |||
|p28since= arma3 1.96 | |||
|r2= [[Diary Record]] | |r2= [[Diary Record]] | ||
|x1= < | |x1= <sqf>player createDiaryRecord ["Diary", ["Intel", "Enemy base is on grid <marker name='enemyBase'>161170</marker>"]]</sqf> | ||
|x2= < | |x2= <sqf>player createDiaryRecord ["Diary", "Information gathered.<br /><img image='wellDone_ca.paa' />"]</sqf> | ||
|x3= < | |x3= <sqf>player createDiaryRecord ["Diary", ["No Title", "description"], taskNull, "", false];</sqf> | ||
|x4= < | |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= < | |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= < | |x6= <sqf>player createDiaryRecord ["Diary", ["Linebreak","Line1<br></br>Line2<br></br><br></br>Line4"], taskNull, "", false];</sqf> | ||
|x7= < | |x7= <sqf>player createDiaryRecord ["Diary", ["Execute","<execute expression='hint ""Some code"";'>Some text</execute>"], taskNull, "", false];</sqf> | ||
|x8= < | |x8= <sqf>player createDiaryRecord ["Diary", ["ExecuteClose", "<executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose>"], taskNull, "", false];</sqf> | ||
|seealso= [[processDiaryLink]] [[createDiaryLink]] [[createDiarySubject]] [[diarySubjectExists]] [[setDiaryRecordText]] [[removeDiaryRecord]] | |seealso= [[allDiaryRecords]] [[processDiaryLink]] [[createDiaryLink]] [[createDiarySubject]] [[diarySubjectExists]] [[setDiaryRecordText]] [[removeDiaryRecord]] | ||
}} | }} | ||
<dl class="command_description"> | |||
<dt></dt> | <dt></dt> | ||
<dd class="notedate">Posted on March 24, 2017 - 20:11 (UTC)</dd> | <dd class="notedate">Posted on March 24, 2017 - 20:11 (UTC)</dd> | ||
Line 150: | Line 182: | ||
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. | 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. | ||
</dd> | </dd> | ||
<dt><dt> | <dt><dt> | ||
<dd class="notedate">Posted on June 22, 2019 - 16:28 (UTC)</dd> | <dd class="notedate">Posted on June 22, 2019 - 16:28 (UTC)</dd> | ||
Line 156: | Line 189: | ||
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. | 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. | ||
</dd> | </dd> | ||
</dl> | </dl> |
Revision as of 00:41, 24 May 2022
Description
- Description:
-
Creates a diary entry. Supported tags and their parameters:
Tag Options Example 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.
- title: String - tooltip to show on mouse over image (Since Arma 3 v2.10)
- src: String - alternative to 'image' (Since Arma 3 v2.10)
<img image="picture.paa" width="128" height="64" />
Since Arma 3 v2.10 :<img title="this is image" src="picture.paa" width="128" height="64" />
font - color: String - HTML color in format #aarrggbb or #rrggbb
- size: Number - font height in pixels.
- 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 record="ABCD">Get to the ABC record</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, text, task, taskState, showTitle]
- Parameters:
- player: Object
- subject: String
- text: String
- task: Task - (Optional, default
taskNull
) - taskState: String (Optional, default
?
) - Changes the state of the given task. Can be "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
Alternative Syntax
- Syntax:
- player createDiaryRecord [subject, [title, text, icon], task, taskState, showTitle]
- Parameters:
- player : Object
- subject: String
- title: String
- text: String
- since 2.10
- icon: String - (Optional) icon to show next to the title
- task: Task - (Optional, default
taskNull
) - taskState: String (Optional, default
?
) - Changes the state of the given task. Can be "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:
- player createDiaryRecord ["Diary", "Information gathered.<br /><img image='wellDone_ca.paa' />"]
- 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 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 June 22, 2019 - 16:28 (UTC)
- R3vo
- 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.