createDiaryRecord: Difference between revisions
Killzone Kid (talk | contribs) No edit summary |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
Line 33: | Line 33: | ||
* ''title'': [[String]] - tooltip to show on mouse over image (Since Arma 3 v2.10) | * ''title'': [[String]] - tooltip to show on mouse over image (Since Arma 3 v2.10) | ||
* ''src'': [[String]] - alternative to '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. {{ | {{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. {{hl|height {{=}} 370; ratio {{=}} 16/9; height {{=}} width / ratio;}}}} | ||
| <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> | | <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> | ||
|- | |- | ||
Line 124: | Line 124: | ||
|p3= text: [[String]] | |p3= text: [[String]] | ||
|p4= task: [[Task]] - (Optional, default | |p4= task: [[Task]] - (Optional, default [[taskNull]]) | ||
|p5= taskState: [[String]] (Optional, default {{ | |p5= taskState: [[String]] (Optional, default {{hl|?}}) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "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 | ||
Line 146: | Line 146: | ||
|p25since= arma3 2.10 | |p25since= arma3 2.10 | ||
|p26= task: [[Task]] - (Optional, default | |p26= task: [[Task]] - (Optional, default [[taskNull]]) | ||
|p27= taskState: [[String]] (Optional, default {{ | |p27= taskState: [[String]] (Optional, default {{hl|?}}) - Changes the state of the given task. Can be "NONE", "CREATED", "ASSIGNED", "SUCCEEDED", "FAILED", "CANCELED" | ||
|p28= showTitle: [[Boolean]] (Optional, default | |p28= showTitle: [[Boolean]] (Optional, default [[true]]) - Whether or not to show title in the description section as well | ||
|p28since= arma3 1.96 | |p28since= arma3 1.96 | ||
Line 174: | Line 174: | ||
}} | }} | ||
{{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. | |||
}} | |||
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. | |||
Revision as of 16:41, 26 July 2022
Description
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
- 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:
- 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.