createDiarySubject: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game name=" to "|Game name= |gr1= Briefing |GROUP1= ")
m (Text replacement - "\] +\[" to "] [")
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


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


|gr1= Briefing |GROUP1=
|game2= arma2oa
|version2= 1.50


|game3= tkoh
|version3= 1.00


|game4= arma3
|version4= 0.50


|1.00|Game version=
|gr1= Briefing
____________________________________________________________________________________________


| Create a new subject page in a log. |DESCRIPTION=
|eff= local
____________________________________________________________________________________________


| person '''createDiarySubject''' [subject, displayName, picture] |SYNTAX=
|arg= local


|descr= Creates a new subject in the [[Diary]].


|p1= person: [[Object]] |PARAMETER1=
|s1= player [[createDiarySubject]] [subject, displayName, picture]


|p2= [subject, displayName, picture]: [[Array]] |PARAMETER2=
|p1= player: [[Object]]


|p3= subject: [[String]] |PARAMETER3=
|p2= subject: [[String]]


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


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


| [[Number]] |RETURNVALUE=
|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>|EXAMPLE1=
|seealso= [[removeDiarySubject]] [[processDiaryLink]] [[createDiaryLink]] [[createDiaryRecord]] [[diarySubjectExists]] [[setDiarySubjectPicture]] [[allDiarySubjects]]
 
____________________________________________________________________________________________
 
| [[processDiaryLink]], [[createDiaryLink]], [[createDiaryRecord]], [[diarySubjectExists]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<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:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Briefing|{{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 -->

Latest revision as of 11:46, 5 May 2024

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=364194"