createDiarySubject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )I([a-z])" to "$1i$3")
m (Text replacement - "\] +\[" to "] [")
 
(2 intermediate revisions by the same user not shown)
Line 21: Line 21:
|descr= Creates a new subject in the [[Diary]].
|descr= Creates a new subject in the [[Diary]].


|s1= player [[createDiarySubject]] [subject, displayName, picture]
|s1= player [[createDiarySubject]] [subject, displayName, picture]


|p1= player: [[Object]]
|p1= player: [[Object]]
Line 27: Line 27:
|p2= subject: [[String]]
|p2= subject: [[String]]


|p3= displayName: [[String]] - The visible name
|p3= displayName: [[String]] - the visible name


|p4= picture: [[String]] - (Optional, default {{hl|""}}) icon to display next to the subject. Can be set later with [[setDiarySubjectPicture]]. Similar to [[lbSetPictureRight]].
|p4= picture: [[String]] - (Optional, default {{hl|""}}) icon to display next to the subject. Can be set later with [[setDiarySubjectPicture]]. Similar to [[lbSetPictureRight]].


|r1= [[Number]] - Index of the entry that was added
|r1= [[Number]] - index of the entry that was added


|x1= <sqf>_index = player createDiarySubject ["myPage","My page"];</sqf>
|x1= <sqf>_index = player createDiarySubject ["myPage","My page"];</sqf>

Latest revision as of 11:46, 5 May 2024

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