selectDiarySubject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *S([a-z ])" to "$1 - s$2")
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= Broken Commands |GROUP1=
|game3= tkoh
|version3= 1.00


|gr2= Briefing |GROUP2=
|game4= arma3
|version4= 0.50


|gr1= Briefing


| Selects the subject page in a log.<br><br>
|eff= local
{{Feature|arma3|This command seems to be broken in {{GVI|arma3|1.82}}. Use [[BIS_fnc_selectDiarySubject]] instead.}}|DESCRIPTION=


| person [[selectDiarySubject]] subject |SYNTAX=
|arg= local


|p1= person: [[Object]] - Player|PARAMETER1=
|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.


|p2= subject: [[String]]|PARAMETER2=
|s1= player [[selectDiarySubject]] subject


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


| [[Nothing]] |RETURNVALUE=
|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.
|x1= <code>[[player]] [[selectDiarySubject]] "someSubject";</code>|EXAMPLE1=
<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]] if subject was successfully selected


| [[processDiaryLink]], [[createDiaryLink]], [[createDiarySubject]], [[diarySubjectExists]]  |SEEALSO=  
|x1= <sqf>
openMap true;
player selectDiarySubject "Diary";
</sqf>


| |MPBEHAVIOUR=  
|seealso= [[processDiaryLink]] [[createDiaryLink]] [[createDiarySubject]] [[diarySubjectExists]] [[allDiarySubjects]]
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:49, 8 November 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalLELocal
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
Retrieved from "https://community.bistudio.com/wiki?title=selectDiarySubject&oldid=349165"