BIS fnc createLogRecord: Difference between revisions

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


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= GUI


|args= local |= Arguments
|arg= local  


|eff= local |= Effect
|eff= local
____________________________________________________________________________________________


| Create a dated, timed diary record in the owner's "Log" subject. |DESCRIPTION=
|descr= Create a dated, timed diary record in the owner's "Log" subject.
____________________________________________________________________________________________


| [owner, title, text] call [[BIS_fnc_createLogRecord]] |SYNTAX=
|s1= [owner, title, text] call [[BIS_fnc_createLogRecord]]


|p1= owner: [[Object]] |= Parameter 1
|p1= owner: [[Object]]


|p2= title: [[String]] - (Optional, default "") |= Parameter 2
|p2= title: [[String]] - (Optional, default "")


|p3= text: [[String]] - (Optional, default "") |= Parameter 3
|p3= text: [[String]] - (Optional, default "")


| [[String]] |RETURNVALUE=
|r1= [[String]]
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[[player]], "Title", "This is a log entry. Have fun!"] [[call]] [[BIS_fnc_createLogRecord]];</code> |= Example 1
|x1= <sqf>[player, "Title", "This is a log entry. Have fun!"] call BIS_fnc_createLogRecord;</sqf>
____________________________________________________________________________________________


| [[createDiaryRecord]] |SEEALSO=
|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 17: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