createDiarySubject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(page formatting)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(11 intermediate revisions by 2 users not shown)
Line 2: Line 2:


|game1= arma2
|game1= arma2
|version1= 1.00
|version1= 1.00


|game2= arma2oa
|game2= arma2oa
 
|version2= 1.50
|version2= 1.51


|game3= tkoh
|game3= tkoh
|version3= 1.00
|version3= 1.00


|game4= arma3
|game4= arma3
|version4= 0.50
|version4= 0.50


Line 20: Line 16:


|eff= local
|eff= local
|arg= local


|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 29: 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 {{ic|""}}) 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= <code>_index = [[player]] [[createDiarySubject]] ["myPage","My page"];</code>
|x1= <sqf>_index = player createDiarySubject ["myPage","My page"];</sqf>


|seealso= [[removeDiarySubject]] [[processDiaryLink]] [[createDiaryLink]] [[createDiaryRecord]] [[diarySubjectExists]] [[setDiarySubjectPicture]] [[allDiarySubjects]]
|seealso= [[removeDiarySubject]] [[processDiaryLink]] [[createDiaryLink]] [[createDiaryRecord]] [[diarySubjectExists]] [[setDiarySubjectPicture]] [[allDiarySubjects]]
}}
}}

Latest revision as of 16:50, 8 November 2023

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