createDiarySubject: Difference between revisions

Latest revision as of 11:46, 5 May 2024

1.00

Hover & click on the images for description

Description

Description:: Creates a new subject in the Diary.
Groups:: Briefing

Syntax

Syntax:: player createDiarySubject [subject, displayName, picture]
Parameters:: player: Object
: subject: String
: displayName: String - the visible name
: picture: String - (Optional, default "") icon to display next to the subject. Can be set later with setDiarySubjectPicture. Similar to lbSetPictureRight.
Return Value:: Number - index of the entry that was added

Examples

Example 1:: _index = player createDiarySubject ["myPage","My page"];

Additional Information

See also:: removeDiarySubject processDiaryLink createDiaryLink createDiaryRecord diarySubjectExists setDiarySubjectPicture 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

@@ Line 1: / Line 1: @@
-{{Command
+{{RV|type=command
-| arma2
+|game1= arma2
+|version1= 1.00
-|gr1= Briefing
+|game2= arma2oa
+|version2= 1.50
+|game3= tkoh
+|version3= 1.00
+|game4= arma3
+|version4= 0.50
-|1.00
+|gr1= Briefing
-| Create a new subject page in a log.
+|eff= local
-| person '''createDiarySubject''' [subject, displayName, picture]
+|arg= local
+|descr= Creates a new subject in the [[Diary]].
-|p1= person: [[Object]]
+|s1= player [[createDiarySubject]] [subject, displayName, picture]
-|p2= [subject, displayName, picture]: [[Array]]
+|p1= player: [[Object]]
-|p3= subject: [[String]]
+|p2= subject: [[String]]
-|p4= displayName: [[String]] - The visible name
+|p3= displayName: [[String]] - the visible name
-|p5= picture: (optional): [[String]]
+|p4= picture: [[String]] - (Optional, default {{hl|""}}) icon to display next to the subject. Can be set later with [[setDiarySubjectPicture]]. Similar to [[lbSetPictureRight]].
-| [[Number]]
+|r1= [[Number]] - index of the entry that was added
+|x1= <sqf>_index = player createDiarySubject ["myPage","My page"];</sqf>
-|x1= <code>_index <nowiki>=</nowiki>[[player]] [[createDiarySubject]] ["myPage","My page"];</code>
+|seealso= [[removeDiarySubject]] [[processDiaryLink]] [[createDiaryLink]] [[createDiaryRecord]] [[diarySubjectExists]] [[setDiarySubjectPicture]] [[allDiarySubjects]]
-| [[processDiaryLink]], [[createDiaryLink]], [[createDiaryRecord]], [[diarySubjectExists]]
 }}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
-<!-- CONTINUE Notes -->
-<dl class="command_description">
-<dd class="notedate">Posted on June 22, 2019 - 10:11 (UTC)</dd>
-<dt class="note">[[User:R3vo|R3vo]]</dt>
-<dd class="note">
-The parameter '''picture''' seems to have no effect in {{arma3}}
-<code>player [[createDiarySubject]] ["myPage","My page","\A3\Data_F_Argo\Logos\arma3_argo_artwork.jpg"];</code>
-No image is shown.
-</dd>
-</dl>
-<!-- DISCONTINUE Notes -->