BIS fnc createLogRecord: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= GUI


|1.00|= Game version
|arg= local
____________________________________________________________________________________________


| <pre>/*
|eff= local


Description:
|descr= Create a dated, timed diary record in the owner's "Log" subject.
Create diary record in unified "Log" subject (create it when it doesn't exist yet)


Parameter(s):
|s1= [owner, title, text] call [[BIS_fnc_createLogRecord]]
0: OBJECT - owner
1: STRING - title
2: STRING - text


Returns:
|p1= owner: [[Object]]
STRING
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p2= title: [[String]] - (Optional, default "")
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_createLogRecord]]; --> |= Syntax
|p3= text: [[String]] - (Optional, default "")


|p1= |= Parameter 1
|r1= [[String]]


| |= Return value
|x1= <sqf>[player, "Title", "This is a log entry. Have fun!"] call BIS_fnc_createLogRecord;</sqf>
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[createDiaryRecord]]
}}
}}
<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:Function Group: GUI|{{uc:createLogRecord}}]]
[[Category:Functions|{{uc:createLogRecord}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:createLogRecord}}]]

Latest revision as of 18:00, 13 July 2022

Hover & click on the images for description

Description

Description:
Create a dated, timed diary record in the owner's "Log" subject.
Execution:
call
Groups:
GUI

Syntax

Syntax:
[owner, title, text] call BIS_fnc_createLogRecord
Parameters:
owner: Object
title: String - (Optional, default "")
text: String - (Optional, default "")
Return Value:
String

Examples

Example 1:
[player, "Title", "This is a log entry. Have fun!"] call BIS_fnc_createLogRecord;

Additional Information

See also:
createDiaryRecord

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