ApiApp().SetSocketOutput

Sends the string to the currently attached socket.

Description

This method forces the sending of the string as a message to the socket connection. In C#, you may set up your own socket output via direct scripting, or through a loaded and registered plugin. Note that application specific scripts, not the core, are responsible for the setup and attachment of the appropriate socket scripts and the connection to an external client or server. This function was originally implemented for LUA applications, support for LUA itself is deprecated.

Example Usage (C#)


bool success = _core.ApiApp().SetSocketOutput(“I am an in game character.”);

Parameters

string

output

The string for socket message output via the pre-attached socket.

Returns

The boolean success or failure of the operation.

See Also

  • ApiApp().SetVoiceOutput
  • ApiApp().SetTextOutput
  • ApiApp().SetDiagOutput
  • ApiApp().DisableSocketOutput

ApiApp() Functions