selectDiarySubject: Difference between revisions

Revision as of 12:02, 17 June 2021

Hover & click on the images for description

Description:: Selects a subject page in the diary. The subject page is selected but the command does not open the map by default, which could be opened with openMap if necessary.
Groups:: Briefing

Syntax:

player selectDiarySubject subject

Parameters:

player: Object - Player

subject: String - Subject name, for example "Diary" (see also Diary).

ⓘ

In order to open a specific record inside a subject one can append :Record0-n to the subject name.

player selectDiarySubject "Diary:Record0"; // Selects the first record in the diary subject (from bottom to top)
player selectDiarySubject "Diary:Record1"; // Selects the second record

Return Value:

Boolean - True if subject was successfully selected

See also:: processDiaryLink createDiaryLink createDiarySubject diarySubjectExists allDiarySubjects

: 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

@@ Line 25: / Line 25: @@
 |p1= player: [[Object]] - Player
-|p2= subject: [[String]] - Subject name, for example "Diary" (see also [[Diary]]). It can be further instructed to select a record too, for example "Diary:Record2".
+|p2= subject: [[String]] - Subject name, for example "Diary" (see also [[Diary]]).
+{{Feature|Informative|In order to open a specific record inside a subject one can append <tt>:Record0-n</tt> to the subject name.
+* {{ic|[[player]] [[selectDiarySubject]] "Diary:Record0"; {{cc|Selects the first record in the diary subject (from bottom to top)}}}}
+* {{ic|[[player]] [[selectDiarySubject]] "Diary:Record1"; {{cc|Selects the second record}}}}}}
 |r1= [[Boolean]] - [[true|True]] if subject was successfully selected