API:CreateConversationLog

UI Lua API · Interface functions
Version: WAR 1.4.8

Creates the per-player conversation text log for a player, if it does not exist yet.

CreateConversationLog(playerName)

Arguments

playerName

wstring – Name of the other player. It must be a wide string (L"Name" or towstring()).

Returns

Nothing.

Details

• The text log is named after playerName. If a text log with that name already exists, nothing changes.
• Otherwise the client creates it with the same code it uses when an incoming chat message needs a per-sender log: it creates a folder for the conversation under the client's log directory, gives the log a save file there, and enables saving to disk according to the player's chat-logging setting.
• The function uses the local player's server and character name, so call it only when in the game world.
• The stock UI never calls this function.

Errors

None besides the Invalid Parameters argument check.

Example

A minimal example built from the signature:

CreateConversationLog( L"Somebody" )

See also

• TextLogCreate
• TextLogGetEnabled