selectDiarySubject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|game([0-9]) ?= (.+) \|version([0-9]) ?= (.+) " to "|game$1= $2 |version$3= $4 ")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *S([a-z ])" to "$1 - s$2")
 
(12 intermediate revisions by 2 users not shown)
Line 23: Line 23:
|s1= player [[selectDiarySubject]] subject
|s1= player [[selectDiarySubject]] subject


|p1= player: [[Object]] - Player
|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 {{hl|:Record#}} to the subject name.
<sqf>
player selectDiarySubject "Diary:Record0"; // selects the first record in the diary subject (from bottom to top)
player selectDiarySubject "Diary:Record1"; // selects the second record
</sqf>
}}


|r1= [[Boolean]] - [[true|True]] if subject was successfully selected
|r1= [[Boolean]] - [[true]] if subject was successfully selected


|x1= <code>[[openMap]] [[true]];  
|x1= <sqf>
[[player]] [[selectDiarySubject]] "Diary";</code>
openMap true;
player selectDiarySubject "Diary";
</sqf>


|seealso= [[processDiaryLink]] [[createDiaryLink]] [[createDiarySubject]] [[diarySubjectExists]] [[allDiarySubjects]]
|seealso= [[processDiaryLink]] [[createDiaryLink]] [[createDiarySubject]] [[diarySubjectExists]] [[allDiarySubjects]]
}}
}}

Latest revision as of 16:49, 8 November 2023

Hover & click on the images for description

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

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 :Record# 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

Examples

Example 1:
openMap true; player selectDiarySubject "Diary";

Additional Information

See also:
processDiaryLink createDiaryLink createDiarySubject diarySubjectExists allDiarySubjects

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