Difference between revisions of "Diary"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added image)
m (update v2.04)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[File:A3 Diary v2.jpg|350px|right]]
 
[[File:A3 Diary v2.jpg|350px|right]]
{{WIP}}
 
  
Fixed Subjects: Tasks, Diary, Units, Players, Statistics
+
== Subjects ==
 +
=== Default Subjects ===
 +
{| class="wikitable"
 +
! Display Name !! Internal Name !! Can be Linked !! Can be Edited !! Notes
 +
|-
 +
| Map || Map || {{Icon|unchecked}} || {{Icon|unchecked}} || Dummy tab
 +
|-
 +
| Tasks || Tasks || {{Icon|checked}} || {{Icon|unchecked}} || Hidden when no tasks exist
 +
|-
 +
| Briefing || Diary || {{Icon|checked}} || {{Icon|checked}} || Always shown, even when empty. Can be edited with [[createDiaryRecord]].
 +
|-
 +
| Team || Units || {{Icon|checked}} || {{Icon|unchecked}} || Always shown
 +
|-
 +
| Players || Players || {{Icon|checked}} || {{Icon|unchecked}} || Hidden in singleplayer
 +
|-
 +
| Statistics || Statistics || {{Icon|checked}} || {{Icon|unchecked}} || Hidden until scores are changed
 +
|}
  
* displayed name: Tasks; link name: Tasks; hidden when no tasks exist; read-only
+
=== Custom Subjects ===
* displayed name: Briefing; link name: Diary; always shown; can be added to
+
Can be created with [[createDiarySubject]] - they go after all the default ones and can obviously be modified.
* displayed name: Team; link name: Units; always shown; read-only
 
* displayed name: Players; link name: Players; hidden when in SP; read-only
 
* displayed name: Statistics; link name: Statistics; hidden until there are scores to show; read-only
 
  
{{TODO | Sort below note later}}
+
=== Related Commands ===
 +
* [[:Category:Command Group: Briefing|Command Group: Briefing]]
 +
{| class="wikitable" width="30%"
 +
|-
 +
! Subject commands !! Record commands !! Helper commands
 +
|-
 +
| [[createDiarySubject]] || [[createDiaryRecord]] || [[createDiaryLink]]
 +
|-
 +
| [[removeDiarySubject]] || [[removeDiaryRecord]] || [[processDiaryLink]]
 +
|-
 +
| [[selectDiarySubject]] || [[setDiaryRecordText]] ||
 +
|-
 +
| [[diarySubjectExists]] || [[diaryRecordNull]] ||
 +
|-
 +
| [[setDiarySubjectPicture]] || ||
 +
|-
 +
| [[allDiarySubjects]] || ||
 +
|}
  
{{Informative | In Arma 3 the top subject called "Map" but it is a dummy, the 1st subject is Tasks, internal name is also "Tasks" and it is hidden until there are any assigned tasks to show. It cannot be modified directly. Second subject is called "Briefing", but its internal name is "Diary", this can be modified and selected. Next is called "Team", internal name "Units", cannot be modified but can be selected. Next is called "Players" (same internal name) but it is hidden in SP and also cannot be modified. Next is called "Statistics" (same internal name), hidden until there are some statistics to show (kills etc), cannot be modified. Any custom subjects created with [[createDiarySubject]] go at the bottom and can be modified. }}
+
[[Category: Scripting Topics]]
 
+
__NOTOC__
 
 
 
 
Subject commands
 
 
 
* [[createDiarySubject]]
 
* [[removeDiarySubject]]
 
* [[selectDiarySubject]]
 
* [[diarySubjectExists]]
 
* [[setDiarySubjectPicture]]
 
* [[allDiarySubjects]]
 
 
 
 
 
Record commands
 
 
 
* [[createDiaryRecord]]
 
* [[removeDiaryRecord]]
 
* [[setDiaryRecordText]]
 
* [[diaryRecordNull]]
 
 
 
 
 
Helpers
 
 
 
* [[createDiaryLink]]
 
* [[processDiaryLink]]
 

Latest revision as of 16:08, 27 April 2021

A3 Diary v2.jpg

Subjects

Default Subjects

Display Name Internal Name Can be Linked Can be Edited Notes
Map Map Unchecked Unchecked Dummy tab
Tasks Tasks Checked Unchecked Hidden when no tasks exist
Briefing Diary Checked Checked Always shown, even when empty. Can be edited with createDiaryRecord.
Team Units Checked Unchecked Always shown
Players Players Checked Unchecked Hidden in singleplayer
Statistics Statistics Checked Unchecked Hidden until scores are changed

Custom Subjects

Can be created with createDiarySubject - they go after all the default ones and can obviously be modified.

Related Commands

Subject commands Record commands Helper commands
createDiarySubject createDiaryRecord createDiaryLink
removeDiarySubject removeDiaryRecord processDiaryLink
selectDiarySubject setDiaryRecordText
diarySubjectExists diaryRecordNull
setDiarySubjectPicture
allDiarySubjects