setDiaryRecordText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}")
No edit summary
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game=
|game1= arma3
|version1= 1.96


|1.96|Game Version (number surrounded by NO SPACES)=
|gr1= Briefing


|arg=  |Multiplayer Arguments ("local" or "global")=
|descr= Set text of a log record.


|eff=  |Multiplayer Effects ("local" or "global")=
|s1= unit [[setDiaryRecordText]] [[subject, diaryRecord], [title, text, icon]]


|serverExec=  |Multiplayer Execution ("server" or empty)=
|p1= unit: [[Object]]


|gr1= Briefing |GROUP1=
|p2= subject: [[String]]
____________________________________________________________________________________________


| Set text of a log record. |Description=
|p3= diaryRecord: [[Diary Record]]
____________________________________________________________________________________________


| unit [[setDiaryRecordText]] [[subject, diaryRecord], [title, text]] |Syntax=
|p4= title: [[String]]


|p1= unit: [[Object]] |PARAMETER1=
|p5= text: [[String]]


|p2=[[subject, diaryRecord], [title, text]]: [[Array]] |PARAMETER2=
|p6= icon: [[String]] - (Optional) icon to show next to the title. "" to remove.
|p6since= arma3 2.10


| Nothing |Return Value=
|r1= Nothing
____________________________________________________________________________________________


|x1= <code>[[player]] [[setDiaryRecordText]] [<nowiki/>["diary", _diaryRec], ["Kill all enemies."]]</code> |Example 1=
|x1= <sqf>player setDiaryRecordText [["diary", _diaryRec], ["Kill all enemies.", "The enemies are the bad guys. Kill them because you are the good guy."]];</sqf>
____________________________________________________________________________________________


| [[processDiaryLink]], [[createDiaryRecord]], [[createDiarySubject]], [[diarySubjectExists]] |See Also=
|seealso= [[allDiaryRecords]] [[processDiaryLink]] [[createDiaryRecord]] [[createDiarySubject]] [[diarySubjectExists]]
}}
}}
<dl class="command_description">
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">[[User:User Name|User Name]]</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 00:41, 24 May 2022

Hover & click on the images for description

Description

Description:
Set text of a log record.
Groups:
Briefing

Syntax

Syntax:
unit setDiaryRecordText [[subject, diaryRecord], [title, text, icon]]
Parameters:
unit: Object
subject: String
diaryRecord: Diary Record
title: String
text: String
since Arma 3 logo black.png2.10
icon: String - (Optional) icon to show next to the title. "" to remove.
Return Value:
Nothing

Examples

Example 1:
player setDiaryRecordText [["diary", _diaryRec], ["Kill all enemies.", "The enemies are the bad guys. Kill them because you are the good guy."]];

Additional Information

See also:
allDiaryRecords processDiaryLink createDiaryRecord createDiarySubject diarySubjectExists

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