selectDiarySubject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(page formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2


|1.00
|version1= 1.00


|gr1=  
|game2= arma2oa


|gr2= Briefing
|version2= 1.51


| Selects the [[Diary]] subject page in a log. The subject is selected but the command doesn't open the map by default, which could be opened with [[openMap]] if necessary.<br><br>
|game3= tkoh
 
|version3= 1.00
 
|game4= arma3
 
|version4= 0.50
 
|gr1= Briefing
 
|eff= local
 
|arg= local
 
|descr= Selects a subject page in the [[Diary|diary]]. The subject page is selected but the command does not open the map by default, which could be opened with [[openMap]] if necessary.
{{Feature|arma3|This command seems to be broken in {{GVI|arma3|1.82}}. Use [[BIS_fnc_selectDiarySubject]] instead.}}
{{Feature|arma3|This command seems to be broken in {{GVI|arma3|1.82}}. Use [[BIS_fnc_selectDiarySubject]] instead.}}
{{Wiki|todo| Remove the above note after 2.03.147165}}
{{Wiki|todo| Remove the above note after 2.03.147165}}


| person [[selectDiarySubject]] subject
|s1= player [[selectDiarySubject]] subject


|p1= person: [[Object]] - Player
|p1= player: [[Object]] - Player


|p2= subject: [[String]] - subject name, for example "Diary" (Briefing tab). It could be further instructed to select a record too, for example "Diary:Record2".
|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".


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


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


|seealso= [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]], [[allDiarySubjects]]
|seealso= [[processDiaryLink]] [[createDiaryLink]] [[createDiarySubject]] [[diarySubjectExists]] [[allDiarySubjects]]
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 11:47, 4 March 2021

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.
Arma 3
This command seems to be broken in Arma 3 logo black.png1.82. Use BIS_fnc_selectDiarySubject instead.
🚧
TODO: Remove the above note after 2.03.147165
Groups:
Briefing

Syntax

Syntax:
player selectDiarySubject subject
Parameters:
player: Object - Player
subject: String - subject name, for example "Diary" (see also Diary). It can be further instructed to select a record too, for example "Diary:Record2".
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