createDiaryRecord: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) |
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "") |
||
(8 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
| arma2 |Game name= | | arma2 |Game name= | ||
|gr1= Briefing |GROUP1= | |||
|1.00|Game version= | |1.00|Game version= | ||
Line 27: | Line 31: | ||
{{!}}- | {{!}}- | ||
{{!}} br | {{!}} br | ||
{{!}} | {{!}} {{n/a}} | ||
{{!}}- | {{!}}- | ||
{{!}} marker | {{!}} marker | ||
Line 88: | Line 92: | ||
|p5= taskState: (optional): [[String]] - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED"|PARAMETER5= | |p5= taskState: (optional): [[String]] - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED"|PARAMETER5= | ||
|p6= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3| | |p6= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3|1.96}} |PARAMETER6= | ||
| [[Diary Record]] |RETURNVALUE= | | [[Diary Record]] |RETURNVALUE= | ||
Line 107: | Line 111: | ||
|p26= taskState: (optional): [[String]] - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED" |PARAMETER26= | |p26= taskState: (optional): [[String]] - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED" |PARAMETER26= | ||
|p27= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3| | |p27= showTitle (Optional): [[Boolean]] - Title visibility. Default: [[true]] {{GVI|arma3|1.96}} |PARAMETER27= | ||
|r2= [[Diary Record]] |RETURNVALUE2= | |r2= [[Diary Record]] |RETURNVALUE2= | ||
Line 128: | Line 132: | ||
|x8= <code>[[player]] [[createDiaryRecord]] ["Diary", ["ExecuteClose", "<nowiki><executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose></nowiki>"], [[taskNull]], "", [[false]]];</code>|EXAMPLE8= | |x8= <code>[[player]] [[createDiaryRecord]] ["Diary", ["ExecuteClose", "<nowiki><executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose></nowiki>"], [[taskNull]], "", [[false]]];</code>|EXAMPLE8= | ||
| [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]] |SEEALSO= | | [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]], [[setDiaryRecordText]], [[removeDiaryRecord]] |SEEALSO= | ||
| |MPBEHAVIOUR= | | |MPBEHAVIOUR= | ||
Line 134: | Line 138: | ||
<h3 style='display:none'>Bottom Section</h3> | <h3 style='display:none'>Bottom Section</h3> | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
[[Category: | [[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | ||
<!-- CONTINUE Notes --> | <!-- CONTINUE Notes --> | ||
Line 148: | Line 150: | ||
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> | ||
<dd class="notedate">Posted on May 21, 2018 - 08:21 (UTC)</dd> | <dd class="notedate">Posted on May 21, 2018 - 08:21 (UTC)</dd> | ||
<dt class="note">[[User:Kalthramis|Kalthramis]]</dt> | <dt class="note">[[User:Kalthramis|Kalthramis]]</dt> | ||
Line 158: | Line 156: | ||
To add an entry under the 'Briefing' subject, which is available by default, use "Diary" as the subject. | To add an entry under the 'Briefing' subject, which is available by default, use "Diary" as the subject. | ||
</dd> | </dd> | ||
<dd class="notedate">Posted on June 22, 2019 - 16:28 (UTC)</dd> | <dd class="notedate">Posted on June 22, 2019 - 16:28 (UTC)</dd> | ||
<dt class="note">[[User:R3vo|R3vo]]</dt> | <dt class="note">[[User:R3vo|R3vo]]</dt> |
Revision as of 11:19, 25 September 2020
Description
- Description:
- Creates a diary entry. Supported tags and their parameters:
Tag Options img font - color: String - HTML color in format #aarrggbb or #rrggbb
- size: Number - font height in pixels.
- face: String - font type (class from CfgFontFamilies)
br N/A 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 - unit ID
ban - id: Number - unit ID
mute - id: Number - unit ID
currentTask - id: Number - task ID
- Groups:
- Briefing
Syntax
- Syntax:
- unitName createDiaryRecord [subject, text, task, taskState, showTitle]
- Parameters:
- unitName: Object
- subject: String
- text: String
- task: (optional): Task
- taskState: (optional): String - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED"
- showTitle (Optional): Boolean - Title visibility. Default: true 1.96
- Return Value:
- Diary Record
Alternative Syntax
- Syntax:
- unitName createDiaryRecord [subject, [title, text], task, stateState, showTitle]
- Parameters:
- unitName: Object
- subject: String
- title: String
- text: String
- task: (optional): Task
- taskState: (optional): String - Changes the state of the given task. Can be "CANCELED", "ASSIGNED", "FAILED", "CREATED", "SUCCEEDED"
- showTitle (Optional): Boolean - Title visibility. Default: true 1.96
- 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:
player createDiaryRecord ["Diary", ["No Title", "description"], taskNull, "", false];
- Example 4:
player createDiaryRecord ["Diary", ["Font tag","<font color='#7FFF00' size='30' face='TahomaB'>This will changed text size, colour and font</font>"], taskNull, "",false];
- Example 5:
player createDiaryRecord ["Diary", ["Image", "<img image='\A3\Ui_F_Curator\Data\Logos\arma3_curator_artwork.jpg' width='500' height='800'/>"], taskNull, "", false];
- Example 6:
player createDiaryRecord ["Diary", ["Linebreak","Line1<br></br>Line2<br></br><br></br>Line4"], taskNull, "", false];
- Example 7:
player createDiaryRecord ["Diary", ["Execute","<execute expression='hint ""Some code"";'>Some text</execute>"], taskNull, "", false];
- Example 8:
player createDiaryRecord ["Diary", ["ExecuteClose", "<executeClose expression=""hint 'Diary closed';"">Close Diary</executeClose>"], taskNull, "", false];
Additional Information
- See also:
- processDiaryLinkcreateDiaryLinkcreateDiarySubjectdiarySubjectExistssetDiaryRecordTextremoveDiaryRecord
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
Bottom Section
- 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 May 21, 2018 - 08:21 (UTC)
- Kalthramis
- To add an entry under the 'Briefing' subject, which is available by default, use "Diary" as the subject.
- Posted on June 22, 2019 - 16:28 (UTC)
- R3vo
- It seems that the task parameter has no effect because the task entry in the briefing menu is created when the task itself was created.