createDiarySubject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Bot: Replacing category Scripting Commands Arma 3 with Arma 3: Scripting Commands)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(48 intermediate revisions by 4 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


| Create a new subject page in a log. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| person '''createDiarySubject''' [subject, displayName, picture] |= Syntax
|game4= arma3
|version4= 0.50


|gr1= Briefing


|p1= person: [[Object]] |= PARAMETER1
|eff= local


|p2= [subject, displayName, picture]: [[Array]] |= PARAMETER2
|arg= local


|p3= subject: [[String]] |= PARAMETER2
|descr= Creates a new subject in the [[Diary]].


|p4= displayName: [[String]] - The visible name|= PARAMETER4
|s1= player [[createDiarySubject]] [subject, displayName, picture]


|p5= picture: (optional): [[String]]|= PARAMETER5
|p1= player: [[Object]]


| [[Number]] |= RETURNVALUE
|p2= subject: [[String]]


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


|x1= <code>_index <nowiki>=</nowiki>[[player]] [[createDiarySubject]] ["myPage","My page"];</code>|= EXAMPLE1
|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


| [[processDiaryLink]], [[createDiaryLink]], [[createDiaryRecord]], [[diarySubjectExists]] |= SEEALSO
|x1= <sqf>_index = player createDiarySubject ["myPage","My page"];</sqf>


| |= MPBEHAVIOUR
|seealso= [[removeDiarySubject]] [[processDiaryLink]] [[createDiaryLink]] [[createDiaryRecord]] [[diarySubjectExists]] [[setDiarySubjectPicture]] [[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>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 3: Scripting Commands]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Briefing|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:50, 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:
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
Retrieved from "https://community.bistudio.com/wiki?title=createDiarySubject&oldid=349221"